Program Exit Return Value
Program exits have a single return value, which is an XML buffer. Program exits must return an XML buffer, which has the following format:
cim1265
Program exits have a single return value, which is an XML buffer. Program exits must return an XML buffer, which has the following format:
<eTExitReturn> <eTExitReturnCategory> </eTExitReturnCategory> <eTExitReturnNative> </eTExitReturnNative> <eTExitLogMsg> </eTExitLogMsg> <eTExitContinue> </eTExitContinue> <eTExitCustom> </eTExitCustom> <eTPersistentFailure> </eTPersistentFailure> </eTExitReturn>
- eTExitReturnCategory XML
- RequirementThis value is not required.
- PurposeGroups various native return codes into one of three categories for the purpose of simplifying process flow.
- Valid ValuesSUCCESSWARNINGFAILURE
- Default ValuesIf no value is specified, SUCCESS is assumed.
- eTExitReturnNative XML
- RequirementThis value is not required.
- PurposeSpecifies the return value from the native program exit call.
- Valid ValuesThis value is a string representation of what occurred.
- Default ValuesNone.
- eTExitLogMsg XML
- RequirementThis value is not required. It is, however, highly recommended to enter a value for failure or warning responses:
- Without eTExitLogMsg value, the server will send the eTExitReturnNative code for logging.
- Without eTExitLogMsg and etExitReturnNative values, the server will make up a generic message indicating no message present and that there was an error/ warning.
- PurposeSpecifies a string value that the native program exit wants the server to log.
- Valid ValuesThis value will be a UTF-8 string.
- Default ValuesNone.
- eTExitContinue XML
- RequirementThis value is not required.
- PurposeSpecifies whether to continue the process flow after the return from the program exit. This value overrides the default behavior. See Default Values.
- Valid ValuesTRUE - Continue Execution.FALSE - Stop Execution.
- Default ValuesThe default values are based on the eTExitReturnCategory attribute.TRUE - If eTExitReturnCategory is SUCCESS or WARNING.FALSE - If eTExitReturnCategory is FAILURE.
- eTExitCustom XML
- RequirementThis value is not required.
- PurposeFor common program exits, this value is reserved for future use.For native exits, this value is connector-specific.
- Valid ValuesAny valid XML document.
- Default ValuesNone.The program exit parses this input argument to get the data it needs to perform its specific task.
- eTPersistentFailure
- RequirementThis value is not required.
- PurposeUsed only in responses from IMS Notifications, which share with program exits the same XML buffers for encoding requests and responses. A persistent failure is a notification that is rejected based on a problem in the content (likely a programming error) rather than based on some retry-able situation.
- Valid ValuesTRUE - Indicates a persistent failure.FALSE - Indicates a transient failure, one that might succeed later if retried.
- Default ValuesFALSE