MDSBMRFP - RFP Submission command
MDCMS is delivered with a command-based API similar to the Installer API. The difference with the Submitter API is that RFPs will be submitted when they have status 01 (Objects assigned to RFP) and/or status SP (Submission Pending). This API allows external processes, such as End-of-Day, to submit some or all RFPs for promotion.
The Object Checking and Compilation portion of a Promotion will be performed for the selected RFP(s). If no problems are encountered, the Auto-Approve and Auto-Install flags for the Promotion Level will be checked. If one of the flags is set to N, the process stops, otherwise the RFP will be installed. The API does not fail if no RFPs are currently waiting to be submitted.
This allows a business to embed the MDCMS Submission process into its remote systems for clean, hands free processing.
The MDCMS command is named MDSBMRFP and is located in library MDCMS*.
If the submission of an RFP is not successful, its status returns to 01 and the objects in the environment remain the same as they were prior to the submission.
All MDSBMRFP API transactions are logged to file MDCMS/MDDSRFP.
MDSBMRFP 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 RFPs *YES = RFPs with status SP are also considered *NO = only RFPs with status 01 are considered *ONLY = only RFPs with status SP 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 submit RFP if one or more Objects in the RFP are requested for the Project |
| TASK | INTEGER | 7 | Task Filter - only submit RFP if one or more Objects in the RFP are requested for the Project Task |
| STSK | INTEGER | 7 | Subtask Filter - only submit 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. *CREATOR = same user that created the RFP number *USER = same user that called the API A specific User Profile |
| CONT | CHAR | 4 | Continue Submitting RFPs if a RFP Fails *YES = any further RFPs will be submitted *NO = this API stops submitting RFPs |
| 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: MDSBMRFP 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. |