BPML Activities in Business Process Models

• BPML code includes activities and elements that work together in a business process.
• An activity is a step in a business process, and may be comprised of multiple
elements.
• Elements are defined components of code that provide structure and instructions
regarding the activity they embody.
• BPML refers to entities outside of the business process as participants.
• Activities within BPML code correspond to the icons you include in your business
process models when you create them using the GPM. However, while an icon
displays as a single, contained, unit, viewing the related BPML code shows the
several elements that comprise the activity.
• You may refer to any service or other business process model component as an
activity, but in the context of BPML, an activity may also be a BPML construct used
to define the structure and progress of a business process flow.

 Before each service in a business process model, you must include the Sequence
Start BPML activity, and after the service you must include the Sequence End
Activity
 Some BPML activities must be used in pairs, to bracket other activities. That is, for
a given processing step in a business process model; you must use one of these
bracketing activities at the beginning and one at the end. These are considered to
be parent activities.

Parent Activities Used in Pairs

You can use specific parent activities to bracket other activities in the Graphical
Process Modeler.

The following list describes the BPML icons in the GPM that represent activities
used to bracket other activities:

The Start activity indicates the beginning of a business process. Every

business process model must begin with Start.

The End activity indicates the end of a business process. Every business
process model must finish with End.
The All Start activity is a parent activity in a business process. All Start
indicates that a business process is simultaneously executing all of the
child activities contained within the parent activity.
The All activity runs two or more complex child activities within a
business process simultaneously. Because there are performance
implications to using the All activity, use it only if you expect branches of
your business process model to take significant amounts of time (in
seconds or minutes) to complete (very few services take this long).
Do not use the All activity to run two or more instances of the same
subprocess simultaneously. The system will handle the proper load
balancing.

The All End activity indicates that all child activities within the parent
activity are completed. Use All End to finish All Start.

The Choice Start activity is a parent activity in a business process. Choice

Start indicates a decision and runs one child activity as a result of that
decision. You must assign a name to Choice Start using the Property editor
and assign rules using the Rule Manager.

The Choice End activity indicates that the child activity that ran as a result
of the parent activity is completed. Use Choice End to finish Choice Start.

The Sequence Start activity is a parent activity in a business process.

Sequence Start runs a series of child activities in the order in which they
are listed within the parent activity. When using Sequence Start, you must
assign a name using the Property editor.
 The Sequence End activity indicates that the last child activity in a series of
child activities in the parent activity is finished. Use Sequence End to finish
Sequence Start.

More Complex BPML Activities

You can use specific business process modeling language activities to enable more
complex operations within a business process.

The following BPML activities are not used in pairs to bracket business process
model components. Rather, they enable more complex operations within a business
process. The following list describes the icons and activities:

The Assign activity sets a value in the business process data that is equal
to a fixed value. Inside an input or output element, the activity identifies a
message it should receive from a participant or identifies the contents of a
message it should send to a participant.
Configuration parameters enable you to indicate a fixed value or
input/output message.

The OnFault Group activity is a subflow used to associate a fault handling

activity with a complex activity. Use it to recover from faults and allow the
process to continue.

The Repeat activity runs an activity or subflow one or more additional

times.
Configuration parameters enable you to indicate a name for an instance of
the Repeat activity and the name of the activity the Repeat activity should
run again.
 SERVICES AND ADAPTERS USED IN BUSINESS PROCESS

Services
In Sterling B2B Integrator, a service is a resource that you can configure to carry out
an activity. For example, the Translation service is used to convert EDI or XML data
from one format to another.
Adapters
Adapters are special cases of services that interact with external systems, or that
store or manage state data outside of the workflow context.
The following are the list of services and adapters used in Business Process:
Document Extraction service:

