Previous Topic: Supported Server OperationsNext Topic: Syntax of PRESET, PRESET_REL, ALG_PRESET, and ALG_PRESET_REL


Operation Variables

This table lists the variables that can be set for each of the operations in the supported operations:

Variables

Description

Operations

ALG_PRESET

ALG_PRESET_REL

Specifies values for one or more of the attributes of the activity log created as a result of the CREATE_ALG variable. If CREATE_ALG is not specified, ALG_PRESET and ALG_PRESET_REL are ignored.

CREATE_NEW
SEARCH
SHOW_DETAIL

CREATE_ALG

Specifies the activity log type of an activity log to be created as a side effect of the operation. Use the ALG_PRESET or ALG_PRESET variables to specify values for the attributes of the new activity log.

The timing of creation of the activity log depends on the operation, as follows:

CREATE_NEW
The activity log is created when the new record is saved. If the new record is not saved, no activity log is created.

SEARCH
The activity log is created when a record is selected from the list form. If the record is viewed instead of selected (that is, the user explicitly selects the View command from the list form's mouse-over menu), no activity log is created.

SHOW_DETAIL
The activity log is created before the record is displayed.

CREATE_NEW
SEARCH
SHOW_DETAIL

FACTORY

Specifies the class of object to be searched, created, or updated. You can use any name specified as an OBJECT in the *.maj files in $NX_ROOT/bopcfg as listed in the CA SDM Technical Reference Guide.

CREATE_NEW
GENERIC_LIST
SEARCH
UPDATE

HTMPL

Allows the HTMPL author to override the default template naming convention and explicitly specify the HTMPL file to display, instead of the default template.

Note: When the HTMPL specifier is used with CREATE_NEW or UPDATE, the name of the referenced form must conform to the naming convention zdetailxxx_factory.htmpl, where xxx are any characters, and factory is the factory name.

CREATE_NEW
DISPLAY_FORM
JUST_GRONK_IT
MENU
SEARCH
SET_MENU
SHOW_DETAIL

UPDATE

KEEP.name

Specifies the value that can be saved and passed between pages.

CREATE_NEW
GENERIC_LIST
SEARCH
UPDATE

KEY.attr_name

Similar to the SET.attr_name, except that this specifies a lookup on attr_name, which must be a reference to another table or object.

UPDATE

NEXT_PERSID

Specifies the persistent ID of the record to be displayed next.

UPDATE

PERSID

Specifies the persistent ID of a record to be displayed. You can specify this in either of the following ways:

Directly, with a persistent ID consisting of a factory name, a colon (:), and a unique integer database ID. For example, PERSID=chg:1234, specifies the change order with database ID 1234.

Indirectly, with a persistent ID consisting of a factory name, a colon (:), an attribute name, a second colon (:), and a value. This form of PERSID specifies the record of the specified factory that has an attribute of the specified value. For example, PERSID=chg:chg_ref_num:demo:3 specifies the change order with reference number demo:3.

SHOW_DETAIL
UPDATE

PRESET

PRESET_REL

Specifies values for one or more of the attributes of the record created as a result of the CREATE_NEW variable. If CREATE_NEW is not specified, PRESET is ignored.

CREATE_NEW

QBE.op.attr_name

Specifies the values to use when performing a search. These values are identified using a QBE keyword, where attr_name identifies any attribute name on a ticket that can be set and op indicates to search where the attribute:

EQ is equal to the value

NE is not equal to the value

GT is greater than the value

LT is less than the value

GE is greater than or equal to the value

LE is less than or equal to the value

NU is null

NN is not null

IN matches the SQL LIKE expression

KY contains the text entered

If you do not define any QBE variables, the standard search window is displayed.

SEARCH

SET.attr_name

Specifies an attribute name to use when a ticket is created, where attr_name identifies any attribute in a ticket that can be set. The attribute names will vary depending on the underlying object. All objects and their attributes can be found in the *.maj files in the majic directory in bopcfg as listed in the CA SDM Technical Reference Guide.

CREATE_NEW
UPDATE

SET.id

Specifies the database ID of the row to be updated.

UPDATE

SKIPLIST

When set to 1, searches that result in 1 hit do not display the search result list. Instead, the read-only detail is displayed directly.

SEARCH

use_template

When set to 1, the SEARCH operation will return a list of templates. The returned template selected will be used in the CREATE_NEW operation to populate a new record. This variable is valid for change orders, issues, and requests.

CREATE_NEW
SEARCH

More information:

Syntax of PRESET, PRESET_REL, ALG_PRESET, and ALG_PRESET_REL