PRINT:UOA:User Options and API's

Welcome to the index of the User Options and API's. Please select the link of your interest.

TD/OMS User options

The user option maintenance function allows you to create your own list options. The functions currently supported are the four major TD/OMS entities; Object Maintenance, Solution Maintenance, Request Maintenance and Fix Maintenance.

User options are available in the green screen and in the GUI.

The user options are cross application functions. This means that the user options are not owned by one of the applications, and all applications can use all user options.

A user option is always calling a user program or a user command. Commands can be executed on the client or on the server. You can specify if the program is to receive parameters. The parameters received are the data to the list entry on which the operation took place. TD/OMS comes with a few user options already installed. The sources of the corresponding programs reside in the QUSRSRC file in your TD/OMS library.

The user option program can be invoked by using the special user option '/' in the object maintenance, request maintenance, fix maintenance or solution maintenance displays. In the graphical user interface there is a special view to maintain user options.

User options can be made available for one user, or they can be assigned to just one user. If you are not an administrator then you can only remove, add and change a user option that is assigned to your user profile. You can ask the administrator to 'promote' a personal user option to a public user option.

You are able to override a public user option by a personal user option. A user option code and user code combination makes a user option unique.

Display 1 – Select User Option

This display is the user option maintenance list. You can select an entry from the list to retrieve it into your program. If you are authorized, you are also able to maintain the user options by pressing the F8=Toggle Edit command key. Please note that user options are cross application. The user option you want to make, alter or remove can be used in other applications.

Press F11=View to show more columns with information.

Option

Use this column to perform different operations on individual objects. Type the option number next to an entry and press Enter. You can type the same option next to more than one entry at a time, and you can also type different options next to different entries at the same time.

Choose from the following:

Select

Type 1 to select the requested user option. After you pressed enter. The code will appear on the option line of the main function ;Display :Type 5 to display the user option.

User option

The user option is a user-defined code that can be used together with program defined options. User options normally operate on a list entry. The user option is associated with a user program that is activated when the user option is utilized. The user program performs the designated task and communicates the status of the operation to the calling program. See the technical description of the User Option Maintenance program for details.

User

This is the user for which the option is available. If you are not an administrator then you are able to create your own user options but you are not able to create user options for other people.

User option description

This is the description of the user option. It appears in the selection window and is used to identify the function of the user option.

Group

The group is the submenu in the graphical user interface context menu.

Program

If any, this is the program that is associated with the user option. You are also able to enter a command.

Library

If any, this is the library where the program resides.

Auth

This is the authorization level required to execute the user option. Authorization code \’0\’ indicates that the user option is disabled.

Check entry

This field indicates if TD/OMS should check if the user is authorized for the selected entry. This field should be set to *NO if the user option is not related to a particular entry. The user option CW (Command line in a window) is an example of such an option.

Parms

Indicates if parameters are passed. Only meaningful if the user option executes a program instead of a command.

All, Req, Fix, Sol, Obj

Indicates for which entity the user option is valid.

Display 1 – Work with user options

If you press F8=Toggle Edit the the display is the user option maintenance list. You can select an entry from the list to retrieve it into your program. If you are authorized, you are also able to maintain the user options. Please note that user options are cross application. The user option you want to make, alter or remove can be used in other applications. If you are not an administrator then you can only maintain your own user options.

Option

Use this column to perform different operations on individual objects. Type the option number next to an entry and press Enter. You can type the same option next to more than one entry at a time, and you can also type different options next to different entries at the same time.

Choose from the following:

Select

Type 1 to select the requested user option. After you pressed enter. The code will appear on the option line of the main function you used. After you pressed enter again the user option will be processed.

Change

Type 2 to change the attributes of the user option.

Copy

Type 3 to copy a user option to a new user option.

Delete

Type 4 to delete the user option.

Display

Type 5 to display the user option.

Display 2 – Maintain user option

This display is invoked by every list option except 4, Delete. The user options can be viewed, added, copied and changed in this display.

User option

The user option is a user-defined code that can be used together with program defined options. User options normally operate on a list entry.

The user option is associated with a user program that is activated when the user option is utilized. The user program performs the designated task and communicates the status of the operation to the calling program.

See the technical description of the User Option Maintenance program for details.

User option description

This is the description of the user option. It appears in the selection window and is used to identify the function of the user option.

Private for User

Enables you to define a user option for one specific person.

Action Group

The Action Group code can be used to group user options in logical groups. These groups will manifest themselves as submenus in the GUI.

Authorization

This is the authorization level required to execute the user option. Authorization code ‘0’ indicates that the user option is disabled.

Check entry

This field indicates if TD/OMS should check if the user is authorized for the selected entry. This field should be set to *NO if the user option is not related to a particular entry. The user option CW (Command line in a window) is an example of such an option. If set to *YES then e.g. programmers are not allowed to use the option against production objects.

Entity

This is a binary addition field. If the entity should be made available for requests and fix then the two values must be added (1+2=3). If the user option must be available for objects and solutions then the value should be 12 (4+8).

Where to activate

Defines where the user option must be activated. Please note that programs cannot be called on the client. These must be command strings that can be executed by the client operating system.

Where visible/Platform

Specifies where the entry is visible. Specify 0=Client to indicate that the user option is only valid in the graphical user interface, specify 1=Server to indicate that the user option is only visible in the green screen and use 2=both to make it visible everywhere.

Pass Parameters

This element specifies whether or not parameters are passed to the calling program. The possible values are:

0=No No parameters are passed to the calling program.
1=Yes Parameters are passed to the calling program.

Program and Library

Library

Contains the name of the library where the user option program can be found.

Program

Contains the name of the program that is called when the indicated user option is used. Please keep in mind that the program you are using may not adopt authority from the calling program. Otherwise, the program would adopt TD/OMS authority because all TD/OMS functions are owned by the user OMS (including the database).

Command

The Command String can be used to enter a command string that can be executed by TD/OMS. Depending on the entity code the attributes of the entity can be substituted. Please note that application fields are always available and object fields are available when a solution is processed (except when the solution is not yet registered in the components database.)

The values that can be substituted are:

Fields from Application Database

&APAPPL Application code

&APAPNM Application name

&APERPR Request manager

&APDMPL Dump library

&APGL4N 4-GL Name

&APSRCI Check source indicator

&APCRLS Release

&APCERR Request number

&APIERR Increment

&APCFIX Fix number

&APIFIX Increment

&APCNVS Data conversion scope

&APCATT Attribute conversion type

&APCATS Attribute conv. scope

&APCAUT Authorisation conv. type

&APCAUS Authorisation conv. scope

&APCJOT Journal conversion type

&APCJOS Journal conversion scope

&APMODC Module code

&APDRVC Derivation code

&APMTPC Message 2 programmer code

&APFBLC Fall back library

&APFJBD Fast JOBD

&APFJBL Fast JOBD library

&APSJBD Slow JOBD

&APSJBL Slow JOBD library

&APPATH Default Transfer Path

Fields from component database (objects)

&OBAPPL Application code

&OBENVC Environment code

&OBOBJC Object code

&OBOBJL Object library

&OBOBJT Object type

&OBOBJA Object attribute

&OBOBJD Object description

&OBSRCF Source file

&OBSRCL Source library

&OBSRCM Source member

&OBSRCS Sources belong to object

&OBSRCX Source Change date

&OBOBJX Object Source change date

&OBOMOD Object modified

&OBOCRT User which created object

&OBFIXN Fix number

&OBUSDF User defined

&OBEXCI May not exist indicator

&OBOCLS Object class

&OBVRSN Version number

&OBMODN Modification number

&OBCHGX Object Change date

&OBIOBC IFS object code

&OBIDRC IFS Directory code

&OBGLMC 4-GL Model code

&OBGLLC 4-GL Library code

&OBGLK2 4-GL Additional key 2

&OBGLK3 4-GL Additional key 3

&OBGLK4 4-GL Additional key 4

&OBGLK5 4-GL Additional key 5

&OBGL4N 4-GL Name

&OBGLMD 4-GL Model description

&OBROTC Route Code

&OBPTHX Path Extension code

&OBELBC Extended Library Code

&DTMBRC Member code

&DTMBRA Member attribute (MBSEU)

&DTMBRD Member text

&DTFIXN Fix number

&DTOMOD Object modified

&DTUSDF User defined

&DTEXCI May not exist indicator

&DTAPPL Application code

&DTVRSN Version number

&DTMODN Modification number

Fields from Solution database

&SOAPPL Application code

&SOFIXN Fix number

&SOOBJC Object code

&SOOBJT Object type

&SOOBJA Object attribute

&SOMBRC Member code

&SOOBJL Object library

&SOOCLS Object class

&SOENVC Environment code

&SOSRCP Source Processing

&SOVRSB Version number

&SOMODB Modification number

&SOVRSN Version number

&SOMODN Modification number

&SOOVRC Override code

&SOSOLT Solution type

&SOSTAT Status

&SOROTC Route Code

&SOELBC Extended Library Code

&SOPTHX Path Extension

Fields from Fix database

&FIAPPL Application code

&FIFIXN Fix number

&FIFIXT Fix type

&FIRLSN Release

&FIDEXN Development exit count

&FIREAC Reason code

&FIFIXS Fix status

&FIPRIN Priority numeric

&FIPGMR Programmer

&FIESDT Expected start date

&FIRSDT Realized start date

&FIECDT Expected completion date

&FIRCDT Realized completion date

&FIEDDT Expected dev. end date

&FIRDDT Realized dev. end date

&FIEPHN Expected number of hours

&FIERHN Realized number of hours

&FISHFD Short fix description

&FINACN Number of ratification grps

&FIACCN Ratification count

&FIREJI Rejected indicator

&FIFREE Free user space

&FIPATH Path code

Fields from Request database

&REAPPL Application code

&REREQN Request number

&REERRT Request type

&REENVC Environment code

&REREAC Reason code

&REPRIN Priority numeric

&REUSID User i.d., or user class

&READDR User address, distribution

&REUSRI Distributed user i.d.

&RETELN Telephone number

&REWCDT Requested completion date

&RERCDT Realized completion date

&REINDT Income date

&REINTM Income time

&RESHED Short request description

&RENACN Number of ratification grps

&REACCN Ratification count

&REREJI Rejected indicator

&REFREE Free user space

PDM

Besides these codes, the general PDM style substitutions can also be used where appropriate:

&A Object Attribute

&C User defined option code

&F Name of file containing selected member

&L Object or member library name

&N Name of selected resource

&O Object library

&S Item Type without *

&T Item Type

&X Object or member text in single quotes

TD/OMS API's

The TD/OMS APIs enable you to manipulate the TD/OMS database from within your user functions. The functions in the API menu are both used by the TD/OMS managers and the TD/OMS programmers.

What is an API?

An API (Application Program Interface) is a functional interface that enables an application program, written in a high- or low-level language, to use specific data or functions of TD/OMS.

The TD/OMS APIs are commands that include all basic functions for a specific entity related to the API category. The name of an API starts with ‘OMQ’, followed by a category code and ends with an entity code.

TD/OMS APIs are available for the four most used entities; Object, Request, Fix and Solution and they are divided into four categories:

User Interface API

Each user interface API enables you to start maintenance functions for a specific entity in an interactive way. Error and warning messages are sent to the display.

Change API

Each change API enables you to process a maintenance function for a specific entity without the use of a display panel. This API can be used interactively and in the batch environment. Error and warning messages are sent to the calling program.

Print API

Each print API can be used to get several types of information listed on paper, including selections to be made on all data elements of that entity.

Retrieve API

Each retrieve API’s can be used to retrieve the contents of data elements from the TD/OMS database for a specific occurrence of the entity. These APIs are only usable in CL programs.

Why should you use an API

The APIs enables you to integrate TD/OMS functions into your own application programs, with the following advantages:

Future release consistency

Each API is provided with an interface level that is used to prevent conflicts for future release changes. You do not have to change your programs if a new TD/OMS version of the API is released.

Performance

Each API has several keywords provided in order to speed up the performance. You can use them when several consecutive actions have to be performed on a specific entity.

User interface consistency

The display will be the same whether you are using the standard TD/OMS functions, or one of the User Interface API’s. The standard TD/OMS functions are also using the APIs themselves.

Database consistency

All checking for a specific action is handled by one TD/OMS program. The result will always be the same whether you are using a standard TD/OMS function, the User Interface API’s or the Change API’s.

Examples when to use an API

Examples of integrating TD/OMS functions into your own application programs are:

Adding requests.

You are able to add the Add-Request function to an attention program if you provide your end-users with an attention key function.

Interfacing with Project Management.

You are able to add, change or delete a fix automatically from a Project Management application when a task is changed. This will decrease the number of actions to be performed.

Using APIs in an TD/OMS exception.

The APIs can be used in an TD/OMS exception program, which has to be executed during an Object Transfer function.

Store object definition after compilation.

The OS/400 Create Program commands can be replaced by your own Create Program commands which process the original OS/400 commands and the TD/OMS object API in order to update the TD/OMS database with the most recent information.

What are the features of an API

User Interface API

The User Interface APIs are available for Object (OMQUSIOB), Request (OMQUSIRE), Fix (OMQUSIFI) and Solution (OMQUSISO). Additional functions are provided for some of these APIs, but all these APIs have functions like Add, Change, Delete and Display. The functions for Request, Fix and Solution include the updating of extended text.

One additional feature of a User Interface API is that you can select the standard TD/OMS function keys or define your own function keys. TD/OMS will in both cases return the used function key to the calling program. The calling program can start another function depending on the returned function key.

Another feature of a User Interface API is that you can pre fill the display fields with some specific values to optimize the number of necessary keystrokes for the end user.

The performance of the processing can be improved by not closing the API, so consecutive processing of that API will diminish the initialization activities. APIs that remain active have to be closed when all processing has been completed. Note that some actions are performed when the API is closed, e.g. rebuilding the relations for changed objects or resetting the status of a fix after solutions have been connected to that fix.

Change API

The Change APIs are available for Object (OMQCHGOB), Request (OMQCHGRE), Relationships (OMQCHGOR), Fix (OMQCHGFI) and Solution (OMQCHGSO). Additional functions are provided for some of these APIs, but all of these APIs do have functions like Add, Change, and Delete. The functions for Request, Fix and Solution do not include the updating of extended text.

Generally, all database actions to be performed for a specific occurrence of an entity, can be performed with these APIs. Escape and diagnostic messages start with ‘OMQ’, and the escape message can be monitored in CL programs, for example by using the MONMSG (OMQ0000) statement.

The performance of the processing can be improved by not closing the API, so consecutive processing of that API will diminish the initialization activities. APIs that remain active have to be closed when all processing has been completed. Note that some actions are performed when the API is closed, e.g. rebuilding the relations for changed objects or resetting the status of a fix after solutions have been connected to that fix.

Print API

The Print APIs are available for Request (OMQPRTRE) and (OMQPRTFI). Both APIs can be used to print Request, Fix and Solution information. These APIs can be used to:

Select Requests or Fixes to be printed.

Depending on the print API being used, you can select Requests or Fixes with selection fields for all attributes of the entity.

Select list form and related entities

You can specify for the selected items whether the item itself has to be printed and/or related entities. The related fixes and solutions can also be listed on the print if, for example, you have selected all completed requests that ended in the last week. There are two options per item for the amount of information to be listed. You can select a detailed print per item or the list form. The list form includes one print line per item. The detailed print shows all attributes per item.

Select report type

Both APIs offer you a normal report with standard entity information, and/or a quality report that includes specific information about planned versus realized dates and hours.

Select Paging specifications.

Some additional keywords can be used to specify per entity whether it has to be printed on a new page or not.

Specify Performance options.

The performance of the processing can be improved by not closing the API, so consecutive processing of that API will diminish the initialization activities. APIs that remain active have to be closed when all processing has been completed.

Retrieve API

The Retrieve APIs are available for Object (OMQRTVOB), Request (OMQRTVRE), Fix (OMQRTVFI), Solution (OMQRTVSO), Request / Fix relations (OMQRTVRF), Fix / Request relations (OMQRTVFR), Application (OMQRTVAP), 4GL Library attributes (OMQRTV4G) and special TD values (OMQRTVSR).

All stored attributes in the TD/OMS database can be retrieved into a variable by using these APIs. Note that these APIs can only be used in a CL program.

Example user option program

This user option program prints object relations in html format.

User Interface with Object (OMQUSIOB) - Help

User Interface with Object (OMQUSIOB)

This Application Program Interface command allows 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 an object and does so in a user-friendly manner. This command cannot be run in the background.

Action code (ACTC)

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

*ADD

Use this action code to add a new object to the TD/OMS database.

*CHANGE

Use this action code to change one or more object attributes.

*CLOSE

Use this action code to close the object database and to perform the 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 an object as a base for another object. Several object dependent attributes cannot be copied but are retrieved from the object's object description.

*DELETE

Use this action code to remove an object from the database.

*DISPLAY

Use this action code to display the description of an object. 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)

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.

Object class (OCLS)

Specify the class of the object. The class is always determined by TD/OMS unless the object is temporary. The possible values are:

*OS400

The object is an OS/400 object.

*GL4

The object is an object from a fourth-generation language.

*HFSOBJ

The object is an object from a hierarchical file system. This can be a PC object or a document from an AS/400 folder.

Temporary or virtual object (EXCI)

Specify whether the object is a virtual or temporary object or if it is a real object. The possible values are:

*NO

The object is not temporary or virtual. TD/OMS can expect to find the object in the indicated location. If the object cannot be found in this location an error is reported.

*YES

The object is virtual or temporary. A temporary object can be a work file to which programs relate but only exists during the duration of a job. Virtual objects are mostly used to represent a real object like a printer or a terminal.

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.

Protect environment (PRENVC)

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

*NO

The environment code of the display is not protected. You can enter an environment code in the display of the function.

*YES

The environment field of the functions display is not accessible for input. Use this value to make sure that the environment code is not changed by the user. This value is useful only in combination with a pre-filled

environment 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
ENVC	Environment
OBJC	Object code
OBJL	Object library
OBJT	Object type
OBJA	Object attribute
OBJD	Object description
SRCF	Source file
SRCL	Source library
SRCM	Source member
FIX	Fix number

Key (KEY)

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

Object code

Specify the name of the object.

Object library

Specify the location of the object.

Object type

Specify the type of the object.

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:

*APPL

The current active application code is used. An error is reported if no application is currently active.

application-code

Specify the application code.

Environment (ENVC)

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

Object code (OBJC)

Specify the object 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.

Object type (OBJT)

Specify the object 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.

Object attribute (OBJA)

Specify the attribute 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:

*OBJD

Use the attribute from the actual object. This value is not allowed for temporary or virtual objects.

object-attribute

Specify the attribute

Object description (OBJD)

Specify the 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. The possible values are:

*OBJD

Use the description from the actual object. This value is not allowed for temporary or virtual objects.

object-description

Specify the description of the object.

Source file (SRCF)

Specify the source file 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:

*OBJD

Use the source file from the actual object. This value is not allowed for temporary or virtual objects.

source file

Specify the source file of the object.

*BEST

Search the environment definitions for the best source library.

source-library

Specify the source library.

Source member (SRCM)

Specify the source member 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:

*OBJD

Use the member from the actual object. This value is not allowed for temporary or virtual objects.

source-member

Specify the source member of the object.

Created by (OCRT)

Specify the user who 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:

*OBJD

Use the user from the actual object. This value is not allowed for temporary or virtual objects.

user ID.

Specify the user who created the object.

Fix number (FIX)