You can use the Document Extraction service to split individual documents
out of a batch file and make each one a separate document, to initiate EDI enveloping and
outbound document processing, or to batch multiple XML documents for processing.
The Document Extraction service takes a file that contains one or more individual documents,
and attempts to find the map (from a specified list of maps) that produces output. The Document
Extraction service reads through this specified list from left to right until it finds a map that
produces output. The correct map is determined by recognizing the data through the file type and
record properties. Once this map is found, the service does not attempt to process the file though
any other maps in the list. The service extracts each individual document and puts it into the
business process context with the name DOC-SPLIT-N where N is a 1-based number.
Additionally, you have the option of having the extracted documents batched, EDI encoded, and
EDI enveloped.
The Document Extraction service can also extract XML sub-documents out of an XML
compound document.
Business usage
The Document Extraction service allows you to concatenate many files into one, making
tracking of the data more manageable.
Usage example
Your application generates purchase orders in a batch file, once a day. The IBM®
Sterling B2B Integrator is scheduled to retrieve this file each day. When it is received, the
first step in the business process has the Document Extraction service parse the file and
produce an order document for each trading partner. Each document is passed on to the
translator for conversion, and sent to the appropriate trading partner.
Configuring the Document Extraction Service
To configure the Document Extraction service, you must specify field settings in the
Graphical Process Modeler (GPM).

The following table describes the fields used to configure the Document Extraction service in the
GPM:

Field Description

Config Name of the service configuration.

BatchLikeDocuments Whether to combine documents extracted by the

service into a single document, or split each
document out individually. Valid values are Yes
and No.
• If Yes is specified, documents that are extracted by
the service are combined into a single document if
they have the same sender ID, receiver ID, and
accepter lookup alias. This parameter also allows
you to batch XML documents.
• If No is specified, each document is split out
individually, regardless of sender ID, receiver ID,
and accepter lookup alias values.

DocExtractMapList List of map names defined in the IBM Sterling B2B

Integrator Map Editor that should be used to extract
documents from a single batch file. The Document
Extraction service reads through this specified list
of maps from left to right until it finds a map that
produces output. Once this map is found, the
service does not attempt to process the file though
any other maps in the list. Valid values are the
names of the maps created. Make sure that all maps
in this list are active in IBM Sterling B2B
Integrator and are of the same file type. For
example, all maps in the list are of the positional
file type and are not mixed with the delimited file
type. Map names in the list are separated by a
space. Map names in the list are separated by a
space.
 NoteThis parameter is mutually exclusive with the
XMLInput parameter. If XMLInput is set to Yes,
this parameter will be ignored.

EDIEncodeDocument Whether each document extracted should be

immediately EDI-encoded. Valid values are Yes
and No. Must be set to Yes if
EDIEnvelopeDocument is set to Yes. Otherwise,
the service will generate an error and halt the
business process.

EDIEnvelopeDocument
Whether each document extracted and encoded should be
immediately EDI-enveloped. Valid values are Yes and No.
If this parameter is set to Yes, the EDIEncodeDocument
parameter must also be set to Yes. Otherwise, the service
will generate an error and halt the business process.

EDI DEENVELOPE:

Identifies the EDI interchanges (including VDA, SWIFTNet, and RND) contained within
a message, extracts them to separate messages, and starts the appropriate business process
to handle each one.
Configuring the EDI Deenveloping Service:

To configure the EDI Deenveloping service, you must define following fields in the
GPM:

Field Description

Config Name of the service configuration.

BASIC_CHECK_FOR_MISSING_END_TAG If this option is set to Yes, the

business process checks to see if
any end tags are missing.
COMPREHENSIVE_CHECK_ If this option is set to Yes, the
FOR_MISSING_END_TAG business process kicks off a
comprehensive check to see if any
end tags are missing.
The EDI Enveloping service and EDI Deenveloping service automatically collect the following
correlation information from EDI documents:

Field Description

Category Data Collected

Sender ID • InterchangeSenderID
• GroupSenderID
• TransactionSenderID

Receiver ID • InterchangeReceiverID
• GroupReceiverID
• TransactionReceiverID

Control Numbers • InterchangeControlNumber

• GroupControlNumber
• TransactionControlNumber

Acknowledgement Requested • InterchangeAckRequested

• GroupAckRequested

Acknowledgement Status • InterchangeAckStatus

• GroupAckStatus

Standard Standard – values are CII,

EDIFACT, VDA, RND, SWIFT,
and X12

ID • FunctionalID
• TransactionSetID

