getMessageHeader() Method Purpose This method can be used to get the message summary information for the messages in a given queue. Type Synchronous, IMPACT_INFO. Arguments Name Type Description QueueID Integer The ID of the message queue from which you want message summary information. For Oracle only: ShowExceptionMessage Boolean Set this parameter as true if you want to show exception message items. Otherwise set it as false. Returns Name Type Description MessageID String The message ID of a message in the queue. This and the other items listed are returned for each message in the queue. Instruction String The instruction type of the message (for example KEEP, RELEASE, NEWCASE). Addressee String The addressee of the message. Procedure String The name of the procedure which generated the message. StepName String The name of the step within the procedure which generated the message. CaseNumber String The case number of the case being processed. ReqID String The request ID for the message. A ReqID is needed for each work item. For SQL Server Only: Failedby String This parameter is only applicable to messages in the dead queue. It indicates the process from which the dead message was created, such as WIS or BG. For DB2 only: Failedby String This parameter is only applicable to messages in the dead queue. It is the database table where the message was located before it became dead. Errors Error Code Error Message ERR_PMAMI_PARAM If you enter an invalid QueueID, the interface returns an error similar to the following: Failed to open queue queue id:iProcess error code
