The GetMessage command gets a copy of the first message in the Get Channel queue. Note that it does not actually delete the message, as it did in release 2.8.3. Instead, the user’s script has to manage the deletion of the message, by using either the RemoveMessage command or manage the restoration of the message, by using the RestoreMessage command. You can define the following parameters from this window.
Field |
Description |
|---|---|
Label |
Specifies the unique label of this process command. This label allows other commands to branch to this command. The label that you type here appears in the Label column on the EC Gateway Process window. |
Disable command |
Disabling the command will allow temporary modification of the process statements. This allows for testing of the statements for error-free robustness. The command that has been disabled will not show in the script file (.pfs file). |
Get Channel |
Name of the communications channel where the message will be read. Click the arrow icon and the Communications Channel window displays. Double-click on a channel to select it. This channel can have a receive (inbound) direction or can send and receive. |
Get Data |
Specifies where the message will be placed for further processing. There are two choices available when clicking on the arrow icon beside the field: Message and FileName. |
Overwrite/Append |
Specifies whether the newly read message should overwrite or be appended to the previous message in Get Data. There are two choices available: Overwrite and Append. |
Message Type |
User-defined message type found in the incoming message header. The message type will be stored in the Parameter. |
Timeout [ms] |
Period of time to wait for the message. There are two choices available when clicking on the arrow icon beside the field: Count and Constant where you can display a window so that you can enter a numeric value for the time period in milliseconds. On Timeout condition, an error is written to the log, and an error status is returned. |
