MDINSRFP - RFP Installer command
MDCMS is delivered with a command-based API that allows external processes, such as End-of-Day, to install some or all RFPs. An RFP must have status 03 (Ready for Installation) and/or status IP (Installation Pending) in order to be considered by the API. The API does not fail if no RFPs are currently waiting to be installed. This allows a business to cleanly embed the MDCMS Installation process into its nightly or weekend batch processing so that conflicts are avoided.
The MDCMS command is named MDINSRFP and is located in library MDCMS*.
If the installation of an RFP is not successful, its status returns to 03 and the objects in the environment remain the same as they were prior to the installation. This API allows the option of automatically rolling back all RFPs that were installed prior to the RFP which failed.
All MDINSRFP API transactions are logged to file MDCMS/MDDIRFP.
MDINSRFP Parameter Table
| Name | Type | Length | Description |
|---|---|---|---|
| Name | Type | Length | Description |
| APPL | CHAR | 6 | Application Code or *ALL for any application |
| FROMLVL | INTEGER | 3 | Minimum Application Level to consider |
| TOLVL | INTEGER | 3 | Maximum Application Level to consider |
| FROMRFP | INTEGER | 7 | Minimum RFP Number to consider |
| TORFP | INTEGER | 7 | Maximum RFP Number to consider |
| PEND | CHAR | 4 | Include Pending Installs *YES = RFPs with status IP are also considered *NO = only RFPs with status 03 are considered *ONLY = only RFPs with status IP are considered |
| SCHDT | CHAR | 8 | Pending until Scheduled Date *CURRENT = include RFPs with a scheduled date that is not greater than the current date Or, enter a date in YMD format to designate the maximum allowed scheduled date |
| PROJ | CHAR | 12 | Project Filter - only install RFP if one or more Objects in the RFP are requested for the Project |
| TASK | INTEGER | 7 | Task Filter - only install RFP if one or more Objects in the RFP are requested for the Project Task |
| STSK | INTEGER | 7 | Subtask Filter - only install RFP if one or more Objects in the RFP are requested for the Project Subtask |
| PIPE | CHAR | 10 | Pipeline Filter - Specifies the Pipeline Server ID of a Pipeline TraceKey request. This value is required if a value for TRCKEY is provided. If values for PIPE/TRCKEY are provided, an RFP will only be included if it contains an object request of type *PIPE with the Pipeline server ID and TraceKey in the object name. |
| TRCKEY | CHAR | 128 | Pipeline TraceKey Filter - Specifies the Pipeline TraceKey of a Pipeline TraceKey request. This value is required if a value for PIPE is provided. If values for PIPE/TRCKEY are provided, an RFP will only be included if it contains an object request of type *PIPE with the Pipeline server ID and TraceKey in the object name. |
| USER | CHAR | 10 | The User Profile ID to be displayed in Installation History. *APPROVER = same user that approved RFP for Installation *USER = same user that called the API A specific User Profile |
| CONT | CHAR | 4 | Continue Installing RFPs if an Installation Fails *YES = any further RFPs will be installed *NO = this API stops Installing RFPs |
| ROLLBACK | CHAR | 4 | Rollback any RFPs that were already installed by the API prior to the RFP that has failed. *YES = The prior RFPs will be rolled back (only valid if CONT=*NO) *NO = The prior RFPs remain installed |
| ENV | CHAR | 4 | Specifies the MDCMS environment that should be used to place the Request. The ID correlates to the suffix of the MDCMS library name. For example, TEST correlates to library MDCMSTEST. *DFT = The default environment will be used. This correlates to library MDCMS. |
| EMSG | CHAR | 7 | Specifies if and to what extent an exception message should be returned to the calling program. An exception message occurs when an input parameter value is invalid, causing the addition of the request to fail. *DIAG = A diagnostic message will be placed in the calling program's message queue in the following format: MDINSRFP Exception. Object= *ESCAPE = The full diagnostic message as described above will be placed in the calling program's message queue and then followed by escape message CPF0001 for which the calling program can monitor. *NONE = An exception message will not be returned to the calling program's message queue. |