Specify the fix number 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:

*ACTIVE

The solution database is searched for the current active fix number.

*NONE

The fix number in the object is not filled.

fix-number

Specify the fix number which caused the fix to be created into this library.

TDOMS API - Change Object (OMQCHGOB) - Help

Change Object (OMQCHGOB)

This OMQCHGOB 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 an object.

Action code (ACTC)

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

*ADD

Use this action code to add a new object to the TD/OMS database.

*CHANGE

Use this action code to change one or more object attributes.

*CLOSE

Use this action code to close the object database and to perform the last record processing. This option enables you to keep the interface to the object database open until you explicitly close it. This will make the interface faster.

*DELETE

Use this action code to remove the description from the TD/OMS object database. You are also able to delete the related object and source.

*JOBREL

Use this action code to process pending relationship requests for a certain job. Requests are also queued to build the relationship database if objects are added to the TD/OMS database. These requests are processed in batches to make the relationship search faster. You can specify *ALL to process pending relationship requests for all jobs.

Example: Three programs are added to the TD/OMS object database. These programs are called PGMA, PGMB, and PGMC. PGMA calls both PGMB and PGMC. If PGMA is added to the database, a relationship request is queued for it and the next object (PGMB) is added. PGMB also places a relationship request in the queue and the same steps are performed for PGMC. The function now sees that there are no more objects to be added and starts dequeuing the relationship requests. If the relationships of PGMA were determined when the object was added to the database, both PGMB and PGMC would not yet exist. This would cause error reporting. This action code dequeues all requests and starts building the relationships.

*OBJREL

Use this action code to request a relationship rebuild for the specified object.

*REFILL

Use this action code to request a refresh of the specified object. If the object was not found in the database it will be added, or it will be changed according to the user specifications or the new attributes of the object.

Object code (OBJC)

The object code is the i5/OS system name of an object. The length is 10 characters for normal objects and 12 for document library objects. If the name contains a tilde (~) or a question mark (?), it is the short name for an object in the Integrated File System. You can also have short name's if your application contains LANSA objects. The details for the entry show the full name of the object.

*IFSOBJ

Use this value if you want to register an object from the integrated file system (IFS) instead of the normal OS/400 library structure.

character-value

Specify the object code of the object.

Object Library (OBJL)

The Object Library is the library that contains the object. The object library can be an i5/OS system library or a logical library. A logical library is the logical representation of another place holder, e.g. a folder or a 4GL storage location.

Object type (OBJT)

The object type specifies the type of object. Program objects are of the type *PGM, file objects are of the type *FILE, etc. Refer to the IBM i5/OS reference guide for more information.

IFS Object code (IFSOBJ)

The IFS Full Path Name is a complete reference to an IFS object. This includes the directory and the object.

*OBJC

Use this value if you want to register an object from the OS/400 library structure instead of the integrated file system (IFS).

path-name

Specify a full pathname to the object.

Application (APPL)

Specify the application code of the object. The possible values are:

*SAME

The application code of the object does not change. This value is not allowed if an object is first added to the object database.

application-code

Specify the application code of the object.

Environment (ENVC)

Specify the environment code where the object resides. TD/OMS will check if the library of the object is defined in the definition of the specified environment. The possible values are:

*SAME

The environment code of the object does not change. This value is not allowed if an object is first added to the object database.

environment-code

Specify the environment code of the object.

Fix number (FIX)

The fix number attribute of the object is not the fix the object is currently connected to, but the fix which caused the object to be placed in this environment. The possible values are:

*SAME

The fix number in the object does not change.

*NONE

The solution database is not searched for the fix by which the object could have been placed in this environment.

*ACTIVE

The solution database is searched and the last fix to which this object was connected is used as the fix number for this object. However, if the fix number in the object is already filled then the fix number does not change.

fix-number

Specify the fix number to be used as the fix number in the object file. If a fix is specified, it must exist in the TD/OMS database and the object must be connected to it.

Object description (OBJD)

Specify the description of the object. The possible values are:

*SAME

The description of the object does not change. When the object is first added to the TD/OMS database the description is taken from the object's header. This value is not allowed when adding temporary objects.

*OBJD

The object description is retrieved from the object's header. This value is not allowed for temporary objects.

object-description

Specify the object's description.

User ID (USID)

Specify the user who created the object. The possible values are:

*SAME

The user does not change. The value is retrieved from the header of the object if objects are added to the database. This value is not allowed when adding temporary objects.

*OBJD

The user who created the object is taken from the header of the object. This value is not allowed for temporary objects.

user ID

Specify a valid AS/400 user ID.

User defined (USDF)

Specify whether the object is added by the user or retrieved by automated TD/OMS functions as "fill object file" (STRFOF). The possible values are:

*SAME

The value of the field does not change. If *SAME is used when the object is first added, the value *YES is assumed.

*YES

The object was added manually.

*NO

The object was not added manually.

Temporary or virtual object (TOVI)

Specify whether the object is a virtual or temporary object or if it is a real object. The possible values are:

*SAME

The value of the element does not change. If *SAME is used when the object is first added, the value *NO is assumed.

*NO

The object is not temporary nor virtual. TD/OMS can expect to find the object in the indicated location. If the object cannot be found in this location an error is reported.

*YES

The object is virtual or temporary. A temporary object can be a work file to which programs relate but only exist for the duration of a job. Virtual objects are mostly used to represent a real object like a printer or a terminal.

*STUB

The object is not temporary nor virtual but TD/OMS will not look for the object on disk. This means that you will have to supply all the attributes just as if this was a virtual object but the virtual flag is not actually set in the database.

This can be used for creating a stub for an object that will exist later on like when creating new objects in development.

Object attribute (OBJA)

Specify the attribute of the object. The possible values are:

*SAME

The value of the element does not change. If *SAME is used when the object is first added, then the attribute is retrieved from the object's description. This value is not allowed for temporary objects.

*OBJD

The attribute is retrieved from the object's object description. This value is not allowed when adding a temporary object.

attribute

Specify the object attribute. The value you specify here is only used for temporary objects.

Object class (OCLS)

Specify the class of the object. The class is always determined by TD/OMS unless the object is temporary. The possible values are:

*SAME

The value of the element does not change. If *SAME is used when the object is first added, then the class is determined by TD/OMS.

*OS400

The object is an OS/400 object.

*GL4

The object is an object from a fourth-generation language.

*HFSOBJ

The object is an object from a hierarchical file system. This can be a PC object or a document from an AS/400 folder.

Source file (SRCF)

Specify the name of the source file. The possible values are:

*SAME

The value of the element does not change. If *SAME is used when the object is first added then the source file and library are determined by TD/OMS.

*NONE

The object does not have a source or the object has a source but the source is not available. TD/OMS will not try to search for the object's source if it transfers the object.

*OBJD

The object is initially taken from the object's object description. TD/OMS will try to locate a better source if one is available.

source-file-name

Specify the name of the source file.

*SAME

The value of the element does not change. If *SAME is used when the object is first added then the library is determined by TD/OMS.

*BEST

OMS will search for the best logical source location and will issue a report with possible source conflicts.

*OBJD

The library is initially taken from the object's object description. TD/OMS will try to locate a better source library if one is available.

source-library-name

Specify the name of the source library.

Source member (SRCM)

Specify the name of the source member. The possible values are:

*SAME

The value of the element does not change. If *SAME is used when the object is first added then the member is determined by TD/OMS.

*OBJD

The member is initially taken from the object's object description. TD/OMS will try to locate a better source member if one is available.

source-member-name

Specify the name of the source member.

Close API indicator (EOPI)

Specify whether 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 open the needed files and programs again.

*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.

Note: Keep in mind that the last action of a series should close the API in order to close spooled files and do relationship processing.

Relations indicator (RELI)

Indicate if and how the object's relationships should be (re)build. The possible values are:

*NO

The relationships are not processed for the indicated object. This value has no meaning if the action code is one of the related processing action codes.

*IMMED

Do an immediate update of the object's relationships. This value is useful when only one object is added to the object file.

*DELAYED

The rebuild of the relationships is not done when this value is used and if the end processing indicator (EOPI) is set to *NO. Instead the relationship rebuild requests are queued and processed when either the *CLOSE action code is used, the command is used again but now with the EOPI indicator set to *YES or when the relationship action codes *JOBREL and *OBJREL are used on the data of the queued relationship requests. Use this value when you are adding more than one object to the

object database and want to postpone the load of the inter-object relationships until a later time.

*CHANGED

This value is equal to the *DELAYED value but is even more effective in the sense that the relationship request is only performed if the object was changed after the last update of the TD/OMS database.

Note: The *CHANGED and *DELAYED values are by far the most efficient ways of relationship processing.

Print Indicator (PRTI)

Specify the amount of data to print if a request is made to the API. The possible values are:

*YES

Indicates that conflicts are reported when they arise. Successful requests are not printed.

*NO

Nothing is printed.

*ALL

Everything is printed.

Delete object indicator (DLTI)

Specify if the object and the source are also deleted if the deletion of the object in the TD/OMS database is requested.

*NO

The object and the source are not deleted.

*YES

The object will be deleted. The source will only be deleted if it is not referred to by any other object.

Rebuild relationships job number (JOB)

Specify the job number for which queued relationships must be processed with action code *JOBREL. Relationship requests are queued in file OMO001W4 in your TD/OMS library. The possible values are:

*CURRENT

The relationship requests placed in the current job are processed.

*ALL

The relationship requests must be processed for all jobs.

job-number

Specify a job number from which the relationships must be processed.

Print Mutations (PR2I)

Specify if a mutation report must be printed. A mutation is a difference between the TD/OMS database and the object in the library. If the timestamps in the TD/OMS database differ from the timestamps in the actual object description, or the object was removed from the library, or the object was added to the library then a line is printed on the report. The possible values are:

*NO

The mutations are not printed.

*YES

Mutations are printed.

Include 4GL generated objects (GENI)

Specify, for 4GL objects, if the generated objects also have to be processed. The possible values are:

*NO

Generated objects are not processed.

*YES

Generated objects are processed.

Retrieve Object (OMQRTVOB) - Help

Retrieve Object (OMQRTVOB)

The Retrieve Object Description API command allows you to retrieve the description of an object in the TD/OMS database. This command has to be activated in a program.

Object (OBJC)

Specify the object code from which the description has to be retrieved.

object-code

Enter a valid object code.

Library (OBJL)

Specify the name of the library in which the object which has to be retrieved is located.

library-code

Enter a valid library code.

Object type (OBJT)

Specify the object type of the object from which the description has to be retrieved.

object-type

Enter a valid object type.

Detail code (DTLC)

Specify the detail code of the object from which the description has to be retrieved. If a detail code is specified additional parameters are provided to contain detail descriptions.

*NONE

No detail code is involved.

detail-code

Enter the code of the connected detail.

IFS Object (IFSOBJ)

Specify the IFS-object from which the description has to be retrieved. This has to be a full pathname.

IFS-object

Enter a valid IFS object.

CL var for APPL

Specify the name of a variable used to retrieve the application code. This should be a 5-character variable in CL programs.

CL var for ENVC

Specify the name of a variable used to retrieve the environment code. This should be a 5-character variable in CL programs.

CL var for OBJA

Specify the name of a variable used to retrieve the code of the object attribute. This should be a 10-character variable in CL programs.

CL var for OBJD

Specify the name of a variable used to retrieve the description of the specified object. This should be a 50-character variable in CL programs.

CL var for SRCF

Specify the name of a variable used to retrieve the name of the related source file. This should be a 10-character variable in CL programs.

CL var for SRCL

Specify the name of a variable used to retrieve the name of the library in which the source is located. This should be a 10-character variable in CL programs.

CL var for SRCM

Specify the name of a variable used to retrieve the name of the source member. This should be a 10-character variable in CL programs.

CL var for SRCS

Specify the name of a variable used to retrieve the source status. This should be a 1-character variable in CL programs.

CL var for SRCX

Specify the name of a variable used to retrieve the source change date. This should be a 13-character variable in CL programs. The format of the change date is CYYMMDDHHMMSS (century, year, month, day, hour, minute, second).

CL var for OBJX

Specify the name of a variable used to retrieve the object source change date. This should be a 13-character variable in CL programs. The format of the change date is CYYMMDDHHMMSS (century, year, month, day, hour, minute, second).

CL var for OCRT

Specify the identification of the user who created this object in this environment. This should be a 10-character variable in CL programs.

CL var for FIX

Specify the code of the fix by which this object was placed in this environment. This should be a 10-character variable in CL programs.

CL var for USDF

Specify the name of a variable used to retrieve the user-defined attribute of the object. This should be a 1-character variable in CL programs.

CL var for TOVI

Specify the name of a variable used to retrieve the temporary or virtual object indicator. This should be a 1-character variable in CL programs.

CL var for OCLS

Specify the name of a variable used to retrieve the object class of the object. This should be a 1-character variable in CL programs.

CL var for VRSN

Specify the name of a variable used to retrieve the object's current version number. This should be a 5-position decimal variable in CL programs.

CL var for MODN

Specify the name of a variable used to retrieve the modification number of the object. This should be a 5-position decimal variable in CL programs.

CL var for CHGX

Specify the name of a variable used to retrieve the object change date. This should be a 13-character variable in CL programs. The format of the change date is CYYMMDDHHMMSS (century, year, month, day, hour, minute, second).

CL var for DTLA

Specify the name of a variable used to retrieve the attribute of the specified detail code. This should be a 10-character variable in CL programs.

CL var for DTLD

Specify the name of a variable used to retrieve the description of the specified detail code. This should be a 50-character variable in CL programs.

CL var for DTLFIX

Specify the code of the fix by which this detail was placed in this environment. This should be a 10-character variable in CL programs.

CL var for DTLUSDF

Specify the name of a variable used to retrieve the user-defined attribute of the detail. This should be a 1-character variable in CL programs.

CL var for DTLTOVI

Specify the name of a variable used to retrieve the temporary or virtual detail indicator. This should be a 1-character variable in CL programs.

CL var for FLR

Specify the name of a variable used to retrieve the name of the folder in which the object is located. This should be a 63-character variable in CL programs.

CL var for RTNOBJC

Specify the name of a variable used to retrieve the object code. For an IFS-object, the abbreviated name is returned. For other objects, the value specified in the OBJC parameter is returned. This should be a 12-character variable in CL programs.

CL var for RTNOBJL

Specify the name of a variable used to retrieve the object library. For an IFS-object, a handle to the directory name is returned. For other objects, the value specified in the OBJL parameter is returned. This should be a 10-character variable in CL programs.

CL var for RTNOBJT

Specify the name of a variable used to retrieve the object type. For an IFS-object, the object type (*STMF, *DIR ...) is returned. For other objects, the value specified in the OBJT parameter is returned. This should be a 9-character variable in CL programs.

CL var for RTNIFSOBJ

Specify the name of a variable used to retrieve the full pathname of the IFS-object. The name is capitalized according to the rules of the filesystem. This should be an 896-character variable in CL programs.

Note

For library-objects, the parameter returns the corresponding pathname for the object in the QSYS.LIB filesystem, as in the following example: For message file HELPMSG in library DEVLIB, the value

/QSYS.LIB/DEVLIB.LIB/HELPMSG.MSGF will be returned.

CL var for VRS

DEPRECATED: USE VRSN.

CL var for MOD

DEPRECATED. USE MODN.

TDOMS API Change Relationship (OMQCHGOR) - Help

Change Relationship API (OMQCHGOR)

This Application Program Interface command allows you to manipulate the TD/OMS database. This can be done from a command line or from within your programs. The command enables you to perform all allowed actions on a relationship. You can use this command to create an interface with another system.

Action code (ACTC)

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

*ADD

Use this action code to add a new relationship to the TD/OMS database.

*CLOSE

Use this action code to close the relationship database and to close the program. This option enables you to keep the interface to the relationship database open until you explicitly close it. This will make the interface faster.

*DELETE

Use this action code to remove a relationship from the database.

Object code (OBJC)

Specify the object code of the object to which the relationship must be added or from which a relationship has to be removed. The object code is the OS/400 name of the object.

Object library (OBJL)

Specify the object library of the object to which the relationship must be added or from which a relationship must be removed. The object library can be an OS/400 library or a logical library.

Object type (OBJT)

Specify the object type of the object to which the relationship must be added or from which a relationship must be removed.

Member code (MBRC)

The member code is the name of the member of an object, e.g. a message in a message file or a source member in a source file.

*NONE

The relationship is not concerning a member of an object.

member-code

If the relationship is concerning a member then you must enter the member code here.

IFS-Object (IFSOBJ)

Specify the IFS-object to which the relationship must be added or from which a relationship must be removed.

Related object (ROBC)

Specify the object code of the related object. Use the special value *ALL in combination with action code *DELETE to remove this object's user-defined relationships.

Related object library (ROBJ)

Specify the object library of the related object. The object library can be an OS/400 library or a logical library.

*NONE

The library of the related object is not registered in the relational database.

library-code

Specify the object library of the related object.

Member code (RMBC)

The member code is the name of the member of an object, e.g. a message in a message file or a source member in a source file.

*NONE

The relationship is not concerning a member of an object.

member-code

If the relationship is concerning a member then you must enter the member code here.

Related IFS-Object (RIFSOBJ)

Specify the related IFS-object.

Related IFS-Object (RIFSOBJ)

Specify if the API should 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 open the necessary files and programs again.

*NO

The state of the API was left when the requested action was completed. Files remain open and status updates are postponed. Subsequent calls to the API are considerably faster and storage is not freed.

Note: Note that the last action of a series should close the API in order to close spooled files and do status calculations.

TDOMS API Retrieve Relationship API (OMQRTVOR) - Help

Retrieve Relationship API (OMQRTVOR)

This Application Program Interface command allows you to manipulate the TD/OMS database. This can be done from a command line or from within your programs. The command enables you to perform all allowed actions on a relationship. You can use this command to retrieve the relationships of an object.

Object code (OBJC)

Specify the object code of the object from which the relationship must be retrieved. The object code is the OS/400 name of the object, the name of a document library object, the name of a 4GL object, etcetera.

Object library (OBJL)

Specify the object library of the object from which the relationship must be retrieved. The object library can be an OS/400 library or a logical library.

Object type (OBJT)

Specify the object type of the object from which the relationship must be retrieved.

Detail code (DTLC)

The detail code is the name of the detail of an object, e.g. a message in a message file or a source member in a source file.

*NONE

The relationship is not concerning the detail of an object.

detail-code

If the relationship is concerning a detail then you must enter the detail code here. The relationship will be retrieved from the detail instead of the object.

Direction (DIRC)

Specify the direction of the relationship to be retrieved. The possible values are:

*USING

Retrieve a relationship which this object is using. The object to be retrieved is used by the object specified in the object keywords. E.g. if the object in the object keywords is a program that is calling another program then this program could be retrieved because the object in the object keyword is using it.

*USEDBY

Specify this keyword if the relationship you want is in the other directions and the object in the object keywords are used by the object to be retrieved.

Reference object code (REFOBJC)

Specify the reference object code of the object from which the relationship must be retrieved. Use this keyword in combination with the RTVOPT keyword to specify the next or this object. The possible values are:

*FIRST

The reference object is the first object related to the object specified in the OBJC keyword.

object-code

Specify the object code to be used as the reference object.

Reference object library (REFOBJL)

Specify the reference object library of the object from which the relationship must be retrieved. The object library can be an OS/400 library or a logical library.

Reference object type (OBJT)

Specify the reference object type of the object from which the relationships must be retrieved.