Versions • InterchangeVersion
• GroupVersion
• TransactionVersion

Date and Time • InterchangeDateTime

• GroupDateTime

Overdue Time • InterchangeOverdueTime

• GroupOverdueTime

Level Level – values are Interchange,

Group, and Transaction
 Direction Direction – values are Inbound and
Outbound

Envelope Type • InterchangeEnvelopeType

• GroupEnvelopeType
• TransactionEnvelopeType

Envelope Name • InterchangeEnvelopeName

• GroupEnvelopeName
• TransactionEnvelopeName

Envelope Version • InterchangeEnvelopeVersion

• GroupEnvelopeVersion
• TransactionEnvelopeVersion

Compliance Status • InterchangeComplianceStatus

• GroupComplianceStatus
• TransactionComplianceStatus
Values are OK and NOT OK

Test Mode TestMode – values are Production,

Test Data and Information

Counts • TransactionCount
• GroupCount

Container Doc ID ContainerDocID

 The information for these correlations is automatically collected at each envelope and
deenvelope stage for a document, which facilitates the tracking of individual documents as
they move through the IBM® Sterling B2B Integrator.
 There is no setup required for using the correlation information collected by the EDI
Enveloping and EDI Deenveloping services. After you use one of these services in a
business process, the information is available through the Correlation Search option.
EDI Encoder :

Determines which transaction-level envelope will be used on the document. If translations

are specified in an envelope, the service determines which map to use.
Configuring the EDI Encoder
To configure the EDI Encoder service, you must specify settings for the following fields
in the GPM:
Field Description

Config Name of the service configuration.

AccepterLookupAlias Identifying string used with the sender ID (and/or

Application Sender ID for CHIPS) and receiver ID
(and/or Application Receiver ID for CHIPS) to look up
this envelope. This alias associates a document with the
service it requires. This same field is specified in the
transaction-level outbound envelope. Also, this
identifying string is used with the Sender ID and
Receiver ID to look up this envelope for the Fedwire
Outbound Envelope. Required.

Mode Determines whether documents are enveloped

immediately or deferred to be enveloped at a later time.
Optional. The mode used here must correspond to the
mode in which the EDI Envelope service will be called.
Valid values are:
• Immediate – The envelopes are determined and
associated with the document to be used during
enveloping. Assumes the EDI Envelope service will be
used to envelope the document later in the process.
• Deferred – The service marks the document to be
enveloped at a later time, usually according to a
schedule. The document is stored in the database until
enveloping takes place. (Default)

ReceiverID Receiver identification, 2 characters minimum, 15

maximum. Required. Must match the receiver ID in the
transaction-level document envelope.

SenderID Sender identification, 2 characters minimum, 15

maximum. Required. Must match the sender ID in the
transaction-level document envelope.
EDI Enveloping Service

The EDI Enveloping service translates messages, determines which business

processes need to run to apply EDI envelopes, and starts those business processes. The EDI
Enveloping service has two methods of translating and enveloping messages:
• In Deferred mode, the EDI Enveloping service runs at a scheduled time and it translates
and envelopes messages into interchanges in batches.
• In Immediate mode, the EDI Enveloping service translates and envelopes messages
immediately after the EDI Encoder service processes the messages.
Before the IBM® Sterling B2B Integrator runs the EDI Enveloping service, you must have
the EDI Encoder service process EDI messages that need to be translated and enveloped.
The EDI Encoder service tags messages so that the EDI Enveloping service can properly
translate and envelope them.

Description

Responsible for translating and enveloping a message. It can be configured to run in

either of two modes: Deferred or Immediate.
• In Deferred mode, the service queries the IBM Sterling B2B Integrator to identify
messages that require translation and enveloping. The query can incorporate an optional
filter that allows the business process developer to restrict messages by any or all of
Sender ID, Receiver ID, and Envelope ID. The service then divides the messages
according to the envelopes they require and initiates the appropriate enveloping business
processes. In deferred mode, the IBM Sterling B2B Integrator translates and envelopes
messages in batches at specified intervals.
NoteThe EDI Enveloping service should be excluded from the business process when the
EDI Encoding service is used; instead, the deferred EDI Enveloping service must be used
in a different business process and should be triggered periodically.
• In Immediate mode, the service translates and envelopes the current message as soon as
the EDI Encoder service is finished with the message. It operates on the primary message
it receives and initiates the appropriate enveloping business process.
Configuring the EDI Enveloping Service

