Inbound CHIPS Envelope
You only need to create an Inbound CHIPS envelope if you are receiving inbound CHIPS messages. However, if you are receiving inbound CHIPS messages, you need to create a separate Inbound CHIPS envelope for each CHIPS message type you will be receiving. The following table describes Inbound CHIPS envelope properties:
Note: An (*)
asterisk indicates that a wildcard value can be used with that parameter.
For Inbound envelopes, a wildcard value in the envelope matches any
value in the input document, while an empty value in the envelope
matches only an empty value in the input document. For Outbound envelopes,
a wildcard value is equivalent to an empty value in the envelope.
- Field or Check Box
- Description
- Send participant number*
- Four-digit participant number. Required. Note: When you are setting up an inbound CHIPS envelope for the response codes 55 and 85, the Send Participant Number must be set to * (a single asterisk character). CHIPS messages with response codes of 55 and 85 do not contain the send participant number information in them, so using an asterisk allows the envelope lookup to work with only the response code.
- Message name*
- Select a CHIPS message name. Required. Note: The CHIPS deenveloping functionality uses the CHIPS response code in combination with another piece of data (this is usually the value of the first tag in the message) to obtain the CHIPS response message name from the chips.properties property file. The CHIPS deenveloping functionality will then use the message name in combination with the Send Participant Number to find the envelope. Wildcards can be used for the Send Participant Number and the CHIPS message name.
- Compliance check document
- Check the message body for compliance. Required. Valid values are Yes (default) and No.
- Map Name Mode
- How to determine which map to use to perform a
compliance check. Required. Valid values are:
- Specify (default)
- Generate from data (this is useful if you want to share across envelopes)
Note: If you select this option, you must select at least one parameter for Primary Name Format. - Map Name
- Which map to use to perform a compliance check (if Compliance Check document is set to Yes and Map Name Mode set to Specify). The map must already be checked in to Sterling B2B Integrator. Optional.
- Primary Name Format
- Check boxes to specify which information to include
when generating and matching a name for the map. Optional.
Select from:
- Send Participant Number
- Message name
Note: If you are using a generated map name (Map Name Mode is set to Generate from data), Sterling B2B Integrator tries to generate and match the following maps:- First, it tries to generate and match the map in the primary name format (replacing the values that are selected for the corresponding value in the message).
- Second, it tries to generate and match the First Backup Name.
- Third, if there is not an existing map that matches the names generated in steps 1-2, an error is generated.
Only occurs if Generate an error if no generated map name exists in the system is set to Yes.
- Use backup name format
- Whether to use a backup name format if a generated map name cannot be found using the Primary Name Format. Default is selected (use a backup name format).
- First Backup Name Format
- The first backup name format to use when generating
a map name. The system allows for an alternative if the Primary Name
Format is not found—checking for the First Backup Name Format. Optional.
Select from:
- Send participant number
- Message name
Note: If you are using a generated map name (Map Name Mode is set to Generate from data), Sterling B2B Integrator tries to generate and match the following maps:- First, it tries to generate and match the map in the primary name format (replacing the values that are selected for the corresponding value in the message).
- Second, it tries to generate and match the First Backup Name.
- Third, if there is not an existing map that matches the names generated in steps 1-2, an error is generated.
Only occurs if Generate an error if no generated map name exists in the system is set to Yes.
- Generate an error if no generated map name exists in the system
- Specifies whether to generate an error if the Map
Name selected is not found. Valid values are Yes (default) and No. Note: Only displayed if Map Name Mode is set to Generate from data.
- Translate message
- Whether to translate the message (using the specified map). Valid values are Yes (default) and No. Required.
- Validate translation output
- Whether to validate the translation output. Valid values are Yes (default) and No. Required.
- Error Business Process Mode
- How to determine which business process name to
use if there were errors in the compliance check. Required.Valid values
are:
- Specify (default)
- Generate from data
Note: If you select this option, you must select at least one parameter for Primary Name Format. - Primary Name Format
- Check boxes to specify which information to include
when generating and matching a name for the error business process.
Optional.
Select from:
- Send participant number
- Message name
Note: If you are using a generated business process name (Error Business Process is set to Generate from data), Sterling B2B Integrator tries to generate and match the following business process:- First, it tries to generate and match the business process in the primary name format (replacing the values that are selected for the corresponding value in the message).
- Second, it tries to generate and match the first Backup Name.
- Third, if there is not an existing business process that matches the names generated in steps 1-2, an error is generated.
Only occurs if Generate an error if no generated business process name exists in the system is set to Yes.
- Use backup name format
- Whether to use a backup name format if a generated error business process cannot be found using the Primary Name Format. Default is selected (use a backup name format).
- First Backup Name Format
- The backup name format to use when generating an
error business process name. The system allows for one alternative
if the Primary Name Format is not found—checking for the First Backup
Name Format. Optional.
Select from:
- Send participant number
- Message name
Note: If you are using a generated business process name (Error Business Process name is set to Generate from data), Sterling B2B Integrator tries to generate and match the following business process:- First, it tries to generate and match the business process in the primary name format (replacing the values that are selected for the corresponding value in the message).
- Second, it tries to generate and match the First Backup Name.
- Third, if there is not an existing business process that matches the names generated in steps 1-2, an error is generated.
Only occurs if Generate an error if no generated business process name exists in the system is set to Yes.
- Generate an error if no generated business process name exists in the system
- Specify whether to generate an error if there is
no match to the generated business process name in the system. Valid
values are Yes (default) and No. Note: Only displayed if Determine the Business Process By is set to Generating the business process name from the data.
- Business Process List
- Select a previously created business process to
associate with this envelope Optional.
Displayed only if Error Business Process Name is set to Specify.
- Determine the business process by
- How to determine which business process name to
use if there were no errors in the compliance check. Required. Valid
values are:
- Specifying a business process
- Generating the business process name from the data
Note: If you select this option, you must select at least one parameter for Primary Name Format. - Primary Name Format
- Check boxes to specify which information to include
when generating and matching a name for the business process. Optional.
Select from:
- Send participant number
- Message name
Note: If you are using a generated business process name (Error Business Process is set to Generate from data), Sterling B2B Integrator tries to generate and match the following business process:- First, it tries to generate and match the business process in the primary name format (replacing the values that are selected for the corresponding value in the message).
- Second, it tries to generate and match the first Backup Name.
- Third, if there is not an existing business process that matches the names generated in steps 1-2, an error is generated.
Only occurs if Generate an error if no generated business process name exists in the system is set to Yes.
- Use backup name format
- Whether to use a backup name format if a generated business process cannot be found using the Primary Name Format. Default is selected (use a backup name format).
- First Backup Name Format
- The backup name format to use when generating an
business process name. The system allows for one alternative if the
Primary Name Format is not found—checking for the First Backup Name
Format. Optional.
Select from:
- Send participant number
- Message name
Note: If you are using a generated business process name (Error Business Process name is set to Generate from data), Sterling B2B Integrator tries to generate and match the following business process:- First, it tries to generate and match the business process in the primary name format (replacing the values that are selected for the corresponding value in the message).
- Second, it tries to generate and match the First Backup Name.
- Third, if there is not an existing business process that matches the names generated in steps 1-2, an error is generated.
Only occurs if Generate an error if no generated business process name exists in the system is set to Yes.
- Generate an error if no generated business process name exists in the system
- Specify whether to generate an error if there is
no match to the generated business process name in the system. Valid
values are Yes (default) and No. Note: Only displayed if Determine the Business Process By is set to Generating the business process name from the data.
- Business Process List
- Select a previously created business process to
associate with this envelope Optional.
Displayed only if Determine the Business Process Name is set to Specifying a business process.
- Extraction Options
- Business process data extraction. Required.
Valid values:
- Determined by business process (default)
- Extract to a file system directory
- Extract to a mailbox
- Data Extraction Directory
- Directory for data extraction. Displayed only if Extraction Options set to Extract to a file system directory. Optional
- Data Extraction Filename
- Filename for data extraction. Displayed only if Extraction Options set to Extract to a file system directory. Optional.
- Data Extraction Mailbox
- Mailbox for data extraction. Displayed only if Extraction Options set to Extract to a mailbox. Optional.
- Data Extraction Mailbox Message Name
- Mailbox message name for data extraction. Displayed only if Extraction Options set to Extract to a mailbox. Optional.