Reference detail code (REFDTLC)

The reference detail code is the name of the detail of an object, e.g. a message in a message file or a source member in a source file.

Retrieve option (RTVOPT)

Used in combination with the reference object. The possible values are:

*REF

Get the relation of the object in the reference object keyword. If the reference object is not related to the object an error will be reported.

*NEXT

Retrieve the next sequential object relationship in relation to the reference object.

Related object (RELOBJC)

Specify a CL variable that receives the name of the object related to the object in the OBJC keyword.

Related object library (RELOBJL)

Specify a CL variable that receives the code of the related object's object type.

Related object type (RELOBJT)

Specify a CL variable that receives the code of the related object's object type.

Related object detail (RELDTLC)

Specify a CL variable that receives the name of the related object's detail.

Relation type (RELRELT)

Specify a CL variable that receives the relation type.

Relation type

The relation type attribute identifies how the object relates to the related object. The current relation types are:

Type	Description
*USER - (100)	Specifies user-defined relations. These relations are not generated by OMS. OMS keeps track of the user-defined relation if the related object moves to another environment.
*GENBY - (200 or 300)	Specifies that this object is generated by the related object. This relation type is most commonly seen with 4GL objects. The definition of a 4GL object normally results in the generation of one or more native i5/OS objects
*MODUL - (350)	Specifies a module relationship. The object is a module of the object that is using it.
*4GL - (400)	This relation type is used if 4GL objects use other 4GL objects. This can be caused by a function invoking another function or a function using an element from the data model.
*INP - (5x1)	Specifies a relation to an object containing data. The data is read by the related object.
*OUT - (5x2)	Specifies a relation to an object containing data. The data is written by the related object.
*I/O - (5x3)	Specifies a relation to an object containing data. The data is written and read by the related object.
*UPD - (5x4)	Specifies a relation to an object containing data. The data is changed by the related object.
*I/U - (5x5)	Specifies a relation to an object containing data. The data is read and changed by the related object.
*O/U - (5x6)	Specifies a relation to an object containing data. The data is changed and written by the related object.
*I/O/U - (5x7)	Specifies a relation to an object containing data. The data is read, changed, and written by the related object.
*PFCST -(620)	Specifies a referential integrity relation with a database file.
*PFTRG -(630)	Specifies a relation to a physical file trigger. The program is called whenever actions occur on a database file.
*REXX -(650)	This is mostly a command processing program. The REXX program is called by the command to process the keyword values.
*MBR - (800)	Specifies a relation to detail. This can be a message or a member from a database or source file.
*EXT - (850)	Specifies an extended relationship.
*SRC - (900)	Specifies a relation to the source of this component. Please note that traditional iSeries sources are included as an attribute of the TD object. Other objects could use several master sources or include a source that is not found in a traditional source file.
*INSRC - (901)	Specifies a relation to an included source. E.g. a /COPY member or a header file.
*EXTDS - (910)	Specifies an external data structure relationship.
*ATTR - (915)	Specifies an attribute relation. The related component exists as an attribute. Attributes can be fields, methods, subroutines, data exports, etc.

User defined (RELUSDC)

Specify a CL variable that receives the user-defined code. Code '0' means that the relationship was found by TD/OMS. Code '1' means that the relationship was added manually.

Interface with Request (OMQUSIRE) - Help

Interface with Request (OMQUSIRE)

This Application Program Interface command allows 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 upon a request and does so in a user-friendly manner. This command cannot be run in the background.

Action code (ACTC)

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

*ADD

Use this action code to add a new request to the TD/OMS database.

*CHANGE

Use this action code to change one or more request attributes.

*CLOSE

Use this action code to close the request database and to perform the last record processing. This option enables you to leave the interface to the database open until you explicitly close it. This will make the interface faster.

*COPY

Use this action code to copy a request. The extended description is also copied, but not the associated word processing document (if any). The connected fixes are also not copied.

*DELETE

Use this action code to remove a request from the database.

*DISPLAY

Use this action code to display the contents of the request. 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 is 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 are supplying one or more function keys to the user interface. When 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
REQ	Request number
REQT	Request type
ENVC	Environment code
REAC	Reason code
PRIC	Priority code
USID	User ID
ADDR	Remote address
USRI	Remote user
TEL	Telephone
WCDT	Requested completion date
SHRD	Short request 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.

Request (REQ)

Specify the request 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. This value can only be used when the request is first added to the database.

request number

Specify the request number.

Request type (REQT)

Specify the request 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 request type is retrieved from the request type table. No value is retrieved if no default request type is specified.

request-type

Specify the request type which has to exist in the request type table.

Reason code (REAC)

The reason code is currently not used by the OMQUSIRE API. The possible values are:

*DFT

Use the default reason code.

reason-code

Specify the reason code.

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.

Reported by (USID)

Specify the user who 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 user that reported the request.

Reported by remote user (USRI)

Specify the remote user who must be used to pre-fill the field in the display of the function. Consult the pre-fill help texts for more information.

Address of remote user (ADDR)

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

Telephone (TEL)

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

Requested completion date (WCDT)

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.

Short request description (SHRD)

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.

Print Request (OMQPRTRE) - Help

Print Request (OMQPRTRE)

The Print Request command allows you to obtain a printed report of the OMS database. You can select requests on numerous selections, making this an extremely powerful command.

The reports also provide some basic time calculations.

Action code (ACTC)

Specify the action code to be used. The possible values are:

*PRINT

Start printing the request database using these command specifications.

*CLOSE

Use this action code to close the request database and to perform last record processing. This option enables you to keep the interface to the database open until you explicitly close it. This will make the interface faster.

Application (APPL)

Specify the application code to be used. The possible values are:

*ALL

Do not use the application code as a selection field. All values are valid.

application-code

Specify the application code.

Request Number (REQ)

Specify the request number to be used. The possible values are:

*ALL

Do not use the request number as a selection field. All values are valid.

request-number

Specify the request number.

Request status (ENVC)

Specify the request status to be used. The possible values are:

*ALL

Do not use the request status as a selection field. All values are valid.

*OPEN

Select only requests currently being worked on.

*COMPLETE

Select only completed requests.

environment-code

Specify the environment code.

Ratification status (RATS)

Specify the ratification status to be used. The possible values are:

*ALL

Do not use the ratification status as a selection field. All values are valid.

*OPEN

Select only requests which have ratifications pending. This will show all fixes which still have to be ratified.

*COMPLETE

Select only requests which are ratified by members of all connected ratification groups.

*REJECTED

Select only requests of which one of the members of the ratification group rejected the requests.

Request type (REQT)

Specify the request type to be used. The possible values are:

*ALL

Do not use the request type as a selection field. All values are valid.

request-type

Specify the request type.

Priority (PRIN)

Specify the priority code to be used. The possible values are:

*ALL

Do not use the priority code as a selection field. All values are valid.

priority

Specify the priority code.

Reason code (REAC)

Specify the reason code to be used. The possible values are:

*ALL

Do not use the reason code as a selection field. All values are valid.

reason-code

Specify the reason code.

User ID (USID)

Specify the user ID to be used. The possible values are:

*ALL

Do not use the user ID as a selection field. All values are valid.

user ID.

Specify the user ID.

Telephone (TEL)

Specify the telephone number to be used. The possible values are:

*ALL

Do not use the telephone number as a selection field. All values are valid.

telephone-number

Specify the telephone number.

Address (ADDR)

Specify the address of the remote user to be used. The possible values are:

*ALL

Do not use the address of the remote user as a selection field. All values are valid.

address

Specify the address of the remote user.

Remote user ID (USRI)

Specify the id of the remote user to be used. The possible values are:

*ALL

Do not use the id of the remote user as a selection field. All values are valid.

remote-address-ID

Specify the ID of the remote user as it appears in the distribution directory.

Income date from (INFR)

Specify the income date lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the income date as a selection field. All values are valid.

date

Specify the income date lower limits.

Income date until (INTO)

Specify the income date upper limits to be used. The possible values are:

*ALL

Do not use the upper limits of the income date as a selection field. All values are valid.

date

Specify the income date upper limits.

Requested vs realized completion date (COCO)

Specify the relationship between the requested and the realized completion date. The possible values are:

*ALL

Do not use the relationship between the requested and realized dates as a selection field. All values are valid.

*LT

Specify that all requests are selected which were realized in the request time frame.

*GT

Specify that all requests are selected which were not realized in the requested time frame (overdue).

Requested completion date from (WCFR)

Specify the requested completion date lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the requested completion date as a selection field. All values are valid.

date

Specify the requested completion dates lower limits.

Requested completion date until (WCTO)

Specify the requested completion date upper limits to be used. The possible values are:

*ALL

Do not use the upper limits of the requested completion date as a selection field. All values are valid.

date

Specify the requested completion date upper limits.

Realized completion date from (RCFR)

Specify the realized completion date lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the realized completion date as a selection field. All values are valid.

date

Specify the realized completion dates lower limits.

Realized completion until (RCTO)

Specify the realized completion date upper limits to be used. The possible values are:

*ALL

Do not use the upper limits of the realized completion date as a selection field. All values are valid.

date

Specify the realized completion date upper limits.

Request data (RDTA)

Specify the amount and kind of request data to be printed. The possible values are:

*SHORT

Prints only the basic amount of request information.

*NONE

Prints no request information.

*DETAIL

Prints detailed request information.

The possible ratification data values are.

*NONE

The print of ratification data is currently not implemented.

Fix data (FDTA)

Specify the amount and kind of fix data to be printed. The possible values are:

*SHORT

Prints only the basic amount of fix information. Use this value for rough reports.

*NONE

Prints no fix information.

*DETAIL

Prints detailed fix information.

The possible ratification data values are.

*NONE

The print of ratification data is currently not implemented.

Solution data (SDTA)

Specify the amount of solution data to be printed. The printed solutions are the objects connected to the selected fixes. The possible values are:

*SHORT

Prints only the basic amount of solution information.

*NONE

Prints no solution information.

*DETAIL

Prints detailed solution information.

Specify whether the override information will have to be printed. The possible values are:

*NONE

No override information will be printed.

*SHORT

Override information will be printed for each solution, when available. The description belonging to the solution will be truncated, even when no overrides are found.

Using this option, you are able to see on the report whether a solution is merged, if applicable.

Output format (FMT)

Specify how the data must be formatted. The possible values are:

*COMPOUND

Prints the requested data in a combined form. The request, fix and solution information is printed together.

*LIST

The request, fix and solution data is printed in separate lists.

Request quality data (RQDA)

Specify if the request dates must be compared with the actual fix and request dates. The possible values are:

*NONE

Do not print request quality information.

*SHORT

Print a brief list of requests and compare the request dates with the actual dates.

Fix quality data (FQDA)

Specify if quality data must be printed. The quality data is the data concerned with expected and realized dates. The possible values are:

*NONE

Do not print quality data.

*SHORT

Prints a list of the selected fixes. The differences between expected and realized dates and hours are printed.

*DETAIL

Prints a detailed list of fixes and the exact expected and realized dates.

Close indicator (EOPI)

Indicate if the interface has to be closed. The possible values are:

*YES

Files are closed and storage is freed. Subsequent requests must establish a new connection to the information.

*NO

Keep the interface to the information when the function exits. The same data paths are used when subsequent requests are made. This makes the interface considerably faster.

Application per page (PAGA)

Specify if the function has to start printing on a new page when the application code changes. The possible values are:

*NO

Do not skip to a new page.

*YES

Skip to a new page.

Request per page (PAGR)

Specify if each request has to be printed on a separate page. The possible values are:

*NO

Do not print each request on a separate page.

*YES

Print each request on a separate page.

Fix per page (PAGF)

Specify if each fix has to be printed on a separate page. The possible values are:

*NO

Do not skip to a new page when a new fix is started.

*YES

Skip to a new page when a fix is started.

Solution per page (PAGS)

Specify if each solution has to be printed on a separate page. The possible values are:

*NO

Do not print each solution on a separate page.

*YES

Print each solution on a separate page.

Print cover page (COVR)

Specify if a cover page has to be printed with additional information. The possible values are:

*NO

Do not print the cover page.

*YES

Print the cover page.

Print end page (ENDP)

Specify if a closing page has to be printed with additional information. The possible values are:

*NO

Do not print the end page.

*YES

Print the end page.

Close print file (CLSF)

Specify if subsequent print requests have to direct their output to the same spooled file. The possible values are:

*YES

The print file is closed. Subsequent requests print to a new spooled file.

*NO

The print file is not closed. This value is valid only in combination with the "Close API indicator". Subsequent requests print their output to the same spooled file.

Change Request Description (OMQCHGRE) - Help

Change Request Description (OMQCHGRE)

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 request.

Action code (ACTC)

Specify the action to be performed with the request. The possible values are:

*ADD

Use this action code to add a new request to the TD/OMS database.

*CHANGE

Use this action code to change one or more of the request attributes.

*CLOSE

Use this action code to close the request database and to perform the last record processing. This option enables you to keep the connection to the database open until you explicitly close it. This will make the interface

considerably faster.

*COMPLETE

Use this action code to complete a request that has not yet been processed. This action cannot be used if fixes are connected to the request.

You can use this option to complete obsolete requests, hence removing them from the active request list.

*CONNECT

Use this action code to connect a request to a fix. The request/fix relationship enables you to group fixes under one logical request. A fix can be connected to more than one request in more than one application.

*COPY

Use this action code to copy the attributes of a request. The extended description is also copied, but not the associated word processing document (if any).

*DELETE

Use this action code to remove a request from the database and to remove all relationships to connected fixes.

*DISCONNECT

Use this action code to disconnect a fix from a request.

*RENAME

Use this action code to rename a request.

*RATIFY

Use this action code to ratify the fix (or not). This action code is used in combination with the ratification group and the ratification code. Together they determine whether or not the connected objects are able to go to the next environment. Consult the Ratification Group Maintenance function for more information.

*STATUS

Use this action code to determine the status of a request. The request status is determined when the object transfer function is ended in a controlled manner; so normally you should not have to use this action. However, you

can use this action code to rebuild the status when it is not updated correctly.

Application code request (APPL)

Specify the application code of the request.

Request (REQ)

Specify the request number. The possible values are:

request-number

Specify a unique identification of the request.

*GEN

Use this value to have the number generated by TD/OMS as defined in the application definition.

Request type (REQT)

Request type

The 'Request type' indicates the type of request. These types are user-defined and can be maintained in the Table Maintenance function. One of the available types can serve as the default type. The special value *DFT

indicates that the default type will be used.

*SAME

Use this value to indicate that the request type does not change. TD/OMS will try to find the best value for the element if a new request is added and the value *SAME is used.

*DFT

Use this value to indicate that the default request type must be used. The default request type is a user-defined value.

request type

Enter a request type.

Reason code (REAC)

The reason code is used in combination with the action code *COMPLETE. It indicates the reason why the request was completed. The possible values are:

*SAME

Use this value to indicate that the reason code does not change. TD/OMS will try to find the best value for the element if a request was completed and the value *SAME is used.

*DFT

Use this value to indicate that the default reason code is to be used to complete the fix. The default reason code is user defined.

reason code

Enter a reason code.

Note

The reason code is maintained using the table maintenance(STRTM) function.

Priority code (PRIC)

Priority code

The priority code identifies the priority of a request or a fix. Priority codes are maintained using the table maintenance function and consists of two co-operating codes. The first occurrence of the priority code is 1

character in length and the second is five characters in length. They both identify the same priority level. OMS does not bind rules to the priority codes since they are user-defined. However, several list programs and reports : allow you to use the priority code to filter elements from entities where the priority code is used.

In general, when the priority code is used in a request it can be treated as the required priority. When the priority is used in a fix, it can be seen as the granted priority.

*SAME

Use this value to indicate that the priority code does not change. If a new request is added and the value *SAME is used, TD/OMS will try to find the best value for the element.

*DFT

Use this value to indicate that the default priority code is to be used for the request.

priority-code

Enter a priority code.

Note

The priority code is maintained using the table maintenance (STRTM) function.

User identification (USID)

Specify a user who is associated with this request. The possible values are:

*SAME

Use this value to indicate that the user ID does not change. If a new request is added and the value *SAME is used, TD/OMS will use the id of the current user.

*CURRENT

Use this value to indicate that the current user is used for the user ID.

user ID

Enter a valid user ID.

Address of remote user (ADDR)

Specify the distribution address of the remote user associated with this request. This field is used if you allow remote users to enter requests on their local sites. The possible values are:

*SAME

The remote address does not change. TD/OMS will use a blank value for this element if a new request is added and the value *SAME is used.

remote-address

Specify the remote address.

Identification of remote user (USRI)

Specify the remote user associated with this request. This field is used if you allow remote users to enter requests on their local sites. The possible values are:

*SAME

The user ID does not change. TD/OMS will use a blank value for this element if a new request is added and the value *SAME is used.

remote-user

Specify the remote user ID.

Telephone number (TEL)

Specify the telephone number on which the associated user can be reached to answer questions about the request. The content of this field is arbitrary and is only used by TD/OMS as a selection field. The possible values are:

*SAME

The telephone number does not change. This value is not allowed if the action is *ADD.

telephone-number

Enter a telephone number.

Requested completion date (WCDT)

Specify the date on which you wish the request to be completed. This date is used for selection purposes only. The request print facility uses this field for date calculations. The possible values are:

*SAME

The requested completion date does not change. The date is initialized with the current date if the action is *ADD.

date

Enter a valid date.

Short request description (SHRD)

Specify a short description of the request. The short request description appears in the "Work with Requests" display and is used to identify the request. The possible values are:

*SAME

The description does not change. This value is not allowed if the action is *ADD.

description

Enter a description.

Free user text (FREE)

The free user text contains user defined information. The free user text is not used by TD/OMS.

Note

OMS does not use this element and the existence of the field may vary from release to release. Do not store vital information here.

Application of fix (FAPL)

The fix involved must be specified when connecting to- or disconnecting from a request. The unique fix identification consists of the application code and the fix number. This is the application code. The possible values are:

*APPL

Specifies that the application code of the request is to be used.

application-code

Specify an application code.

Fix number (FIX)

The fix involved must be specified when connecting to- or disconnecting from a request. The unique fix identification consists of the application code and the fix number. This is the fix number. The possible values are:

Fix number

Specify a fix number.

*ALL

Use this value to disconnect all fixes from the request in all applications. The application code is not used for this single value.

Target application (TAPL)

Used for copying a request to another application.

Target request (TREQ)

Specify the request number used as a target for copy operations. The possible values are:

request-number

Specify a target request number.

*GEN

Use this value to generate a new request number in the indicated application while the copy action is performed. The new number is calculated using the application definitions.

Ratification Group (RAGC)

Enter the ratification group for which you want to do the ratification. You must be a member of the ratification group. Otherwise, your ratification is not accepted.

Ratification Code (RATI)

Enter the ratification code for the ratification group. You must be a member of the ratification group. Otherwise, your ratification is not accepted. The possible values are:

*YES

Specifies that you ratify the request, thus releasing the objects (connected to fixes with relationships to this request) for the next environment. If the objects are really allowed to go to the next environment depends on the ratifications of other ratification groups (if any).

*NO

Specifies that you do not ratify the request. The objects connected to fixes with relationships to this request are not allowed to enter the next environment. The objects can only go to a previous environment.

Close API indicator (EOPI)

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 open the necessary files and programs again.

*NO

The state of the API was left when the requested action was completed. Files remain open and status updates are postponed. Subsequent calls to the API are considerably faster and storage is not freed.