To create a EDI Enveloping service configuration, you must specify field settings in
the IBM Sterling B2B Integrator and in the Graphical Process Modeler (GPM).

The following table describes the fields used to configure the EDI Enveloping service in the IBM
Sterling B2B Integrator:
Note:The field names in parentheses represent the corresponding field names in the GPM. This
information is provided for your reference.

Field Description

Enveloping Instructs the IBM Sterling B2B Integrator when to translate and envelope
Mode messages:
(MODE) • Deferred – Translate and envelope messages in batches at specified intervals.
NoteWhen using deferred mode, the EDI Enveloping service should be excluded
from the business process when the EDI Encoding service is used; instead, the
deferred EDI Enveloping service must be used in a different business process and
should be triggered periodically.
• Immediate – Translate and envelope the current message as soon as the EDI
Encoder service is finished with the message.
• NoteThe EDI Enveloping service notifies you if there is an incorrect value or
mismatch in the MODE parameter by writing information on how to correct the
problem in the status report of the Business Process step. However, this can
cause a performance degradation in some very heavy usage scenarios by adding
additional load on the database. We recommend that you review all Business
Processes that use the EDI Enveloping service to verify that they are using the
correct MODE parameter, and that the values match in the Business Process. The
EDI Encoder service should be set as "MODE," as follows:
Note
<assign to="MODE">IMMEDIATE</assign>
Sender ID Enter a Sender ID to be used as a filter for selecting messages from the database
for enveloping. Optional.

Receiver ID Enter a Receiver ID to be used as a filter for selecting messages from the
database for enveloping. Optional.
File System Adapter:

Use the File System adapter to collect files within a business process,
extract files to the file system from a business process, or collect files and then start a
new business process.
This table contains only the fields that are configured in the GPM. The values in parentheses
represent the corresponding BPML values.

Field Description
Action Action that the File System adapter is to perform. Required.
No default. Valid values:
• Collection (FS_COLLECT) - Files are collected or picked up
from the specified folder.
• Extraction (FS_EXTRACT) - Files are extracted or written to
the specified folder.
collectMultiple Used to collect multiple files in non-bootstrap mode. Collected
files are placed into process data.
• Yes (true)
• No (false) - Default
Filenaming convention Whether to override the document file name and use the
(assignFilename) assigned file name. Required. Valid values:
• Use the original file name as the extracted file name - Keeps
the names of the files.
Assign a specific name - Gives you the option to navigate to a
screen and specify a different filename for the file extracted to
the file system.
collectZeroByteFiles Whether to collect zero-byte files. Valid values:
(true/false) • Yes (true) - Zero-byte files are collected.
• No (false) - Zero-byte files are ignored. Default.
Collection folder The name of the folder or subfolder on the same computer
where Sterling B2B Integrator is installed and where it collects
(or picks up) files as part of a business process. If the path for
the folder is not included as part of the name, the folder is
assumed to be in the Sterling B2B Integrator working
directory. Required.
Note
• The deleteAfterCollect parameter in the GPM defaults to Yes.
If you do not change the default value to No, files that are
collected are deleted from the Collection Folder. The File
System adapter does not copy the files it collects for
Field Description
processing. See Graphical Process Modeler Configuration for
information about the deleteAfterCollect parameter.
• The collectionFolder parameter is read-only in the GPM.
However, you can override this parameter using BPML.

Collect files from subfolders Whether to scan for files in subfolders of the collection folder.
within and including the Required. Valid values:
collection folder? • Yes - Collects files in the specified folder and all subfolders.
(useSubFolders) • No - Collects files in the specified folder only.

Start a business process once Whether to start a business process using the File System
files are collected? (bootstrap) adapter after files are collected. Required. Valid values:
• Yes - Starts the business process specified from the business
process drop-down list.
No - No business process will be started.
Business Process The business process to start after files are collected. Required
(initialWorkFlowId) when Start a business process is set to Yes. Valid values:
• Name of the business process to start
• Not Applicable

