AS3 Build Service
The following table provides an overview of the AS3 Build service:
- System name
- AS3 Build Service.
- Graphical Process Modeler (GPM) categories
- All Services, INTERNETB2B-EDIINT.
- Description
- This service is used to build an AS3 message, including constructing the message header.
- Business usage
- A user needs to build an AS3 message and initiate an AS3 message exchange with a trading partner.
- Usage example
- An example of the usage of this service is as follows:
- The user wants to initiate an AS3 message exchange with a trading partner.
- The user writes a business process and includes the AS3 Build service in the process definition.
- The AS3 Build service starts the AS3 message exchange as configured in the trading partner contract.
- Preconfigured?
- Yes, a preconfigured instance, AS3BuildService, is created during installation process.
- Requires third party files?
- No.
- Platform availability
- All supported application platforms.
- Related services
- This service is used in conjunction with the AS3 Parse service, File System adapter, and FTP adapter.
- Application requirements
- An AS3 message exchange agreement is configured with an external trading partner. A trading partner contract must be configured to initiate the AS3 message exchange.
- Initiates business processes?
- This service initiates the AS3MessageInitiation internal business process.
- Business process context considerations
- None.
- Invocation
- This service is invoked from a business process. It can be used in any business process for which this functionality is desired.
- Restrictions
- No.
- Returned status values
- Success, Failure
- Testing considerations
- Debug information for this service can be found in the AS3 log files.
How the AS3 Build Service Works
The following steps summarize how the AS3 Build service works within a business process:
- The AS3 Build service starts the AS3 message exchange as configured in the trading partner contract.
- The AS3 Build service initiates a message exchange with the trading partner as specified in the AS3 contract.
- The AS3 message is exchanged based on the contract configuration.
- For Bulk Message Generation, a scheduled business process is created. This business process has an instance of a File System adapter that collects the documents from the specified folder and invokes a business process containing the AS3 Build service for each document collected.
Implementing the AS3 Build Service
To implement the AS3 Build service, complete the following tasks:
- Install the AS3 Build service.
- Create an AS3 Build service configuration.
- Configure the AS3 Build service only once in the user interface.
- Configure the AS3 Build service parameters only once in the GPM.
- Use the AS3 Build service in a business process or create the one necessary AS3 trading partner contract with the Bulk Message Generation parameter enabled so a scheduled business process that includes the AS3 Build service is created.
Note: Two AS3 contracts are automatically created
when you use the AS3 Partner Wizard to create a trading partner contract.
The second contract is used by the AS3 Parse Service when parsing
incoming AS3 messages.
Configuring the AS3 Build Service
To configure the AS3 Build service, you must complete the following steps:
- Select .
- Search for AS3 Build service or select it from the list and click Go!.
- Click Edit.
- Specify field settings in the Admin Console (Creating or Setting Up a Service Configuration in the Admin Console) and the GPM (Setting Up the Service in the GPM).
- On the Confirm page, verify that the Enable Service for Business Processes check box is selected and click Finish.
Creating or Setting Up a Service Configuration in the Admin Console
To configure the AS3 Build service, you must specify settings for the following fields in the IBM® Sterling B2B Integrator user interface one time only. Additionally, you will need to specify settings in the GPM:
- Field
- Description
- Name
- Unique and meaningful name for the service configuration. Required.
- Description
- Meaningful description for the service configuration, for reference purposes. Required.
- Select a Group
- Select one of the options:
- None – You do not want to include this configuration in a group at this time.
- Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
- Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
Optional.
Setting Up the Service in the GPM
Use the field definitions in the following table to set up the service configuration in the GPM:
- Parameter
- Description
- ContractName
- The contract to use when initiating an AS3 message exchange. Value is any valid contract name. Required. BPML element value is ContractName.
- CustomizedBPML
- The customized business process to invoke. Value is any valid IBM Sterling B2B Integrator business process name. By default, the predefined (internal) AS3MessageInitiation business process is invoked. Optional.
- BPInvokeMode
- The business process invocation mode. Valid values are ASYNC (asynchronous) or SYNC (synchronous). Default is ASYNC. Optional.
- MessageStoreDirectory
- The directory in which to store the AS3 message that is created or picked up from the trading partner. Value is any valid file directory. Optional.
- FileSystemInstance
- The File System adapter instance that will write the AS3 message to the file system. Value is any File System adapter instance. Optional.
- FTPAdapterName
- The FTP adapter instance to use to transport the AS3 message to the trading partner. Value is any valid FTP adapter instance. Default is FTPClientAdapter. Optional.
- PipelineTimeoutInSecs
- The timeout value for building an AS3 message. Valid value is any numeric value. Default is 1800 seconds. Optional.
Process Data Example
This example shows an example business process using the AS3 Build service to exchange AS3 messages:
<process name="test_AS3Build">
<sequence name="seq1">
<operation name="AS3 BUILD SERVICE">
<participant name="AS3Build"/>
<output message="outmsg">
<assign to="ContractName">SendToCleo</assign>
</output>
<input message="inmsg">
<assign to="." from="*"></assign>
</input>
</operation>
</sequence>
</process>