Note

Keep in mind that the last action of a series should close the API in order to close spooled files and perform status calculations.

Send message indicator (MSGI)

Specify if the assigned programmer should receive a message when the fix is added to the database. The possible values are:

*YES

After the fix has successfully been added to the database, TD/OMS tries to send a message to the assigned programmer stating the short fix description and other informative text.

*NO

No message is sent to the assigned programmer.

Retrieve Request Description (OMQRTVRE) - Help

Retrieve Request Description (OMQRTVRE)

The Retrieve Request Description API command allows you to retrieve the description of a request. This command must be activated in a program.

Application (APPL)

Specify the application of the request from which the description has to be retrieved.

application-code

Enter a valid application code.

Request (REQ)

Specify the request from which the description has to be retrieved.

request-number

Enter a valid request number.

CL var for REQT

Specify the name of a variable used to retrieve the code of the request type. This should be a 1-character variable in CL programs.

See the description of the request type for more information.

CL var for REQS

Specify the name of a variable used to retrieve the status of the request. This should be a 5-character variable in CL programs.

See the description of the request status for more information.

CL var for REAC

Specify the name of a variable used to retrieve the reason code of the request. This should be a 1-character variable in CL programs.

See the description of the reason code for more information.

CL var for PRIN

Specify the name of a variable used to retrieve the short priority of the request. This should be a 1-character variable in CL programs.

See the description of the priority for more information.

CL var for USID

Specify the name of a variable used to retrieve the identification of the user who created the request. This should be a 10-character variable in CL programs.

See the description of the created-by user for more information.

CL var for ADDR

Specify the name of a variable used to retrieve the identification of the address on which this request was created. Use this value in combination with the remote user (USRI) value to get a fully qualified created-by-remote-user identification. This should be an 8-character variable in CL programs.

See the description of the address for more information.

CL var for USRI

Specify the name of a variable used to retrieve the identification of the remote user that created the request. Use this value in combination with the address (ADDR) value to get a fully qualified created-by-remote-user identification. This should be an 8-character variable in CL programs.

See the description of the created-by-remote-user for more information.

CL var for TEL

Specify the name of a variable used to retrieve the telephone number element of the request. This should be a 15-character variable in CL programs.

See the description of the telephone number for more information.

CL var for WCDT

Specify the name of the requested completion date of the request. The date is in the CYYMMDD format. This should be a 7-position decimal variable in CL programs.

See the description of the requested completion date for more information.

CL var for RCDT

Specify the name of a variable used to retrieve the realized completion date of the request. The date is in the CYYMMDD format. This should be a 7-position decimal variable in CL programs.

See the description of the realized completion date for more information.

CL var for INDT

Specify the name of a variable used to retrieve the income date of the request. The date is in the CYYMMDD format. This should be a 7-position decimal variable in CL programs.

See the description of the income date for more information.

CL var for INTM

Specify the name of a variable used to retrieve the income time of the request. The time is in HHMMSS format. This should be a 6-position decimal variable in CL programs.

See the description of the income time for more information.

CL var for SHRD

Specify the name of a variable used to retrieve the short request description. This should be a 50-character variable in CL programs.

See the description of the short request description for more information.

CL var for NORG

Specify the name of a variable used to retrieve the number of ratification groups which must ratify the fix. This is a decimal variable of three positions with zero decimal positions.

See the description of the number of ratifiers for more information.

CL var for CRAC

Specify the name of a variable used to retrieve the current ratification count for this fix. This is a decimal variable of three positions with zero decimal positions.

See the description of the ratification count for more information.

CL var for REJI

Specify the name of a variable used to retrieve the reject indicator. This is a character variable of one position.

See the description of the reject indicator for more information.

CL var for FREE

Specify the name of a variable used to retrieve the free user text. This should be a 32-character variable in CL programs.

See the description of the free text for more information.

Retrieve Request Fix Relationship (OMQRTVRF) - Help

Retrieve Request Fix Relationship (OMQRTVRF)

The Retrieve Request Fix Relation API command allows you to retrieve the fix numbers which are related to a request. This command must be activated in a program.

This command is useful if you wish to retrieve the connected fixes from a request in a user program that is interfacing with TD/OMS.

Application (APPL)

Specify the application of the request from which the related fix numbers has to be retrieved.

*APPL

Indicates the current application. An error is reported to the calling program if no application is active.

application-code

Enter a valid application code.

Request (REQ)

Specify the request number from which the fix relationships has to be retrieved. The application/request combination must be valid and fix relationships must exist for this combination. An error is reported to the calling program if no relationships can be found, or the application/request combination does not exist.

Reference Application (REFAPPL) - Help

The reference application is used in combination with the reference fix and the retrieve option. Together they control the related request number which is retrieved. See the Retrieve Option parameter for details.

Reference Fix (REFFIX) - Help

The reference fix is used in combination with the reference application and the retrieve option. Together they control the related request number which is retrieved. See the Retrieve Option parameter for details.

Retrieve Option (RTVOPT) - Help

The retrieve option is used in combination with the reference application and the reference fix. Together they control the related fix number which is retrieved.

*REF

Returns the application and the fix of the reference application and reference fix. An error is returned if the reference application and reference fix specified are not related to the request.

*NEXT

Returns the application and the fix which comes after the reference application and the reference fix. An error is returned if the reference application and the reference fix do not exist or if no more related fixes can be

found.

Note

The related fixes are returned in ascending application sequence, and descending fix number sequence.

CL var for RELAPPL (RELAPPL) - Help

Specify the name of the control language (CL) character variable, if any, which contains the application key identifying the application of the related fix. The variable must be a character variable having a length of 5 characters.

CL var for RELFIX (RELFIX) - Help

Specify the name of the control language (CL) character variable, if any, which contains the fix related to the specified request. The variable must be a character variable having a length of 10 characters.

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.

Print Fix (OMQPRTFI) - Help

Print Fix (OMQPRTFI)

The Print Fix command enables you to obtain a printed report of the fix database. You can select fix numbers on numerous selections, making this an extremely powerful command.

The reports also provide some basic time calculations.

Action code (ACTC)

Specify the action code to be used. The possible values are:

*PRINT

Start printing the fix database using these command specifications.

*CLOSE

Use this action code to close the fix database and to perform the last record processing. This option enables you to keep the interface to the object database open until you explicitly close it. This will make the interface

faster.

Application (APPL)

Specify the application code to be used. The possible values are:

*ALL

Do not use the application code as a selection field. All values are valid.

application-code

Specify the application code.

Fix Number (FIX)

Specify the fix number to be used. The possible values are:

*ALL

Do not use the fix number as a selection field. All values are valid.

fix-number

Specify the fix number.

Fix status (FIXS)

Specify the fix status to be used. The possible values are:

*ALL

Do not use the fix status as a selection field. All values are valid.

*OPEN

Select only fixes currently being worked on.

*COMPLETE

Select only completed fixes.

application-code

Specify the application code.

Ratification status (RATS)

Specify the ratification status to be used. The possible values are:

*ALL

Do not use the ratification status as a selection field. All values are valid.

*OPEN

Select only fixes which have ratifications pending. This will show all fixes which still have to be ratified.

*COMPLETE

Select only fixes which are ratified by members of all connected ratification groups.

*REJECTED

Select only fixes of which one of the members of the ratification group rejected the fix.

Fix type (FIXT)

Specify the fix type to be used. The possible values are:

*ALL

Do not use the fix type as a selection field. All values are valid.

fix-type

Specify the fix type.

Release (RLS)

Specify the release to be used. The possible values are:

*ALL

Do not use the release as a selection field. All values are valid.

release-number

Specify the release number.

Development exit count from (DEFR)

Specify the development exit count lower limits to be used. The possible values are:

*ALL

Do not use the development exit count lower limits as a selection field. All values are valid.

number

Specify the lower limits of the development exit count.

Development exit count until (DETO)

Specify the upper limits of the development exit count to be used. The possible values are:

*ALL

Do not use the upper limits of the development exit count as a selection field. All values are valid.

number

Specify the upper limits of the development exit count.

Reason code (REAC)

Specify the reason code to be used. The possible values are:

*ALL

Do not use the reason code as a selection field. All values are valid.

release-number

Specify the reason code.

Priority (PRIN)

Specify the priority code to be used. The possible values are:

*ALL

Do not use the priority code as a selection field. All values are valid.

priority

Specify the priority code.

Programmer (PGMR)

Specify the programmer to be used. The possible values are:

*ALL

Do not use the programmer as a selection field. All values are valid.

programmer-id

Specify the programmer id.

Expected vs realized start date (SDCO)

Specify the relationships between the expected and the realized start date. The possible values are:

*ALL

Do not use the relationship between the expected and realized dates as a selection field. All values are valid.

*LT

Specify that all fixes are selected which were realized in the expected time frame.

*GT

Specify that all fixes are selected which were not realized in the expected time frame (overdue).

Expected start date from (ESFR)

Specify the expected start date lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the expected start date as a selection field. All values are valid.

date

Specify the expected start dates lower limits.

Expected start date until (ESTO)

Specify the expected start date upper limits to be used. The possible values are:

*ALL

Do not use the upper limits of the expected start date as a selection field. All values are valid.

date

Specify the expected start dates upper limits.

Realized start date from (RSFR)

Specify the realized start date lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the realized start date as a selection field. All values are valid.

date

Specify the realized start dates lower limits.

Realized start date until (RSTO)

Specify the realized start date upper limits to be used. The possible values are:

*ALL

Do not use the upper limits of the realized start date as a selection field. All values are valid.

date

Specify the realized start dates upper limits.

Expected vs realized completion date (CDCO)

Specify the relationship between the expected and the realized completion date. The possible values are:

*ALL

Do not use the relationship between the expected and realized dates as a selection field. All values are valid.

*LT

Specify that all fixes are selected which were realized in the expected time frame.

*GT

Specify that all fixes are selected which were not realized in the expected time frame (overdue).

Expected completion date from (ECFR)

Specify the expected completion date lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the expected completion date as a selection field. All values are valid.

date

Specify the expected completion dates lower limits.

Expected completion date until (ECTO)

Specify the expected completion date upper limits to be used. The possible values are:

*ALL

Do not use the upper limits of the expected completion date as a selection field. All values are valid.

date

Specify the expected completion date upper limits.

Realized completion date from (RCFR)

Specify the realized completion date lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the realized completion date as a selection field. All values are valid.

date

Specify the realized completion dates lower limits.

Realized completion until (RCTO)

Specify the realized completion date upper limits to be used. The possible values are:

*ALL

Do not use the upper limits of the realized completion date as a selection field. All values are valid.

date

Specify the realized completion date upper limits.

Expected vs realized development date (DDCO)

Specify the relationship between the expected and the realized development end dates. The possible values are:

*ALL

Do not use the relationship between the expected and realized dates as a selection field. All values are valid.

*LT

Specify that all fixes are selected which were realized in the expected time frame.

*GT

Specify that all fixes are selected which were not realized in the expected time frame (overdue).

Expected development end date from (EDFR)

Specify the expected development end date lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the expected development end date as a selection field. All values are valid.

date

Specify the expected development end dates a lower limit.

Expected development end date until (EDTO) - Help

Specify the expected development end date upper limits to be used. The possible values are:

*ALL

Do not use the upper limits of the expected development end date as a selection field. All values are valid.

date

Specify the expected development end date lower limits.

Realized development end date from (RDFR)

Specify the realized development end date lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the realized development end date as a selection field. All values are valid.

date

Specify the realized development end date as lower limits.

Realized development end date until (RDTO)

Specify the realized development end date upper limits to be used. The possible values are:

*ALL

Do not use the lower limits of the realized development end date as a selection field. All values are valid.

date

Specify the realized development end date lower limits.

Expected vs realized number of hours (NHOU)

Specify the relationship between the expected and the realized number of hours. The possible values are:

*ALL

Do not use the relationship between the expected and realized hours as a selection field. All values are valid.

*LT

Specify that all fixes are selected which were realized in the expected time frame.

*GT

Specify that all fixes are selected which were not realized within the expected time frame (overdue).

Expected number of hours from (EPFR)

Specify the expected number of hours lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the expected number of hours as a selection field. All values are valid.

date

Specify the expected number of hours lower limits.

Expected number of hours until (EPTO)

Specify the expected number of hours upper limits to be used. The possible values are:

*ALL

Do not use the upper limits of the expected number of hours as a selection field. All values are valid.

date

Specify the expected number of hours upper limits.

Realized number of hours from (ERFR)

Specify the realized number of hours lower limits to be used. The possible values are:

*ALL

Do not use the lower limits of the realized number of hours as a selection field. All values are valid.

date

Specify the realized number of hours lower limits.

Realized number of hours until (ERTO)

Specify the realized number of hours upper limits to be used. The possible values are:

*ALL

Do not use the upper limits of the realized number of hours as a selection field. All values are valid.

date

Specify the realized number of hours upper limits.

Fix data (FDTA)

Specify what data must be printed and the format in which it must appear.

*SHORT

Prints only the basic amount of information. Use this value for rough reports.

*NONE

Prints no additional information. Some information (e.g. the fix number) will always be printed.

*DETAIL

Prints detailed information.

Request data (RDTA)

Specify the amount and kind of request data to be printed. The printed requests are the request connected to the selected fixes. The possible values are:

*SHORT

Prints only the basic amount of request information.

*NONE

Prints no request information.

*DETAIL

Prints detailed request information.

The possible ratification data values are.

*NONE

The print of ratification data is currently not implemented.

Solution data (SDTA)

Specify the amount of solution data to be printed. The printed solutions are the objects connected to the selected fixes. The possible values are:

*SHORT

Prints only the basic amount of solution information.

*NONE

Prints no solution information.

*DETAIL

Prints detailed solution information.

Specify whether the override information will have to be printed. The possible values are:

*NONE

No override information will be printed.

*SHORT

Override information will be printed for each solution, when available. The description belonging to the solution will be truncated, even when no overrides are found. Using this option, you are able to see on the report

whether a solution is merged, if applicable.

Output format (FMT)

Specify how the data must be formatted. The possible values are:

*COMPOUND

Prints the requested data in a combined form. The fix, request and solution information is printed together.

*LIST

The fix, request, and solution data is printed in separate lists.

Fix quality data (FQDA)

Specify if quality data has to be printed. The quality data is the data concerned with expected and realized dates. The possible values are:

*NONE

Do not print quality data.

*SHORT

Prints a list of the selected fixes. In this list, the differences between expected and realized dates and hours are printed.

*DETAIL

Prints a detailed list of fixes and the exact expected and realized dates.

Request quality data (RQDA)

Specify if the request dates have to be compared with the actual fix and request dates. The possible values are:

*NONE

Do not print request quality information.

*SHORT

Print a brief list of requests and compare the request dates with the actual dates.

Processing indicators (PRC)

The processing indicators enable you to steer the interface and some of its formatting. The following attributes can be specified.

Close indicator

Indicate if the interface has to be closed. The possible values are:

*YES

Files are closed and storage is freed. Subsequent requests must establish a new connection to the information.

*NO

Keep the interface to the information when the function exits. The same data paths are used which makes the interface considerably faster when subsequent requests are made.

Application per page

Specify if the function has to start printing on a new page if the application code changes. The possible values are:

*NO

Do not skip to a new page.

*YES

Skip to a new page.

Fix per page

Specify if each fix has to be printed on a separate page. The possible values are:

*NO

Do not skip to a new page when a new fix is started.

*YES

Skip to a new page when a fix is started.

Request per page

Specify if each request has to be printed on a separate page. The possible values are:

*NO

Do not print each request on a separate page.

*YES

Print each request on a separate page.

Solution per page

Specify if each solution must be printed on a separate page. The possible values are:

*NO

Do not print each solution on a separate page.

*YES

Print each solution on a separate page.

Print cover page

Specify if a cover page has to be printed with additional information. The possible values are:

*NO

Do not print the cover page.

*YES

Print the cover page.

Print end page

Specify if a closing page has to be printed with additional information. The possible values are:

*NO

Do not print the end page.

*YES

Print the end page.

Close print file

Specify if the subsequent print request has to direct their output to the same spooled file. The possible values are:

*YES

The print file is closed. Subsequent requests print to a new spooled file.

*NO

The print file is not closed. This value is valid only in combination with the "Close API indicator". Subsequent requests print their output to the same spooled file.

Change Fix Description (OMQCHGFI) - Help

Change Fix Description (OMQCHGFI)

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

The command enables you to perform all allowed actions on a fix. You can use this command to create an interface with another system or to create an alternative fix maintenance program.

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 the last record processing. This option enables you to keep the interface to the fix database open until you explicitly close it. This will make the interface faster.

*COMPLETE

Use this action code to complete a fix which has not yet been processed. This action cannot be used if objects are connected to the fix or if the fix has a status other then *NEW.

You can use this option to complete obsolete fixes.

*CONNECT

Use this action code to connect a fix to a request. The fix/request relationship enables you to group fixes under one logical request. A fix can be connected to more that one request in more than one application.

*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.

*DISCONNECT

Use this action code to disconnect a fix from a request.

*RATIFY

Use this action code to ratify the fix (or not). This action code is used in combination with the ratification group and the ratification code. Together they determine whether or not the connected objects are able to go to the : next environment. Consult the Ratification Group Maintenance function for more information.

*STATUS

Use this action code to determine the status of a fix. The fix status is determined when the object transfer function is ended in a controlled manner so normally this action will not be used. However, when the status of the

fix is not updated correctly, you can use this action code to determine the status.

*LOCK

Use this action code to lock the fix. When a fix is locked, it cannot be processed until the lock is removed.

*UNLOCK

Use this action code to unlock the fix if it is currently locked. However, the fix cannot be unlocked if all solutions associated with the fix are also locked.

Application code fix (APPL)

Specify the application code of the fix.

Fix number (FIX)

Specify the fix number. The following values are allowed:

fix-number

Specify an unique identification of the fix.

*GEN

Use this value to have the fix number generated by TD/OMS as defined in the application definition.

Fix type (FIXT)

Fix type

The Fix type indicates the type of Fix. These types are user defined and can be maintained in the Table Maintenance function. One of the available types can serve as the default type. The special value *DFT indicates that the default type will be used.

*SAME

Use this value to indicate that the fix type does not change. TD/OMS will try to find the best value for the element if a new fix is added and the value *SAME is used.

*DFT

Use this value to indicate that the default fix type must be used. The default fix type is a user defined value.

fix-type

Enter a fix type.

Release number (RLS)

The release number is a user-defined field. Initially, the release number is filled with the current release number from the application definition. The possible values are:

*SAME

Use this value to indicate that the release number does not change. TD/OMS will try to find the best value for the element if a new fix is added and the value *SAME is used.

*CURRENT

Use this value to indicate that the release of the fix is the current release from the application definition.

character-value

Enter a release code.

Transfer Path (PTH)

Enter the transfer path that you want to use for the task. The transfer path must exist.

*SAME

The path is not changed. If the task is added, the value *DFT will be assumed.

*DFT

Takes the default transfer path from the application definition.

path code

Specify an existing path code. Path codes can be maintained in the Environment Maintenance function. See the description of the Transfer Path for more information.

Reason code (REAC)

The reason code is used in combination with the action code *COMPLETE. It indicates the reason why the fix was completed. The possible values are:

*SAME

Use this value to indicate that the reason code does not change. TD/OMS will try to find the best value for the element if a fix is completed and the value *SAME is used.

*DFT

Use this value to indicate that the default reason code is to be used to complete the fix. The default reason code is user-defined.