Use the absolute file path Whether to keep the absolute path name of the files collected
name for the document name? when assigning the document name. Required. Valid values:
(keepPath) • Yes - The absolute file path name is kept with the document in
the business process. Choose this value if your business
process requires the path information to precede the file name.
• No - Only the file name is kept with the document in the
business process.

deleteAfterCollect Whether to delete the file after collection. Valid values:

• Yes (true) - File is deleted from the Collection folder after it is
collected. Default.
• No (false) - File is left in the folder after it is read into Sterling
B2B Integrator.
For Each Document service:

The For Each Document service incrementally processes a set of

documents. Each time the service runs, it makes the next document in the document set
the primary document. This enables business processes to contain loops that operate on
each document in turn.
The following table describes the fields used to configure the For Each Document service in the
GPM:

Field Description
Config(participant name) Name of the service configuration.
ITERATOR_NAME Name used to identify this document iterator in the business
process. This is the prefix for the tags that are generated by
the service and is incremented as it loops through the
documents.
DOCUMENT_NAME_PREFIX Filter that restricts the documents included in the iteration.
The filter is the prefix on each document name. When this
parameter is used, only documents beginning with this prefix
are processed. If DOCUMENT_KEY_PREFIX is used, this
parameter is ignored. If neither this parameter or
DOCUMENT_KEY_PREFIX is specified, all documents in
the business process are processed by the For Each service.
DOCUMENT_KEY_PREFIX Filter that restricts the documents included in the iteration.
The filter is the prefix on the key in process data for each
document. When this parameter is used, only documents that
have keys beginning with this prefix are processed. The
parameter DOCUMENT_NAME_PREFIX is ignored if this
parameter is specified. If neither this parameter or
DOCUMENT_NAME_PREFIX is specified, all documents
in the business process are processed by the For Each
service.
Invoke Business Process Service:

The Invoke Sub-Process service provides a way to reuse the same

business process in multiple business processes by invoking the subprocess from within a
parent process
Configuring the Invoke Sub-Process Service
To configure the Invoke Sub-Process service, you must specify settings for the following
fields in the GPM.

Field Description

Config Name of the service configuration. Required.

WFD_NAME Business process used in the service configuration. Valid value is

the name of any business process checked into the system.
Required.

INVOKE_MODE Mode in which to run the subprocess. Optional. Valid values are:
• async = asynchronous (default)
• sync = synchronous
• inline = In-line
• embedded = starts business process in SYNC mode with Enable
Transaction on, and runs the subprocess in the same transaction
as the Invoke Sub-Process service. The subprocess is run with no
persistence.
PASS_STATUS_REPORT Pass status report to parent. Valid values are:
• ON_SUCCESS
• ON_ERROR
• ALWAYS
• NEVER
Default is ON_ERROR. Required.

COPY_SERVICE_PARMS Invoke service parameters passed to the subprocess. Valid values

are True and False. Default is True. Required.
 Mailbox Add service:

The Mailbox Add service adds a message to one or more mailboxes.

Configuring the Mailbox Add Service

The following table describes the fields used to configure the Mailbox Add service in the GPM:

Consider the following when providing the MessageName and DocumentID:

• If a primary document is available in the business process for the Mailbox Add service,
DocumentID and MessageName are not required.
• If no primary document is available in the business process for the Mailbox Add service,
(OutputMsg is set to MessageOnly), DocumentID is required. When both PrimaryDocument and
DocumentID are present in the Process Data, PrimaryDocument is ignored and only
DocumentID is recognized by the Mailbox Add Service. When using the Mailbox Add service in
a loop, you can use the Release service to remove Document ID node from the Process Data.

Field Description

MailboxPath Mailbox path that the user has permission to use. If a user has been set up with a
virtual root, the MailboxPath will be a relative path to the virtual root. The
virtual root is not visible to the business process. Required. Valid values are
UNIX-style paths where the folders correspond to a mailbox name. A path must
begin with the ‘/' character and use the ‘/' to separate mailboxes in the hierarchy.
Following is an example of a valid mailbox
path:/Customers/DallasHardware/InboundThe following characters cannot be
used in a mailbox name: ? < > | : \ / % *.

