Step program format STEP0100 - assure_mimix - 10.0

Assure MIMIX Administrator Reference

Product type
Software
Portfolio
Integrate
Product family
Assure
Product
Assure MIMIX™ Software
Version
10.0
Language
English
Product name
Assure MIMIX
Title
Assure MIMIX Administrator Reference
Copyright
2023
First publish date
1999
ft:lastEdition
2024-05-07
ft:lastPublication
2024-05-07T13:36:02.962500

You can create your own program that can be identified in and called by a procedure by using format STEP0100.

The program should identify a specific task to be performed. The step program identifies the program to MIMIX and specifies the type of node on which the program can run and the type of step program. The step program type determines the configuration level at which jobs for the procedure will process the program. When a step is added to a procedure, attributes of the step define runtime attributes within the context of the procedure, including the action to take when a job used to run the program ends in error.

Note: For steps that run at data group level, the program object will be called regardless of whether the data group state is enabled or disabled. Therefore, if you want your program logic to be performed only for data groups in a particular state, you must check the state at the beginning of the program. This is a requirement to allow steps to operate on disabled data groups, which are frequently used in environments that have three or more nodes.

Programs can be written in C, RPG, or CL. Source code templates ENDUSRAPP and STRUSRAPP in source physical file MCTEMPLSRC in the installation library can be used as templates for any step program. These templates can be used for any custom step program; however, avoid using these names for your program.

A step program is called with the following parameters.

Application Group Name

INPUT; CHAR (10)

The name that identifies the application group definition. If the step program is of type *NODE, this parameter contains all blanks.

Resource Group Name

INPUT; CHAR (10)

The name that identifies the resource group. If the resource group is not applicable or if the step program is of type *NODE, this parameter contains all blanks.

Data Group Name

INPUT; CHAR (26)

The name that identifies the data group definition (name system1 system2). If the data group is not applicable or if the step program is of type *NODE, this parameter contains all blanks.

Data Group Source

INPUT; CHAR (1)

The value that identifies the data source as configured in the data group definition. If the step program is of type *NODE, this parameter contains all blanks.

1

System1 is the source for the data group.

2

System2 is the source for the data group.

New Primary Node

INPUT; CHAR (8)

The name that identifies the node that becomes the new primary node during a switch operation. This is the system to which production is being switched. If used in a procedure of a type other than *SWTPLAN or *SWTUNPLAN, the node name is the primary node. For procedures of type *NODE, the current local node is specified.

Old Primary Node

INPUT; CHAR (8)

The name that identifies the node that is the old primary node during a switch opera­tion. This is the system from which production is being switched. For procedures of type *NODE, the current local node is specified.

Current Node

INPUT; CHAR (8)

The name that identifies the current local node. This is the node on which the step program is running.

Returned Message Identifier

OUTPUT; CHAR (7)

The value is the message identifier returned for an error message. If there is no error, the step program should return all blanks.

Returned Message Data Length

OUTPUT; DECIMAL (5, 0)

The value identifies the length of the message data being returned.

0

No message data is returned.

value 

Identifies the length of the data returned in the Returned Message Data parameter.

Returned Message Data

OUTPUT; CHAR (900)

The text returned as message data for the returned message ID.