reason-code

Enter a reason code.

Note

The reason code is maintained using the table maintenance(STRTM) function.

Priority code (PRIC)

Priority code

The priority code identifies the priority of a request or a fix. Priority codes are maintained using the table maintenance function and consists of two co-operating codes. The first occurrence of the priority code is 1 character in length and the second is five characters in length. They both identify the same priority level.

OMS does not bind rules to the priority codes since they are user-defined. However, several list programs and reports allow you to use the priority code to filter elements from entities where the priority code is used.

In general, when the priority code is used in a request it can be treated as the required priority. When the priority is used in a fix, it can be seen as the granted priority.

*SAME

Use this value to indicate that the priority code does not change. TD/OMS will try to find the best value for the element if a new fix is added and the value *SAME is used.

*DFT

Use this value to indicate that the default priority code is to be used for the fix.

priority-code

Enter a priority code.

Note

The priority code is maintained using the table maintenance (STRTM) function.

Programmer (PGMR)

Programmer

The programmer element is used in the fix entity and contains the user who is responsible for the fix. The programmer field can contain the special value *PGMR to indicate that no user has been assigned to the fix yet. If no user is assigned as the programmer and the fix is processed for the first time, the user who processes the fix is assigned as the programmer.

Users with application authority '1' or '2' can only change the attributes of a fix if they are assigned to it. In other words, no user without application authority '3' can change a fix assigned to another user with exception of the Request Processor.

*SAME

Use this value to indicate that the programmer code does not change. If a fix is added the current user ID is used.

*CURRENT

Take the current user as the programmer for the fix.

*PGMR

The fix is assigned to an unnamed programmer. The programmer that does the first transfer of this fix will be automatically assigned as the programmer of this fix.

programmer-name

Enter the programmer's user ID.

Expected start date (ESDT)

Expected start date

The 'Expected start date' contains a valid date indicating the expected date on which the fix will be transferred to a development environment for the first time. This element will be initialized with the date on which the fix : was added.

• SAME

Use this value to indicate that this date does not change. TD/OMS uses the current date if a new fix is added and the value *SAME is used.

*CURRENT

Specifies the current date.

*NONE

No date is used.

date

Enter the required date.

Expected development end date (EDDT)

Expected development-end date

The expected development end date contains the date on which you expect the fix to leave the development environment. This field is initially filled with the date on which the fix was added.

*SAME

Use this value to indicate that this date does not change. TD/OMS uses the current date if a new fix is added and the value *SAME is used.

*CURRENT

Specifies the current date.

*NONE

No date is used.

date

Enter the required date.

Expected completion date (ECDT)

Expected completion date

The expected completion date contains the date on which you expect the fix to be completed. This field is initially filled with the date on which the fix was added.

*SAME

Use this value to indicate that this date does not change. TD/OMS uses the current date if a new fix is added and the value *SAME is used.

*CURRENT

Specifies the current date.

*NONE

No date is used.

date

Enter the required date.

Expected number of hours (EHR)

Expected number of hours

The 'expected number of hours' contains the expected number of hours the programmer will be working on this fix. A zero value is allowed.

*SAME

Use this value to indicate that the number of hours does not change. The value zero is used if a new fix is added and the value *SAME is used.

number

Specify the number of hours.

Realized number of hours (RHR)

Realized number of hours

The 'realized number of hours' contains the realized number of hours the programmer has been working on this fix. A zero value is allowed.

*SAME

Use this value to indicate that the number of hours does not change. The value zero is used if a new fix is added and the value *SAME is used.

*NONE

Use this value to indicate that the number of hours is not to be filled.

number

Specify the realized number of hours.

Short fix description (SHFD)

Short fix description

The short fix description contains a short description of the fix. A blank value is not allowed.

*SAME

Use this value to indicate that the description does not change.

description

Enter a fix description.

Free user text (FREE)

The free user text contains user-defined information. The free user text is not used by TD/OMS.

Note

OMS does not use this element and the existence of the field may vary from release to release. Do not store vital information here.

Ratification Group (RAGC)

Enter the ratification group for which you want to do the ratification. You must be a member of the ratification group. Otherwise, your ratification is not accepted.

Ratification Code (RATI)

Enter the ratification code for the ratification group. You must be a member of the ratification group. Otherwise, your ratification is not accepted. The possible values are:

*YES

Specifies that you ratify the fix, thus releasing the objects for the next environment. If the objects are really allowed to go to the next environment depends on the ratifications of other ratification groups (if any).

*NO

Specifies that you do not ratify the fix. The objects connected to this fix are not allowed to enter the next environment. The objects can only go to a previous environment.

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.

Application of request (RAPL)

The request involved must be specified when connecting to- or disconnecting from a request. The unique request identification consists of the application code and the request number. This is the application code. The possible values are:

*APPL

Specifies that the application code of the fix is to be used.

application-code

Specify an application code.

Request number (REQ)

The request involved must be specified when connecting to- or disconnecting from a request. The unique request identification consists of the application code and the request number. This is the request number. The possible values are:

request number

Specify a request number.

*ALL

Use this value to disconnect the fix from all requests it is connected to in all applications. The application code is not used for this single value.

Target application (TAPL)

Used for copying a fix to another application.

Target fix (TFIX)

Specify the fix number used as a target for copy operations. The possible values are:

fix number

Specify a target fix number.

*GEN

Use this value to generate a new fix number in the indicated application while the copy action is performed. The new fix number is calculated using the application definitions.

Close API indicator (EOPI)

Specify if the API should 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 open the necessary files and programs again.

*NO

The state of the API was left when the requested action was completed. Files remain open and status updates are postponed. Subsequent calls to the API are considerably faster and storage is not freed.

Note

Note that the last action of a series should close the API in order to close spooled files and do status calculations.

Send message indicator (MSGI)

Specify if the assigned programmer should receive a message when the fix is added to the database. The possible values are:

*YES

OMS tries to send a message to the assigned programmer stating the short fix description and other informative text after the fix is successfully added to the database.

*NO

No message is sent to the assigned programmer.

Count hours (CHNI)

Specify how the entered hours should be handled. This keyword allows you to perform minimal calculations on the realized and expected number of hours. The possible values are:

*CHANGE

The realized and the expected number of hours are (if specified) changed to the indicated value.

*ADD

he values in the expected and indicated number of hours are added to the current database values.

*SUBTRACT

The values in the expected and indicated number of hours are subtracted from the current database values.

Retrieve Fix Description (OMQRTVFI) - Help

Retrieve Fix Description (OMQRTVFI)

The Retrieve Fix Description API command allows you to retrieve the description of fix. This command must be activated in a program.

Application (APPL)

Specify the application of the fix from which the description has to be retrieved.

application-code

Enter a valid application code.

Fix (FIX)

Specify the fix from which the description has to be retrieved.

fix-number

Enter a valid fix number.

CL var for FIXT

Specify the name of a variable used to retrieve the code of the fix type. This should be a 1-character variable in CL programs.

See the description of the fix type for more information.

CL var for RLS

Specify the name of a variable used to retrieve the release number used in the fix. This should be a 10-character variable in CL programs.

See the description of the release number for more information.

CL var for DEX

Specify the name of a variable used to retrieve the development exit count for the indicated fix. This should be a 3-position decimal variable in CL programs.

See the description of the development exit count for more information.

CL var for REAC

Specify the name of a variable used to retrieve the reason code of the fix. This should be a 1-character variable in CL programs.

See the description of the reason code for more information.

CL var for FIXS

Specify the name of a variable used to retrieve the status of the fix. This should be a 5-character variable in CL programs.

See the description of the fix status for more information.

CL var for PRIN

Specify the name of a variable used to retrieve the short priority of the fix. This should be a 1-character variable in CL programs.

See the description of the priority for more information.

CL var for PGMR

Specify the name of a variable used to retrieve the programmer assigned to the fix. This should be a 10-character variable in CL programs.

See the description of the programmer for more information.

CL var for ESDT

Specify the name of a variable used to retrieve the expected start date of the fix. This should be a 7-position decimal variable in CL programs.

See the description of the expected start date for more information.

CL var for RSDT

Specify the name of a variable used to retrieve the realized start date of the fix. This should be a 7-position decimal variable in CL programs.

See the description of the realized start date for more information.

CL var for ECDT

Specify the name of a variable used to retrieve the expected completion date of the fix. This should be a 7-position decimal variable in CL programs.

See the description of the expected completion date for more information.

CL var for RCDT

Specify the name of a variable used to retrieve the realized completion date of the fix. This should be a 7-position decimal variable in CL programs.

See the description of the realized completion date for more information.

CL var for EDDT

Specify the name of a variable used to retrieve the expected development end date of the fix. This should be a 7-position decimal variable in CL programs.

See the description of the expected development end date for more information.

CL var for RDDT

Specify the name of a variable used to retrieve the realized development end date of the fix. This should be a 7-position decimal variable in CL programs.

See the description of the realized development end date for more information.

CL var for EPH

Specify the name of a variable used to retrieve the expected number of hours for the fix. This should be a 5-position decimal variable in CL programs.

See the description of the expected number of hours for more information.

CL var for ERH

Specify the name of a variable used to retrieve the realized number of hours for the fix. This should be a 5-position decimal variable in CL programs.

See the description of the realized number of hours for more information.

CL var for SHFD

Specify the name of a variable used to retrieve the short fix description. This should be a 50-character variable in CL programs.

See the description of the short fix description for more information.

CL var for NORG

Specify the name of a variable used to retrieve the number of ratification groups which must ratify the fix. This is a decimal variable of three positions with zero decimal positions.

See the description of the number of ratifiers for more information.

CL var for CRAC

Specify the name of a variable used to retrieve the current ratification count for this fix. This is a decimal variable of three positions with zero decimal positions.

See the description of the ratification count for more information.

CL var for REJI

Specify the name of a variable used to retrieve the reject indicator. This is a character variable of one position.

See the description of the reject indicator for more information.

CL var for FREE

Specify the name of a variable used to retrieve the free user text.

This should be a 32-character variable in CL programs.

See the description of the free text for more information.

CL var for PATH

Specify the name of a variable used to retrieve the Transfer Path.

This should be a 10-character variable in CL programs.

See the description of the Transfer Path for more information.

Retrieve Fix Request Relationship (OMQRTVFR) - Help

Retrieve Fix Request Relationship (OMQRTVFR)

The Retrieve Fix Request Relation API command allows you to retrieve the request number which is related to a fix. This command must be activated in a program.

This command is useful if you wish to retrieve the connected request in a program which is interfacing with TD/OMS.

Application (APPL)

Specify the application of the fix from which the related request numbers have to be retrieved.

*APPL

Indicates the current application. An error is returned to the calling program if no application is active.

application-code

Enter a valid application code.

Fix (FIX)

Specify the fix number from which the request relationships have to be retrieved. The application/fix combination must be valid and request relationships must exist for this combination. An error is returned to the calling program if no relationship can be found, or the application/fix combination does not exist.

Reference Application (REFAPPL) - Help

The reference application is used in combination with the reference request and the retrieve option. Together they control the related request number which is retrieved. See the Retrieve Option parameter for details.

Reference Request (REFREQ) - Help

The reference request is used in combination with the reference application and the retrieve option. Together they control the related request number which is retrieved. See the Retrieve Option parameter for details.

Retrieve Option (RTVOPT) - Help

The retrieve option is used in combination with the reference application and the reference request. Together they control the related request number which is retrieved.

*REF

Both application and the request of the reference application and the reference request are returned. An error is returned to the calling program if the reference application and reference request specified are not related to : the fix.

*NEXT

Both the application and the request of the request which comes after the reference application and the reference request are returned. An error is returned to the calling program if the reference application and the reference : request do not exist or if no more related requests can be found.

Note

The related requests are returned in ascending application sequence and descending request number sequence.

CL var for RELAPPL (RELAPPL) - Help

Specify the name of the control language (CL) character variable, if any, which contains the application key identifying the application of the related request. The variable must be a character variable having a length of 5 characters.

CL var for RELREQ (RELREQ) - Help

Specify the name of the control language (CL) character variable, if any, which contains the request related to the specified fix. The variable must be a character variable having a length of 10 characters.

Branch API (BRANCH) - Help

Branch API (BRANCH)

This Application Program Interface command enables you to create, change, and delete branches. It also enables you to calculate the status of a branch and you can set the branch library to the beginning of the library list with the help of this API.

A branch in TD/OMS is an isolated work area where a task can be worked on in isolation. All work done here will not interfere with any other work currently underway. Every developer works in a branch for the task at hand and then later merges the changes back into the master branch if needed.

Action code (ACTC)

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

*ADD

Use this action code to add a new branch to the TD/OMS database After a branch is created with this API it needs to be assigned to a task by filling in the Transfer Path field of the task.

*CHANGE

Use this action code to change one or more branch attributes.

*DELETE

Use this action code to remove a branch from the database. After a branch is deleted with this API it needs to be removed from the task by clearing or changing the Transfer Path field.

*STATUS

Use this action code to calculate and update the status of a branch.

*SETLIBL

Use this action code to set the branch library to the beginning of the library list.

Application code fix (APPL)

Specify the application code of the branch.

Branch Code (PTHC)

Specify the branch code.

*SELECT

In *SETLIBL mode, use this value to display a pop-up to choose the task and the associated branch code will be automatically selected.

Character value

Specify the name of the branch code.

Environment code

Specify the environment from which the libraries are being set.

Fix Code (FIX)

Specify the fix code name to which the transfer path is connected.

*NONE

No fix code is involved.

*BRANCH

The branch code would be set the name of the fix code.

fix-code

Specify the name of the fix code.

Description (TEXT)

The description contains a short description of the branch. A blank value is not allowed.

*SAME

Use this value to indicate that the description does not change.

description

Enter a branch description.

Force (FORCE)

In delete mode, If the branch is not empty (i.e. libraries and directories contain objects) or the associated tasks are not yet complete then the branch can not be deleted unless the force parameter is set to *YES.

In add mode, if the task is already connected to another branch then you cannot continue unless the force parameter is set to *YES.

It is important that the environment branches ONLY contain temporary branch definitions and no official libraries because they will be deleted if this command is executed in FORCE mode.

*NO

The branch may only be deleted if all associated tasks are complete and the branch libraries and directories are empty. In add mode, the branch can only be assigned to the task when the task is not already assigned to another branch.

*YES

The branch may be deleted even if the associated tasks are not completed. Associated libraries and directories are removed regardless of their content. In add mode, the branch will forcefully be assigned to the task, even if the task is already assigned to another branch.

<translate>

Registry Settings

The TD/OMS system registry is a place where additional configuration values are stored that are not part of the normal database. You can use this registry to set the values of our predefined registry settings to enforce certain TD/OMS behavior that cannot be specified elsewhere.

API has been created to change and retrieve TD/OMS system registry settings. This Application Program Interface command allows you to manipulate the TD/OMS database. This can be done from a command line or from within your programs.

The command enables you to perform all allowed actions on a registry key. You can use these command to nudge some TD/OMS behavior or you can use the registry to store your own values.

By convention, all TD/OMS system registry values start with OMQ.

Storing a Registry Setting

A registry setting can be stored by using the following command:

OMQCHGSR

• Action code (ACTC)

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

  *ADD

  Use this action code to add a new registry key to the OMS database.

  *CHANGE

  Use this action code to change the value of a registry key.

  *CLOSE

  Use this action code to close the registry database and to close the program. This option enables you to keep the interface to the registry database open until you explicitly close it. This will make the interface faster.

  *DELETE

  Use this action code to remove a registry key from the database.

• Application (APPL)

  Specify the application code of the application to which the registry key must be added or from which a registry key has to be removed.

• Environment (ENVC)

  Specify the environment code for which this registry key is valid.

• Route code (ROTC)

  Specify the route code for which this registry key is valid.

• Program name (PGMN)

  Specify the program name for which this registry key is valid.

• Keyword (KEYW)

  Specify the registry keyword.

• Keyword value (KEYV)

  Specify the registry keyword value.

• Close API indicator (EOPI)

  Specify if the API should 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 open the necessary files and programs again.

  *NO

  The state of the API was left when the requested action was completed. Files remain open and status updates are postponed. Subsequent calls to the API are considerably faster and storage is not freed.
  

  Note:  Note that the last action of a series should close     
  the API in order to close spooled files and do status         
  calculations.

</translate>

<translate>

Registry Settings

The TD/OMS system registry is a place where additional configuration values are stored that are not part of the normal database. You can use this registry to set the values of our predefined registry settings to enforce certain TD/OMS behavior that cannot be specified elsewhere.

API has been created to change and retrieve TD/OMS system registry settings. This Application Program Interface command allows you to manipulate the TD/OMS database. This can be done from a command line or from within your programs.

The command enables you to perform all allowed actions on a registry key. You can use these command to nudge some TD/OMS behavior or you can use the registry to store your own values.

By convention, all TD/OMS system registry values start with OMQ.

Storing a Registry Definition

A registry setting can be stored by using the following command:

OMQCHGRD

• Action code (ACTC)

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

  *ADD

  Use this action code to add a new registry key to the OMS database.

  *CHANGE

  Use this action code to change the value of a registry key.

  *DELETE

  Use this action code to remove a registry key from the database.

Keyword

You can specify the registry keyword.

System Context Indicator

You can Specify the system context indicator. Possible values are 0, 1, or 2. Where 0 is not required, 1 is Required and 2 is Optional.

Application Context Indicator

You can Specify the application context indicator. Possible values are 0, 1, or 2. Where 0 is not required, 1 is Required and 2 is Optional.

Environment Context Indicator

You can Specify the environment context indicator. Possible values are 0, 1, or 2. Where 0 is not required, 1 is Required and 2 is Optional.

Route Context Indicator

You can Specify the route context indicator. Possible values are 0, 1, or 2. Where 0 is not required, 1 is Required and 2 is Optional.

Program Context Indicator

You can Specify the program context indicator. Possible values are 0, 1, or 2. Where 0 is not required, 1 is Required and 2 is Optional.

Restricted Value Indicator

You can Specify the restricted value indicator. Possible values are 0 or 1.

Description

You can Specify the description of the registry keyword.

</translate>

<translate>

Retrieving a Registry Setting

A registry setting can be retrieved in a CL program by using the following command:

OMQRTVSR

• Keyword (KEYW)

  Specify the registry keyword.

• Application (APPL)

  Specify the application code of the application for which this registry key is valid.

• Environment (ENVC)

  Specify the environment code for which this registry key is valid.

• Route code (ROTC)

  Specify the route code for which this registry key is valid.

• Program name (PGMN)

  Specify the program name for which this registry key is valied.

• CL Var for KEYV (KEYV)

  Specify the 256 character CL variable that is used to store the value.

</translate>

<translate>

Registry Settings

The TD/OMS system registry is a place where additional configuration values are stored that are not part of the normal database. You can use this registry to set the values of our predefined registry settings to enforce certain TD/OMS behavior that cannot be specified elsewhere.

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

Use the Registry Definition Maintenance function (STRRDM) to work with registry definitions and registry keyword values.

This API enables you to add keyword values to a system registry key. These keywords define the valid values for a system registry key. By convention, all TD/OMS system registry values start with OMQ.

Storing a Registry Definition

Registry keyword values can be stored by using the following command:

OMQCHGRK

• Action code (ACTC)

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

  *ADD

  Use this action code to add a new registry keyword value.

  *CHANGE

  Use this action code to change the registry keyword value.

  *DELETE

  Use this action code to remove a registry keyword value from the database.