Mailbox Extract Begin service:

The Mailbox Extract Begin service begins the extraction of a message from a
mailbox. Call this service in a business process to automate the extraction of messages from
designated mailboxes. Configuring the Mailbox Extract Begin Service
The following table describes the fields used to configure the Mailbox Extract Begin service in
the GPM:
Field Description

Config Name of the adapter configuration.

CommitNow Yes – Automatically commits the message for extraction without the use of
Mailbox Extract Commit service. The business process does not lock the
message. No – Requires the Mailbox Extract Commit service to commit the
message for extraction. The business process locks the message until the
Mailbox Extract Commit or Mailbox Extract Abort service is complete. Default.

MessageId ID of the stored message. Required. Valid values are numbers >=0.

Mailbox Query Service:

The Mailbox Query service performs a query of Sterling B2B

Integrator mailboxes for messages that meet specified criteria and returns results.
Configuring the Mailbox Query Service
The following table describes the fields used to configure the Mailbox Query service in the
GPM:
Field Description

Config Name of the adapter configuration.

MailboxPath One or more mailbox paths that the user has permission to use. If the
user has a virtual root, then MailboxPath is a relative path to the
virtual root. The virtual root is not visible to the business process.
Required if you do not have Mailbox Global Query Permission. Valid
values are UNIX-style paths where the folders correspond to a
mailbox hierarchy. Paths must begin with the / character and use
the / to delimit mailboxes in the hierarchy. The space character is
allowed within a mailbox name. Do not use the following characters
in a mailbox name:
?<>|/\"%*!
MessageId ID of the stored message. Required. Valid values are numbers greater
than or equal to 0.
Field Description

MessageNamePattern Pattern to select messages with names matching the pattern. The
following characters cannot be used in a message name:
?<>|/\"%*!
You can use an asterisk (*) as a wildcard such as *.po

Mailbox Extract Commit Service:

The Mailbox Extract Commit service indicates the successful completion of

the extraction of a message from a mailbox.
Configuring the Mailbox Extract Commit Service
To configure the Mailbox Extract Commit service, you must specify settings for the
following fields in the GPM:
Field Description

Config Name of the adapter configuration.

MessageId ID of the stored message. Required. Valid values are numbers >=0.

Release Service:

The Release service is a system service that is used to remove elements from the
process data of a business process.
The following table describes the Release service parameter:
Parameter Description

TARGET The element(s) to remove from process data. Notes:

• You must specify the TARGET parameter in all uppercase characters.
• You can use either the Advanced Editor in the GPM or BPML to specify this
parameter.
• You can use the following formats to assign an element to the TARGET
parameter.
Parameter Description

<assign to="TARGET">target_element_name</assign>
where target_element_name is the name of the XML element you want removed
from process data. The Use XPATH? option in the GPM is not selected when
using constants to assign the TARGET parameter.
or
<assign to="TARGET" from=" 'xpath_statement' " />
Notice that the xpath_statement is enclosed in both double quotes and single
quotes. The Use XPATH? option in the GPM must be selected when using XPath
statements to assign the TARGET parameter.

SFTP Client Services for Use in Business Processes

After you configure and set up the SFTP Client adapter to exchange files with a trading partner’s
SFTP server, you can build business processes that include the services provided by the SFTP
Client adapter.
The available services offer the following functionality:
SFTP Client Service Functionality
SFTP Client Begin Session Starts an SFTP session with an external trading partner for the
service purpose of exchanging business documents
SFTP Client CD service Changes directories on the trading partner’s SFTP server
SFTP Client End Session Ends an SFTP session with an external trading partner
service
SFTP Client GET service Retrieves a document in a specified directory on the trading
partner’s SFTP server
SFTP Client LIST service Retrieves a list of files on a specified directory on the trading
partner’s SFTP server
SFTP Client PUT service Places a document in a specified directory on the trading partner’s
SFTP server

SFTP Client Begin Session service:

The SFTP Client Begin Session service starts an SFTP session with an external
trading partner for exchanging business documents.
The following table contains the parameters passed from the business process to the SFTP Client
Begin Session service:
Field Description
KnownHostKeyId Public key used to authenticate remote SFTP servers to the Sterling B2B
Integrator SFTP Client. Internal value is GUID. Required.
Note: The value entered for this parameter overrides the setting in the
SSH Remote Profile configuration.
RemoteHost External Trading Partner host system (SFTP server IP Address or DNS
name. Required if ProfileId is not specified. Use any valid IP Address or
DNS name.
RemotePort External Trading Partner port number. Required if ProfileId is not
specified.
NoteThe value entered for this parameter overrides the setting in the SSH
Remote Profile configuration.
RemoteUserId SFTP remote login username. Required if ProfileId is not specified.
NoteThe value entered for this parameter overrides the setting in the SSH
Remote Profile configuration.
SFTPClientAdapter Select the SFTP Client adapter or a group that includes an SFTP Client
adapter for this service to use when beginning sessions with an SFTP
server. Required.

SFTP Client CD service:

The SFTP Client CD service changes directories on the trading partner’s SFTP
server.
The following table contains the parameters passed from the business process to the SFTP Client
CD service:
Field Description
Directory The directory to change to. Can also be a relative directory depending on
server capabilities. Required.
SessionToken The returned SessionToken from the Begin Session service. Required.
SFTP Client GET service:

The SFTP Client GET service retrieves a document from a specified directory on
the trading partner’s SFTP server.
The following table contains the parameters passed from the business process to the SFTP Client
GET service:
Field Description
RemoteFileName The name of the file to be retrieved from the remote trading partner.
Required.
SessionToken The returned SessionToken from the Begin Session service. Required.

SFTP Client LIST service:

The SFTP Client LIST service retrieves a list of files on a specified directory on
the trading partner’s SFTP server.
The following table contains the parameters passed from the business process to the SFTP Client
LIST service:
exactly
Field Description
SessionToken The returned SessionToken from the Begin Session service. Required.

SFTP Client PUT service:

The SFTP Client PUT service places a document in a specified directory on the
trading partner’s SFTP server.
The following table contains the parameters passed from the business process to the SFTP Client
PUT service:
Field Description
SessionToken The returned SessionToken from the Begin Session service. Required.
SFTP Client End Session service:

The SFTP Client End Session service ends an SFTP session with an external
trading partner SFTP server.
The following table contains the parameters passed from the business process to the SFTP Client
End Session service:
Field Description
SessionToken The returned SessionToken from the Begin Session service that initiated the
session to be ended. Required.

TRANSLATION SERVICE:

Performs translation of the primary document using a specified map, and

replaces the primary document with the result of the translation.
Example
You want to take positional data from your order system and translate it to variable-
length-delimited data so that it can be read by your billing system.
Use the Sterling B2B Integrator Map Editor to create a map that will translate the
incoming data from positional data to variable-length-delimited data. Write a business
process that will put the data into the primary document, then start the Translation
service. Using the map you created, the service translates the data from positional data to
variable-length-delimited, and replaces the old data with newly translated data in the
primary document.

Configuring the Translation Service

To configure the Translation service, you must specify settings for the following fields in
the GPM:
Field Description

Config Name of the service configuration.

map_name Name of the map used for translation. The map

must already be checked in to the IBM Sterling
B2B Integrator and enabled.
 TIMESTAMP UTILITY SERVICE:

The Timestamp Utility service creates, formats, and performs arithmetic

operations on timestamp values in a business process.
• It enables to use and manipulate timestamps as part of a business process ,
• This service can be used to generate a timestamp when errors occur in a business
process, and use the timestamp as part of the information delivered in an e-mail
message about the error, or send the information to a report.
• It calculates the time difference using the UNIX time stamp.
Configuring the Timestamp Utility Service
The following table describes the fields used to configure the Timestamp Utility service in the GPM:
Field Description

Config Name of the service configuration.

action Action the service should perform. Optional. Valid values are:
• Add
• Current Time
• Format
• Subtract
baseTime String to use as the base time. Optional. Default time expression is milliseconds; used
if no scale is supplied (see scale parameter, below).

baseTimeFormat String to use as the base time format. Optional. For example, yyyy-MM-dd
HH:mm:ss

format String that describes how to format the parameter. Optional.

offsetTime Amount to add or subtract from the baseTime. Used with action parameters add and
diff only. Optional. Default time expression is milliseconds; used if no scale is
supplied (see scale parameter, below).

scale How the parameter value is expressed in time scales. Optional. Valid values are:
• Day
• Hour
• Millisecond
• Minute
• Second
If not set, the baseTime and offsetTime parameters are expressed in milliseconds.
 X12 Deenvelope service:

Handles deenveloping of inbound X12 interchanges. It does compliance

checking (except for sequence checking). It also generates 997, 999, and TA1
acknowledgements, and reconciles inbound 997 and 999 acknowledgements, if no sequence
checking is required. Additionally, this service supports the translation and compliance
checking of WebSphere® Transformation Extender (WTX) maps.
Business usage
The business value of the service is to improve performance by deferring sequence
checking (if required) so that database updates of control numbers can be done by the
EDI Post Processing service.
Example
An inbound purchase order is received inside an X12 interchange. The EDI envelopes are
parsed and the document envelopes that match the envelope data are retrieved. With the
document envelopes, this service knows what to do with the purchase order, such as
initiating a business process to perform some business logic.
Field Description

Config Name of the service configuration.

Adding Translation Map The X12 Deenvelope service automatically adds the name
Name to Process Data of the map used by the translator (as specified when
building the envelope) in an inbound or outbound
translation to process data. The X12 Deenvelope service
writes the map name into the process data regardless of the
reason the translator was invoked; that is, for a compliance
check only, or for both compliance check and translation.
The map name in process data enables enhanced
configuration possibilities for your business process
models. For example, you can configure business processes
to use the map name for tracking or cross reference
purposes, configure decisions in your process models to
choose a subprocess according to the map that was run, or
to create a report when there are translation errors.
X12 Envelope service:

Handles enveloping of outbound X12 interchanges.

Business usage

This service improves performance of EDI X12 by consolidating EnvelopeST,

EnvelopeGS, and EnvelopeISA into a single service.
Example
An outbound purchase order is to be sent inside an X12 interchange. The document
envelopes that match the SenderID, ReceiverID, and AccepterLookupAlias specified in
the EDI Encoder service are retrieved. If required by the ST envelope, translation is
performed using the map specified by the envelope. The ST, GS, and ISA envelopes are
applied to the output of this step. It checks if the document being enveloped is a 997 or a
999. The service will then initiate a business process if one is specified in the ISA
envelope definition.
Field Description

Config Name of the service configuration.

Adding Translation Map The X12 Envelope service automatically adds the name of
Name to Process Data the map used by the translator (as specified when building
the envelope) in an inbound or outbound translation to
process data. The X12 Envelope service writes the map
name into the process data regardless of the reason the
translator was invoked; that is, for a compliance check
only, or for both compliance check and translation. The
map name in process data enables enhanced configuration
possibilities for your business process models. For
example, you can configure business processes to use the
map name for tracking or cross reference purposes,
configure decisions in your process models to choose a
subprocess according to the map that was run, or to create a
report when there are translation errors.
AS2 Trading Partner:
We need the following criteria to set up a trading partner
1.Self signed certificate-system and trusted:organization,partner
2.as2 partner organization/partner: organization,Partner
3.as2 relationshioship: organization, partner
4.Finally run Test now as2
Organization Partner
i. Self-signed i. Self-signed
certificate certificate

ii. Name ii. Name

iii. Organization iii. Organization

iv. Identity Name iv. Identity Name

v. AS2 Identifier v. AS2 Identifier

vi. Profile Name vi. Profile Name

vii. Exchange vii. Exchange

certificate certificate

viii. Signing viii. Signing

Certificate Certificate

 When organization send file the default Business Process (AS2SendSynMDN) gets
triggered
 When partner receives file the default 3BP’s (EDIINT Service, HTTP Sync Send, AS2
Extract) get execute in Background