Manager Controls: Sales Document Configuration Maintenance

iRow.ColumnName

Returns the cell contents in a row variable defined by the column name or number.

iMyList.RowNo.ColumnName

Returns the cell contents in a list variable defined by row number and column name or number. Note that if the list has a current line (clicked by the user, or set programmatically), iMyList.ColumnName will return the cell of the current line.

$topwind.$objs.Scroll.$objs.GroupName.
$objs.ItemName.$contents

Returns the data contents of an item in the wizard. $contents is a property of the object whose path is defined by the notation. See section on Programming How-To below for more details.

$topwind.$objs.Scroll.$objs.GroupName.
$objs.ItemName.$width.$assign(60)

Runs the $assign method to the item $width property on the wizard window and sets the objects width to 60 pixels. See section on Programming How-To below for more details.

iSOCustom.$MyMethod(Parameters, , )

Runs a custom method called $MyMethod in the oSOCustom object.

Set the width of an entry field to a different width than standard.

You can do this using Do condition statements. However, condition statements are run before the item is created on the window, so you must have your statements on an Item or Group that occurs after the object is created.

In this case the attribute of the object that you want to assign is the $width property. It takes an integer number of pixels.

Example: to set the data entry field to 100 pixels wide (one line):
Do {iWizardPaneRef.$objs.GroupText.
$objs.ItemDataname.$width.$assign(100)} returns {}

Stop a multiline entry field expanding when the window is re-sized.

You can do this using Do condition statements. However, as above, the object must have been created.

In this case the attribute of the object that you want to assign is firstly the $edgefloat property. It takes a constant as follows:

• kEFnone = no movement regardless of window re-sizing
• kEFright = right edge moves with the window’s right side
• kEFleftRight = the whole object moves with the window’s right side

Example: to stop a data entry field expanding with the window (one line):
Do {iWizardPaneRef.$objs.GroupText.
$objs.ItemDataname.$edgefloat.$assign(kEFNone)} returns {}

Make an Item display-only

You can do this using Do condition statements. However, as above, the object must have been created.

In this case the attribute of the object that you want to assign is typically the $enabled property. It takes a value of either kTrue or kFalse or a calculation that evaluates such.

Example 1: to make a checkbox display only (one line):
Do {iWizardPaneRef.$objs.GroupText.
$objs.ItemDataname.$enabled.$assign(kFalse)} returns {}

Example 2: to make an Entry, Multiline Entry or Combo box display only. This uses an environment method called $FieldState that takes two parameters, a reference to the object and the enabled state (one line):
Do {$ctask.tEnv.$FieldState(iWizardPaneRef.$objs.GroupText.
$objs.ItemDataname,kFalse)} returns {}

Make more lines visible on a Droplist or Combo

The normal number of lines that drop from a Droplist or Combo is 5. You can make this larger using a Do condition statement. However, as above, the object must have been created.

In this case the attribute of the object that you want to assign is the $listheight property. It takes a value of the number of lines.

Example: to make a droplist display up to 15 lines (one line):
Do {iWizardPaneRef.$objs.GroupText.
$objs.ItemDataname.$listheight.$assign(15)} returns {}

Embed data in the text of an Item

You cannot do this.

Position several Items side-by-side

You cannot do this.

iDocType

Determines the type of document produced. It takes a value of 0, 1, 2 or 3 that represents:

• 0 = Quotation
• 1 = Sales Order
• 2 = Estimate
• 3 =Job

Do {2} returns {iDocType}
This is the same as the Result statement:
Document Type is {‘ES’} if {}

iJobRow

This is the row variable of the Job header and has columns for each JOBFILE and CUSFILE field and SOHBOND (sales orders are data converted jobs). You can address job fields using dot notation in the form iJobRow.Fieldname.

To set the Customer Reference you would use:
Do {‘ABCDEF’} returns {iJobRow.JOBCREF}
This is the same as the Result statement:
Set Header Value {JOBCREF} to {‘ABCDEF’} if {}

iJbiList

This list variable contains a row for each document line item created by Include line result statements of previous pages. The list variable contains a column for each JBIFILE and WKCFILE field (plus SOLUSER, SOLDATO, SOLDATX for quotations and sales orders, plus the following parts fields: PTMSTUM, PTMTYPE, PTMMASS, PTMACCO, PTMSNO, PTMSLOC, PTMMLOC, PTMTRAC, PTMMSTO, PTMQATS, PTMSHEL, PTMASTO, PTMPHYQ, PTMENGC, PTMPDAT, PTMCOML in addition to a LineName column). You can address the currently selected line using the iJbiList.Fieldname syntax, or a specific line field using iJbiList.LineNo.Fieldname syntax. In the later case the LineNo is the line in the list NOT the document line number, so to use this you must keep track of the line items that have been Included and Excluded.

If you are confident of the current line you can set the account code using:
Do {‘0023400000’} returns {iJbiList.JBIACCO}
This is the same as the Result statement but the result statement has the advantage of identifying the row by LineName:
Set Line Value {Line1,JBIACCO} to {‘0023400000’} if {}
Once a result statement with an identified line name is run, that line item line becomes the current line until another line item is added to the list or another similar statement resets the current line.

WARNING: The Do statement does not implement any intelligent logical row organisation. To apply a Part or a Work Centre to a line item you should use the Set Line Value result statement. When this is used the part or work centre is added to the line using the same logic as when added in the document maintenance window. The same applies for values that affect price and/or cost.

iNewPtmList