• Keyword

  You can Specify the registry keyword for which you want to add a new value.

• Keyword Value

  You can Specify the registry keyword value.

• Sequence Number

  You can Specify the Sequence number. Character values are not allowed. It is a numeric field.

• Keyword Value Description

  Specify the description of the registry keyword value.

</translate>

<translate>

Retrieving Registry Definition

The Retrieve Registry Definition API command enables you to retrieve OMS special registry definition values. This command must be activated in a program. Use the Registry Definition Maintenance function (STRRDM) to work with registry definitions.

This command is used to retrieve internal TD/OMS values:

OMQRTVRD

• Keyword (KEYW)

  Specify the keyword for which you want to retrieve the definition values.

• System Context Indicator (SYSI)

  Specify the name of a variable used to retrieve the system context of the requested keyword.

• Application Context Indicator (APPI)

  Specify the name of a variable used to retrieve the application context of the requested keyword.

• Environment Context Indicator (PDLI)

  Specify the name of a variable used to retrieve the environment context of the requested keyword.

• Route Context Indicator (ROTI)

  Specify the name of a variable used to retrieve the route context of the requested keyword.

• Program Context Indicator (PGMI)

  Specify the name of a variable used to retrieve the program context of the requested keyword.

</translate>

<translate>

User

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

The command enables you to perform all allowed actions on a user. You can use this command to create, update and delete a user. By convention, all TD/OMS values start with OMQ.

Storing a User

A user can be stored by using the following command:

OMQCHGUS

• Action code (ACTC)

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

  *ADD

  Use this action code to add a new user.

  *CHANGE

  Use this action code to change the user.

  *DELETE

  Use this action code to remove the user from the database.

  *CHGPWD

  Use this action code to change the user's password from the database.

Id

Specify an existing id. An Id cannot be specified for the *ADD. Action because an id is generated for you.

IBMi User Id

Specify the IBMi user id. A blank value is allowed. The possible values are:

*NONE

If you specify *NONE, Then the password is required for the user.

NAME

Specify the valid IBMi user id. Password is not required in this case and will be ignored.

User Id

Specify the user id. A blank value is not allowed.

Password

Specify the password for the user. Passwords can be up to 128 characters and are case-sensitive. It should be at least 6 characters.

Current Password

Specify the current password of the existing user.

New Password

Specify the new password for the user. It should not be the same as the current password.

Confirm New Password

Specify the new password for the user again.

Title

Specify the title for the user name.

First Name

Specify the first name of the user.

Last Name

Specify the last name of the user.

Email

Specify the email of the user.

Telephone Number

The telephone number is a user-defined field which can be can be used as a reference.

Description=

Specify the description of the user.

</translate>

<translate>

Retrieving User

The Retrieve User API command enables you to retrieve the OMS user. This command must be activated in a program. Use the User Maintenance function (STRUSRM) to work with the user. This command is used to retrieve internal TD/OMS values

OMQRTVUS

• Generic Id (GNID)

  Specify the id for which you want to retrieve the user definitions.

• User Id (USER)

  Specify the name of a user for which you want to retrieve the user definitions.

• CL-var for USID (USID)

  Specify the name of a variable used to retrieve the IBMi user id of the requested user.

• CL-var for UPWD (UPWD)

  Specify the name of a variable used to retrieve the user password of the requested user.

• CL-var for FNAM (FNAM)

  Specify the name of a variable used to retrieve the first name of the requested user.

• CL-var for LNAM (LNAM)

  Specify the name of a variable used to retrieve the last name of the requested user.

• CL-var for TITL (TITL)

  Specify the name of a variable used to retrieve the title of the requested user.

• CL-var for EMAC (EMAC)

  Specify the name of a variable used to retrieve the email of the requested user.

• CL-var for TEL (TEL)

  Specify the name of a variable used to retrieve the telephone number of the requested user.

</translate>

Change Application (OMQCHGAP) - Help

Change Application (OMQCHGAP)

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

The command enables you to perform all allowed actions on an application. You can use this command to add and update an application.

Action code

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

*ADD

Use this action code to add a new application.

*CHANGE

Use this action code to change the contents or certain attributes of an application.

*COPY

Use this action code to add a new application definition and, at the same time, copy one or more parts of the extended definition of an existing application.

Application code

Specify the application code. See the description of the application code for more information.

Application description

Specify the application description. See the description of the application description for more information.

*SAME

Use this value to indicate that the application description does not change if you are in change mode.

Request processor

Specify the request processor. See the description of the request processor for more information.

*SAME

Use this value to indicate that the request processor does not change if you are in change mode. If you are in add mode then the current user profile will be used.

Check source location

The Check source location indicator instructs TD/OMS how to handle source members related to an object. The possible values are:

0=No (*NO)

The value "0" (*NO) indicates that in general, the objects do not have a related source in this particular system. No errors will occur if no source can be found if a new object is registered in the TD/OMS database. Use this value for instance for applications in remote systems where no sources reside, or if you wish to register some objects from the QSYS library.

1=Yes (*YES)

The value "1" (*YES) indicates that objects do have related sources in this system. The environment definition determines the way TD/OMS searches for the right source member. Information about the source change date of the object and source is stored in TD/OMS, but a mismatch does not cause an error.

2=Check Date (*CHECKDATE)

The value "2" (*CHECKDATE) is equal to the value "1" (*YES) but a mismatch of source change date between the object and source will result in an error. This value is recommended if objects should have sources in this system.

*SAME

Use this value to indicate that the check source location does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the check source location is '*CHECKDATE'.

Release

Specify the release code. See the description of the release code for more information.

*SAME

Use this value to indicate that the current release does not change if you are in change mode. If you are in add mode it contains a blank value.

4GL name

Specify the 4GL name. See the description of the 4GL name for more information.

*SAME

Use this value to indicate that the 4-GL name does not change if you are in change mode. If you are in add mode it contains a blank value.

*AS/SET

AS/SET

*IDDOS

IDDOS

*LANSA

LANSA

*POWERH

POWERHOUSE4

*SYNON

SYNON

Transfer path

Specify the transfer path. See the description of the transfer path for more information.

*SAME

Use this value to indicate that the transfer path does not change if you are in change mode. If you are in add mode it contains a blank value.

*RELEASE

When you are using the value *RELEASE you need to be ensured that there is a transfer path defined with the same name as the release.

Last request number

The last request number is used by TD/OMS as a base for generating request numbers. TD/OMS will generate the request number if the default request number "*GEN" has been used during the addition of a Request. The generated request number is stored in this attribute. The last request number is shown and can be maintained in the Application Definition function. The following rules apply to the generation of numbers:

*BLOCK

No request can be added to the application when this value is specified.

*NONE

No number is generated. The user must enter a number before the request can be created. Use this to prevent the automatic numbering of a request.

*PGM

A program with the name OMUSRGENNR is called to generate a new number. The user is responsible. The source of this program can be found in the QUSRSRC source file.

Template

Specify a template that will be used as described below.

1. If the string ends with an alphabetic character TD/OMS will extend the string with "0000".

2. If the string ends with a numeric character TD/OMS will use all ending numeric characters as a base. Examples: (Assume increment value is 1)

+---------------------------------+
¦ Base value Generated value      ¦
+---------------------------------+
¦ R         R0001                 ¦
¦ R1        R2                    ¦
¦ R9        R10                   ¦
¦ ABCDEFGHI ABCDEF0001            ¦
¦ R00000000 R00000001             ¦
+---------------------------------+

*SAME

Use this value to indicate that the last request number does not change if you are in change mode. If you are in add mode it contains the default value of the last request number.

*DEFAULT

Use this value to write the default value of the last request number. The default value of the last request number is 'R'.

Last task number

The last task number is used by TD/OMS as a base for generating task numbers. During the addition of a task, TD/OMS will generate the task number if the default task number "*GEN" has been used. The generated task number is stored in this attribute. The last task number is shown and can be maintained in the Application Definition function. The following rules apply to the generation of numbers:

*BLOCK

No task can be added to the Application when this value is specified.

*NONE

No number is generated. The user must enter a number before the task can be created. Use this to prevent the automatic numbering of a task.

*PGM

A program with the name OMUSRGENNR is called to generate a new number. The user is responsible. The source of this program can be found in the QUSRSRC source file.

Template

Specify a template that will be used as described below.

1. If the string ends with an alphabetic character TD/OMS will extend the string with "0000".

2. If the string ends with a numeric character TD/OMS will use all ending numeric characters as a base. Examples: (Assume increment value is 1)

+---------------------------------+
¦ Base value Generated value      ¦
+---------------------------------+
¦ T         T0001                 ¦
¦ T1        T2                    ¦
¦ T9        T10                   ¦
¦ ABCDEFGHI ABCDEF0001            ¦
¦ T00000000 T00000001             ¦
+---------------------------------+

*SAME

Use this value to indicate that the last task number does not change if you are in change mode. If you are in add mode it contains the default value of the last task number.

*DEFAULT

Use this value to write the default value of the last task number. The default value of the last task number is 'T'.

Request number increment

Specify the request number increment. See the description of the request number increment for more information.

*SAME

Use this value to indicate that the request number increment does not change if you are in change mode. If you are in add mode it contains the default value of the request number

increment.

*DEFAULT

Use this value to write the default value of the request number increment. The default value of the request number increment is '01'.

Task number increment

Specify the task number increment. See the description of the task number increment for more information.

*SAME

Use this value to indicate that the task number increment does not change if you are in change mode. If you are in add mode it contains the default value of the task number increment.

*DEFAULT

Use this value to write the default value of the task number increment. The default value of the task number increment is '01'.

Data conversion scope

The data conversion scope is used to indicate where to search for a reference object if the data of a physical file has to be converted during Object Transfer. The default value is '0'. The possible values are:

0=Library (*LIB)

The data is only converted if the reference object exists in the library where the new physical file has to be created.

1=Sub-environment (*SUBENV)

The data is only converted if the reference object exists in the sub-environment where the new physical file has to be created. The libraries are searched in order of definition.

2=Environment (*ENV)

The data is only converted if the reference object exists in the Environment where the new physical file has to be created. The sub-environments are searched in order of definition.

*SAME

Use this value to indicate that the data conversion scope does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the data conversion scope is '*LIB'.

Attribute conversion type

The attribute conversion type instructs Object Transfer what to do with the object attributes of a native OS/400 object. Copying of the object attributes are only applicable for OS/400 objects with a prompt override program specified in the CHG.... command. The possible values are:

0=None (*NONE)

No additional copying of attributes is done, except for logical files, because objects are by default copied, and thus the object attributes will also be copied.

The object attributes of the logical file in the source environment are copied to the newly created logical after compilation. This is because logical files are compiled instead of duplicated.

If the object is created by an exception at user exit point 5 the exception must also copy the object attributes.

1=Adopt (*ADOPT)

The attributes are copied from a reference object with the same object code and object type in the target library, target sub-environment, or target environment depending on the attribute conversion scope. The reference object 'OMSREFOBJ' will be used as if value '2' has been used if no equally named reference object can be found.

2=OMSREFOBJ (*OMSREFOBJ)

The attributes are copied from a reference object 'OMSREFOBJ' with the same object type in the target library, the target sub-environment, or the target environment, depending on the attribute conversion scope. No further processing is done for the attributes if the object OMSREFOBJ cannot be found.

*SAME

Use this value to indicate that the attribute conversion type does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the attribute conversion type is '*NONE'.

Attribute conversion scope

The attribute conversion scope is used to indicate where to search for a reference object if the attributes of a native OS/400 object have to be changed during Object Transfer. The possible values are:

0=Library (*LIB)

The object attributes are only copied if the reference object exists in the library where the new object has to be created.

1=Sub-environment (*SUBENV)

Attributes are copied if the reference object exists in the sub-environment where the new object has to be created. The libraries are searched in order of definition.

2=Environment (*ENV)

Attributes are copied if the reference object exists in the environment where the new object has to be created. The sub-environments are searched in order of definition.

*SAME

Use this value to indicate that the attribute conversion scope does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the attribute conversion scope is '*LIB'.

Authority conversion type

The authority conversion type instructs Object Transfer what to do with the object owner and authority of an OS/400 object. Copying of the object owner and authorities is only applicable to native OS/400 objects. The default value is '0'. The possible values are:

0=None (*NONE)

No additional copying of authority is done.

1=Adopt (*ADOPT)

The owner and authorities are copied from a reference object with the same object code and object type in the target library, target sub-environment, or target environment, depending on the authority conversion scope. The reference object 'OMSREFOBJ' will be used if no equally named object can be found. This is the same as code '2'.

2=OMSREFOBJ (*OMSREFOBJ)

The authorities are copied from a reference object 'OMSREFOBJ' with the same object type in the target library, the target sub-environment, or the target environment, depending on the attribute conversion scope. If an OMSREFOBJ with the same type cannot be found then the attributes are copied from a reference object 'OMSREFOBJ' with type *DTAARA in the target library, target sub-environment, or target environment, depending on the authority conversion scope.

This data area 'OMSREFOBJ' can be created with TYPE(*CHAR) and LEN(1) and without contents. No further processing is done for ownership and authorities if data area OMSREFOBJ cannot be found.

*SAME

Use this value to indicate that the authority conversion type does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the authority conversion type is '*NONE'.

Authority conversion scope

The authority conversion scope is used to indicate where to search for a reference object if the owner and authorities of a native OS/400 object has to be changed during Object Transfer. The default value is '0'. The possible values are:

0=Library (*LIB)

The authority is copied only if the reference object exists in the library where the new object has to be created.

1=Sub-environment (*SUBENV)

The authority is copied if the reference object exists in the sub-environment where the new object has to be created. The libraries are searched in order of definition.

Note: The sub-environment mentioned here is the TD/OMS
sub-environment as defined in the environment definitions.

2=Environment (*ENV)

The authority is copied if the reference object exists in the environment where the new object has to be created. The sub-environments are searched in order of definition.

*SAME

Use this value to indicate that the authority conversion scope does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the authority conversion scope is '*LIB'.

Journal conversion type

The journal conversion type instructs Object Transfer on what to do about the journalling of an OS/400 physical file. The default value is '0'. The possible values are:

0=None (*NONE)

Physical files will not be journaled automatically.

1=Adopt (*ADOPT)

The physical file will be journaled in the same way as a reference physical file in the target library, target sub-environment, or target environment, depending on the journal

conversion scope. A reference physical file 'OMSREFOBJ' will be used if no equally named reference object can be found if value '2' has been used.

2=OMSREFOBJ (*OMSREFOBJ)

The physical file will be journaled in the same way as a reference physical file with the name 'OMSREFOBJ' in the target library, target sub-environment, or target environment,

depending on the journal conversion scope. The physical file will not be journaled automatically if no 'OMSREFOBJ' object can be found.

*SAME

Use this value to indicate that the journal conversion type does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the journal conversion type is '*NONE'.

journal conversion scope

The journal conversion scope is used to indicate where to search for a reference object if a physical file has to be checked for journalling during Object Transfer. The default value is '0'. The possible values are:

0=Library (*LIB)

Journalling of the physical file is only done if the reference to the object exists in the library where the new physical file has to be created.

1=Sub-environment (*SUBENV)

Journalling of the physical file is done if the reference to the object exists in the sub-environment where the new physical file has to be created. The libraries are searched in order of definition.

2=Environment (*ENV)

Journalling of the physical file is done if the reference to the object exists in the Environment where the new physical file has to be created. The sub-environments are searched in order of definition.

*SAME

Use this value to indicate that the journal conversion scope does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the journal conversion scope is '*LIB'.

Module code

Specify the module code. See the description of the module code for more information.

*SAME

Use this value to indicate that the module code does not change if you are in change mode. If you are in add mode it contains a blank value.

Derivation code

Specify the derivation code. See the description of the derivation code for more information.

*SAME

Use this value to indicate that the derivation code does not change if you are in change mode. If you are in add mode it contains a blank value.

Message to programmer

The message to the programmer specifies if a programmer has to be informed if a task, which has been assigned to her/him, is changed by another user. The default value is '0'. The possible values are:

0=No (*NO)

No messages will be sent to the programmer.

1=Yes (*YES)

The programmer will receive a message if another user adds a new task with his name specified as a programmer, or if another user starts Object Transfer for a task, with his or her name specified, to or from the development environment.

2=Incl. remote transfer (*INCRMTTFR)

A message will be sent in the situations as mentioned for 1=Yes and also if such a situation is met on the remote system.

*SAME

Use this value to indicate that the message to the programmer does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the message to the programmer is '*NO'.

Source archive library

Specify the source archive library. See the description of the source archive library for more information.

*SAME

Use this value to indicate that the source archive library does not change if you are in change mode. If you are in add mode it contains a blank value.

Fall back save library

Specify the fallback save library. See the description of the fall back save library for more information.

*SAME

Use this value to indicate that the fallback save library does not change if you are in change mode. If you are in add mode it contains a blank value.

Target application code

Specify the target application code. Refer to the description of the application code for a detailed description.

Security

Specify the security indicator. Use this field to indicate if the user authority definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Environments

Specify the environment indicator. Use this field to indicate if the environment definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

 Note: Copying of environments also includes the security
definitions per environment.

Sub-environments

Specify the sub-environments indicator. Use this field to indicate if the sub-environment definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

libraries

Specify the libraries indicator. Use this field to indicate if the library definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Library details

Specify the library details indicator. Use this field to indicate if the library detail definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Route

Specify the route indicator. Use this field to indicate if the route definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Distribution details

Specify the distribution details indicator. Use this field to indicate if the distribution list definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Remote location override

Specify the remote location override indicator. Use this field to indicate if the remote location override definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Exception functions

Specify the exception functions indicator. Use this field to indicate if the exception function definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Exception selections

Specify the exception selections indicator. Use this field to indicate if the exception selection definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Table

Specify the table indicator. Use this field to indicate if the table definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

File conversion data

Specify the file conversion data indicator. Use this field to indicate if the file conversion definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Connection rules

Specify the connection rules indicator. Use this field to indicate if the connection rule definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Comments

Specify the comments indicator. Use this field to indicate if the comments have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Job description

Specify the job description indicator. Use this field to indicate if the job description definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.                                                                       

Change Environment API (OMQCHGEN) - Help

Change Environment API (OMQCHGEN)

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

The command enables you to perform all allowed actions on an environment. You can use this command to add and update an application.

Action code (ACTC)

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

*ADD

Use this action code to add the environment.

*CHANGE

Use this action code to change the environment.

*DELETE

Use this action code to remove the environment.

Application code (APPC)

Specify the application code. See the description of the application code for more information.

Environment code (PDLC)

Specify the environment code. See the description of the environment code for more information.

Environment description (PDLD)

The environment description contains a description of the environment code. A blank value is not allowed.

*SAME

Use this value to indicate that the description does not change. In *ADD mode, this value is not allowed.

Environment sequence number (SEQN)

The environment sequence number is of importance for the routing of objects during Object Transfer and indicates the sequence of environments in the maintenance cycle. The following rules apply to the sequence number:

1. Number 00 is a reserved number for an emergency environment. 00 At the start of the maintenance cycle you can decide to follow the normal or the emergency routing. The emergency routing is specially useful for the rapid solution of the problems with the production functions. Begin sequencing with a number greater than zero if you do not wish to use an Page 2 emergency environment.

2. The lowest number greater then zero is the start of the normal maintenance cycle and is mostly called development.

3. The highest number represents the end of the maintenance cycle, called the production environment. The status of Requests, Fixes and Objects which are placed in this environment by OMS, is set to "*CMP" which indicates completion.

