UOA:OMQUSIFI

From Remain Software
Revision as of 05:03, 6 November 2020 by Dharmveer (talk | contribs) (→‎Interface with Fix (OMQUSIFI) - Help)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Interface with Fix (OMQUSIFI) - Help

Interface with Fix (OMQUSIFI)

This Application Program Interface command enables you to manipulate the TD/OMS database. This can be done from a command line or from within your own programs.

The command enables you to perform all allowed actions on a fix and does so in a user-friendly manner. This command cannot be run in the background. Consult the function information for additional information.

Action code (ACTC)

Specify the action to be performed on the fix. The possible values are:

*ADD
Use this action code to add a new fix to the TD/OMS database.
*CHANGE
Use this action code to change one or more fix attributes.
*CLOSE
Use this action code to close the fix database and to perform last record processing. This option enables you to leave the interface to the fix database open until you explicitly close it. This will make the interface faster.
*COPY
Use this action code to copy the attributes of a fix to a new fix. The extended description of the fix is also copied, but not the associated word processing document (if any). The connected objects are also not copied.
*DELETE
Use this action code to remove a fix from the database.
*DISPLAY
Use this action code to display the contents of the fix. No change actions are allowed.

Function key definition (FUNKEY)

This User Interface API enables you to create your own function key definitions. With this feature, you are able to customize the API and create a seamless interface to the TD/OMS database. If a user presses one of the user-defined function keys, a diagnostic message will be sent back to the caller stating the function key which was pressed. You are able to receive this message and have your programs act upon it. The possible values are:

*DFT
Use the default function keys.
*USER
Indicates that you supply one or more function keys to the user interface. If this value is used, you will be prompted for the function keys you wish to supply.

Function keys (USERKEYS)

Specify the function keys you wish to activate. The function keys you specify are placed at the bottom of the screen. If more function key text is provided than can be placed on the line, TD/OMS activates the F24=More keys function key which will toggle the display of other function keys.

Function key F1 cannot be supplied because it is engraved to trigger the display of help texts. For CUA compliance, TD/OMS will automatically supply the following default function keys:

F1 This key will always be used to trigger help.
F3 Exits the display without updating the database.
F4 This key will first be used to prompt the fields determined by the function. If the cursor is not a promptable field and it is assigned by the user then it is returned to the caller.
F5 This will be the refresh key.
F8 This will show the object's OS/400 description.
F12 Cancel the input without updating the database.
F24 If the program detects more function keys than will fit on one line, the user-supplied F24 key will be replaced by the F24=More standard key.

The function keys F1, F3, F4, F5, F8, and F12 will be added to the area for a user-defined function key area if they are not supplied. Function keys F1 and F4 do not show text in the area but they are active.

You should be careful about using these function keys because they are normally used for other purposes.

Function key number

Specify the number of the function key. This should be a numerical value in the range of 2 to 24.

Process screen data

Use this element to specify if the data already entered by the user should be processed when the function key is pressed. The possible values are:

*NO
The data in the display will not be processed if the function key is pressed. Possible conflicts that were keyed after the last use of the enter key will not be signaled.
*YES
The data in the display will be processed before the function returns to the calling program. The database will be updated and the function returns if no errors are found. If errors are found they will be displayed and the
function will not return until either all the errors are solved or an exit key is pressed.

Message identifier

Use this element in combination with the message file qualifier to specify the message which contains the function key description. Only the first 30 positions of the first level message text are retrieved. The possible values are:

*NONE
The text is not stored in a message. The text is instead retrieved from the function key text element.
message-identifier
Specify the message which holds the description of the function key. Only the first 30 positions of the first level text of the message are placed in the function key area.

Message file

If the message identifier is specified, the message file and library must also be specified. The possible values are:

OMSDSP
This message file is used by TD/OMS to store language-independent texts. You can use this to retrieve texts which are already defined. Do not add new message id's to this message file because it will be replaced when a new release is installed.
message-file
Specify the message file.

Message file library

*LIBL
All the libraries in the user and system's portion of the library are searched to locate the message file.
library
Specify the library of the message file.

Function key text

Specify the function key text. The text should preferably be in the format Fnn=tttt where nn is the function key number and tttt is the description of the function key. The text may not exceed 30 characters in length. The possible values are:

*BLANK
The contents of the message identifier is used to describe the function key. The literal *BLANK will be displayed in the function key area if no message identifier is specified.
function-key-description
Specify the description of the function key.

Close API (CLOSE)

Specify if the API must close all files and free storage upon completion of the requested action. The possible values are:

*YES
The files are closed and storage is freed by the API upon completion of the requested action. Subsequent actions must re-open the necessary files and programs.
*NO
The state of the API was left when the requested action was completed. Files remain open and relationship updates are postponed. Subsequent calls to the API are considerably faster and storage is not freed.

Fast re-display (REDISPLAY)

Use this element to specify if the API must perform a fast re-display. This option will only have an effect if it is used in combination with CLOSE(*NO). The possible values are:

*NO
Do not use a fast re-display. Open the program normally and perform function key determination, authorization checking, and buffer filling.
*YES
Use a fast re-display. When this option is used, the function keys area is not changed, most buffer fill requests are skipped and the authorization checks are also skipped. This value is only meaningful if the function was called before with CLOSE(*NO). A normal display will be performed if the interface to the database is not yet open.

Protect application (PRAPPL)

The protect application element is used to prevent the user from changing the contents of the application field. The possible values are:

*NO
The application code of the display is not protected. You can enter an application code in the display of the function.
*YES
The application field of the functions display is not accessible for input. Use this value to make sure that the application code is not changed by the user. This value is useful only in combination with a pre-filled application code.

Pre-fill fields (PREFILL)

Specify if fields have to be loaded with (initial) values before they are displayed on the screen. This element is useful only when the action is *ADD (*COPY) or *CHANGE. The possible values are:

*NO
No values are pre-filled with the supplied data. All fields are loaded with initial values if the action is add. The fields are loaded with the values from the database if the action is change.
*YES
The fields on the display are first filled with the values from the database (if any) and then overwritten with the user-supplied values (if any). Output only fields cannot be overwritten in change mode.
*FIELD
Specifies that the field in the cursor field is supplied by the user and other values are either initialized (when adding) or filled with the database value (when changing).

Cursor field (CRSFIELD)

Specify the field which must be pre-filled before it is displayed. This element is useful only when the action is *ADD (*COPY) or *CHANGE. The possible values are:

APPL Application code
FIX Fix number
FIXT Fix type
RLS Release number
PRIC Priority code
PGMR Programmer
ESDT Expected start date
EDDT Expected development end date
ECDT Expected completion date
EPH Expected number of hours
SHFD Short fix description

Key (KEY)

Specify the key to the object if one is required by the selected action.

Application
Specify the application in which the request can be found.
Request number
Specify the request number.

Application (APPL)

Specify the application which must be used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information. The possible values are:

*CURRENT
The current active application code is used. If no application is currently active then an error is reported.
application-code
Specify the application code.

Fix (FIX)

Specify the fix which must be used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information. The possible values are:

*GEN
The special value *GEN is used for the fix. This value can only be used when the fix is first added to the database.
fix number
Specify the fix number.

Fix type (FIXT)

Specify the fix type which must be used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information. The possible values are:

*DFT
The default fix type is retrieved from the fix type table. No value is retrieved if no default fix type is specified.
fix-type
Specify the fix type (which must exist in the fix type table.)

Release (RLS)

Specify the release which must be used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information. The possible values are:

*DFT
The current active release is used. It is retrieved from the application definition.
release-number
Specify the release number.

Priority (PRIC)

Specify the priority code which must be used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information. The possible values are:

*DFT
The default priority code is retrieved from the priority code table. The field is filled with blanks if no default priority exists.
priority-code
Specify the priority code.

Programmer (PGMR)

Specify the programmer which must be used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information. The possible values are:

*USER
The current active user ID is used.
user-id.
Specify the user ID to be used for the programmer.

Expected start date (ESDT)

Specify the expected start date which must be used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information.

Expected completion date (ECDT)

Specify the completion date which must be used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information.

Expected development end date (EDDT)

Specify the expected development end date used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information.

Expected number of hours (EPH)

Specify the expected number of hours used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information.

Realized number of hours (ERH)

Specify the realized number of hours used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information.

Short fix description (SHFD)

Specify the short description which must be used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information.

Copy solutions (SOLI)

Indicate whether you want to have the connected solutions of the fix to be copied added to the connection list.

*YES
The connected solutions are added to the connection list.
*NO
The connected solutions are not added to the connection list.