This list variable contains a row for each new part to be created with a column for each PTMFILE field plus a LikePart column. A line is added for each Create part like statement is run. If the part is to be assigned a SO-999999-999 number in the same way as Order Item Configuration, you should use ???? as the first four characters of the number. Any other characters will be added to SO-999999 after the document is created.

NOTE: When a part is added using the Create part like result statement any BoM, Process Route, Quality Tests and Serial Number Structure records are copied from the LikePart for the new part into iNewBomList, iNewProList, iNewQapList and iNewSnsList list variables. If you want to avoid this you can add a new part to iNewPtmList using the following series of Do If result statements:
Find on {PTMPTNO} where value {‘LikePart’}
Do {iNewPtmList.$add()} returns {}
Do {iNewPtmList.$linecount} returns {iNewPtmList.$line}
Do {‘LikePart’} returns {iNewPtmList.PTMPTNO}
Do {‘????-01’} returns {iNewPtmList.PTMPTNO}
This first loads the LikePart into the CRB (see Current Record Buffer below), then adds the part data to a new line in the iNewPtmList, then sets the current line of the list, then sets the LikePart number and finally sets the new part number.

If you are confident of the current line, you can set the stock units using:
Do {‘Each’} returns {iNewPtmList.PTMSTUM}
This is the same as the Result statement but that has the advantage of identifying the row by Part Number:
Set Part Value field {????-01,PTMSTUM} to {‘Each’} if {}
Once a result statement with an identified part is run, that part line becomes the current line until another part is added to the list or another similar statement resets the current line.

iNewBomList

This list variable contains a row for each new BoM record to be created with a column for each BOMFILE field. iNewBomList lines are automatically added when a Create part like result statement is run and the LikePart BoM is copied to the list. In addition, lines can be added using the result statement:
Add/Change Component {Parent,Component,Field} with quantity {Value} if {}
when the Parent,Component combination is not in the list already.

Use the result statement:
Add/Change Component {Parent,Component,Field} with quantity {Value} if {}
to change values (or set the BOMQTY to zero to remove it) as this statement appropriately adjusts costs and therefore line item prices.

iNewProList

This list variable contains a row for each new Process Route record to be created with a column for each PROFILE field. iNewProList lines are automatically added when a Create part like result statement is run and the LikePart Route is copied to the list. In addition, lines can be added using the result statement:
Add/Change Route Op. {Parent,Op.No,Field} with quantity {Value} if {}
when the Parent,Op.No combination is NOT in the list already.

Use the result statement:
Add/Change Route Op. {Parent,Op.No,Field} with quantity {Value} if {}
to change values (or set the PROOPNO to zero to remove it) as this statement appropriately adjusts costs and therefore line item prices.

iNewQapList

This list variable contains a row for each new Quality Test record to be created with a column for each QAPFILE field. iNewQapList lines are automatically added when a Create part like result statement is run and the LikePart Quality Test is copied to the list. In addition, lines can be added using the result statement:
Add/Change Quality Test {Parent,No,Field} with quantity {Value} if {}
when the Parent,No combination is NOT in the list already.

Use the result statement:
Add/Change Quality Test {Parent,No,Field} with quantity {Value} if {}
to change values (or set the QAPNO to zero to remove it).

iNewSnsList

This list variable contains a row for each new Serial Number Structure record to be created with a column for each SNSFILE field. iNewSnsList lines are automatically added when a Create part like result statement is run and the LikePart Serial Number Structure is copied to the list. In addition, lines can be added using the result statement:
Add/Change Serial Structure {Parent,Component,Field} with quantity {Value} if {}
when the Parent,Component combination is NOT in the list already.

Use the result statement:
Add/Change Serial Structure {Parent,Component,Field} with quantity {Value} if {}
to change values (or set the SNSQTY to zero to remove it).

WARNING: Images of all the above variables are saved after the result statements for each page have been run and before the new page is created. When the Back button is operated the state of these variables is recovered for the opening of the previous page. This ensures that the action of result statements for a page are reversed when the user steps back in the wizard. The one variable that is not reversed is the following iDataRow. If the state of iDataRow was reversed, users would have to re-enter data they have already entered.

iDataRow

This row variable has a column for each item dataname of the configuration with the datatype and characteristics you defined for it.