4. Other numbers represent the phases in between the lowest and the highest number and will be passed in order of sequence number.

Note: Adding a new "Highest sequence number" to the list, will Note:
not result in resetting the status of Requests, Fixes and
Objects in the previous highest environment. They will keep the
status "*CMP".

*SAME

Use this value to indicate that the sequence number does not change. In *ADD mode, this value is not allowed.

Include sub-environment (LVSC)

The include sub-environment code is the conditional controller for TD/OMS during Object transfer procedure: transporting Tasks and Solutions from one environment (From-environment) to a subsequent or previous environment (To-environment). If the TO-environment is divided into more than one sub-environment, the value of this attribute determines the way of selecting target locations in those various sub-environments of the TO-environment:

*SELECT

A selection display is shown during the start of Task processing in order to select sub-environments. One or more sub-environments can be selected.

*PATH

Only those sub-environments in the TO-environment are automatically selected, if the Transfer Path assigned to the Task, matches the Transfer Path, that is found in one or more sub-environment definitions of the TO-environment. It is allowed to define a sub-environment without Transfer Path reference as a collecting box of all remaining. All Tasks with a blank Transfer Path will be processed to that sub-environment.

*USRPRF

An automatic selection of one or more sub-environment in the TO-environment will be determined by tracing the following series of conditions:

A first match is searched for the Path definition in the library list and one of the following attributes of the job User profile: - the User profile name, - the User class, - the Group profile, - the Group profile class, - a supplemental group or - the Page 3 class of a supplemental group.

If in addition the Task contains a Path code, a valid target sub-environment resulting from the profile match, must also refer to the Path in that Task. This is an extension of the *PATH selection method. This selection method can be used to automatically select sub-environments in a development environment in case each developer has its own set of libraries. Also this method may define additional authority at the library list level just preventing generally authorised users to start transfers to specific, individual sub-environment.

*ALL

All sub-environments in the TO-environment are automatically selected.

*NONE

No sub-environments are selected for Task Processing because definitions are absent. This value is meant for environments which serve only as a status phase in the maintenance cycle. No objects are physically transferred.

*SAME

Use this value to indicate that the sub-environment does not change. In *ADD mode, this value is not allowed.

*NUMBER

You can use *NUMBER to define the number of sub-environments. When you use *NUMBER in the include sub-environment field, it contains a blank value and the number of sub-environments must contain a valid numeric value.

Per selected sub-environments, TD/OMS will determine via the object's type and attribute if it has to be created in that sub-environment.

Note: The values *SELECT, *PATH, *USRPRF, *ALL and *NONE are mutually exclusive with *NUMBER.

Number of sub-environments (LVSN)

A number of sub-environments number having value > ZERO, may replace the Include sub-environment value *SELECT in such a way that in the selection display shown during the start of Task processing, a number of library lists equal to the actual value, must be selected.

*SAME

Use this value to indicate that the number of sub-environment does not change. In *ADD mode, this value is not allowed.

Ratification type (ACCT)

The ratification type defines the method of ratification before objects are able to leave the environment. The possible values are:

0=None (*NONE)

This value indicates that no ratification has to be performed for objects passing through this environment. The objects can be moved from this environment by all authorized persons.

1=Request (*REQUEST)

Use this value to indicate that ratification is to be done at the request level. Objects which are connected to the related fixes are not able to leave the environment until the request is ratified by the required number of people.

2=Task (*TASK)

Use this value to indicate that ratification is to be done at the task level. Objects which are connected to a task are not able to leave the environment until they the task is ratified by the required number of people.

The number of ratifications required to release objects from a task or request depends on the number of ratification groups defined for the environment.

Close API indicator (EOPI)

Specify whether the API must close all files and free storage upon completion of the requested action or leave the files and programs open for subsequent requests. The possible values are:

*YES

The files and programs are closed and storage is freed by the

API upon completion of the requested action. Subsequent actions must open the needed files and programs again.

*NO

Use this if you plan to do more than one call to the label API.

The API is left open when the requested action completes. Subsequent calls to the API are considerably faster and storage is not freed.

Note:  Keep in mind that the last action of a series should
       close the API in order to close programs and files. This
       can be done by using *YES on this parameter for the last
       call, or use the *CLOSE action.

Change Sub-environment (OMQCHGSE) - Help

Change Sub-environment (OMQCHGSE)

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

The command enables you to perform all allowed actions on a sub-environment. You can use this command to add, change, copy, and delete the sub-environment definition.

Action code

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

*ADD

Use this action code to add the sub-environment definition.

*CHANGE

Use this action code to change the sub-environment definition.

*COPY

Use this action code to copy the sub-environment definition.

*DELETE

Use this action code to remove the sub-environment definition.

Application code

Specify the application code. See the description of the application code for more information.

Environment code

Specify the environment code. See the description of the environment code for more information.

Sub-environment sequence number

Specify the sub-environment sequence number. See the description of the sub-environment sequence number for more information.

*NEXT

Use this value to allocate the next sub-environment sequence number. It will increment by 10 or round off to the nearest multiple of 10 if you are in add mode. However, if you are in change, copy, or delete mode, this value is not allowed.

*NEXT1

Use this value to allocate the next sub-environment sequence number. It will increment by 1, if you are in add mode. However, if you are in change, copy, or delete mode, this value is not allowed.

Sub-environment new sequence number

Specify the sub-environment new sequence number.

*SAME

Use this value to indicate that the sub-environment sequence number does not change.

*NEXT

Use this value to modify or copy the sub-environment sequence number to a new value. It will increase by 10 or round off to the nearest multiple of 10.

*NEXT1

Use this value to modify or copy the sub-environment sequence number to a new value. It will increase by 1.

Sub-environment description

Specify the sub-environment description. See the detail of the sub-environment description for more information.

*SAME

Use this value to indicate that the sub-environment description does not change if you are in change mode.

Relation level

The relation level determines the extent of searching by TD/OMS for the related objects. TD/OMS uses the default highest value of 4 unless filled in otherwise. The possible values are:

0=Database, relations only (*LEVEL0)

TD/OMS keeps track of relations between physical files (PF) and logical files (LF) only. Other relations are not registered.

1=Relations only (*LEVEL1)

TD/OMS keeps track of relations between other object types besides the relations between PF and LF without, however, searching for a specific environment and library.

2=Database, relations, and locations in the same sub-environment (*LEVEL2)

This value is equal to value 1 (*LEVEL1) and it specifies the environment code and library name for related objects in the same sub-environment.

3=Relations in the same environment (*LEVEL3)

This value is equal to value 2 (*LEVEL2) and it specifies the environment code and library name for related objects in the same environment.

4=Relations and locations (*LEVEL4)

This value is equal to value 3 (*LEVEL3) plus it specifies the environment code and library name for related objects in the same application or related applications.

Note:  Value "4" (*LEVEL4) and "0" (*LEVEL0) are the most 
commonly used values.  

*SAME

Use this value to indicate that the relation level does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the relation level is '*LEVEL4'.

Save replaced objects

The save replaced objects indicator instructs Object Transfer if replaced OS/400 objects or details of an OS/400 object have to be saved in the fallback save library.

This element only influences the saving of objects, not an automatic restore objects after an error during object transfer.

The default value is '0'. The possible values are:

0=No (*NO)

Replaced objects are not saved.

1=On error (*ONERROR)

Replaced objects or details of a replaced object are only saved if an error occurred during an object transfer to this sub-environment.

2=Always (*ALWAYS)

Replaced objects or details of a replaced object are always saved during an object transfer to this sub-environment.

*SAME

Use this value to indicate that the save replaced objects do not change if you are in change mode. If you are in add mode it contains the default value. The default value for the save replaced object is '*NO'.

Quit and Fall Back

The Quit and Fall Back indicator instructs Object Transfer if replaced native OS/400 objects or details of an OS/400 object in this sub-environment has to be automatically restored if an error occurred during an object transfer. The default value is '0'. The possible values are:

0=No (*NO)

No automatic fallback of replaced objects is executed if an error occurs during object transfer. TD/OMS will create as many objects as possible.

1=First failure (*ONERROR)

The processing of this sub-environment will stop and fallback will be executed for all replaced objects in this sub-environment if an error occurred during a transfer in this

sub-environment.

If the error occurred in the first selected sub-environments, further processing of other selected sub-environments will end. Processing will otherwise continue with the next selected sub-environment.

2=Follow rules (*FOLLOWRULES)

The decision to stop processing and start fallback will depend on a predefined critical object if an error occurred during a transfer in this sub-environment.

Processing will continue and no fallback is executed if this critical object has been processed successfully. The processing will stop and fallback will be executed for all replaced objects if this critical object has not been created at this point in the processing.

Further processing of other selected sub-environments will end if the error occurred in the first selected sub-environment. Processing will otherwise continue with the next selected sub-environment.

A critical object can be selected from the transfer proposal in the fix processing function just before you start the actual transfer.

*SAME

Use this value to indicate that the quit and fall-back do not change if you are in change mode. If you are in add mode it contains the default value. The default value for the quit and fall-back is '*NO'.

Sub-environment type

The sub-environment type is used in conjunction with the Object Distribution module at the moment of an object transfer.

If a sub-environment is selected (manually or automatically), the sub-environment type determines if the objects will be processed only on the current machine, only on remote machines specified in the distribution list, or on both remote and current machines. The possible values are:

0=Local (*LOCAL)

The sub-environment is only valid for the current machine. No distribution to remote machines will be started, even if a distribution list is specified. This is the default value for the sub-environment type.

1=Both (*BOTH)

The sub-environment is valid for both the current machine and for remote machines, specified in the distribution list. The distribution module is activated in order to handle the distribution of objects if a type "1" (*BOTH) sub-environment has been processed during an object transfer.

2=Remote (*REMOTE)

The sub-environment is only valid for remote machines specified in the distribution list. No objects are created on the current machine. The distribution module is activated immediately to handle the distribution.

Note:  Sub-environment types "1" (*BOTH) and "2" (*REMOTE)
will only work if you have the TD/OMS modules Object Distribution  
and Object Receiving installed on the sending and receiving     
machine.                                                                                                

*SAME

Use this value to indicate that the sub-environment type does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the sub-environment type is '*LOCAL'.

Status

You can use the status option to disable this target or mark it as a branching template.

*SAME

Use this value to indicate that the status does not change if you are in change mode. If you are in add mode it contains the default value. The default value for status is '*ACTIVE'.

*ACTIVE

The sub-environment is used normally when transferring objects.

*DISABLED

The sub-environment is not used when transferring objects.

*TEMPLATE

The sub-environment is a branching template.

To application code

Specify the To application code. A blank value is not allowed.

To environment code

Specify the To environment code. A blank value is not allowed.

Copy directories

Specify the copy directories indicator. Use this field to indicate if the directories have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Copy distribution lists

Specify the copy distribution lists indicator. Use this field to indicate if the distribution list definitions have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Copy transfer paths

Specify the copy transfer paths indicator. Use this field to indicate if the transfer paths have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Copy compilation lists

Specify the copy compilation lists indicator. Use this field to indicate if the compilation lists have to be copied. The possible values are:

*NO

Select value '*NO' to exclude them.

*YES

Select value '*YES' to include these definitions.

Change Sub-Environment Library API (OMQCHGSL) - Help

Change Sub-Environment Library API (OMQCHGSL)

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

The command enables you to perform all allowed actions on a sub-environment library. You can use this command to add, update, copy, and delete the library.

Action code (ACTC)

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

*ADD

Use this action code to add the sub-environment library.

*CHANGE

Use this action code to change the sub-environment library.

*COPY

Use this action code to copy the sub-environment library.

*DELETE

Use this action code to remove the sub-environment library.

Application code (APPC)

Specify the application code. See the description of the application code for more information.

Environment code (PDLC)

Specify the environment code. See the description of the environment code for more information.

Sub-environment sequence (SEQN)

Specify the Sub-environment sequence. See the description of the sub-environment sequence for more information.

Library Sequence (LSEQN)

Specify the Library sequence. See the description of the library sequence for more information.

*NEXT

Use this value to allocate the next available sequence number for the library. This value can be used with action code *ADD only. For other action codes enter the number yourself.

Library (LIB)

The library name is an OS/400 system library or it can be defined as a logical library for describing folder and 4GL model storage information. Libraries are checked for existence if the library list type has a value of "0" or "1". Refer to the functions Folder library definition and 4GL library definition for more detailed information about logical library names.

To Library Sequence Number (TLSEQN)

Use this prompt to enter the to library sequence number. This prompt is available when the action code is *COPY or *CHANGE. By using this prompt user can change the existing sequence number to a new sequence number which is valid. Also, the user can copy a library to a new sequence number.

*NEXT

Use this value to allocate the next available sequence number for the to-library.

This value can be used with action code *copy only. *Next will allocate the next available sequence number to the library which will be created during copy operation.

Catch all library (LIBC)

A library with the catch all indicator specified indicates that the library is the default library to be used. Objects with an unspecified object type are placed in this library. The order of specifying the catch all library is of no importance.

If no catch all library is defined in a sub-environment, only objects with the specified types are created in that sub-environment.

*SAME

Use this value to indicate that the Catch all library does not change if you are in change mode. and If you are in add mode It contains the default value. The default value for the check source location is '*NO'.

*YES

It sets the value as '1' for Catch all library.

*NO

It sets the value as '0' for Catch all library.

Source library indicator (LIBS)

The Source library indicator is used to define a specific library that the library also contains sources. All source libraries are checked in the Fill Object File function, in order of appearance.

The definition of source libraries is also used during Object Transfer to decide where source members have to be stored. If an object is placed in a library which is also defined as a source library, the related source of that object is placed in that library. If an object is placed in a library that is not defined as a source library, the first source library (if any) in that library list will be used.

Refer to the Source handling concepts for more detailed information.

*SAME

Use this value to indicate that the source library does not change if you are in change mode. and If you are in add mode It contains the default value. The default value for the source library is '*NO'.

*YES

It sets the value as '1' for the source library.

*NO

It sets the value as '0' for the source library.

Keep library (KEEP)

The Keep library indicator is used for a specific library to indicate that objects are not being removed by TD/OMS if a move operation is executed during Object Transfer. This is useful for libraries containing database objects, because the data in those files should be kept for testing purposes.

Note:  A keep library will keep the objects during Object Transfer. A related source member however will always be removed after a move action. Use an exception if you also want to retain the source.  

*SAME

Use this value to indicate that the keep library does not change if you are in change mode. and If you are in add mode It contains the default value. The default value for the keep library is '*NO'.

*YES

It sets the value as '1' for keep library.

*NO

It sets the value as '0' for keep library.

Relation search library (LIBR)

The relation search library indicator is used for defining a library which is not owned by the application you are defining it for, but that is to be used for searching for a related object in other applications. A library with this indicator specified, cannot have any other indicator specified.

If, for example, some of your objects are using objects from the QSYS library, define the QSYS library with the search indicator, so it is not part of this application but TD/OMS will check the QSYS library when relations of objects are being built.

NOTE: A search library does not have to be defined in each sub-environment.  You only need to define search libraries in the production environment because TD/OMS is checking all higher environments for related objects.                                              

*SAME

Use this value to indicate that the relation search library does not change if you are in change mode. and If you are in add mode It contains the default value. The default value for the relation search library is '*NO'.

*YES

It sets the value as '1' for the relation search library.

*NO

It sets the value as '0' for the relation search library.

Create directory (CLIB)

The create library parameter is used to create the specified library. The possible values are:

*YES

The library will not be created.

*NO

If the specified library does not exist, it will be created at run time.

Library Details

The library details contain the library description and the name of the library from where OMSREFOBJ will be copied.

Library description

If default value *CALC is used, description will be prepared automatically by the system, else user can give custom description. Description can not exceed length 50.

Copy OMSREFOBJ from

Specify the name of the library from where OMSREFOBJ has to be copied. If special value *NONE is used, OMSREFOBJ will not be copied to the newly created library.

Object Type & Attributes (OBJTA)

The Object Type & Attribute contains Object Type and Attributes. See the description of the object type and object attribute for more information.

*NONE

Use this value when you don't want to pass object type and attributes.

If you pass *NONE with action code *ADD, it will not add the type and attributes to the library you are trying to create. You can leave this field blanks as well if you don't want to pass any type and attributes.

If you pass *NONE with action code *CHANGE, it will not retain the type and attributes from the library you are trying to change.

If you pass *NONE with action code *COPY, it will not copy the type and attributes from the library you are trying to copy.

Compilation LIBL (OMQCHGLL) - Help

Compilation LIBL (OMQCHGLL)

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

The command enables you to perform all allowed actions on an environment and sub-environment library list. You can use this command to add, update, copy and delete the library list.

Action code

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

*ADD

Use this action code to add the library list.

*CHANGE

Use this action code to change the library list.

*COPY

Use this action code to copy the library list.

*DELETE

Use this action code to remove the library list.

Application code

Specify the application code. See the description of the application code for more information.

environment code

Specify the environment code. See the description of the environment code for more information.

Sub-environment sequence number

Specify the sub-environment sequence number. See the description of the sub-environment sequence number for more information.

*ENV

You can use *ENV for the environment level and use a sequence number to specify the sub-environment sequence number.

When to Activate

Specifies when the setting of the library list has to be activated. The possible values are:

*ALWAYS

The compilation library list is set both at User Exit Point 5 or Action CO and at the moment of object creation. This is the recommended default.

*USEREXIT

The compilation library list is only set at User Exit Point 5 or Action CO.

*NOUSEREXIT

The compilation library list is only set at the moment of the object creation.

Target application code

Use this prompt to enter the application code in which you want to copy the library list. Refer to the description of the application code for a detailed description.

*SAME

Use this value to indicate that the target application code is similar to the application code if you are in copy mode.

Target environment code

Use this prompt to enter the environment code in which you want to copy the library list. Refer to the description of the environment code for a detailed description.

*SAME

Use this value to indicate that the target environment code is similar to the environment code if you are in copy mode.

Target sequence number

Use this prompt to enter the sequence number of the environment or sub-environment in which you want to copy the library list. Refer to the description of the sequence number for a detailed description.

Library list

The library name is an OS/400 library or it can be defined as a logical library for describing folder and 4GL model storage information. Libraries are checked for existence if the sub-environment type has a value of "0" or "1".

The following special entries may be used in the compilation library lists.

*SAME

Use this value to indicate that the library list is not changed if you are in CHANGE mode.

*LIBS

The value *LIBS will insert the object and source libraries into the library list. Only libraries that are part of the sub-environment will be used. No *SEARCH libraries will be inserted.

*ENV

This value can be used on the sub-environment level. The compilation library list will be augmented with the compilation libraries specified on the environment level. If no compilation library list is set for a sub-environment, the *ENV value will be assumed.

*JOBLIBL

This value can be used to insert the current job library list. The use of this value is not recommended because it depends on the current value of the job library list. However, in some rare circumstances, it might be useful. Use with caution.

*OMSLIB

The TD/OMS library will always be inserted automatically at the end of the compilation library list. In case you want the library on a different location you may use this value.

Change Transfer Path (OMQCHGTP) - Help

Change Transfer Path (OMQCHGTP)

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

The command enables you to perform all allowed actions on the transfer path. You can use this command to add and update the transfer path.

Action code

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

*ADD

Use this action code to add a new transfer path.

*CHANGE

Use this action code to change the transfer path details.

*DELETE

Use this action code to delete the transfer path details.

Application code

Specify the application code. See the description of the application code for more information.

Environment code

Specify the environment code. See the description of the environment code for more information.

Transfer path

Specify the transfer path. See the description of the transfer path for more information.

Transfer path description

Specify the transfer path description.

Clear task transfer path

Specify the value to perform actions on tasks transfer path values are:

*YES

Use this value to clear the tasks transfer path.

*NO

Use this value to not clear the tasks transfer path.

Route Location API (OMQCHGRT) - Help

Route Location API (OMQCHGRT)

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

The command enables you to perform all allowed actions on a Route location. You can use this command to add, update, and delete the Route.

Action code

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

*ADD

Use this action code to add the route code.

*CHANGE

Use this action code to change the route code.

*DELETE

Use this action code to remove the route code.

Application code

Specify the application code. See the description of the application code for more information.

Route code

The route code specifies the 'path' that an object follows through the environments. In every environment, a route has a directory connected to it. During Object Transfer, the object always stays in the same route. TD/OMS uses this route to search for the target-directory where the object will be located.

Route description

This is a description of the route. In most cases, the name of the route should be a good description on its own, but the description can further clarify the purpose of a route.

*SAME

Use this value to indicate that the route description does not

change if you are in change mode.

Recursive route indicator

This field indicates the recursiveness of the route. In case of the recursive route, objects in subdirectories of the directory that is linked to the route, are also loaded in the TD/OMS database.

*SAME

Use this value to indicate that the recursive route does not

change if you are in change mode. The default value for the recursive route is '*NO'.

*NO

It set the value as '0' for the recursive route.

*YES

It set the value as '1' for the recursive route.

Archive Location

The archive location is the directory in which the archived object is located. This is a path from the root of the integrated file system(IFS).

This archive location will be part of the Route definition that is maintained by the current function. This directory is used as the file location when IFS files residing in this Route and containing source code, are archived at the start of a maintenance cycle. In order to tell TD/OMS which IFS objects are source type files and to start the source archive procedure in a specific Application and/ or a specific Route, a registry entry defined by the keyword OMIFSSRCEXT must be added to the TD/OMS general registry file.

*SAME

Use this value to indicate that the archive location does not

change if you are in change mode. The default value for the archive location is blank.

Ignore warning

Specify the warning indicator. The possible values are:

*NO

Use this value if you do not want to ignore the warnings.

*YES

Use this value to ignore the warnings.

IFS Directory API (OMQCHGID) - Help

IFS Directory API (OMQCHGID)

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

The command enables you to perform all allowed actions on the directory. You can use this command to add, change and delete the directory definition.

Action code

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

*ADD

Use this action code to add the directory definition.

*CHANGE

Use this action code to change the directory definition.

*DELETE

Use this action code to remove the directory definition.

Application code

Specify the application code. See the description of the application code for more information.

Environment code

Specify the environment code. See the description of the environment code for more information.

Sub-environment sequence number

Specify the sub-environment sequence number. See the description of the sub-environment sequence number for more information.

Route code

Specify the route code. See the description of the route code for more information.

Keep directory

The Keep directory indicator is used for a specific directory to indicate that objects are not being removed by TD/OMS if a move operation is executed during Object Transfer. This is useful for directories containing data files, because the data in those files should be kept for testing purposes.

*SAME

Use this value to indicate that the keep directory indicator does not change if you are in change mode. If you are in add mode it contains the default value. The default value for the keep directory is '*NO'.

*NO

Use this value to delete the original object during transfer.

*YES

Use this value to keep the original object during transfer.

IFS Directory code

Specify the IFS Directory code. See the description of the IFS Directory code for more information.

*SAME

Use this value to indicate that the IFS Directory code does not change if you are in change mode. If you are in add mode specify the valid IFS Directory code.

Ignore warnings indicator

Specify the ignore warnings indicator. The possible values are:

*NO

Use this value if you want to show warning messages.

*YES

Use this value if you do not want to show warning messages.

Change Table - Help

Change Table (OMQCHGTB)

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

The command enables you to maintain the TD/OMS Table entries. The Table entries are used to define priority codes, tasks, request types, and so on.

Action code

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

*ADD

Use this action code to add a new table entry.

*CHANGE

Use this action code to change the table entry details.

*COPY

Use this action code to add a new table entry and at the same time copy one or more parts of the extended definition of an existing table entry.

*DELETE

Use this action code to delete the table entry. A table entry cannot be deleted if it is in use.

Application code

Specify the application code. See the description of the application code for more information.

Table code

Specify the table code. See the description for the table code for more information.

Short table key

Specify the short table code. See the description for the short table key for more information.

Long table key

Specify the long table code. See the description for the long table code for more information.

Target short

Specify the short table code. See the description for the short table key for more information.

Target long

Use this prompt to enter the long table key to be created. See the description for the long table code for more information.

Table item descripton

Specify the table item description. See the description for the table item description for more information.

*SAME

Use this value to indicate that the table item description does not change if you are in change mode or in copy mode.

Default indicator

Specify the default indicator. See the description for the default indicator for more information.

*SAME

Use this value to indicate that the default indicator does not change if you are in change mode or in copy mode.

Change User Authority API (OMQCHGUA) - Help

Change User Authority API (OMQCHGUA)

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

The command enables you to perform all allowed actions on a User authorization. you can use this command to add, update, and delete the User authorization.

Action code (ACTC)

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

*ADD

Use this action code to add the user authorization.

*CHANGE

Use this action code to change the user authorization. Action code *CHANGE is not allowed for environment security.

*DELETE

Use this action code to remove the user authorization.

Application code (KEY)

Specify the application code. See the description of the application code for more information.

Environment code (PDLC)

Specify the environment code. See the description of the environment code for more information.

User ID or User Class (USER)

The user ID or user class element contains the name of an OS/400 system user, user group or user class. The following rules apply to each entry:

User ID

Enter a valid name of an existing user profile. This is the most detailed level to assign an authorization code to and will overrule any other definition.

User group

Enter a valid name of an existing user group profile. All members of this group are implicitly selected. Specifications at the user level, however, overrules the specifications per user group.

User Class

Valid user classes are:

• *SECOFR
• *SECADM
• *PGMR
• *SYSOPR
• *USER

All users belonging to a specified class are implicitly selected. Specifications at group and user level, however, overrules the specification per class.

Authorization code (AUTC)

The OMS authorization code determines which OMS functions can be executed for a user, user class or user group. Some OMS functions also require authority at environment level. Valid authorization codes are:

0=None (*NONE)

No rights are assigned to the related users. This value is useful if authorization codes are assigned at the group or class level and one single user has to be omitted.

1=User (*USER)

Only functions at the end-user level can be executed. These users are in general able to maintain their own user requests and enquire about the related Fix information. The request processor is allowed to maintain the requests from all users if he has authorization code 1 assigned to him.

2=Programmer (*DEV)

Code two is specially meant for functions at the programmer level. They are allowed to maintain their own fixes, to connect objects to fixes, and start Fix Processing. Specific authorization depends on the rights assigned at environment level. The request processor is allowed to maintain the fixes from all programmers if he has authorization code 2 assigned to him.

3=Application manager (*ADMIN)

Users with code 3 are application managers and have rights for all functions at the application level.

Note: 1. See the description per function for a more detailed Note: explanation about rights. The assigned authorization code can be changed at any time.

*SAME

Use this value to indicate that the authorization code does not change if you are in change mode.

Change Remote Location (OMQCHGRL) - Help

Change Remote location (OMQCHGRL)

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

The command enables you to perform all allowed actions on remote locations. You can use this command to add, change, copy, and delete the remote location.

Action code

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

*ADD

Use this action code to add the remote location.

*CONNECT

Use this action code to connect the address for the application and sub-environment.

*CHANGE

Use this action code to change the remote location.

*COPY

Use this action code to copy the remote location.

*DISCONNECT

Use this action code to disconnect the address for the application and sub-environment.

*DELETE

Use this action code to remove the remote location.

Level

Specify the level to work with different types of addresses. The possible values are:

*SYS

Use this value to indicate the system-level address.

*APPC

Use this value to indicate the application-level address.

*SUBENV

Use this value to indicate the sub-environment level address.

Application code

Specify the application code. See the description of the application code for more information.

Environment code

Specify the environment code. See the description of the environment code for more information.

Target Environment code

Specify the target environment code. See the description of the target environment code for more information.

Sub-environment sequence

Specify the sub-environment sequence. See the description of the sub-environment sequence for more information.

Address

Specify the address. See the description of the address for more information.

Target Address

Use this prompt to enter the address to be created. See the description of the address for more information.

Address description

The address description contains a description of the address. It serves for documentary purposes only.

*SAME

Use this value to indicate that the address description does not change if you are in change mode or in copy mode.

System Type

The System Type is a distribution attribute and represents the type of a remote system. Current known system types are:

OS400

This is the default system type when creating a remote machine and it represents a system known as AS/400, iSeries, System i, and IBM i.

WIN

Windows-based machines.

UNIX

Unix-based machines.

 Please note that the list is undefined and can be extended         
 dynamically.
                                                      

*SAME

Use this value to indicate that the system type does not change if you are in change mode or in copy. If you are in add mode it contains the default value. The default value for the system type is *BLANKS.

Device

The device contains the name of a valid OS/400 device name for distribution purposes.

*SNADS

Use this value if the distribution must be done through the SNA distribution services protocol. Please note that SNADS can be run over TCP/IP.

*TCP

Use this value if the distribution must be done over the TCP/protocol.

device-code

Enter a valid i-Series storage device for distribution over tape or network.

*SAME

Use this value to indicate that the device does not change if you are in change mode or in copy. If you are in add mode it contains the default value. The default value for the system type is *SNADS.

Remote location

Specify the remote location. See the description of the remote location for more information.

*SAME

Use this value to indicate that the remote location does not change if you are in change mode or in copy mode. If you specify the device as OS400 then a remote location is required.

Operating system version

Specify the operating system version. See the description of the operating system version for more information.

*SAME

Use this value to indicate that the operating system version does not change if you are in change mode or in copy mode. If you are in add mode and you specify the device OS400 then the operating system version is required.

TD/OMS Library

Specify the TD/OMS Library. See the description of the td/oms library for more information.

*SAME

Use this value to indicate that the TD/OMS Library does not change mode if you are in change mode or in copy mode. If you are in add mode and you specify the device OS400 then the TD/OMS library is required.

Installation job description

The installation job description indicates the job description to be used for automated TD/OMS installations. In some cases, new releases of OMS can be installed by using the distribution facilities of OMS itself.

job-description

Enter the name of a job description. This job description must exist in a remote location.

*SAME

Use this value to indicate that the installation job description does not change if you are in change mode or in copy mode. If you are in add mode. It contains the default

value. The default value for the installation job description is OMSINSTJBD.

*NORM

Enter *NORM to use the normal job description. This job description must exist in a remote location.

*FAST

Enter *FAST to use the fast job description. This job description must exist in a remote location.

*DISABLED

Enter *DISABLED if you do NOT want to use an installation job description. You can specify a job description within 'Fix Processing' (Function 10) for the FIX being processed.

Installation job description library

Specify the Installation job description library. See the description of the installation job description for more information.

*SAME

Use this value to indicate that the installation job description library does not change if you are in change mode or in copy mode. If you are in add mode it contains default values. The default value for the installation job description library is *BLANKS.

Distribute object indicator

The Distribute object indicates the type of distribution to be activated. The possible values are:

0=No

No objects are sent to the address specified. Only a job is sent in order to start Object Transfer on the address specified. Use this value only if objects were distributed to the address in an earlier phase of the maintenance cycle.

1=Yes

The objects are sent to the address specified, followed by a job for processing these objects.

Example: You use the environments *DEV(elopement), *TEST,            
*ACC(eptance) and *PROD(uction). The acceptance is done on the      
remote system. If objects are transferred from *TEST to *ACC the    
distribution process has to be activated to send the object. If     
objects are transferred from *ACC to *PROD, the objects do not have 
to be re-sent to the remote system. They only have to be transferred
on the remote system from *ACC to *PROD. Use the following          
specification: 

Environment     From Env.    Distr. type 
*DEV                                      
*TEST                                     
*ACC            *TEST         1
*PROD           *ACC          0

*SAME

Use this value to indicate that the send-distribute objects do not change if you are in change mode.If you are in connect mode it will have default value. The default value is *NO.

Send application definitions

The Send Application Definitions indicator is used by OMS to indicate if definitions have to be sent to the remote address. The possible values are:

0=No (*NO)

No definitions are sent to the remote address. This value is used if you do not wish the local definitions to be made active on the remote location. Please keep in mind that the remote location must have valid definitions before a remote transfer can take place. You must manually enter the remote definitions if this value is used.

1=Yes (*YES)

The definitions are always sent to the remote location. Each time objects are distributed to the remote location the definitions are included and will automatically be implemented.

2=When changed (*WHENCHANGED)

The definitions are only sent to the remote location if some of the definitions have been changed. OMS keeps track of changes and determines if the definitions have to be sent.

 Note:  The sending OS/400 system cannot detect a   
 failure in the distribution. In other words; The mutation  
 flags which are used to trigger the sending of the         
 definitions are reset after the definitions have been sent 
 to the remote location. If the distribution fails, you must
 manually set these flags by using the Vary Definition 
 Distribution command. This will force the definition  
 distribution on the next transfer to this location.  

*=Default

The value '*' indicates that the default values are used from a higher definition level. Each address that is used, has default values specified via the Remote Location Maintenance function. This is the highest definition level per address. Some of the attributes can be altered at the application level by using the Remote Location Override function. This is the second definition level per address. The lowest level of definition is in the Environment Maintenance function on the Maintain Distribution List Display.

*SAME

Use this value to indicate that the send exception definitions do not change if you are in change mode or in copy mode. If you are in add mode it contains default values. The default values for send exception definitions are *NO.

Send exception definitions

The Send Exception Definitions indicator is used by OMS to detect if exceptions must have to be sent to the remote address. The possible values are:

0=No

No exception definitions are sent to the remote address. This value is used if you do not wish the local exceptions to be made active on the remote location.

1=Yes (*YES)

The exceptions are always sent to the remote location. Each time objects are distributed to the remote location the definitions are included and will automatically be implemented.

2=When changed (*WHENCHANGED)

The exceptions are only sent to the remote location if some of the definitions have been changed. OMS keeps track of changes and determines if the definitions have to be sent.

 Note:  The sending OS/400 system is not able to detect a 
 failure in the OS/400 part of the distribution. In other 
 words, after exceptions are sent to the remote location, 
 the alteration flags which are used to trigger the sending 
 of the exceptions are reset. If the distribution fails, you
 must manually set these flags by using the Vary Definition 
 Distribution command. This will force the exception        
 distribution on the next transfer to this location.

*=Default

The value '*' indicates that the default values are being used from a higher definition level. Each address that is used, has default values specified via the Remote Location Maintenance function. This is the highest definition level per address. Some of the attributes can be altered at the application level by using the Remote Location Override function. This is the second definition level per address. The lowest level of definition is in the Environment Maintenance function on the Maintain Distribution List Display.

*SAME

Use this value to indicate that the send application definitions do not change if you are in change mode or in copy mode. If you are in add mode it contains default values.The default values for send application definitions are *NO.

Distribute sources

The Distribute Sources indicates if sources must be sent to the remote address. The possible values are:

0=No (*NO)

No source members are sent to the remote address, except for logical files.

1=Yes (*YES)

All source members are sent to the remote address.

*=Default

The value '*' indicates that the default values are being used from a higher definition level. Each address being used has default values specified via the Remote Location Maintenance function. This is the highest definition level per address. Some exceptions can be defined at the application level in the Remote Location Override function. This is the second definition level per address. The lowest level of definition is in the Environment +Maintenance function on the Maintain Distribution List Display.

*SAME

Use this value to indicate that the distribute sources do not change if you are in change mode or in copy mode. If you are in add mode it contains default values. The default values for distribute sources are *NO.

Monitor Remote Job

The Monitor Remote Job indicates if remote jobs, starting from this the address is being monitored. The possible values are:

0=No (*NO)

No remote jobs are being monitored.

1=Yes (*YES)

The Remote jobs are being monitored. The status of the process will be logged at four points during the distribution and receiving process:

1. The first logging is performed once the distribution process has been completed successfully.

2. A message is sent to the originating OMS on the sending address once the receiving job starts receiving the network files.

3. The actual start of the Object Transfer at the remote address is the third monitoring point and finally.

4. The result of the processing is sent to the originator once the object transfer completes its processing the result.

All messages are sent to the OMS queue at the sending address. Use the Remote Job Monitor function to check the status and results of all your remote jobs. Note: The user OMS on both addresses must be defined in the directory entries In order to use the monitoring facilities. Please consult the Distribution Concepts for details.

*=Default

The value '*' indicates that the default values are being used from a higher definition level. Each address being used has default values specified via the Remote Location Maintenance function. This is the highest definition level per address. Some exceptions can be defined at the application level in the Remote Location Override function. This is the second definition level per address. The lowest level of definition is in the Environment Maintenance function on the Maintain Distribution List Display.

*SAME

Use this value to indicate that the monitor remote jobs does not change if you are in change mode or in copy mode. If you are in add mode it contains default values. The default values for monitoring remote job sources are *NO.

Registered Distribution dependency ind

Distribution registration is a special way of sending a distribution that is stored in the TD/OMS database, because the installation procedure on the remote server may be postponed. The sequence of starting installations from the waiting queue on the remote server is monitored. This monitor is based on a Distribution dependency analysis that is determined by all registration data of the central source server sending the distributions. Distribution Registration is activated by setting the Registered distribution dependency indicator for the general address entry.

*SAME

Use this value to indicate that the distribution registration does not change if you are in change mode or in copy mode. If you are in add mode it contains default values. The default values for the registered dependency indicator are *NO.

Ratification Group API (OMQCHGRG) - Help

Ratification Group API (OMQCHGRG)

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

The command enables you to perform all allowed actions on the ratification group. You can use this command to add, change or delete the ratification group. Additionally, you can add or remove members from the ratification group and connect or disconnect the ratification group to/from the environment specified.

Action code

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

*ADD

Use this action code to add a ratification group.

*CHANGE

Use this action code to change the ratification group definition.

*DELETE

Use this action code to delete the ratification group definition.

*CONNECT

Use this action code to connect the ratification group to the environment.

*DISCONNECT

Use this action code to disconnect the ratification group from the environment.

*ADDMEMBER

Use this action code to add the members to the ratification group.

*RMVMEMBER

Use this action code to remove the members from the ratification group.

Application code

Specify the application code. See the description of the application code for more information. The possible values are:

*SYS

Use this value if you want to add the system ratification group. System ratification group can be used across applications.

Note:  When you are in *CONNECT or *DISCONNECT mode *SYS is not allowed for application. Please specify the valid application code.

Ratification group

Specify the ratification group. See the description of the ratification group for more information.

Environment code

Specify the environment code. See the description of the environment code for more information.

Ratification group description

The ratification group description contains a description of the ratification group. A blank value is not allowed.

*SAME

Use this value to indicate that the ratification group description does not change if you are in change mode. If you are in add mode specifies the valid description.

Member

Specify the valid member. Here you can specify up to 32 members at once.

*SAME

Use this value to indicate that the members do not change if you are in change mode. If you are in add mode it contains a blank value.

Note:  When you are in *ADDMEMBER or *RMVMEMBER mode, please specify the valid members. Otherwise, it contains a blank value. A blank value is not allowed for members when you are in *ADDMEMBER or *RMVMEMBER mode.