Values for these variables can be set with the following condition statements
Set Initial Value to {‘ABCDEF’}
Set Value to {‘ABCDEF’}
Set Value to {‘ABCDEF’} if {##MyField##}
These condition statements can be used only in the conditions for the item associated with the variable. Elsewhere, they can be referred to using the ## syntax, for example:
Do {##MyField##} returns {##AnotherField##}

#D

The current date or date and time.

Do {#D} returns {iJobRow.JOBDATE}
sets the job date to the current clock date.

#T

The current time.

Do {con(‘This job was created at ‘,#T,’ on ‘,#D,’.’)} returns {iJobRow.JOBCOMM}
sets the job comments to something like This job was created at 11:56 on 20 Jun 2005..

m_UserId

The current user’s login ID.

Do {con(‘This job was created by ‘,m_UserId,’ at ‘,#T,’.’} returns {iJobRow.JOBCOMM}
sets the job comments to something like This job was created by JFK at 11:56..

m_MakeDate

The current make calendar date.

Do {m_MakeDate} returns {iJobRow.JOBDATE}
sets the job date to the current make calendar date.

m_BuyDate

The current buy calendar date.

Do {m_BuyDate} returns {iJobRow.JOBDATE}
sets the job date to the current buy calendar date.

MCDFILE values

Any field from the company details and system preferences file. E.G. MCDSTCU is the local currency symbol.

Do {MCDSTUM} returns {iJbiList.JBISAUM}
sets the job item unit of measure to the default unit of measure.

TIP: The easiest way to identify MCDFILE fields is to find the data in question in Company Details Maintenance, System Preferences and Account Manager Controls Maintenance and turn on Window Tooltips. The tooltip shows the data fieldname.

Checkbox

The familiar on/off checkbox. It can only have a Boolean datatype associated with it.

Print document after creation

Radio button

The one-of-several radio button type selection device. There must be more than one radio button in a consecutive set for them to be useful. Each radio button must have the same dataname of type Integer. The first radio button of a set, when chosen, sets the variable to 0, the next 1, and so on.

110V 60Hz power supply
240V 50Hz power supply

Entry

The familiar single-line data entry box.This fieldtype has the Uppercase option, which when checked forces uppercase character entry.

NOTE: To make an Entry or Entry multiline fieldtype a read-only type viewing field, use the condition statement:
Hide If {kTrue}

Date delivery due

Entry multiline

The data multiline entry box. This fieldtype has the Uppercase option, which when checked forces uppercase character entry.

Line item description

Droplist

This fieldtype enables you to have a number of alternative options the user can choose from in the form of a drop-down list. You will need to add a number of list lines associated with it. The first line is set to the current line when the list is first created on the window. A droplist can have multiple columns determined by the first list line entry (columns are entered as comma-separated text). However, only the first column is show to the user. Other columns can be accessed using the syntax iDataRow.Dataname.LineNo.C1 for the first column, C2 for the second, etc.. For the currently selected line, you can omit the LineNo, so column 3 contents would be iDataRow.Dataname.C3

The current line list line result statements are run only.

Colour scheme alternatives

Combo entry and droplist

This fieldtype enables you to have a number of alternative options the user can choose from in the form of a drop-down list but the user can also enter a value directly. You will need to add a number of list lines associated with it for the list part of the field. The first non-hidden line is set to the current line when the list is first created on the window and the dataname value set to the first column, first line value. A droplist can have multiple columns determined by the first list line entry (columns are entered as comma-separated text). However, only the first column is shown to the user and loaded into the field when selected. Other columns can be accessed using the syntax iDataRow.DatanameList.Cn (for the currently selected line and where n should be set for the column number) as in the Droplist above.

The user can open a combo by clicking on the drop arrow, or tabbing to the field and pressing Alt plus the down arrow key; pressing just the down arrow key cycles through the choices in the list. Selecting a line with the mouse or pressing the Tab or Esc key closes the list.

With a combo fieldtype the item result statements are always run. If a list line is selected (or the value entered is equal to a list line value), that list line result statements are also run.

TIP: Because of the combo entry and droplist fieldtype’s dual behaviour you need to be careful to accommodate both free data entry and list selection alternatives in your result statements. To accommodate a free entry, you need to have result statements at the Item level and use the if to identify that a list line is not selected, for example (one line only):

Do {$ctask.tEnv.$Ok('',kFalse,kFalse,kFalse,
     'Free Entered Data')} returns {}
     if {##ItemDataname##List.$line=0}

The Ok message will then only appear when the list has no current line (List.$line=0). If a free entry value is equal to a list line value, or a list line is clicked, then that line’s result statements are executed, and the above will not.

Packaging alternatives

Headed List

This fieldtype enables you to have a standard multi-column list. It can be single-line or multi-line selectable by the user. The text determines the headings and if you want more than one column you must provide a comma-separated list of headings. Cell (line and column) data can be accessed using the syntax iDataRow.Dataname.LineNo.C1 as in the Droplist above.

For multi-select lists, list line result statements are run only for the selected lines. Otherwise only the current line result statements are run.

NOTE: You can drag and drop parts from the Parts ScratchPad or the BoM and Where-Used List on to the List Lines list to populate it with 4-column data. The columns are: Part No, Quantity, Units, Description. Appropriate result statements will need to be added to each list line produced.

Parts list

Push Button

Adding a push button to a configuration enables you to trigger an activity under user control. Typically, a pushbutton will process condition statements only, for example:
USER ACTION boundary
Do {iSOCustom.$TestButton()} returns {}
Message User with {This is a button that can operate a Condition Statement event.}

Custom calculator activity

Information Text

This field type simply adds text to the configurator page to give instructions to the user. It can be controlled with a condition statement:
Hide If {}

TIP: You can embed data in information text using Omnis’s square bracket notation. However be aware that the data must have been prepared before the text is presented or setup in condition statements immediately before. For example:
Today’s date is [#D]

User help

Subwindow

This is a complex object type that places a window within the configurator window and can provide any sophisticated configuration interface – see the discussion on Customisation below.

There are the following available standard subwindows:

• wSOConfigSubWinAdr for applying addresses to the document.
• wSOConfigSubWinDemo as a final summary for the document.
• wSOConfigSubWinScratch to allow the user to make a selection from any of the 4 ScratchPads.
• wSOConfigSubWinWkc to allow the user to make a work centre selection and enter operation details.

wSOConfigSubWinDemo

WARNING: Do not use standard Caliach Vision window classes as subwindows – they are not designed for this use.

Character

none

‘AAAA’ or ‘Test part to apply to description’

Number

0 decimals
1 decimal
2 decimals
3 decimals
4 decimals
5 decimals
6 decimals
8 decimals
10 decimals
12 decimals
14 decimals
Floating point

1987
26.1
856.25
216.003
427.3786
21.36856
1.678421
2.15692527
1.0010010297
2.001001589302
5.78258943691056
1.9156272e-14

Integer

0-255
Long

125
-29643267

Boolean (Yes/No)

none

0 or 1, kTrue or kFalse

Date and Time

Date
Time
Date and time

1 Jun 2008 (format depending on company details)
18:25 (24 hour military time)
1 Jun 2008 18:25

Set Initial Value to {}

Sets the initial value of the variable associated with the item. This condition statement is only run once when the page is first opened to the user and not if the user uses the Back button to re-read the window. It only operates on an Item.

Set Initial Value to {4}
sets the variable to an initial value of 4.

Set Value to {}

Sets the value of the variable associated with the item. This condition statement is run every time the page is opened. It only operates on an Item.

Set Value to {‘Created by Order Configurator’}
Forces the variable value to the text.

Set Value to {} if {}

Conditionally sets the value of the variable associated with the item. The calculation entry must evaluate to a non-zero quantity or a logical true for the value to be set. It only operates on an Item.

Set Value to {#D} if {##MyVariable##<#D}
Sets the value of the variable to today’s date if the date entered is less than today.

Disable If {}

Conditionally disables a Page, Group or Item. The user can see the object but not operate on it..

NOTE: The Results for any Item that is disabled, whether by using this condition statement or other technique such as a Do statement, are ignored automatically. If a Group is disabled all Items within it are disabled.

Disable If {iDocType=2}
Disables the object when the document is an Estimate.

Hide If {}

Conditionally hides a Configuration, Page, Group, Item or List Line. The user will not see the object and any associated result statements within it are ignored.

NOTE: Note that any Hide If condition statement is ignored for the last page in the configuration.

Hide If {iDocType=3}
Hides the object when the document is a Job.

WARNING: Do not hide entities that require an initial value that has not been set elsewhere.

Find on {} where value {}

Places in the Current Record Buffer (CRB) a record of data equal to or greater than the calculated value. It operates on all objects.

Find on {PTMPTNO} where value {‘DSK01000’}
Locates the part record with part number DSK01000 (or next on the index) and places it in the CRB. From this point onwards any part field for the part can be read.

Set search as calculation {}

Sets up a search for a subsequent Find on search condition (or result) statement. It operates on all objects.

Set search as calculation {SAHDDAT>=’1 JAN 2004′}
sets up a search for sales dispatches greater than or equal to 1 Jan 2004.

Find on search {} where value {}

Places in the Current Record Buffer (CRB) a record of data equal to or greater than the calculated value using a preceding search criteria. It operates on all objects.

Find on search {SAHPTNO} where value {‘DSK’}
Locates a dispatch record from part number DSK and onwards that (with the search above) has been dispatched on or after 1 Jan 2004 and places it in the CRB. From this point onwards any sales history (SAHFILE) field in it can be read.

Do {} returns {}

This is a general purpose calculate and operate statement. The calculation can be any calculation or combination calculation with dot-notation. The return value must be a variable or ## reference to a field in which the evaluated result is placed. It operates on all objects.

NOTE: Lists (that is the variables behind Droplist, Combo entry and droplist, and Headed List fieldtypes) can not be changed with the Set Initial Value or Set Value condition statements. List contents can be controlled only with Do statements. The list variable is the dataname of the item (except for Combo fieldtypes where the entry field part of the combo is the dataname and the list is the dataname followed by “List” e.g. MyCombo entry part would be iDataRow.MyCombo and the list part would be iDataRow.MyComboList). Columns are named C1, C2, etc and the lines are counted as displayed. So for example, the following will set the 2nd column of line 3 to a value of 5.000:

  Do {5.000} returns {iDataRow.ItemDataname.C2.3}

However this will only work if there are no Hide If statements in lines 1, 2 and 3. If there are, you need to use a special Do statement (one line):

  Do {iSOCustom.$SetListLineValue
     (iDataRow.ItemDataname,'C2',3,5.000)}
     returns {}

The reason for this is that you can use the Hide If command to eliminate lines inappropriate to a previous choice, so the list line number will become different from the design.

Do {con(‘This job was created by ‘,m_UserId,’ at ‘,#T,’ on ‘,#D,’.’} returns {iJobRow.JOBCOMM}
sets the job comments to something like This job was created by JFK at 11:56 on 20 Jun 2005..

A more sophisticated statement using customisation could be:
Do {iSOCustom.$MyMethod(##MyVariable##} returns {##MyVariable##}
this would run the $MyMethod method in the oSOCustom object class passing the parameter of MyVariable and returning a value into it.

See also warning in Do result statement.

Message User with {}

This causes an Ok type message to be presented to the user with the entered text. Unlike other statements, the text of the message is not evaluated as a single calculation. I.E. Do not use quoted text or a con() function. However, you can embed variables in your text with the ##MyVariable## syntax. You use the ## syntax for any global or instance variable or calculation thereof. It operates on Page, Group or Item objects.

Message User with {Today is ##m_MakeDate##.}
pops up an Ok message to the user with the text of: Today is 1 Jan 2005.

Message User with {} if {}

Conditional Ok message to the user (same rules as above apply).

Message User with {Today is ##m_MakeDate##.} if {m_MakeDate<>#D}
pops up the message if the current make date is not today.

USER ACTION boundary

This is a boundary in the conditions and does not actually perform any action itself. It only operates on an Item. All statements above this boundary statement are operated on when an Item is built. While those after this boundary statement are operated when a user event takes place on the Item.

Comment {}

This is a condition that does not perform any action, but provides the designer with the ability to document the condition statements with comments.

Comment {The following was added to accommodate engineering design time – CR 12/2/2005}

Configuration

When testing an order configuration to decide whether the configuration will be offered to the user.

Hide If
Find On
Set Search
Find On Search
Do

To control access or relevance.

Hide if {#D>dat(’30 DEC 2005′)},
limits the availability to the end of the year 2005.

Configuration

When opening an order configuration.

Find On
Set Search
Find On Search
Do

Provides special actions before the first page, typically with Do statements.

Do {1} returns {iDocType}
sets the document to a Sales Order.

Page

When opening the first page and other pages with both Next and Back buttons.

Disable If
Hide If
Find On
Set Search
Find On Search
Do
Message User
Message User If

To disable or hide the page or message users when opening the page.

Message User {Take great care with this page!}
provides an Ok message to the user.

Group

When placing a group on a page.

Disable If
Hide If
Find On
Set Search
Find On Search
Do
Message User
Message User If

To disable or hide the group.

Disable If {iDocType=1}
disables the group of items for a Sales Order.

Item

When placing an item inside a group.

Set Initial Value
Set Value
Set Value If
Disable If
Hide If
Find On
Set Search
Find On Search
Do

To control the contents of variables and the status of an item.

Set Initial Value {4}
sets the default value to 4.

Item

On a user activity event on an item.
On a click on checkbox, radio buttons, lists and push buttons.
On an after event for entry items.

Set Value
Set Value If
Find On
Set Search
Find On Search
Do
Message User
Message User If
USER ACTION

Controlling user data entry and other warnings.

Set Value {#D+1} If {##Date##<#D}
resets the date to tomorrow if the date entered was less than today, where the item dataname is Date.

List Lines

When adding or re-presenting a list line of a list item.

NOTE: When a list item is re-presented (after a Back-Next cycle) the user’s selections will be restored only to the extent that Hide If statements permit.

Hide If
Find On
Set Search
Find On Search
Do

To conditionally hide particular list lines or to set values with a Do statement.

Hide If {iDocType=1|(iDocType=3)}
only includes the list line for Quotations and Estimates.

Include line {} if {}

Adds a line item to the document. The line is not given a line number at this stage, it is given a Line Name (temporarily held as iJbiList.LineName). The line can subsequently be referenced by the Line Name in Exclude line and Set Line Value result statements. When the line is added to the iJbiList, that line becomes the current line in the list so immediate Set Line Value result statements can omit the LineName prefix.

NOTE: If the user attempts to close the order configuration wizard window using the close box, they will typically receive a warning message saying:

Some processing or data change has not be completed in the “Sales Document Configurator” window. Click OK now to complete it or Cancel to abandon it.

To avoid this being unnecessarily annoying, this only becomes effective once an Include Line or Exclude Line result statement has resulted in at least 1 line item for the document.

Include line {01FirstLine} if {##IncludeCheckbox##}
Add a line item called 01FirstLine if the item variable IncludeCheckbox is set true.

NOTE: At the end of the wizard, when the document is created the line item list is sorted alphabetically by line name and then assigned line numbers sequentially. Hence, the line name you choose is significant to the order of lines on the resulting document.

Exclude line {} if {}

Removes a line item from the list of line items for the document. You must provide the Line Name given to the line in it’s Include line statement. This happens in memory as soon as the result statement is run. So errors will result if there are subsequent Set Line Value statements for that line name. This statement will change the iJbiList current line if the line removed is itself the current line.

Exclude line {01FirstLine} if {##Colour##=’BLUE’}
Removes the line item called 01FirstLine if the item variable Colour is set to BLUE.

Set Header Value {} to {} if {}

Sets a value in the document header. You need to state the header field and a calculation which evaluates to the value you want to give it. An error will occur if the field entered is not a valid JOBFILE field, or SOHBOND (Dispatch complete flag). Use the Tool button on the Sales Document Configuration Results Tool window, when this result statement is selected, to see which fields can usefully be changed with this command.

Set Header Value {JOBCREF} to {##CusRef##} if {len(##CusRef##)}
will set the customer reference field to the value in the item with dataname CusRef if the user has entered a value.

Set Line Value {} to {} if {}

Sets a value for a line item from the list of line items for the document. You should provide the Line Name given to the line in it’s Include line statement, unless you are confident that the line you want to change is the current line in the list. This statement will change the iJbiList current line if a line name is included.

Set Line Value {01FirstLine,JBIQTY} to {5} if {}
Sets the line item named 01FirstLine quantity field to a value of 5.

NOTE: This statement is similar to a user action on the normal document maintenance window in as much as other fields in the line record can be effected. For example, setting the line item part number to a valid part will clear fields associated with a work centre operation and affect cost and price fields.

Document Type is {} if {}

Sets the document type that will be created by the configuration. The following are valid calculation results:

• 0 or QU = Quotation
• 1 or SO = Sales Orders
• 2 or ES = Estimate
• 3 or JO = Job

The instance variable iDocType is consequently set to 0, 1, 2 or 3, as above, by this statement and therefore can be referenced in subsequent condition or result statements.

Document Type is {‘SO’} if {##DocType##}
The document will be a Sales Order if the item variable DocType is true.

Create part like {} with new number {} if {}

Creates a part list line for a new part to be added to the parts master before creating the document. You need to identify the part that is already in the database whose details are copied for the new part and give it a new part number. If the part is to be assigned a SO-999999-999 number in the same way as Order Item Configuration, you should use ???? as the first four characters of the number. Any other characters will be added to SO-999999 after the document is created. If you use just ???? then the full SO-999999-999 will be applied. After adding the part to iNewPtmList, any Bills of Materials, Process Route Operations, Quality Tests and Serial Number Structure records are copied from the Like Part to iNewBomList, iNewProList, iNewQapList and iNewSnsList. The current line of the iNewPtmList will be set to the new part and the PTMFILE CRB is setup. If the part has already been created in a previous Create part like statement the iNewPtmList current line will be reset. Note that the SO shown above will in fact be the Parent Number prefix in SO Configuration, or Parent Number prefix in Job Configuration depending on document type, set up in File — System Manager — Company Details.

Create part like {‘AHD00080’} with new number {‘????’}
will populate all new item lists.

Set Part Value field {} to {} if {}

This sets a value for a new part in the iNewPtmList. If you are not confident that the current part list line is set to the part you intend, prefix the field with the new part number followed by a comma, then the field name.

Set Part Value field {‘????’,PTMDESC} to {‘New part description’}
Sets the description for the new part.

Add/Change Component {} with quantity {} if {}

This sets a value for a new BoM component in the iNewBomList. If you are not confident that the current list line is set to the component you intend, prefix the field with the parent part number followed by a comma, then the component part number, then the field name. The parent part is a calculation and the component can contain ## syntax variables but the fieldname must be a proper BOMFILE fieldname.

If the Parent and Component combination does not exist, a new iNewBomList line will be added. To prevent a BoM line being created, set its BOMQTY value to zero. The iNewBomList will remain in the list but it will be ignored at the point of creating records in the database.

Add/Change Component {‘????’,SWARF2,BOMQTY} with quantity {5}

Add/Change Route Op. {} with quantity {} if {}

This sets a value for a new Route operation in the iNewProList. If you are not confident that the current list line is set to the operation you intend, prefix the field with the parent part number followed by a comma, then the operation number, then the field name. The parent part is a calculation and the operation can contain ## syntax variables but the fieldname must be a proper PROFILE fieldname.

If the Parent and Operation combination does not exist, a new iNewProList line will be added. To prevent an operation line being created, set its PROOPNO value to zero. The iNewProList will remain in the list but it will be ignored at the point of creating records in the database.

Add/Change Route Op. {‘????’,020,PRORUNT} with quantity {0.250}
sets the runtime of operation 020 to 0.25 hours.

Add/Change Quality Test {} with quantity {} if {}

This sets a value for a new Quality test in the iNewQapList. If you are not confident that the current list line is set to the test you intend, prefix the field with the part number followed by a comma, then the test number, then the field name. The parent part is a calculation and the test number can contain ## syntax variables but the fieldname must be a proper QAPFILE fieldname.

If the Parent and Test combination does not exist, a new iNewQapList line will be added. To prevent a test line being created, set its QAPNO value to zero. The iNewQapList will remain in the list but it will be ignored at the point of creating records in the database.

Add/Change Quality Test {‘????’,10,QAPMIN} with quantity {4.65}
sets the minimum test value to 4.65 for test 10 of the new part.

Add/Change Serial Structure {} with quantity {} if {}

This sets a value for a new Serial Number Structure in the iNewSnsList. If you are not confident that the current list line is set to the structure you intend, prefix the field with the parent part number followed by a comma, then the component part number, then the field name. The parent part is a calculation and the test number can contain ## syntax variables but the fieldname must be a proper SNSFILE fieldname.

If the Parent and Test combination does not exist, a new iNewSnsList line will be added. To prevent a test line being created, set its SNSNO value to zero. The iNewSnsList will remain in the list but it will be ignored at the point of creating records in the database.

Add/Change Serial Structure {‘????’,DSK01000,SNSQTY} with quantity {4}
sets the DSK01000 structure quantity to 4.

Find on {} where value {} if {}

Operates in the same manner as the same Condition Statement – see above.

Find on {PTMPTNO} where value {‘DSK01000’} if {iDocType=1}

Set search as calculation {} if {}

Operates in the same manner as the same Condition Statement – see above.

Set search as calculation {SAHDDAT>=’1 JAN 2004′} if {iDocType=1}

Find on search {} where value {} if {}

Operates in the same manner as the same Condition Statement – see above.

Find on search {SAHPTNO} where value {‘DSK’} if {iDocType=1}

Do {} returns {} if {}

Operates in the same manner as the same Condition Statement – see above.

WARNING: Do statements directly run and therefore contain no ‘document intelligence’ in that it acts without regard for what it is acting on. For example, setting iJobRow.JOBCUSC with the Do command would not be wise as none of the customer characteristics would be set in the document. To apply document logic to the document you should use the following statements:

• Set Header Value {} to {} if {}
  for JOBCUSC
• Set Line Value {} to {} if {}
  for JBIPTNO, JBIWKC or JBIQTY and any field effecting cost or price
• Select Dialog of type {} into {} if {}
  for JOBCUSC or JBIPTNO

Do {con(‘This job was created by ‘,m_UserId,’ at ‘,#T,’ on ‘,#D,’.’} returns {iJobRow.JOBCOMM} if {iDocType=1}

Select Dialog of type {} into {} if {}

Opens a selection dialogue window. The value must be one of the following non-calculated literal texts:

• CUSTOMER
• PART

The calculation must be a field into which the part number the user selects is placed, typically iJobRow.JOBCUSC or iJbiList.JBIPTNO respectively.

This is unique as a result statement as it re-executes the results, other than any Select Dialog and Post Process statements when the user confirms his selection in the dialog. The reason for this is that the user response to a dialogue takes place later than the occasion the result is first run. As a consequence any result statements that select a list line or setup the CRB will have potentially been disrupted. So re-executing them enables you to re-establish list line selections and the CRB state before the product of the dialogue is applied.

Include line {02EngPart} if {##EngExtraPart##}
Select Dialog of type {PART} into {iJbiList.JBIPTNO} if {##EngExtraPart##}
In the above, a checkbox with dataname EngExtaPart is used to control whether a line is added to the document with a LineName of 02EngPart. When this result set is first run, the line is created and the Part selection dialogue opens. When the user confirms their selection the Include line statement is re-run (causing the line to become the current line, because it already exists) before applying the part number to the JBIPTNO field and thus setting the part for the line item.

NOTE: It is not wise therefore to mix result statements that have an accumulating effect along with Select Dialog statements. For instance, a statement such as Do {iJbiList.JBIQTY+2} returns {iJbiList.JBIQTY} would add 2 to the quantity twice.

Post Process command {} with {} if {}

Adds an activity to a list of activities that will be carried out after the document has been created. Full details of the range of available post-processing activities is listed below.

Post Process command {PrintDoc} with {Screen,Doc} if {##Print##}
where Print is the dataname of a checkbox item for the user to control printing, for example.

Prevent Page Close with message {} if {}

This statement does not act on data in any way. If the If Calculation evaluates to true, the wizard page will not close when the Next button is clicked by the user and optionally will notify the user with a message. It can be used to ensure important data is properly entered by the user.

NOTE: The page is in fact refreshed, which is to say that it is reset as though a Back button had been clicked on after the Next was clicked. This means that any results for the page are rolled-back and any Page result statements re-run. So if there was a Select Dialog result statement at the page level, the dialogue window would be re-presented to the user.

Prevent Page Close with message {Before proceeding you must select a customer in the selection window.} if {iJobRow.JOBCUSC=”}
this will prevent the user moving to the next wizard page without first having selected a customer for the document..

If more than one statement is encountered on for a page, the messages are combined.

Comment {}

Operates in the same manner as the same Condition Statement – see above.

Comment {The following was added to accommodate engineering design time – CR 12/2/2005}

PrintDoc

Destination,Type or just Type to print to the user’s current report destination.

Valid report destinations are:

• Printer
• Preview
• Screen
• Disk
• Clipboard
• HTML
• RTF
• Email

This result statement will print documents. You can have any combination of PrintDoc commands in your order configuration. Each will be acted on in turn. A typical example is:
Post Process command {PrintDoc} with {Screen,Doc} if {##Print##}
where Print is the dataname of a checkbox item for the user to control printing, for example.

Valid Document Types are:

• Doc = Quote, SO, Estimate or Job
• Pick = Picking List (SO and Job only)
• CusDoc = Acknowledgement (Estimate or Job only)
• List = Job List (Job only)
• Make= Job Make-To List (Job only)
• WO = Work Order (SO and Job only when CreateWOs post process is active)
• WOPick = Work Order Pick List (SO and Job only when CreateWOs post process is active)
• PO = Purchase Order or RFQ (SO and Job only when CreatePOs and/or CreateOutPOs post process is active)

MaintDoc

none

This result statement will cause the appropriate document maintenance window to open with the document loaded. The user will get an error message if they don’t have access privileges.

ViewDoc

none

This result statement will cause the appropriate document review window to open with the document loaded. The user will get an error message if they don’t have access privileges.

Message

none

This result statement will simply provide an Ok message to the user telling them the type of document, its number and the customer it has been created for.

CreateWOs

Projected,Backflushed

This result statement will only operate for Sales Orders or Jobs. It causes the system to create Work Orders for all parts that are manufactured parts (part type M or part type A where there is a BoM) for the quantity required on the SO or Job. If the Projected parameter is set to 1, the quantity on the WO will be less the projected quantity. If the backflushed parameter is set to 1, the WOs created will all be set for backflushing. WOs created will be given a reference of:
CustomerCode-SO or JO-SONo or JobNo-LineNo

CreatePOs

Projected,RFQ

This result statement will only operate for Sales Orders or Jobs. It causes the system to create Purchase Orders for all parts that are purchased (part type B or O or part type A where there is no BoM) for the quantity required on the SO or Job. If the Projected parameter is set to 1, the quantity on the PO will be less the projected quantity. If the RFQ parameter is set to 1, the RFQs will be created rather than confirmed Purchase Orders. PO lines created will be given a reference of:
SO or JO-SONo or JobNo-LineNo
and the orders will be given a reference of:
SO or JO-SONo or JobNo
For parts to be included, they must have a Preferred Supplier.

CreateOutPOs

RFQ

This result statement will only operate for Jobs only. It causes the system to create Purchase Orders for all outwork Work Centre operations for the quantity required on the Job item. If the RFQ parameter is set to 1, RFQs will be created rather than confirmed Purchase Orders. PO lines created will be given a reference of:
SO or JO-SONo or JobNo-LineNo
and the orders will be given a reference of:
SO or JO-SONo or JobNo
For this command to operate, and for each outwork operation in the Job that you want it to operate, the supplier code must be set in the SOLUSER field. To do this you must use the following result statement:
Set Line Value {LineName,SOLUSER} to {SupplierCode} if {##pIfCalc##}

Configuration List

List of order configurations. Click to select and edit details here and on other tab panes. Use the delete key to permanently remove.

Name

Sales Document Configurations. Configuration name. {SOCFILE.SOCNAME char 30 Idx}

Last modified date and time

Sales Document Configurations. Last modified date and time. {SOCFILE.SOCMODD date datetime}

User that last modified the configuration

Sales Document Configurations. Last modified user ID. {SOCFILE.SOCINIT char 3}

Description

Sales Document Configurations. Description. {SOCFILE.SOCDESC char 255}

Conditions

Sales Document Configurations. Conditions that are checked before the configuration can be used. {SOCFILE.SOCCOND char 10000000}

Results

Sales Document Configurations. Results applicable to the entire configuration. {SOCFILE.SOCRESU char 10000000}

Group list

Sales Document Configurations. Group access list for restricted access to others (comma delimited). {SOCFILE.SOCGROU char 1000}

User list

Sales Document Configurations. User access list for restricted access to others (comma delimited). {SOCFILE.SOCUSER char 1000}

Notes

Sales Document Configurations. Modification and design notes. {SOCFILE.SOCNOTE char 10000000}

Tool

Click to open the Conditions Design Tool.

Tool

Click to open the Results Design Tool.

Add Configuration

Click to add a new configuration. The name must be unique.

Copy Configuration

Click to copy the currently selected configuration to make a new one. The name must be unique.

Test Configuration

Click to test the currently selected configuration.

Revert

To revert any changes to the previously saved version.

Save

To save the changes you have made to the data file.

Pages List

List of Pages for the selected configuration. Click to select. Drag and drop to re-order. Use the delete key to remove.

Name

The internal name for the page. This can be seen as tooltip on the page title field on the wizard.

Description

The description that is shown for the page at the top of the wizard. This can contain ## syntax variables or calculations.

For example, you can add the Customer code and name to the page description using the following description text:
Completion for Customer: ##iJobRow.CUSCODE## – ##iJobRow.CUSCNAM##

Conditions

The conditions that apply to the page.

Results

The result consequences that apply to the page.

Tool

Click to open the Conditions Design Tool.

Tool

Click to open the Results Design Tool.

Add Page

Click to add a new Page. The name must be unique.

Copy Page

Click to copy the currently selected Page to make a new one. The name must be unique.

Test Configuration

Click to test the currently selected configuration.

Revert

To revert any changes to the previously saved version.

Save

To save the changes you have made to the data file.

Groups List

List of Groups on the selected Page for the selected Configuration. Click to select. Drag and drop to re-order. Use the delete key to remove.

Text

The name that will appear on Group. This must be alphanumeric, start with a non-digit but can contain underscores and spaces.

Tooltip

The tooltip for the group box.

Condition

The conditions that apply to the Group. The Find And Replace context (right-click) menu is available for this field.

Result

The result consequences that apply to the group. The Find And Replace context (right-click) menu is available for this field.

Tool

Click to open the Conditions Design Tool.

Tool

Click to open the Results Design Tool.

Add Group

Click to add a new Group. The name must be unique.

Copy Group

Click to copy the currently selected Group to make a new one. The name must be unique.

Test Configuration

Click to test the currently selected configuration.

Revert

To revert any changes to the previously saved version.

Save

To save the changes you have made to the data file.

Items List

List of Items in the selected Group. Click to select. Drag and drop to re-order. Use the delete key to remove.

Fieldtype drop-down list

Select from the dropdown list of field types for the item. The datatype may be affected by your choice.

Multi-select

Check to permit multiple selections in the headed list.

Force Uppercase

Check to force characters uppercase.

Dataname

The internal dataname for the data. This needs to be unique and can be referred to in conditions and results. This must be alphanumeric, start with a non-digit but can contain underscores.

Datatype drop-down list

Select from the dropdown list of field types. The subtype list will be reset depending on your selection.

Data subtype drop-down list

Select from the dropdown list of data subtypes. The subtype list will be reset depending on your selection of data type.

Maximum length

The maximum length of character fields.

Text

Text for the item. For headed lists this is the heading and can be comma delimited to provide multiple columns.

Tooltip

The tooltip seen by the user when the mouse is over the item.

Condition

The condition logic that applies to the item. The Find And Replace context (right-click) menu is available for this field.

Result

The result consequences that apply to the item. The Find And Replace context (right-click) menu is available for this field.

Tool

Click to open the Conditions Design Tool.

Tool

Click to open the Results Design Tool.

Add Item

Click to add a new Item. The data name must be unique.

Copy Item

Click to copy the currently selected Item to make a new one. The data name must be unique.

Test Configuration

Click to test the currently selected configuration.

Revert

To revert any changes to the previously saved version.

Save

To save the changes you have made to the data file.

List Lines List

List of lines for the List item. Click to select. Drag and drop to re-order. Use the delete key to remove.

Text

Text for the List Line. For headed lists this can be comma delimited to provide multiple columns.

Condition

The condition logic that applies to the List Line for it to be offered to the user. The Find And Replace context (right-click) menu is available for this field.

Result

The result consequences that apply to the list line if selected by the user. The Find And Replace context (right-click) menu is available for this field.

Tool

Click to open the Conditions Design Tool.

Tool

Click to open the Results Design Tool.

Add List Line

Click to add a new List Line.

Copy List Line

Click to copy the currently selected List Line to make a new one.

Test Configuration

Click to test the currently selected configuration.

Revert

To revert any changes to the previously saved version.

Save

To save the changes you have made to the data file.

• Sales Document Configuration Menu
• Sales Document Configuration Conditions Tool
• Sales Document Configuration Results Tool
• Sales Document Configuration Error Log
• Sales Document Configurator
• Sales Document Configuration Subwindow Summary