si_cdsa_user_guide
si_cdsa_user_guide
Version 5.2
This edition applies to the 5.2 Version of IBM Sterling B2B Integrator and to all subsequent releases and modifications until otherwise indicated in
new editions.
Before using this information and the product it supports, read the information in Notices on page 191.
Licensed Materials - Property of IBM
IBM Sterling B2B Integrator
© Copyright IBM Corp. 2010, 2011. All Rights Reserved
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp
CDSAI1107
Contents
Chapter 1 What’s New with the Interface between Sterling B2B Integrator and
Sterling Connect:Direct 9
What’s New with the Interface between Sterling B2B Integrator and Sterling Connect:Direct
9
General Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Improvements to Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
New Documentation on the Sterling Connect:Direct Process Website . . . . 12
Sterling Connect:Direct Process Examples . . . . . . . . . . . . . . . . . . . . . . . . . 12
Enhancements to Sterling Connect:Direct Server Adapter Documentation . 13
Sterling B2B Integrator Business Process Examples . . . . . . . . . . . . . . . . . . 14
Contact Us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Setup Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Create Sterling Connect:Direct and Sterling B2B Integrator User IDs. . . . . . . . . . . . 19
Configure a Sterling B2B Integrator Netmap Entry . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Connect:Direct Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Connect:Direct Netmaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Connect:Direct Netmap Cross-References. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Configure a Sterling Connect:Direct Server Adapter . . . . . . . . . . . . . . . . . . . . . . . . . 24
Add Connect:Direct Server Adapter Node to Sterling Connect:Direct Netmap . . . . . 28
Create a Sterling B2B Integrator Mailbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Use Sterling Connect:Direct to Copy a File to a Sterling B2B Integrator Business Process
35
Create a Sterling B2B Integrator Business Process . . . . . . . . . . . . . . . . . . . . . . 36
Check Your Business Process into Sterling B2B Integrator . . . . . . . . . . . . . . . . 37
Create Your Sterling Connect:Direct Process. . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Submit and Monitor Your Sterling Connect:Direct Process . . . . . . . . . . . . . . . . 39
Monitor with Sterling Connect:Direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Monitor with Sterling B2B Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Chapter 6 Use Sterling Connect:Direct to Pull a File from Sterling B2B Integrator
43
Chapter 8 Use Sterling B2B Integrator to Copy a File from Sterling Connect:Direct
63
Chapter 12 Use Sterling B2B Integrator to Start a Sterling Connect:Direct Run Job
93
Chapter 13 Use Sterling B2B Integrator to Start a Sterling Connect:Direct Run Task
101
Use Sterling B2B Integrator to Start a Sterling Connect:Direct Run Task . . . . . . . . . 101
Check Out the Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Edit the Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Check In Your Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Submit and Monitor Your Sterling B2B Integrator Business Process . . . . . . . . . 104
Monitor with Sterling B2B Integrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Monitor with Sterling Connect:Direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Verifying Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Exchange Process IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Business Process Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Using the Graphical Process Modeler. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Logging Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Customizing the Connect:Direct Server Adapter Log Settings . . . . . . . . . . . . . . 177
Configuration Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Turning on Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Notices 191
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
General Enhancements
In Sterling B2B Integrator version 5.2, several enhancements are focused on making it easier to use the
Sterling Connect:Direct Server Adapter and other related Sterling Connect:Direct Server services, such as
the CopyTo service used to transfer files between a Sterling Connect:Direct Server Adapter node and other
Sterling Connect:Direct server nodes. Here’s a summary of the general enhancements:
✦ Sterling Connect:Direct Server Adapter upgrade now allows you to make changes to an existing
netmap, which take effect immediately without disabling and re-enabling the adapter. Simply edit the
configuration of the Sterling Connect:Direct Server Adapter that uses the modified netmap, click Next
until you reach the Confirm page, and then click Finish for the system to immediately recognize your
netmap changes.
✦ Sterling B2B Integrator version 5.1 and later supports the most common set of parameters available in
the Sterling Connect:Direct for z/OS Process Copy statement To clause to provide more functionality,
such as enhanced file allocation and disposition options for the destination file on the remote Sterling
Connect:Direct for z/OS node. To ensure that business processes created in earlier versions of Sterling
B2B Integrator continue to execute properly, parameters existing in versions 5.0 and earlier will still be
supported. However, these old parameters cannot be mixed with new parameters in the same CopyTo
service. It is recommended that you use the new parameters when you create a new business process
and that when you make changes to an existing CopyTo service that you upgrade and use the new
parameters, as well. For more information, see Sterling Connect:Direct Server CopyTo Service on the
Working with Sterling Connect:Direct page of the Sterling B2B Integrator Library.
✦ To reduce the number of instances business processes that terminate with an error because of PNODE
session limits, Sterling B2B Integrator now places business processes in a suspend queue to await
session availability. When a session count frees up, it is assigned to the oldest suspended business
process which can use the newly available session. The business process then resumes and is allowed
to try to establish a session. For more information on this workflow suspension processing feature, see
How Sessions for Business Processes Are Established on page 169.
✦ Sterling Connect:Direct Server Adapter upgrade now allows you to take advantage of the checkpoint
restart feature. This feature allows the automatic restarting of copy operations that fail in certain ways,
for example, due to network errors. The copy operation is resumed from a previously checkpointed
location rather than having to start over from the beginning of the file transfer. To implement this
feature, you must enable retry processing. For more information, see How Checkpoint Restart and
Retry Processing Works on page 172.
In earlier versions of Sterling B2B Integrator, you had to specify a retry in the business process itself.
In addition, in Sterling B2B Integrator version 5.1 and later, when a session is established the current
retry counts are reset to zero so that if the session subsequently fails, the system starts counting retries
from zero, which represents a departure from the earlier behavior.
The copy checkpoint retry feature is now governed by the same short-term and long-term retries
parameters that control retries for initial session establishment. Prior to Sterling B2B Integrator version
5.1, there were three sets of parameters related to session establishment and retry processing:
Session establishment parameters that were used only for initial session establishment . These two
fields, Number of Retry attempts for establishing a session and Interval between session
establishment attempts, were configurable in both the Sterling Connect:Direct Server Adapter and
Sterling Connect:Direct Server Begin Session Service. These parameters did not affect session
re-establishment after a session failure during COPY processing.
Short-term session retry parameters that were only used when the adapter attempted to establish a
session but there was no PNODE session available. These two fields, Number of short-term
session retry attempts and Interval between short-term session retry attempts, were configurable in
both the Sterling Connect:Direct Server Adapter and Sterling Connect:Direct Server Begin
Session Service. The server in that scenario would perform a series of delays and retries to try to
acquire a free session count. These parameters controlled the retrying of the acquisition of a
session count but had nothing to do with establishing sessions. This functionality has been made
obsolete by the workflow suspension processing feature described above. With that feature, a
business process is put in a suspend queue when there are no available sessions to await for the
next free session count.
Checkpoint-based copy-restart parameters that were used only in CopyTo and CopyFrom
processing. These two fields, Number of Retry attempts for checkpoint-based copy-restart and
Interval between Retry attempts, were configurable in only the Sterling Connect:Direct Server
Adapter.When a COPY operation failed with a 'restartable' error such as a session failure, these
parameters controlled the number of retries performed and the interval between retry attempts.
This retry count was a hard limit on the number of retries that could be done during a given
communications session regardless of whether sessions were re-established and then subsequently
lost or whether a session failed and then could not be re-established. This set of parameters is now
obsolete as a result of the enhanced copy checkpoint retry feature.
Session establishment and retry processing has been both simplified and enhanced in Sterling B2B
Integrator version 5.1. There are now two sets of parameters (short-term and long-term) instead of
three and the two sets apply throughout the session both to initial session establishment and also to
re-establishment after a failure. These two sets of parameters are configured in the Sterling
Connect:Direct Server Adapter and can be overridden in the Sterling Connect:Direct Server Begin
Session service:
Session establishment parameters, which are now the long-term session retry settings and apply
both to initial session establishment as well as to COPY steps when a session must be
re-established. When the default settings defined in the adapter configuration are overridden in the
Begin Session service, the new values are retained for the duration of the session and also apply to
any subsequent COPY steps.
Short-term session retry parameters, which now work in conjunction with the long-term session
retry parameters. The values for the short-term parameters are used first if defined, and if a session
has still not been established (or re-established) when they are exhausted, the long-term retry
values are used, if configured. If the short-term values are overridden in the Begin Session service,
the new values are retained for the duration of the session and also apply to any subsequent COPY
steps.
✦ File Allocation Retry (FAR) processing allows the Sterling Connect:Direct Server Adapter to retry a
Copy operation when one of a set of certain file allocation errors occurs in combination with a
non-zero return code. This is most useful when the Sterling Connect:Direct Server Adapter initiates a
file transfer with a remote Sterling Connect:Direct for z/OS system. This feature only affects locally
initiated (PNODE) sessions that use the Sterling Connect:Direct Server CopyTo service or CopyFrom
service. For more information, see How File Allocation Retry Processing Works on page 173.
✦ For interoperability with other Sterling Connect:Direct nodes in high-availability environmnents, the
Alternate Comm Info parameter in the Sterling Connect:Direct Server Adapter Netmap allows you to
specify a list of alternate hostnames and IP addresses that are used for Netmap checking of inbound
connection requests to the adapter. For more information, see Alternate Comm Info on page 22.
Improvements to Documentation
Throughout information related to the Sterling Connect:Direct Server Adapter and services, links to the
following information have been added to make information more accessible so you can find related
information quickly:
✦ Working with Sterling Connect:Direct page of the Sterling B2B Integrator Library (to access the main
webpage listing Sterling Connect:Direct Server Adapter-related information)
✦ Sterling B2B Integrator documentation library (to access information about the general Sterling B2B
Integrator product that the Sterling Connect:Direct Server Adapter and related services are part of)
✦ Sterling Connect:Direct Process Language Web Site (to access the MFT website for information on
Sterling Connect:Direct processes and how to write them to communicate with Sterling B2B
Integrator)
✦ Retrieving a File from a Sterling B2B Integrator Mailbox to Sterling Connect:Direct for z/OS
✦ Retrieving a File from a Sterling B2B Integrator Mailbox to Sterling Connect:Direct for Microsoft
Windows
✦ Retrieving a File from a Sterling B2B Integrator Mailbox to Sterling Connect:Direct for UNIX
✦ Retrieving a File from a Sterling B2B Integrator Mailbox to Sterling Connect:Direct for HP NonStop
✦ Retrieving a File from a Sterling B2B Integrator Mailbox to Sterling Connect:Direct for i5/OS
✦ Submitting a Sterling B2B Integrator Business Process from Sterling Connect:Direct for z/OS
✦ Submitting a Sterling B2B Integrator Business Process from Sterling Connect:Direct for UNIX
✦ Submitting a Sterling B2B Integrator Business Process from Sterling Connect:Direct for Microsoft
Windows
✦ Submitting a Sterling B2B Integrator Business Process from Sterling Connect:Direct for HP NonStop
✦ Submitting a Sterling B2B Integrator Business Process from Sterling Connect:Direct for i5/OS
Note: In Sterling Connect:Direct Server Begin Session Service, the Using Obscured Password field was added
and the related business process example was enhanced.
As noted in General Enhancements on page 9, several enhancements in Sterling B2B Integrator version 5.2
are focused on making it easier to use the Sterling Connect:Direct Server Adapter and other related Sterling
Connect:Direct Server services. To use these products most efficiently, it is recommended that you use the
information on the Working with Sterling Connect:Direct page of the Sterling B2B Integrator Library as the
best practice. If you need to refer to information related to earlier versions of Sterling B2B Integrator, refer
to the adapter and services information Sterling B2B Integrator documentation library.
Contact Us
IBM welcomes your comments and suggestions for improvements to our product documentation. You can
submit suggestions for improvements to [email protected].
Requirements
Interoperability between Sterling B2B Integrator and Sterling Connect:Direct has the following
system requirements:
Setup Procedures
Setup Procedures
Before you can transfer files or initiate processes between Sterling Connect:Direct servers and the
Sterling Connect:Direct Server Adapter, perform the following:
✦ Create Sterling Connect:Direct and Sterling B2B Integrator User IDs on page 19
✦ Configure a Sterling B2B Integrator Netmap Entry on page 20
✦ Configure a Sterling Connect:Direct Server Adapter on page 24
✦ Add Connect:Direct Server Adapter Node to Sterling Connect:Direct Netmap on page 28
In addition, if you will be transferring files from Sterling Connect:Direct nodes to Sterling B2B
Integrator mailboxes, follow the instructions in the procedure, Create a Sterling B2B Integrator
Mailbox on page 28.
Note: The Sterling Connect:Direct Server Adapter can be a Sterling Connect:Direct local or remote node
and can function as a PNODE or an SNODE, depending on whether or not it initiates the connection
with a remote Sterling Connect:Direct node.
The Connect:Direct Server Adapter configuration identifies the remote nodes that it can
communicate with through the use of a network map, called a netmap.
When you create a Connect:Direct Server Adapter, you must specify a netmap.
In Sterling B2B Integrator version 4.3 and earlier, the netmap is integrated with the Connect:Direct
Server Adapter configuration. In Sterling B2B Integrator version 5.0 and later, netmaps are
configured as separate objects which allows one netmap to be shared by more than one
Connect:Direct Server Adapter.
In Sterling B2B Integrator version 5.0 and later, you can configure a netmap in Sterling B2B
Integrator from the Administration menu by selecting Deployment > Adapter utilities > C:D
Netmaps.
From this menu, you can configure:
✦ Connect:Direct Nodes
✦ Connect:Direct Netmaps
✦ Connect:Direct Netmap cross-references (X-REF)
Note: Updates to the netmap are not done dynamically. If you make changes to an existing netmap,
Connect:Direct node, or Connect:Direct netmap cross-reference, you must refresh the configuration
of each Connect:Direct Server Adapter that uses the netmap by opening the adapter’s configuration
and re-saving it. In version 5.2, refreshing a Connect:Direct Server Adapter’s configuration does not
affect any active sessions. Click Save to go to the Confirm page, and then click Finish to update the
configuration. Your configuration changes to netmap members take effect immediately.
Connect:Direct Nodes
Create a Connect:Direct node definition for each remote Sterling Connect:Direct node that
communicates with the Sterling Connect:Direct Server Adapter. This is only required for nodes you
plan to connect to and for nodes that connect to the Connect:Direct Server Adapter when you have
netmap checking enabled.
Use the following procedure to create a new Connect:Direct node:
1. From the Administration menu, select Deployment > Adapter Utilities > C:D Netmaps > C:D
Nodes.
2. In the Create Nodes pane, click Go!. The Create Nodes page appears.
Connect:Direct Type the node name for the Sterling Name that will be used to identify the Sterling
Server Node Name Connect:Direct server. Connect:Direct server. Required.
Connect:Direct Type the host name or IP address for host name—Host name associated with the IP
Server Host the Sterling Connect:Direct server. address. For example:
host01 (where host01 is a machine on the local
domain)
host01.proddomain.com (fully-qualified host name)
nnn.nnn.nnn.nnn or
nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn—IP
address of a machine running Sterling Connect:Direct.
IPV6 is supported for Sterling Connect:Direct for UNIX
4.0 and Sterling Connect:Direct for Microsoft Windows
4.4 or later.
Required.
Connect:Direct Port Type the host port number for the TCP/IP port number that Sterling Connect:Direct
Sterling Connect:Direct server. monitors for requests from remote nodes. Required.
Note: If Sterling B2B Integrator is installed on a
UNIX operating system, do not select ports
in the range 1-1024. These are normally
reserved by the operating system.
Max locally initiated During testing, set this value to 100 so Maximum number of sessions initiated locally by the
(pnode) sessions that you do not run out of sessions. Connect:Direct Server Adapter that may be active at
allowed After testing, enter the estimated any time. Optional. If omitted, the value defined
number of sessions you require. by the Connect:Direct Server Adapter is used.
Otherwise, accept the default value of This setting overrides the Max locally initiated (pnode)
5. sessions allowed setting in the Connect:Direct Server
Adapter configuration.
Valid value: Any number up to 9999. Minimum value is
1. Default is 5.
For more information on session limits, see How
Sessions for Business Processes Are Established on
page 169.
Max remotely During testing, set this value to 100 so Maximum number of sessions initiated by the remote
initiated (snode) that you do not run out of sessions. node that may be active at any point of time. If
sessions allowed After testing, enter the estimated omitted, the value defined by the Connect:Direct
number of sessions you require. Server Adapter is used.
Otherwise, accept the default value of This setting overrides the Max remotely initiated
5. (snode) sessions allowed setting in the Connect:Direct
Server Adapter configuration.
Valid value: Any number up to 9999. Minimum value is
1. Default is 5.
Alternate Comm Leave this blank unless the inbound Provides support for establishing netmap-checked
Info Sterling Connect:Direct node has sessions with high-availability (especially load
more than one outgoing IP address. balancing) systems with multiple IP addresses, such
If the inbound Sterling Connect:Direct as Sterling Connect:Direct/Plex for z/OS. Use this
node has more than one outgoing IP parameter to list all IP addresses or host names that
address, specify the IP addresses or are part of the multiple IP address environment.
host names in a comma-delimited list For Sterling Connect:Direct/Plex, this list should
as shown in the Description. include the address of each Sterling
Connect:Direct/Server with a different IP address from
the Sterling Connect:Direct/Plex Manager.
If a remote node has more than one outgoing IP
address (as in a load balancing environment), specify
all of the remote node’s possible outgoing addresses
in the Alternate Comm Info field so that those outgoing
IP addresses are contained in the local node’s netmap
entry for that remote node. This configuration allows
netmap checking to succeed when the remote node
connects to the local node using any of the possible
outgoing IP addresses specified.
Valid format: hostname1/IP address, hostname2/IP
address, hostname3/IP address (maximum length is
2048 characters)
host name—Host name associated with the IP
address. For example:
host01 (where host01 is a machine on the local
domain)
host01.proddomain.com (fully-qualified host name)
nnn.nnn.nnn.nnn or
nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn:nnnn—IP
address of a machine running Sterling Connect:Direct
IPV6 is supported for Sterling Connect:Direct for UNIX
4.0 and Sterling Connect:Direct for Microsoft Windows
4.4 or later.
Secure+ Option Accept the default setting (Disabled) Valid if Netmap Override=Yes at the Connect:Direct
until you start using Sterling Server Adapter. Indicate if you want to disable or
Connect:Direct Secure Plus. enable encryption. Required.
Files are not encrypted during copy Valid values are:
operations. Disabled (default)
Enabled
Connect:Direct Netmaps
Once you have defined at least one Connect:Direct node you want to use, you can create a netmap.
When you configure a Connect:Direct Server Adapter, you must specify the netmap you want to
use rather than the individual Connect:Direct nodes you want to communicate with. The individual
Connect:Direct nodes are associated with netmaps with cross references. This arrangement is very
flexible and allows you to:
✦ Define each Connect:Direct node one time no matter how many Connect:Direct Server
Adapters you have.
✦ Use the same netmap for multiple Connect:Direct Server Adapters.
✦ Create specialized netmaps for different Connect:Direct Server Adapters.
Use the following procedure to create a new Connect:Direct netmap:
1. From the C:D Netmaps menu, select C:D Netmaps. The C:D Netmaps page appears.
2. In the Create New Netmap pane, click Go!. The Create Netmap page appears.
Netmap Name Type the Connect:Direct netmap Netmap names consist of alphanumeric, dollar ($), dot
name. (.), underscore (_), and dash (–) characters. The
maximum length is 64 characters. Required.
Note: If you maintain multiple Connect:Direct
Server Adapters, you can use the same
name for the netmap and Connect:Direct
Server Adapter for easier administration.
C:D Netmap Name Select the Connect:Direct netmap Select the Connect:Direct Netmap name. Required.
name that you created in
Connect:Direct Netmaps on page
23.
Note: To enable session establishment retry processing, the value specified for either the number of
long-term or short-term retry attempts must be greater than 0. Both of these adapter-level
settings can be overridden by values specified for in the Connect:Direct Server Begin Session
service for a particular business process.
Note: To enable copy restart processing, session establishment retry processing must be enabled. You
must also configure the Checkpoint Interval in the Connect:Direct Server Adapter CopyTo or
CopyFrom service in your business process. For additional information, see How Checkpoint
Restart and Retry Processing Works on page 172.
Caution: When you configure how you want retry processing to work, note that the short-term retry
interval is configured in seconds rather than in minutes used for the long-term retry interval.
For additional information, see How Checkpoint Restart and Retry Processing Works on
page 172.
Connect:Direct Type the node name to use to Maximum 16 characters. This node name must match
Server Node Name identify this Connect:Direct Server the Connect:Direct netmap entry for the Connect:Direct
Adapter. Best practice is to use the Server Adapter. Required.
same value as the Name field.
Connect:Direct Type the listening port number for TCP/IP port number that Connect:Direct Server Adapter
Server Port the Connect:Direct Server Adapter. monitors for requests from remote nodes. Required.
Make sure you select a port number Note: If your application is installed on a UNIX
that is not in use by another operating system, do not select ports in the
application. range 1-1024. These are normally reserved
by the operating system.
Max locally initiated During testing, you may want to set Maximum number of sessions initiated locally by the
(pnode) sessions this value to a high number, such as Connect:Direct Server Adapter that may be active at
allowed 100, so that you do not run out of any point in time. Required.
sessions. May be overridden at the node level. If a node-level
After testing, enter the estimated value is configured, the effective session limit is the
number of sessions you require. smaller of two values: the limit for the adapter and the
Otherwise, accept the default value session limit for the remote node.
of 5. Valid value: Any number through 9999. Minimum value
If you need to specify session limits is 1. Default is 5.
for each node, set this value at the For more information on session limits, see How
highest anticipated number of total, Sessions for Business Processes Are Established on
locally initiated sessions and then page 169.
specify node limits in the netmap.
Max remotely During testing, you may want to set Maximum number of sessions initiated by all remote
initiated (snode) this value to a high number, such as nodes that may be active at any point in time.
sessions allowed 100, so that you do not run out of Required.
sessions. May be overridden at the node level. If a node-level
After testing, enter the estimated value is configured, the effective session limit is the
number of sessions you required. smaller of two values: the limit for the adapter and the
Otherwise, accept the default value session limit for the remote node.
of 5. Valid value: Any number through 9999. Minimum value
If you need to specify session limits is 1. Default is 5.
for each node, set this value at the
highest anticipated number of total,
remotely initiated sessions and then
specify node limits in the netmap.
NetMap Check For testing purposes, you may find Whether the node netmap should be checked to
it convenient to select the default authorize sessions. Required values are:
(No). After testing, select the value
Check both node name and IP address—Searches
that best serves your network
the Connect:Direct Server Adapter network map for
security requirements.
an entry corresponding to the node name of the
remote client. If one exists, the IP address is
obtained and compared to the IP address of the
remote node making the request.
Check node name only—Searches the
Connect:Direct Server Adapter network map for an
entry corresponding to the node name of the remote
client.
No (default)—Disables netmap validation.
Number of Valid value: Any number up through Specifies the maximum number of short-term attempts
short-term session 9999. Default is 0. Required. for creating a session with a Sterling Connect:Direct
retry attempts Retry activity is logged (if logging node or for re-establishing a session after a session
enabled). failure during COPY processing (both CopyTo and
CopyFrom). This setting can be overridden by the value
For more information on retry
specified for ShortTermMaxRetries in the
processing, see Session
Connect:Direct Server Begin Session service.
Establishment and Process
Recovery. Note: The counter for the number of short-term
session retry attempts is reset to zero when a
session is successfully reestablished.
Interval between Valid value: Any number through Specifies the amount of time, in seconds, to wait
short-term session 99999999. Default is 5. Required. between short-term session establishment and
attempts (seconds) re-establishment attempts. This setting can be
overridden by the value specified for
ShortTermRetryInterval in the Connect Direct Server
Begin Session service.
This parameter performs successive retries within a
shorter period of time than is available with the Interval
between session establishment attempts (minutes)
settings.
Number of Valid value: Any number up to 9999. Specifies the maximum number of long-term attempts
long-term session Default is 0. Required. for creating a session with a Sterling Connect:Direct
retry attempts Retry activity is logged (if logging node or for re-establishing a session after a session
enabled). failure during COPY processing (both CopyTo and
CopyFrom). This setting can be overridden by the value
specified for BeginSessionMaxRetries in the
Connect:Direct Server Begin Session service.
Note: The counter for the number of long-term
session retry attempts is reset to zero when a
session is successfully reestablished.
Interval between Any number through 99999999. Specifies the time, in minutes, to wait between long-term
long-term session Required. Default is 1. session establishment and re-establishment attempts.
attempts (minutes) This setting can be overridden by the value specified for
BeginSessionRetryInterval in the Connect Direct Server
Begin Session service.
Encryption using Select the default setting (Disabled) Whether Sterling Connect:Direct Secure Plus is
Secure+ until you start using Sterling enabled. Required. Valid values are Enabled and
Connect:Direct Secure Plus. Disabled. Default is Disabled.
Sterling Connect:Direct Secure Plus must be installed
on your system. In addition, you must have the required
certificates for implementing Sterling Connect:Direct
Secure Plus. For information, see the Sterling
Connect:Direct documentation for the platform you are
using.
5. On the Confirm page, review your configuration settings, select Enable Service for Business
Processes and click Finish.
This will complete the Connect:Direct Server Adapter configuration and start the adapter.
Parameter Value
Operating System The operating system for your Sterling B2B Integrator
system. Specify UNIX.
to Copy a File to a Sterling Connect:Direct for i5/OS Node on page 130 and Use Sterling B2B
Integrator to Copy a File from Sterling Connect:Direct on page 132.
Setting Up a Mailbox
Note: You do not create a virtual root for your mailbox in this simple procedure. To set up a mailbox
hierarchy using virtual roots, refer to the Sterling B2B Integrator online documentation.
Use the following procedure to create and configure the Sterling B2B Integrator mailbox:
1. Log in to Sterling B2B Integrator.
2. From the Deployment menu, select Mailboxes > Configuration.
3. On the Mailbox Configuration page, click Go! in the Create a new Mailbox pane.
4. On the Mailbox Name page, highlight the forward-slash in the Select pane.
Note: If you are required to specify a virtual root for your mailbox, highlight the mailbox or mailbox
path in the Select pane for your virtual root.
Connect:Direct
Server Adapter destination Mailbox
Sterling le file
ce fi
Connect:Direct sour (SNODE)
Server
Use the following workflow to copy a file from a Sterling Connect:Direct server to a Sterling B2B
Integrator mailbox:
✦ Create Your Sterling Connect:Direct Process on page 32
✦ Submit and Monitor Your Sterling Connect:Direct Process on page 32
Note: It is assumed that you have already set up the Sterling B2B Integrator mailbox to which the
destination file is being copied. For more information, see Create a Sterling B2B Integrator Mailbox
on page 28.
COPY2MB PROCESS
SNODE=yourCDSANode
SNODEID=(yourUserID,yourPassword)
STEP1 COPY
FROM (
FILE=yourSourceFile
)
TO (
FILE=/mailbox/yourMailbox/targetdocName
DISP=RPL
)
PEND
This Sterling Connect:Direct process copies yourSourceFile from your Sterling Connect:Direct
server to the Sterling Connect:Direct Server Adapter, yourCDSANode, which passes the file in the
Sterling B2B Integrator mailbox, yourMailbox. The SNODEID, yourUserID, is your Sterling B2B
Integrator User ID. There are three parts to the destination FILE name in this Copy step:
✦ /mailbox/ is a reserved word and signals to Sterling B2B Integrator that you are copying to a
Mailbox.
✦ yourMailbox includes the name of your Sterling B2B Integrator Mailbox.
✦ targetdocName is the document that is passed to your mailbox by the Connect:Direct Server
Adapter. This document is stored in the mailbox. This document can be retrieved by an FTP
client, business process or another Sterling Connect:Direct process.
Note: Refer to Sterling B2B Integrator-Connect:Direct Server Adapter Examples on the Sterling
Connect:Direct Process Language Web Site to see several examples involving transferring files
from a variety of Sterling Connect:Direct platforms to a Sterling B2B Integrator mailbox.
If the Sterling Connect:Direct process is successful, the Select Statistics detail will report the
following:
Attribute Value
Message ID SCPA000I
If the Sterling Connect:Direct process is not successful, refer to Troubleshooting on page 175.
Note: You can also monitor your Sterling Connect:Direct process from the Business Process menu by
navigating to Monitor > Advanced Search > Documents or Monitor > Advanced Search >
Communication Sessions.
Connect:Direct
Server Adapter destination
Business Process
Sterling le file
ce fi
Connect:Direct sour (SNODE)
Server
Use the following workflow to copy a file from Sterling Connect:Direct to a Sterling B2B Integrator
business process:
✦ Create a Sterling B2B Integrator Business Process on page 36
✦ Check Your Business Process into Sterling B2B Integrator on page 37
✦ Create Your Sterling Connect:Direct Process on page 38
✦ Submit and Monitor Your Sterling Connect:Direct Process on page 39
All business processes begin with a Start icon and end with an End icon. In this business
process, the Get Documentation Information Service provides information about the primary
document.
8. Configure the Get Document Information Service using the following procedure:
a. Double-click the Get Document Information Service icon. This opens the Service Editor
window.
b. In the Service Editor-Get Documentation Information Service window, select
GetDocumentInfoService from the Config drop-down list.
In this step you specify the pre-defined GetDocumentInfoService configuration for the Get
Document Information Service. You can override configuration values in the Service Editor.
9. From the File menu, select Save. In the Validate dialog box, click Yes to validate the business
process.
10. On the Save dialog box, type the business process file name in the File Name box and click
Save.
Remember where you save this file.
Note: To see a sample business process, refer to Use Sterling Connect:Direct to Copy a File to Sterling
B2B Integrator on page 118.
Note: The Sterling B2B Integrator administrator must assign your Sterling B2B Integrator User ID
permission to run this business process.
COPY2SI PROCESS
SNODE=yourCDSANode
SNODEID=(yourUserID,yourPassword)
STEP1 COPY
FROM (
FILE=yourSourceFile
)
TO (
FILE=/businessprocess/yourBusinessProcess/targetdocName
DISP=RPL
)
PEND
This Sterling Connect:Direct process copies yourSourceFile from your Sterling Connect:Direct
server to the Sterling Connect:Direct Server Adapter, yourCDSANode, which invokes the business
process, yourBusinessProcess. The SNODEID, yourUserID, is your Sterling B2B Integrator User
ID. There are three parts to the destination FILE name in this Copy step:
✦ /businessprocess/ is a reserved word and signals to Sterling B2B Integrator that you are
copying to a business process.
✦ yourBusinessProcess is the name of the Sterling B2B Integrator business process that the
Connect:Direct Server Adapter invokes.
✦ targetdocName is the name of the document that is passed to the business process by the
Connect:Direct Server Adapter. This document becomes the Primary Document in the
yourBusinessProcess business process. The primary document is the document that the
services in a business process act on or in relation to; this is usually the document passed to a
business process by the initiating adapter.
Sterling B2B Integrator uses a unique document ID to reference and track documents as they
flow through the application. The document ID is assigned by Sterling B2B Integrator. The
business process may reference a document by the document name or the document ID,
depending on the design of the business process.
Attribute Value
Message ID SCPA000I
If the Sterling Connect:Direct process is not successful, refer to Troubleshooting on page 175.
2. In the Search Using Business Process Name pane, select yourBusinessProcess in the Business
Processes list and click Go!.
Label Description
Status Status of the business process—a green traffic light signals a successful execution
3. Click the ID number to see details about the business process execution.
Label Description
Service The Sterling B2B Integrator service name used in the step
The Process Data page displays process data for the business process. The data is presented in
XML format as shown:
In this example, the Get Document Information Service puts information about the Primary
Document, such as the BodyName and BodyLength, into process data.
Note: You can also monitor your business processes from the Business Process menu by navigating to
Monitor > Advanced Search > Documents or Monitor > Advanced Search > Communication
Sessions.
Connect:Direct 2. Invoke BP
Server Adapter
DSA 3. Send file Business Process
Sterling ec t to C
onn (SNODE)
Connect:Direct 1. C
Server file
opy
4. C
Use the following workflow to pull a file from Sterling B2B Integrator to a Sterling Connect:Direct
server:
✦ Configure a File System Adapter on page 44
✦ Create a Sterling B2B Integrator Business Process on page 46
✦ Check Your Business Process into Sterling B2B Integrator on page 48
✦ Create Your Sterling Connect:Direct Process on page 49
✦ Submit and Monitor Your Sterling Connect:Direct Process on page 49
Collection folder Specify the collection folder you The name of the folder or subfolder on the same
created above. computer where Application is installed and where it
collects (or picks up) files as part of a business process. If
the path of the folder is not included as part of the name,
the folder is assumed to be in the Application working
directory.
Filename filter Specify the filter to match the file Collect only files that match a specified filter within the
you created in the collection folder collection folder. Optional.
above. Examples include:
*.txt (collects only .txt files)
*.dat (collects only .dat files)
EDI.* (collects only files named EDI with any file
extension)
EDI.txt (collects only files named EDI with a file
extension of .txt)
Note: If there are multiple files in the collection folder
and you leave this field blank, one of the
following occurs:
If the adapter is configured to start a business
process, it processes all files in the collection folder.
If the adapter is within a business process, it collects
only the first file in the folder.
Collect files from Select No for this scenario so that Whether to scan for files in subfolders of the collection
subfolders within the File System Adapter does not folder. Required.
and including the collect files from subfolders of the Valid values:
collection folder? collection folder.
Yes—Collects files in the specified folder and all
subfolders.
No—Collects files in the specified folder only.
User absolute file Select No for this scenario so that Whether to keep the absolute path name of the files
path name for the the document name does not collected when assigning the document name. Required.
document name? include the path name. Valid values:
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.
Start a business Select No for this scenario. Whether to start a business process using the File
process once files Since you use the File System System adapter after files are collected. Required.
are collected? Adapter within a business Valid values:
process, there is no need to start Yes—Starts the business process specified from the
another business process. business process drop-down list.
No—No business process will be started.
Extraction folder Select No for this scenario. The name of the folder or subfolder on the same
The File System Adapter collects computer where Application is installed and where it
a file, but does not write (extract) installs (or writes) data from the primary document as part
a file in this scenario. of a business process. If you do not include the file path
for the folder as part of the name, the folder is assumed to
be in the Application working directory. Required.
c. Click the arrow on the right side of the CD Server BP Response Service icon and drag it to
the arrow on the left side of the End icon.
10. Configure the CD Server BP Response Service using the following procedure:
a. Double-click the CD Server BP Response Service icon.
This opens the Service Editor window.
b. In the Service Editor-CD Server BP Response Service window, select
CDServerBPResponse from the Config drop-down list.
In this step you specify the pre-defined CDServerBPResponse configuration for the CD
Server BP Response Service. You can override configuration values in the Service Editor.
11. From the File menu, select Save. In the Validate dialog box, click Yes to validate the business
process.
12. On the Save dialog box, type the name of your business process in the File Name box and
click Save.
Remember where you save this file.
Note: To see a sample business process, refer to Use Sterling Connect:Direct to Retrieve a File from
Sterling B2B Integrator on page 119.
PULLFILE PROCESS
SNODE=yourCDSANode
SNODEID=(yourUserID,yourPassword)
STEP1 COPY
FROM (
FILE=/businessprocess/yourBusinessProcess/yourSourceFile
SNODE
)
TO (
FILE=targetdocName
PNODE
DISP=RPL
)
PEND
This Sterling Connect:Direct process retrieves yourSourceFile from the Sterling Connect:Direct
Server Adapter which receives the file from your business process. There are three parts to the
FROM FILE name in the Copy step:
✦ /businessprocess/ is a reserved word and signals to Sterling B2B Integrator that you are
invoking a business process.
✦ yourBusinessProcess is the name of the Sterling B2B Integrator business process that the
Connect:Direct Server Adapter invokes.
✦ targetdocName is the name of the document that is passed from the Sterling Connect:Direct
Server Adapter to your Sterling Connect:Direct node. This document is the Primary Document
in your business process.
Attribute Value
Message ID SCPA000I
Attribute Value
If the Sterling Connect:Direct process is not successful, refer to Troubleshooting on page 175.
Label Description
Status Status of the business process—a green traffic light signals a successful execution
Label Description
Service The Sterling B2B Integrator service name used in the step
4. Click the Document info link for the Connect:Direct Server Response Service.
The PrimaryDocument page displays the contents of the primary document.
5. Close the PrimaryDocument page.
Note: You can also monitor your business processes from the Business Process menu by navigating to
Monitor > Advanced Search > Documents or Monitor > Advanced Search > Communication
Sessions.
Connect:Direct
Server Adapter source file
Business Process
Sterling
ation
in
dest le
(PNODE)
Connect:Direct
Server fi
Use the following workflow to copy a file from Sterling B2B Integrator to a Sterling Connect:Direct
server:
✦ Create a Sterling B2B Integrator Business Process on page 54
✦ Check Your Business Process into Sterling B2B Integrator on page 57
✦ Submit and Monitor Your Sterling B2B Integrator Business Process on page 58
8. Configure the CD Server Begin Session Service using the following procedure:
a. Double-click the CD Server Begin Session Service icon.
The Connect:Direct Server Begin Session Service functions like the Sterling
Connect:Direct Process statement. It initiates a session on a specified remote Sterling
Connect:Direct node.
b. In the Service Editor-CD Server Begin Session Service window, select
CDServerBeginSession from the Config drop-down list. The Message To Service tab is
displayed.
In this step you specify the pre-defined CDServerBeginSession configuration for the CD
Server Begin Session Service. You can override configuration values in the Service Editor.
c. Select your Connect:Direct Server Adapter node name as the Value for
LocalCDNodeName.
d. Type the remote Sterling Connect:Direct node name as the Value for
RemoteCDNodeName.
e. Type the Sterling Connect:Direct User ID as the Value for RemoteUserId.
Note: You must add the Sterling Connect:Direct User ID to your Sterling Connect:Direct User
Authorities.
f. Type the password for the Sterling Connect:Direct User ID as the Value for
RemotePasswd.
g. Select No as the Value for UsingObscuredPasswd.
11. Click Add and add the following information to the new record:
In the Name box, type BeginSessionResults.
In the Value field, type *.
Select the Use XPATH? check box.
12. Configure the CD Server CopyTo Service using the following procedure:
a. Double-click the CD Server CopyTo Service icon. This opens the Service Editor window.
The Connect:Direct Server CopyTo Service functions like the Sterling Connect:Direct
Copy statement. It copies a file from the PNODE to the SNODE.
b. In the Service Editor-CD Server CopyTo Service window, select CDServerCopyTo from
the Config drop-down list.
In this step you specify the pre-defined CDServerCopyTo configuration to use for the CD
Server CopyTo Service. You can override configuration values in the Service Editor.
Note: To see all parameters available in the CopyTo service, see Settings for Connect:Direct
Server CopyTo Service on page 151.
13. Configure the CD Server End Session Service using the following procedure:
a. Double-click the CD Server End Session Service icon.
The Connect:Direct Server End Session Service functions like the Sterling Connect:Direct
End statement. It terminates the session with the remote Sterling Connect:Direct node. If
the Connect:Direct Server End Session does not execute, the session remains open.
b. In the Service Editor-CD Server End Session Service window, select
CDServerEndSession from the Config drop-down list.
In this step you specify the pre-defined CDServerEndSession configuration to use for the
CD Server End Session Service. You can override configuration values in the Service
Editor.
c. Type //BeginSessionResults/SessionToken/node() as the Value for SessionToken and
select the Use XPATH? box.
The SessionToken value in the CD Server End Session Service ensures that this service
closes the session initiated by the Connect:Direct Server Begin Session Service.
14. From the File menu, select Save. In the Validate dialog box, click Yes to validate the business
process.
15. On the Save dialog box, type your business process file name in the File Name box and click
Save.
Remember where you save this file.
Note: Sample Business Processes on page 117, contains the following examples involving the basic
scenario of copying a file to a remote Sterling Connect:Direct server from Sterling B2B Integrator:
✦ Use Sterling B2B Integrator to Copy a File to a Sterling Connect:Direct for z/OS Node on
page 121
✦ Use Sterling B2B Integrator to Copy a File to a Sterling Connect:Direct for Microsoft
Windows Node on page 123
✦ Use Sterling B2B Integrator to Copy a File to a Sterling Connect:Direct for UNIX Node on
page 125
✦ Use Sterling B2B Integrator to Copy a File to a Sterling Connect:Direct for HP NonStop
Node on page 127
✦ Use Sterling B2B Integrator to Copy a File to a Sterling Connect:Direct for i5/OS Node on
page 130
✦ Use Sterling B2B Integrator to Copy a File to Sterling Connect:Direct for z/OS (Advanced)
on page 145
5. Under Select an input mode for defining the new process, select Check in Business Process
created by the graphical modeling tool and click Next.
6. On the Check-in page, click Browse and navigate to your business process file that you saved
in step 15 of the previous procedure.
7. Type a short description of your business process in the Description box and click Next.
8. On the Process Levels page, select the Set onfault processing check box.
9. Set the Persistence Level to Full.
10. Set the Event Reporting Level to Full.
11. Set the Recovery Level to Auto Resume and click Next.
If Sterling B2B Integrator stops responding during a copy transaction and the recovery level is
set to Auto Resume, the business process resumes automatically at the next Sterling B2B
Integrator start up.
12. On the Deadline Settings page, click Next.
13. On the Life Span page, click Next.
14. On the Confirm page, select the Enable Business Process box.
15. Click Finish.
This is the file that the business process will copy to the Sterling Connect:Direct server.
Label Description
Status Status of the business process—a green traffic light signals a successful execution
3. Click the ID number to see details about the business process execution.
The Business Process Detail page displays the following information for each step:
Label Description
Service The Sterling B2B Integrator service name used in the step
4. Click the Status Report link for the Connect:Direct Server Primitive CopyTo Service.
The Status Report displays a short summary of the CopyTo operation including the destination
file name and number of bytes copied.
5. Click the Document info link for the Connect:Direct Server Primitive CopyTo Service.
The PrimaryDocument page displays the contents of the Primary Document.
6. Close the PrimaryDocument page.
7. From the Business Process Detail page, click the Instance Data info link for the
Connect:Direct Server Primitive CopyTo Service.
The Process Data page displays process data for the business process. The data is presented in
XML format and contains several fields and values, such as:
Remote Node—node name of the remote Sterling Connect:Direct server
Remote User—Sterling Connect:Direct User ID
Remote File Name—your destination file
8. The last step in the Business process Detail page is the CD Server End Session Service. The
Status indicates that it successfully terminates the Sterling Connect:Direct session.
Note: You can also monitor your business processes from the Business Processes menu by navigating to
Monitor > Advanced Search > Documents or Monitor > Advanced Search > Communication
Sessions.
Attribute Value
Message ID SCPA000I
If the Sterling Connect:Direct process is not successful, refer to Troubleshooting on page 175.
Connect:Direct invokes
ects Server Adapter
Sterling conn file Business Process
Connect:Direct PNODE
file
Server
SNODE
Sterling B2B
Integrator
Use the following workflow to copy a file from Sterling B2B Integrator to a Sterling Connect:Direct
server:
✦ Create a Sterling B2B Integrator Business Process on page 64
✦ Check Your Business Process into Sterling B2B Integrator on page 67
✦ Submit and Monitor Your Sterling B2B Integrator Business Process on page 68
8. Configure the Connect:Direct Server Begin Session Service using the following procedure:
a. Double-click the CD Server Begin Session Service icon.
The Connect:Direct Server Begin Session Service functions like the Sterling
Connect:Direct Process statement. It initiates a session on a specified remote Sterling
Connect:Direct node.
b. In the Service Editor-CD Server Begin Session Service window, select
CDServerBeginSession from the Config drop-down list. The Message To Service tab is
displayed.
In this step you specify the pre-defined CDServerBeginSession configuration for the CD
Server Begin Session Service. You can override configuration values in the Service Editor.
Note: To see all parameters available in the CopyFrom service, see Settings for Connect:Direct Server CopyFrom
Service on page 158.
c. Select your Connect:Direct Server Adapter node name as the Value for
LocalCDNodeName.
d. Type the remote Sterling Connect:Direct node name as the Value for
RemoteCDNodeName.
e. Type the Sterling Connect:Direct User ID as the Value for RemoteUserId.
Note: You must add the Sterling Connect:Direct User ID to your Sterling Connect:Direct User
Authorities.
f. Type the password for the Sterling Connect:Direct User ID as the Value for
RemotePasswd.
g. Select No as the Value for UsingObscuredPasswd.
12. Configure the CD Server CopyFrom Service using the following procedure:
a. Double-click the CD Server CopyFrom Service icon. This opens the Service Editor
window.
The Connect:Direct Server CopyFrom Service functions like the Sterling Connect:Direct
Copy statement. It copies a file from the SNODE to the PNODE.
b. In the Service Editor-CD Server CopyFrom Service window, select CDServerCopyFrom
from the Config drop-down list.
In this step you specify the pre-defined CDServerCopyFrom configuration to use for the
CD Server CopyFrom Service. You can override configuration values in the Service
Editor.
c. Type the source file name as the Value for RemoteFileName.
This file must reside on the file system of the Sterling Connect:Direct node.
d. Type //BeginSessionResults/SessionToken/node() as the Value for SessionToken and
select the Use XPATH? box.
The Session Token is created by the CD Server Begin Session Service and identifies the
session that is established with the remote Sterling Connect:Direct node. The
SessionToken value in the CD Server CopyFrom Service ensures that this service copies
the file using the session initiated by the CD Server Begin Session Service.
13. Configure the CD Server End Session Service using the following procedure:
a. Double-click the CD Server End Session Service icon.
The CD Server End Session Service functions like the Sterling Connect:Direct Pend
statement used on the Microsoft Windows and UNIX platforms. It terminates the session
with the remote Sterling Connect:Direct node. If the CD Server End Session does not
execute, the session remains open.
b. In the Service Editor-CD Server End Session Service window, select
CDServerEndSession from the Config drop-down list.
In this step you specify the pre-defined CDServerEndSession configuration to use for the
CD Server End Session Service. You can override configuration values in the Service
Editor.
c. Type //BeginSessionResults/SessionToken/node() as the Value for SessionToken and
select the Use XPATH? box.
The SessionToken value in the CD Server End Session Service ensures that this service
closes the session initiated by the CD Server Begin Session Service.
14. From the File menu, select Save. In the Validate dialog box, click Yes to validate the business
process.
15. On the Save dialog box, type your business process file name in the File Name box and click
Save.
Remember where you save this file.
Note: To see a sample business process, refer to Use Sterling B2B Integrator to Copy a File from Sterling
Connect:Direct on page 132.
Label Description
Status Status of the business process—a green traffic light signals a successful execution
3. Click the ID number to see details about the business process execution.
The Business Process Detail page displays the following information for each step:
Label Description
Service The Sterling B2B Integrator service name used in the step
4. Click the Status Report link for the Connect:Direct Server Primitive CopyFrom Service.
The Status Report displays a short summary of the CopyFrom operation including the source
file name and number of bytes copied.
5. Click the Document info link for the Connect:Direct Server Primitive CopyFrom Service.
The PrimaryDocument page displays the contents of the Primary Document.
6. Close the PrimaryDocument page.
7. From the Business Process Detail page, click the Instance Data info link for the
Connect:Direct Server Primitive CopyFrom Service.
The Process Data page displays process data for the business process. The data is presented in
XML format and contains several fields and values, such as:
Remote Node—node name of the remote Sterling Connect:Direct server
Remote User—Sterling Connect:Direct User ID
Remote File Name—your source file
8. The last step in the Business process Detail page is the CD Server End Session Service. The
Status indicates that it successfully terminates the Sterling Connect:Direct session.
Note: You can also monitor your business processes from the Business Processes menu by navigating to
Monitor > Advanced Search > Documents or Monitor > Advanced Search > Communication
Sessions.
Attribute Value
Message ID SCPA000I
If the Sterling Connect:Direct process is not successful, refer to Troubleshooting on page 175.
d. Click the arrow on the right side of the OnFault Start icon and drag it to the arrow on the
left side of the CD Server End Session Service icon.
e. Click the arrow on the right side of the CD Server End Session Service icon and drag it to
the arrow on the left side of the OnFault End icon.
Note: To see a sample business process, refer to Add Error Handling to the Business Process on page 134.
8. On the Process Levels page, select the Set onfault processing check box.
9. Set the Persistence Level to Full.
10. Set the Event Reporting Level to Full.
11. Set the Recovery Level to Auto Resume and click Next.
If Sterling B2B Integrator stops responding during a copy transaction and the recovery level is
set to Auto Resume, the business process resumes automatically at the next Sterling B2B
Integrator start up.
12. On the Deadline Settings page, click Next.
13. On the Life Span page, click Next.
14. On the Set Default Version page, select the updated version of the business process.
15. On the Confirm page, select the Enable Business Process box.
16. Click Finish.
6. Click Browse and navigate to your source file on your local system and click Open.
7. Click Go! to submit your business process. The Execute Business Process page is displayed.
8. Close the Execute Business Process page.
Label Description
Status Status of the business process—a green traffic light signals a successful execution
3. Click the ID number to see details about the business process execution.
The Business Process Detail page displays the following information for each step:
Label Description
Service The Sterling B2B Integrator service name used in the step
4. Check the Status and Advanced Status for the Connect:Direct Server CopyTo Service.
The Connect:Direct Server CopyTo service generates an error and reports Check the file
permissions or path on Remote Connect:Direct.
5. The next step in the Business Process Detail is the Decision Engine Service.
This step is invoked by the error handling of the OnFault Group in the business process. The
Status for this step indicates that the Decision Engine Service is successfully able to invoke the
OnFault error handling.
6. The last step in the Business Process Detail is the Connect:Direct Server End Session Service.
The Status for this step indicates that it successfully closes the Sterling Connect:Direct
session.
Note: You can also monitor your business processes from the Business Processes menu by navigating to
Monitor > Advanced Search > Documents or Monitor > Advanced Search > Communication
Sessions.
Attribute Value
If the Sterling Connect:Direct process is not successful, refer to Troubleshooting on page 175.
Note: You can use the IBM® Sterling Certificate Wizard to generate certificate signing requests,
self-signed certificates, key certificate files and certificate chains. The online help in the
Sterling Certificate Wizard product will step you through the process.
✦ You have configured the local and remote nodes for Sterling Connect:Direct Secure Plus
following the instructions specific to the platform you are using. After submitting the
parameters file and preparing Sterling Connect:Direct for operation, you have validated and
tested connections between you and your business partners to establish secure
communications and then tested to make sure you can change your security defaults for a
session.
Use the following workflow to implement Sterling Connect:Direct Secure Plus:
✦ Configure Sterling Connect:Direct Secure Plus in Sterling B2B Integrator on page 80
✦ Copy a File Using Sterling Connect:Direct Secure Plus on page 83
✦ Copy a File Using Your Sterling B2B Integrator Business Process on page 84
Note: You can use a self-signed certificate that you create in Sterling B2B Integrator or Sterling
Certificate Wizard as your system certificate for testing purposes. Self-signed certificates
are not recommended for production use.
1. From the Trading Partner menu, select Digital Certificates > System.
2. In the Check in pane, click Go! for Key Certificate.
3. On the Key Certificate Data page, type a descriptive name in the Certificate Name box.
4. In the Private Key Password box, type the passphrase associated with the Sterling
Connect:Direct Server Adapter private key.
You created this passphrase when you generated your CSR.
5. Click Browse and navigate to the private key file.
6. On the Choose File dialog box, click Open. The dialog box closes and you return to the Key
Certificate Data page.
7. Click Next to advance to the Validate When Used page.
8. Click Next to advance to the Confirm Page.
9. Click Finish.
Note: If you plan to configure different Sterling Connect:Direct Secure Plus settings for individual
nodes, you might need to check in additional CA certificates and Key Certificate files.
Enable Netmap Node Select Yes for this scenario. If Yes, specifies that remote node netmap security settings
Override Configure Sterling override the adapter security settings. Required. Valid values
Connect:Direct Secure Plus are Yes and No. Default is No.
at the adapter level and allow
node level settings to
override the adapter Sterling
Connect:Direct Secure Plus
settings.
CA Certificates Select the CA certificate you Drop-down menu that contains a list of trusted Certificate
checked in above. Authority public certificates. Only displayed if "Encryption
This is the CA root certificate using Secure+" is enabled. Required if Encryption using
for the Sterling Secure+ is enabled. Valid values are all CA certificates in this
Connect:Direct server. installation of your application.
System Certificate Select the System certificate List of private keys and public certificates signed by the
you checked in above. trading partner trusted certificate authority. This represents
This is the certificate for the the certificate for the local node (this adapter). Only displayed
Connect:Direct Server if Encryption using Secure+ is enabled. Required if
Adapter node. Encryption using Secure+ is enabled. Valid values are all
system certificates in this installation of your application.
Certificate Common If you want to verify the Value to be compared with the Common Name (CN) field
Name Common Name of the from the remote node's certificate during TLS/SSL
Sterling Connect:Direct CA handshake in order to enhance certificate authentication.
certificate, specify it here. Only displayed if Encryption using Secure+ is enabled. May
This feature is only available be overridden at the node level.
if you use signed certificates. Note: To see the actual CNs being compared during the
Coordinate this with the handshake, set the Perimeter Services logging level to ALL.
remote Sterling
Connect:Direct administrator.
Cipher Suites Select which cipher suites Indicates cipher suites available to support varying
you wish to use. encryption levels. Multiple selections allowed. Selections can
Coordinate this list with the be rank ordered. Only displayed if "Encryption using
remote Sterling Secure+" is enabled. Required if "Encryption using Secure+"
Connect:Direct administrator. is enabled. Valid values are all available cipher suites in this
installation of your application.
Best practice is to list cipher
suites in strongest to weakest
order.
SSL or TLS Select SSL or TLS. Indicates if Sterling Connect:Direct Secure Plus is enabled
Coordinate this choice with using SSL or TLS. Only displayed if "Encryption using
the remote Sterling Secure+" is enabled. Required if "Encryption using Secure+"
Connect:Direct administrator. is enabled. Valid values are SSL and TLS. Default is SSL.
Require Client Select Yes or No for client Indicates whether authentication occurs at the client level.
Authentication authentication. Valid values are:
Coordinate this choice with Yes
the Sterling Connect:Direct No
administrator.
Modify the Netmap Node Configuration to Override Sterling Connect:Direct Secure Plus
Configuration (Optional)
At this point, Sterling Connect:Direct Secure Plus is configured for the Connect:Direct Server
Adapter at the adapter level. All remote nodes will use these Sterling Connect:Direct Secure Plus
settings. If you want to override any or all of the adapter level Sterling Connect:Direct Secure Plus
settings for a remote node, modify the Sterling Connect:Direct Secure Plus node settings for that
node using the following procedure:
Note: You must select Enable Netmap Node Override for the Connect:Direct Server Adapter to use this
option.
1. From the Deployment menu, select Adapter Utilities > C:D Netmaps > C:D Nodes.
2. To select an existing Connect:Direct Node, use the Search or List pane to display and select
the Node, and click Go!.
3. Select edit next to the node name on the C:D Nodes page.
4. Do one of the following:
To disable Sterling Connect:Direct Secure Plus encryption for this node, select the
Secure+ Option Disabled button.
To modify Sterling Connect:Direct Secure Plus encryption for this node, select the
Secure+ Option Enabled button, and click Next. Edit the fields you want to override using
information in the following table:
CA Certificates Select the CA root certificate Drop-down menu that contains a list of trusted Certificate
you checked in above for the Authority public certificates. Only displayed if "Encryption
Sterling Connect:Direct using Secure+" is enabled. Required if Encryption using
server. Secure+ is enabled. Valid values are all CA certificates in this
installation of your application.
System Certificate Select the System certificate List of private keys and public certificates signed by the
you checked in above for the trading partner trusted certificate authority. This represents
Connect:Direct Server the certificate for the local node (this adapter). Only displayed
Adapter node. if Encryption using Secure+ is enabled. Required if
Encryption using Secure+ is enabled. Valid values are all
system certificates in this installation of your application.
Certificate Common If you want to verify the Value to be compared with the Common Name (CN) field
Name Common Name of the from the remote node's certificate during TLS/SSL
Sterling Connect:Direct CA handshake in order to enhance certificate authentication.
certificate, specify it here. Only displayed if Encryption using Secure+ is enabled. May
This feature is only available be overridden at the node level.
if you use signed certificates. Note: To see the actual CNs being compared during the
Coordinate this with the handshake, set the Perimeter Services logging level to ALL.
remote Sterling
Connect:Direct administrator.
Cipher Suites Select which cipher suites Indicates cipher suites available to support varying
you wish to use. encryption levels. Multiple selections allowed. Selections can
Coordinate this list with the be rank ordered. Only displayed if "Encryption using
remote Sterling Secure+" is enabled. Required if "Encryption using Secure+"
Connect:Direct administrator. is enabled. Valid values are all available cipher suites in this
installation of your application.
Best practice is to list cipher
suites in strongest to weakest
order.
SSL or TLS Select SSL or TLS. Indicates if Sterling Connect:Direct Secure Plus is enabled
Coordinate this choice with using SSL or TLS. Only displayed if "Encryption using
the remote Sterling Secure+" is enabled. Required if "Encryption using Secure+"
Connect:Direct administrator. is enabled. Valid values are SSL and TLS. Default is SSL.
Require Client Select Yes or No for client Indicates whether authentication occurs at the client level.
Authentication authentication. Valid values are:
Coordinate this choice with Yes
the Sterling Connect:Direct No
administrator.
Submit your existing Sterling Connect:Direct process to copy a file to Sterling B2B Integrator. You
can monitor the process results from Sterling Connect:Direct or Sterling B2B Integrator as before.
Use the following workflow to submit a Sterling Connect:Direct process with Sterling B2B
Integrator:
✦ Create Sterling Connect:Direct Process on page 85
✦ Check Out the Business Process on page 86
✦ Edit the Business Process on page 86
✦ Check In Your Business Process on page 88
✦ Submit and Monitor Your Sterling B2B Integrator Business Process on page 88
COPY2ZOS PROCESS
SNODE=RemoteNode
STEP1 COPY
FROM (
FILE=sourceFile
)
TO (
FILE=destinationFile
DISP=RPL
)
PEND
Note: To see a sample business process, refer to Use Sterling B2B Integrator to Submit a Sterling
Connect:Direct Process on page 136.
Label Description
Status Status of the business process—a green traffic light signals a successful execution
Label Description
Service The Sterling B2B Integrator service name used in the step
4. The Status for the Connect:Direct Server Submit Service is Success. This indicates only that
the Sterling Connect:Direct process was successfully submitted. It does not provide a
completion status for the process. You must use the Sterling Connect:Direct Statistics to verify
completion status for the process.
5. The last step in the Business Process Detail is the Connect:Direct Server End Session Service.
The Status for this step indicates that it successfully closes the Sterling Connect:Direct
session.
Note: You can also monitor your business processes from the Business Processes menu by navigating to
Monitor > Advanced Search > Documents or Monitor > Advanced Search > Communication
Sessions.
Attribute Value
If the Sterling Connect:Direct process completes successfully, the Select Statistics will indicate this
and show information similar to the following:
Attribute Value
Use the following workflow to start a Sterling Connect:Direct Run Job from Sterling B2B
Integrator:
✦ Check Out the Business Process on page 93
✦ Edit the Business Process on page 94
✦ Check In Your Business Process on page 95
✦ Submit and Monitor Your Sterling B2B Integrator Business Process on page 96
5. On the Source Manager page, click check out for the version of the business process you want
to check out.
6. Click OK in the dialog box to lock the file for editing.
7. In the File Download dialog box, click Save to save a copy of the business process to your
local file system.
8. In the Save As dialog box, navigate to the directory where you want to save the business
process, type the business process file name in the File name box, and click Save.
7. Configure the CD Server Run Job Service using the following procedure:
a. Double-click the CD Server Run Job Service icon. This opens the Service Editor window.
The Connect:Direct Server Run Job Service acts like a Run Job statement in a Sterling
Connect:Direct process. Use this service to start a Sterling Connect:Direct Run Job on a
remote Sterling Connect:Direct server.
b. In the Service Editor-CD Server Run Job Service window, select CDServerRunJob from
the Config drop-down list.
In this step you specify the pre-defined CDServerRunJob configuration to use for the CD
Server Run Job Service. You can override configuration values in the Service Editor.
c. Type pgm(path/filename) desktop(yes) as the Value for Sysopts, where path is the full
directory path and filename is the file name of the program or script you wish to run in the
Run Job.
d. Type //BeginSessionResults/SessionToken/node() as the Value for SessionToken and
select the Use XPATH? box.
The SessionToken value in the CD Server Run Job Service ensures that this service starts
the Sterling Connect:Direct Run Job using the session initiated by the CD Server Begin
Session Service.
8. From the File menu, select Save. In the Validate dialog box, click Yes to validate the business
process.
9. On the Save dialog box, type the business process name in the File Name box and click Save.
Remember where you save this file.
Note: To see a sample business process, refer to Use Sterling B2B Integrator to Start a Sterling
Connect:Direct Run Job on page 138.
5. On the Source Manager page, select Go! to Check in an updated definition for this business
process.
6. On the Process Definition Check-in page, click Browse and navigate to the business process
file that you saved in step 9 of the previous procedure.
7. Type a short description of your business process in the Description box and click Next.
8. On the Process Levels page, select the Set onfault processing check box.
9. Set the Persistence Level to Full.
10. Set the Event Reporting Level to Full.
11. Set the Recovery Level to Auto Resume and click Next.
If Sterling B2B Integrator stops responding during a copy transaction and the recovery level is
set to Auto Resume, the business process resumes automatically at the next Sterling B2B
Integrator start up.
12. On the Deadline Settings page, click Next.
13. On the Life Span page, click Next.
14. On the Set Default Version page, select the updated version of the business process.
15. On the Confirm page, select the Enable Business Process box.
16. Click Finish.
6. Click Browse and navigate to the source file on your local system and click Open.
Label Description
Status Status of the business process—a green traffic light signals a successful execution
3. Click the ID number to see details about the business process execution.
The Business Process Detail page displays the following information for each step:
Label Description
Service The Sterling B2B Integrator service name used in the step
4. The Status for the Connect:Direct Server Run Job Service is Success. This indicates only that
the Sterling Connect:Direct Run Job successfully started. It does not provide a completion
status for the application invoked by the Run Job.
5. The last step in the Business Process Detail is the Connect:Direct Server End Session Service.
The Status for this step indicates that it successfully closes the Sterling Connect:Direct
session.
Note: You can also monitor your business processes from the Business Processes menu by navigating to
Monitor > Advanced Search > Documents or Monitor > Advanced Search > Communication
Sessions.
If the Sterling Connect:Direct Run Job starts successfully, the Select Statistics detail will indicate
this and show information similar to the following:
Attribute Value
If the Sterling Connect:Direct process is not successful, refer to Troubleshooting on page 175.
Use the following workflow to start a Sterling Connect:Direct Run Task from Sterling B2B
Integrator:
✦ Check Out the Business Process on page 101
✦ Edit the Business Process on page 102
✦ Check In Your Business Process on page 103
✦ Submit and Monitor Your Sterling B2B Integrator Business Process on page 104
5. On the Source Manager page, click check out for the version of the business process you want
to check out.
6. Click OK in the dialog box to lock the file for editing.
7. In the File Download dialog box, click Save to save a copy of the business process to your
local file system.
8. In the Save As dialog box, navigate to the directory where you want to save the business
process, type the business process file name in the File name box, and click Save.
7. Configure the CD Server Run Task Service using the following procedure:
a. Double-click the CD Server Run Task Service icon. This opens the Service Editor
window.
The Connect:Direct Server Run Task Service acts like a Run Task statement in a Sterling
Connect:Direct process. Use this service to start a Sterling Connect:Direct Run Task on a
remote Sterling Connect:Direct server and wait for it to complete before executing the
next service in a business process.
b. In the Service Editor-CD Server Run Task Service window, select CDServerRunTask
from the Config drop-down list.
In this step you specify the pre-defined CDServerRunTask configuration to use for the CD
Server Run Task Service. You can override configuration values in the Service Editor.
c. Type pgm(path/filename) desktop(yes) as the Value for SystemOpts, where path is the full
directory path and filename is the file name of the program or script you wish to run in the
Run Task. (SystemOpts is the equivalent of Sysopts.)
Note: Do not enclose the value specified for SystemOpts in double quotes.
Note: To see a sample business process, refer to Use Sterling B2B Integrator to Start a Sterling
Connect:Direct Run Task on page 140. To see a more complex example involving Sterling
Connect:Direct for z/OS, see Use Sterling B2B Integrator to Copy a File to Sterling Connect:Direct
for z/OS (Advanced) on page 145.
6. Click Browse and navigate to the source file on your local system and click Open.
7. Click Go! to submit the business process. The Execute Business Process page is displayed.
8. Close the Execute Business Process page.
Label Description
Status Status of the business process—a green traffic light signals a successful execution
3. Click the ID number to see details about the business process execution.
The Business Process Detail page displays the following information for each step:
Label Description
Service The Sterling B2B Integrator service name used in the step
The Status for the Connect:Direct Server Run Task Service is not reported until the application
or script completes. The Business Process Detail screen shows that the Connect:Direct Server
Run Task Service is In progress...
4. When you close the application or script, The Connect:Direct Server Run Task Service
completes and the last step in the business process, the Connect:Direct Server End Session
Service, terminates the Sterling Connect:Direct session.
Note: You can also monitor your business processes from the Business Processes menu by navigating to
Monitor > Advanced Search > Documents or Monitor > Advanced Search > Communication
Sessions.
If the Sterling Connect:Direct Run Task completes successfully, the Select Statistics detail will
indicate this and show information similar to the following:
Attribute Value
If the Sterling Connect:Direct process is not successful, refer to Troubleshooting on page 175.
Use the following workflow to hide the Sterling Connect:Direct password in the business process:
✦ Configure the Obscure Data - Process Data Values Service on page 109
✦ Check Out the Business Process on page 110
✦ Edit the Business Process on page 110
✦ Check In Your Business Process on page 112
✦ Submit and Monitor Your Sterling B2B Integrator Business Process on page 112
Note: Alternately, you can navigate to Obscure Data - Process Data Values by clicking one of the
navigation buttons next to the Service Type box.
7. On the Parameters page, in the first Parameter Name box, type the Sterling Connect:Direct
User ID.
8. In the first Parameter Value box, type the password for the Sterling Connect:Direct User ID
and click Next.
9. On the Confirm page, click Finish.
5. Drag and drop the Obscure Data - Process Data Values icon from the Connect:Direct stencil
into the Business Process window.
6. To arrange and link the icons:
a. Click the arrow between the start icon and the CD Server Begin Session Service icon and
press Delete to remove it.
b. Place the Obscure Data - Process Data Values icon between the start icon and the CD
Server Begin Session Service icon.
c. Click the arrow on the right side of the start icon and drag it to the arrow on the left side of
the Obscure Data - Process Data Values icon.
d. Click the arrow on the right side of the Obscure Data - Process Data Values icon and drag
it to the arrow on the left side of the CD Server Begin Session Service icon.
7. Configure the Obscure Data - Process Data Values using the following procedure:
a. Double-click the Obscure Data - Process Data Values icon. This opens the Service Editor
window.
b. In the Service Editor-Obscure Data - Process Data Values window, select
CDClientObscureParameter from the Config drop-down list.
In this step you specify the CDClientObscureParameter configuration to use for the
Obscure Data - Process Data Values. You can override configuration values in the Service
Editor.
8. Edit the CD Server Begin Session Service using the following procedure:
a. Double-click the CD Server Begin Session Service icon.
b. Select Yes as the Value for UsingObscuredPasswd.
c. Type CDUserID/text( ) as the Value for the RemotePasswd and select the Use XPATH?
box. CDUserID is the Sterling Connect:Direct User ID.
9. From the File menu, select Save. In the Validate dialog box, click Yes to validate the business
process.
10. On the Save dialog box, type your business process file name in the File Name box and click
Save.
Remember where you save this file.
Note: To see a sample business process, refer to Hide the Sterling Connect:Direct Password in the
Business Process on page 142.
6. Click Browse and navigate to the source file on your local system and click Open.
Label Description
Status Status of the business process—a green traffic light signals a successful execution
Label Description
Service The Sterling B2B Integrator service name used in the step
4. The Status for the Connect:Direct Server Run Task Service is not reported until the application
or script completes. The Business Process Detail screen shows that the Connect:Direct Server
Run Task Service is In progress...
5. When you close the application or script, The Connect:Direct Server Run Task Service
completes and the last step in the business process, the Connect:Direct Server End Session
Service, terminates the Sterling Connect:Direct session.
Note: You can also monitor your business processes from the Business Processes menu by navigating to
Monitor > Advanced Search > Documents or Monitor > Advanced Search > Communication
Sessions.
If the Sterling Connect:Direct Run Task completes successfully, the Select Statistics detail will
indicate this and show information similar to the following:
Attribute Value
If the Sterling Connect:Direct process is not successful, refer to Troubleshooting on page 175.
CDSAMPLE PROCESS
SNODE=SI50
SNODEID=(myUserID,myPassword)
STEP1 COPY
FROM (
FILE=C:\orders.txt
)
TO (
FILE=/businessprocess/ReceiveFromCD/daily.txt
DISP=RPL
)
PEND
In the Sterling B2B Integrator ReceiveFromCD business process, shown in BPML, the Get
Document Information Service obtains file information about the primary document and places it
into process data. You can add additional services to this business process to perform operations
such as translating the file or copying the file to another server using FTP.
Note: The Sterling B2B Integrator Graphical Process Modeler (GPM) is used as the primary means to perform most
of the common user tasks described in the IBM Sterling B2B Integrator - Connect:Direct Server Adapter User
Guide. To see BPML source code like the example shown below, select View > Source while using the GPM.
To see the business process as depicted in the GPM user interface, select View > Graph.
</process>
CDSAMPLE PROCESS
SNODE=SI50
SNODEID=(myUserID,myPassword)
STEP1 COPY
FROM (
FILE=/businessprocess/RespondToCD/sample.txt
)
TO (
FILE=C:\orders.txt
DISP=RPL
)
PEND
In the RespondToCD business process, shown in BPML, the business process retrieves a file, passes
this file to the Connect:Direct Server Adapter, and sends the file back to the Sterling Connect:Direct
node. The business process functions much like a Sterling Connect:Direct process.
In the first operation of the RespondToCD business process, the File System Adapter collects
(reads) the daily.txt file from the Sterling B2B Integrator local file system. This file becomes the
primary document of the business process.
In the next operation of the business process, the CD Server BP Response Service passes the
primary document back to the Sterling Connect:Direct node (PNODE).
Note: The Sterling B2B Integrator Graphical Process Modeler (GPM) is used as the primary means to perform most
of the common user tasks described in the IBM Sterling B2B Integrator - Connect:Direct Server Adapter User
Guide. To see BPML source code like the example shown below, select View > Source while using the GPM.
To see the business process as depicted in the GPM user interface, select View > Graph.
</sequence>
</process>
<process name="CopyToCDMainframeNode">
<sequence>
</sequence>
</process>
Note: The Sterling B2B Integrator Graphical Process Modeler (GPM) is used as the primary means to perform most
of the common user tasks described in the IBM Sterling B2B Integrator - Connect:Direct Server Adapter User
Guide. To see BPML source code like the example shown below, select View > Source while using the GPM.
To see the business process as depicted in the GPM user interface, select View > Graph.
<process name="CopyToCDWin">
<sequence>
<process name="CopyToCDUX">
<sequence>
<process name="CopyToCDHPNonStop">
<sequence>
<process name="CopyToCDi5OS">
<sequence>
<process name="CopyFromCD">
<sequence>
</sequence>
</process>
<process name="CopyToCD">
<sequence>
<operation name="File System Adapter">
<participant name="CollectForCD"/>
<output message="FileSystemInputMessage">
<assign to="Action">FS_COLLECT</assign>
<assign to="filter">daily.txt</assign>
<assign to="collectionFolder">C:\Collection</assign>
<assign to="deleteAfterCollect">false</assign>
<assign to="." from="*"></assign>
</output>
<input message="inmsg">
<assign to="." from="*"></assign>
</input>
</operation>
<sequence>
<operation name="CD Server CopyTo Service">
<participant name="CDServerCopyTo"/>
<output message="CDServerCopyToServiceTypeInputMessage">
<assign to="RemoteFileName">cd.txt</assign>
<assign to="SessionToken"
from="//BeginSessionResults/SessionToken/node()"></assign>
<assign to="." from="*"></assign>
</output>
<input message="inmsg">
<assign to="." from="*"></assign>
</input>
</operation>
</operation>
<onFault>
<operation name="CD Server End Session Service">
<participant name="CDServerEndSession"/>
<output message="CDServerEndSessionServiceTypeInputMessage">
<assign to="SessionToken"
from="//BeginSessionResults/SessionToken/node()"></assign>
<assign to="." from="*"></assign>
</output>
<input message="inmsg">
<assign to="." from="*"></assign>
</input>
</operation>
</onFault>
</sequence>
</sequence>
</process>
<process name="CopyToCD_Submit">
<sequence>
</onFault>
</sequence>
</sequence>
</process>
<process name="CopyToCD_RunJob">
<sequence>
</onFault>
</sequence>
</sequence>
</process>
<process name="CopyToCD_RunTask">
<sequence>
</onFault>
</sequence>
</sequence>
</process>
<process name="CopyToCD_HidePassword">
<sequence>
<operation name="File System Adapter">
<participant name="CollectForCD"/>
<output message="FileSystemInputMessage">
<assign to="Action">FS_COLLECT</assign>
<assign to="filter">daily.txt</assign>
<assign to="collectionFolder">C:\Collection</assign>
<assign to="deleteAfterCollect">false</assign>
<assign to="." from="*"></assign>
</output>
<input message="inmsg">
<assign to="." from="*"></assign>
</input>
</operation>
<onFault>
<operation name="CD Server End Session Service">
<participant name="CDServerEndSession"/>
<output message="CDServerEndSessionServiceTypeInputMessage">
<assign to="SessionToken"
from="//BeginSessionResults/SessionToken/node()"></assign>
<assign to="." from="*"></assign>
</output>
<input message="inmsg">
<assign to="." from="*"></assign>
</input>
</operation>
</onFault>
</sequence>
</sequence>
</process>
Also, do not enclose the value specified for SystemOpts in double quotes.
Operation 4 uses the CD Server CopyTo Service to copy the primary document to the remote
Sterling Connect:Direct for z/OS node. The CopyTo Service allocates an SMS managed file on
z/OS with the following Remote parms:
✦ RemoteSMS—SMS parms passed to z/OS for allocation. This parm specifies that the z/OS
system allocates this file with a DATACLAS of CSGWORK, STORCLAS of BENCH,
MGMTCLAS of STANDARD, and uses kilobytes (K) as the allocation unit (AVGREC)
✦ RemoteDISP— the disposition of the new file.
✦ RemoteFileName—the name of the destination z/OS dataset.
✦ RemoteSPACE—defines the space requirements for the allocation.
Operation 5 uses the CD Server Run Task Service to execute the DMRTDYN utility program to
perform the following functions:
✦ Allocate a file on the z/OS system with a DDname of OLDDD to be used as a basis for
comparison to the output file
✦ Allocate the output file from the previous step with a DDname of NEWDD for a comparison.
✦ Allocate an output DD called OUTDD that holds the output report file for the Compare step
instead of an actual file.
Operation 6 uses the CD Server Run Task Service to execute the ISRSUPC program, a compare
utility. The ISRSUPC program compares the file allocated to OLDDD and the file allocated to
NEWDD using the parms in the Sysopts. The results are written to the OUTDD.
Operation 7 uses the CD Server Run Task Service to execute DMRTDYN to deallocate OLDDD,
NEWDD and OUTDD.
Operation 8 uses the CD Server End Session Service to terminate the session with the Sterling
Connect:Direct server after the business process has executed successfully. To accommodate error
processing, Operation 9 contains an onFault branch with its own instance of the CD Server End
Session Service. If an error occurs after the Begin Session Service, the onFault logic is invoked and
the End Session Service terminates the session with the Sterling Connect:Direct server.
Note: The Sterling B2B Integrator Graphical Process Modeler (GPM) is used as the primary means to perform most
of the common user tasks described in the IBM Sterling B2B Integrator - Connect:Direct Server Adapter User
Guide. To see BPML source code like the example shown below, select View > Source while using the GPM.
To see the business process as depicted in the GPM user interface, select View > Graph.
<process name="CopyTOCDzOS">
<onFault>
</onFault>
</sequence>
</process>
Copy Options
Copy Options
There are many copy options available when you use the Connect:Direct Server CopyTo Service.
When you using the Sterling Connect:Direct Server Adapter to copy a file to a remote Sterling
Connect:Direct server, coordinate the copy options with the Sterling Connect:Direct administrator.
BinaryMode Specifies how the data from the source file on Yes—All platforms
the local Connect:Direct Server Adapter node No—All platforms
will be transferred to the remote Sterling
VB—z/OS platform
Connect:Direct node. Optional.
Valid values are:
Yes—file will be transferred in simple binary
mode
No—file will not be transferred in binary
mode but rather in text mode (default)
VB—copy will be performed as a variable
block binary transfer with Sterling
Connect:Direct on the z/OS platform
CDRecordType Specifies the entry name of the type defaults z/OS platform
file. The type defaults file contains the default
file attributes used to allocate the destination
file. The type defaults file is specified only when
defaults are requested by the user.Optional.
For more information on the type defaults file,
see the Sterling Connect:Direct for z/OS user
documentation.
LocalFileNameLabel Specifies a label for the name of the local file. All platforms
This file name label is provided to the remote
Sterling Connect:Direct node for informational
purposes only. Optional.
RemoteBUFND Specifies the number of I/O buffers VSAM will z/OS platform
use for transmitting data between virtual and
auxiliary storage. Optional.
Used only on the z/OS platform.
For more information on how to specify BUFND
information, see the Sterling Connect:Direct for
z/OS user documentation.
RemoteFileName Name that should be given to the file that is All platforms
copied to the remote Sterling Connect:Direct
server. Required.
Note: You cannot use wildcards to copy
multiple files from Sterling B2B
Integrator to Sterling Connect:Direct
with a single CopyTo service.
RemoteLABEL Specifies label information for the tape used for z/OS platform
the destination file. Optional.
Used only on the z/OS platform. Valid syntax is:
([file-sequence-number]
,[SL | AL | BLP | LTM | NL | AUL | NSL | SUL]
,[PASSWORD | NOPWREAD]
,[IN | OUT]
,[RETPD=nnnn | EXPDT=[yyddd | yyyy/ddd]]
)
For more information on how to specify label
information, see the Sterling Connect:Direct for
z/OS user documentation.
RemoteUNIT Specifies the storage device or type along with z/OS platform
the number of devices required. Optional.
Used only on the z/OS platform. Valid syntax is:
([unit-address | device-type | group-name]
, [unit-count | P ] [,DEFER]
)
For more information on how to specify UNIT
information, see the Sterling Connect:Direct for
z/OS user documentation.
RemoteFileName Name of the file that should be copied from the All platforms
remote Sterling Connect:Direct server. Enter
the legal characters in the file name. Required.
Clustering Considerations
Note: For additional information about the Connect:Direct Server Adapter and multiple node instances of
Sterling B2B Integrator, refer to the Sterling B2B Integrator documentation library.
The Sterling B2B Integrator Admin Console enables you to view information about business
processes that interact with remote Sterling Connect:Direct nodes. Correlation records are
automatically maintained so that you can search for specific information (such as, business process
IDs, document IDs, workflow IDs, and mailbox IDs). Each business process references a unique
business process ID as its primary process identifier.
Central Search Use to search for live (active) business process instances that do not appear in the
Current Processes. Search by Name, Status, or Date.
Current Processes Lists the status of the ten most recent business process instances.
Current Activities Search for Connect:Direct Server Adapter activity by adapter configuration name or
by when the activity registered within Sterling B2B Integrator.
Advanced Search
Business Search for active, archived or stored business processes. Search by business
Processes process instance ID, business process Name, State, or Date.
Documents Search for active, archived or stored documents handled by a business process.
Search by Time, Document ID, Sender or Receiver ID, Type, Status or Correlations.
Communication Search for active, archived or stored communication sessions records. These records
Sessions include the associated authentication, authorization, file transfer, or non-file transfer
records, even if a document is not transferred and no data flow record is created.
Search by Time, Communication Session ID, Process ID, End Point, Protocol and so
forth.
Correlation Search for active, archived or stored business processes by name-value pairs. This is
a key tracking method in interoperability because you can search by values such as
PNODE, SNODE, Sterling Connect:Direct Process Name and so forth.
When you find the business process you are interested in on any of these Monitor pages, you can
obtain additional details by selecting the number in the ID column to open the Business Process
Details page.
Correlation Search
Correlation searches are a key to relating a Sterling Connect:Direct Process with a Sterling B2B
Integrator business process. Whereas Sterling Connect:Direct identifies a process with a Process
Number and a Process Name, Sterling B2B Integrator identifies its business processes with an
Instance ID. The Correlation Search enables you to search for Sterling B2B Integrator processes
using Sterling Connect:Direct identifiers.
Note: Correlations are created to identify related Sterling B2B Integrator and Sterling Connect:Direct
processes.
The Connect:Direct Server Adapter and related services automatically write Sterling B2B
Integrator correlation records to enable searches for business processes and documents containing
certain correlation identifiers.
The Correlation Search page enables you to search for business process activity according to six
Sterling Connect:Direct specific name-value pairs, including:
✦ CD_LocalFileName
✦ CD_RemoteFileName
✦ CD_ProcessName
✦ CD_ProcessNum
✦ CD_PnodeName
✦ CD_SnodeName
Note: Do not perform a correlation search by Process Number only. A Process Number is unique to a
single Sterling Connect:Direct server, therefore you may see the same Process Number used for
different processes—each associated with a different node.
business processes waiting for an available session. When a session has become available, it is
assigned to a previously suspended business process, if any, on a first-come first-served basis.
The first (oldest) suspended business process is given the first chance to use the next free PNODE
session for the Connect:Direct Server Adapter. If no suspended business process can use the session
or if no business processes are in the suspended business process queue, the freed session is returned
to the available session count. If a PNODE session limit was also specified at the node level, the
number of currently active sessions with the particular remote node and the total number of active
PNODE sessions are both decremented when a freed session goes back to the available session
count. To see an example of how session counts go up and down when business processes are
suspended and resumed, see Sample Scenario of Workflow Suspension Processing and Session
Counts on page 170.
If Sterling B2B Integrator or a Connect:Direct Server Adapter is terminated while business
processes are suspending awaiting the next freed session, then an error is returned to the service
invocation that caused the business process to be suspended.
If you suspect an error has occurred or that the execution of a business process has been delayed,
you can check its status and the status of all related services. If a business process has been
suspended, the message, Session count exhausted, waiting for session availability, is displayed for
the Connect:Direct Server Begin Session Service, CopyTo, or CopyFrom service involved in
establishing or re-establishing a session. When a session count becomes available, the message,
Session now available: resuming, is displayed, and the Status Report screen will show how long the
business process was suspended, for example, Session now available, resuming after wait of 1
minutes 35 seconds.
Example 1
Connect:Direct Server Adapter session limit = 2
Connect:Direct Server Adapter current sessions = 2
NODEA session limit = 2
NODEA current sessions = 1
NODEB session limit = 1
NODEB current sessions = 1
SUSPENDED WORKFLOW QUEUE = <empty>
In this scenario, the following sequence of events occurs:
Example 2
In this example, the session limit for NODEB has been bumped up one:
Connect:Direct Server Adapter session limit = 2
Connect:Direct Server Adapter current sessions = 2
NODEA session limit = 2
NODEA current sessions = 1
NODEB session limit = 2
NODEB current sessions = 1
SUSPENDED WORKFLOW QUEUE = <empty>
The following sequence of events occurs:
✦ BP-X attempts to establish a new PNODE session with NODEB.
✦ NODEB is not at its session maximum, but the overall Connect:Direct Server Adapter is at its
limit. As a result, the workflow suspend mechanism is triggered.
✦ BP-X is placed on the suspended workflow queue to await a session count.
✦ The current session with NODEA terminates and is freed.
✦ Connect:Direct Server Adapter looks for a suspended workflow that can use the newly freed
session.
✦ BP-X can use this session because both NODEB and the adapter now have a session available.
✦ BP-X is resumed and allowed to attempt session establishment with NODEB.
After this sequence of events transpires, the situation stands as this:
Connect:Direct Server Adapter session limit = 2
Connect:Direct Server Adapter current sessions = 2
NODEA session limit = 2
NODEA current sessions = 0
NODEB session limit = 2
NODEB current sessions = 2
SUSPENDED WORKFLOW QUEUE = <empty>
Note: Certain errors fail without any retries, for example, when a required parameter is missing or invalid
or a remote node is not in the netmap.
Both the Interval between long-term session attempts (minutes) and Number of long-term session
retry attempts fields deal with long-term session establishment and re-establishment attempts. To
use a shorter timeframe to establish and re-establish sessions, specify the following fields when
configuring the Connect:Direct Server Adapter:
✦ Number of short-term session retry attempts
✦ Interval between short-term session attempts (seconds)
If both the short-term and long-term retry parameters are specified, the values for the short-term
parameters are used first, and if a session has still not been established (or re-established), the value
for the long-term parameter is used if it is specified. For more information, see Setup Procedures
on page 19.
Checkpoint restart is supported for both inbound and outbound file transfers. This feature is only
supported for documents stored in the file system—it is not supported when document storage is set
to Database or data encryption is enabled in Sterling B2B Integrator.
Checkpoint restart can be enabled whether or not Sterling Connect:Direct Secure Plus,
compression, or any other communications session factor is enabled or disabled.
In a file transfer, the PNODE determines whether checkpointing will be performed and sets the
checkpoint interval. These two parameters can be set as a global default (usually in an initialization
parameter or property file) or overridden in the Sterling Connect:Direct Process (Copy step) or
Sterling B2B Integrator business process.
The checkpoint information is kept on the target node (the node receiving the file) until the file
transfer completes successfully (in which case, this temporary record is destroyed) or kept for a
specific period of time if the file transfer fails. When a file transfer fails, the checkpoint information
is retained for a specified default length of time on the target system (30 days is common). In
Sterling B2B Integrator, this setting is configured by setting the ckptRemoveDate property in the
noapp.properties property file located in the properties subdirectory of the installation.
If a remote Sterling Connect:Direct server or the network fails during a copy operation, the
Connect:Direct Server Adapter goes into retry mode using its own default long-term and short-term
values and waits the specified amount of time and then resumes the copy. These values can be
overridden by the following values, if specified, in the Connect:Direct Server Begin Session
service:
✦ Number of long-term session retry attempts (BeginSessionMaxRetries)
✦ Interval between long-term session attempts (BeginSessionRetryInterval)
✦ Number of short-term session retry attempts (ShortTermMaxRetries)
✦ Interval between short-term session attempts (ShortTermRetryInterval)
remote Sterling Connect:Direct for z/OS system. FAR processing only affects locally initiated
(PNODE) sessions that use the Connect:Direct Server CopyTo service or CopyFrom service.
When you enable FAR processing and Connect:Direct Server Adapter receives one of a set of
certain file allocation error messages and a non-zero return code from the remote Sterling
Connect:Direct server during a copy operation, Connect:Direct Server Adapter retries the Copy
operation subject to the existing short-term and long-term retry settings. If the condition that caused
the FAR processing persists, retries are performed up to a maximum of the configured short-term
and long-term retries only. The retry counters are not reset after a successful connection when
triggered by FAR processing.
If the retry counts are exhausted, the CopyTo or CopyFrom service fails and returns an error to the
Business Process that invoked it.
The set of FAR error messages, which include the commonly occurring Sterling Connect:Direct for
z/OS retry-able file allocation errors, is pre-configured in the Sterling B2B Integrator installation.
To enable FAR processing:
1. Log in to Sterling B2B Integrator.
2. From the Deployment menu, select Services > Configuration.
3. From the Services Configuration page, search for the Connect:Direct Server Adapter
configuration.
4. On the InitParms screen, select the Retry Remote File Allocation Errors check box.
5. Save the changes and click Finish.
6. The Sterling B2B Integrator adapter restarts. FAR processing is enabled.
FAR processing is disabled by default when you create a new Connect:Direct Server Adapter
configuration or import a Connect:Direct Server Adapter configuration from an earlier version of
Sterling B2B Integrator.
Troubleshooting
Troubleshooting
Sterling B2B Integrator and Sterling Connect:Direct are designed to work together, in a seamless
and tightly integrated environment. However, as is the case with any application, occasions may
occur when you need to troubleshoot certain components or functions.
This section provides general troubleshooting guidelines when configuring and using Sterling B2B
Integrator with Sterling Connect:Direct.
To troubleshoot general Sterling Connect:Direct functions, see the Sterling Connect:Direct
documentation set for general troubleshooting information and instructions.
You may need to work with your Trading Partners or system administrators to troubleshoot the
systems you are communicating with.
Verifying Connectivity
To verify connectivity between Sterling Connect:Direct and Sterling B2B Integrator:
1. Check configurations on Sterling Connect:Direct and Sterling B2B Integrator for compliance.
In particular, look at the network maps on both systems.
2. Verify that the Sterling Connect:Direct nodes in question are active when a begin session is
invoked.
3. Verify that perimeter services client connects to perimeter services server. If the client cannot
connect, it causes the perimeter services-enabled Connect:Direct Server Adapter to fail.
Perimeter servers do not automatically reboot after a failure.
To determine the status of the perimeter services client in Sterling B2B Integrator:
a. From the Sterling B2B Integrator Operations menu, select Troubleshooter.
b. Look for the Perimeter Servers area. It is usually at the bottom of the Troubleshooting
page. This shows the state of the perimeter server clients which are defined in Sterling
B2B Integrator and whether they are on.
Disconnected is displayed if no perimeter server is installed.
Logging Files
More information, including audit messages and error messages, can be found in Sterling B2B
Integrator log files. Log files are available through the Operations > System > Logs menu.
The cdinterop.log files record details for all adapter activity and business processes that involve the
Connect:Direct Server and Requester adapters and the related Connect:Direct services.
A new cdinterop.log is create each time the Sterling B2B Integrator server is started. At midnight,
the current log file is closed and a new one is created. In addition, when the size of the current log
file reaches the maximum size specified in the cdinterop log file configuration screen, it is closed
and a new log file is opened. The log file name includes a date and time stamp to make each name
unique.
By default, the cdinterop.log file captures audit level messages, even when logging is not enabled.
When the log is enabled, all transactions are recorded, including:
✦ Error messages
✦ Adapter startup and shutdown
✦ Adapter changes
✦ Security checks
Caution: Overriding the log.properties settings for the cdinterop.log can have a dramatic impact on
performance and log volume.
The customer_overrides.properties file is used to override property settings in other property files.
Unlike the other property files and their associated .properties.in files, the
customer_overrides.properties file is not changed during installation of Application upgrades or
patches. To prevent having your customized settings overwritten, you should use the customer
override property file whenever possible rather than editing the Application property files or .in
files.
The customer_overrides.properties file is not part of the initial Application installation and must be
created. It must be named customer_overrides.properties.
To override log.properties file settings for the cdinterop.log:
1. In the install_dir/properties directory, locate (or create, if necessary) the
customer_overrides.properties file.
2. Open the customer_overrides.properties file in a text editor.
3. Add the cdinteropcdinterop.log properties that you want to override to the log.properties file,
using the following format:
logService.PROPERTY_NAME=PROPERTY_VALUE
logService—Name used to reference the log.properties file.
PROPERTY_NAME—Name of the property as used in the log.properties file.
PROPERTY_VALUE—The value you want to assign to the property.
For example, assume that you want to change the maximum number of cdinterop.log files to 5.
To do so, override the cdinteroplogger.maxnumlogs property value in the log.properties file by
adding the following line to the customer_overrides.properties file:
logService.cdinteroplogger.maxnumlogs=5
4. Save and close the customer_overrides.properties file.
5. Stop and restart Application to use the new values.
6. Test your changes to ensure that the overrides give the desired results. If you have problems,
contact IBM Customer Support for assistance.
Configuration Settings
The following table describes properties used to configure the customer_overrides.properties file
for the CDInterop logger:
Property Description
logService.cdinteroplogger.rotatelogs Flag indicating whether to rotate the log after it has reached its
maximum size.
Example: true
logService.cdinteroplogger.showsource Flag indicating whether to show the java class that originated
an error message.
Note: This can have a dramatic impact on performance and
log volume, so it should only be used to diagnose
problems.
Example: false
Turning on Logging
If the error is not in the existing logs, turn on the Sterling B2B Integrator cdinterop.log to capture
activity of the Connect:Direct Server Adapter and the services:
1. Browse to Operation > System > Logs.
2. Scroll to the Environment section of the page.
3. Click the edit icon to the left of Connect:Direct Server and Requester Adapter and Services.
4. In the Environment window, select On next to Logging Level and click Save.
$ cd <install_dir>/properties
$ cp cdinterop-spoe-policy.properties cdinterop-spoe-policy.properties.copy
2. Use a text editor to make the desired changes to the cdinterop-spoe-policy.properties.copy file:
$ vi cdinterop-spoe-policy.properties.copy
$ cd <install_dir>/properties
$ cp cdinterop-spoe-policy.properties.copy cdinterop-spoe-policy.properties
Map Sterling Connect:Direct User IDs to Sterling B2B Integrator User Accounts
After you enable SPOE authentication for the Connect:Direct Server Adapter, configure the
cdinterop-spoe-auth.properties file to map external Sterling Connect:Direct user IDs to Sterling
B2B Integrator user accounts.
Configuration Settings
The following table describes properties used to configure the cdinterop-spoe-auth.properties file
in Sterling B2B Integrator:
Syntax Description
spoe-user-id Specifies a unique remote user identifier. The remote user may be specified by an
asterisk (*) to enable this definition to match any user.
Note: The asterisk does not perform similar to a wildcard character or regular
expression operator. It is a special keyword having the meaning "any user."
nodename Specifies the name of the remote Sterling Connect:Direct PNODE node. The node
name may be specified by an asterisk (*) to enable this definition to match any node.
Note: The asterisk does not perform similar to a wildcard character or regular
expression operator. It is a special keyword having the meaning "any
node."
Each entry associates a SPOE username and remote Sterling Connect:Direct node name with a
Sterling B2B Integrator user account. Each entry in the file consists of a single line of the form:
spoe-user-id@nodename=gis-user-id
The @ joins the user identifier with the node name to form the SPOE remote user identifier. No
space is permitted either before or after it. The = associates the SPOE remote user identifier with
the Sterling B2B Integrator user account. No space is permitted either before or after it.
Examples
A remote user id 'user1' is mapped to the gis 'user2' account:
[email protected]=user2
Any remote id from the cd.chicago node is mapped to the gis account 'chicago':
*@cd.chicago=chicago
The remote id 'anonymous' from the *any* node is mapped to the Sterling B2B Integrator
'anonymous' account:
anonymous@*=anonymous
Any remote id from the *any* node is mapped to the Sterling B2B Integrator 'guest' account:
*@*=guest
$ cd <install_dir>/properties
$ cp cdinterop-spoe-auth.properties cdinterop-spoe-auth.properties.copy
2. Use a text editor to make the desired changes to the cdinterop-spoe-auth.copy file:
$ vi cdinterop-spoe-auth.properties.copy
$ cd <install_dir>/properties
$ cp cdinterop-spoe-auth.properties.copy cdinterop-spoe-auth.properties
Configuration Settings
The following table describes properties used to configure the cdinterop-user-records.properties file
in Sterling B2B Integrator:
Property Description
directory.precedence Specifies the processing order in cases where two or more directory parameters
conflict. Example:
jsmith/download = /mailbox/inbox
[cdsa-1]download = /mailbox/downloads
Valid values:
user—Choose the definition that supplies the Sterling B2B Integrator user account
ID. In the example above, the first rule is chosen. Default.
adapter—Choose the definition that supplies the Connect:Direct server adapter
name. In the example above, the second rule will be chosen.
userid An existing local Sterling B2B Integrator user. If omitted, may be any Sterling B2B
Integrator user. Optional.
Property Description
parameter-name Specifies either the "download" or "upload" keyword. Keywords are not
case-sensitive. Required.
download—Designates that the parameter's value identifies the location where
the incoming file is to be stored. Default (when no other definitions match the
session's adapter or user account):
/businessprocess/PO-Request
upload - Designates that the parameter's value identifies the location from which
the outgoing file is to be obtained.
gis-path-prefix Path used to store the incoming document or retrieve the outgoing one. Valid
values:
/businessprocess/<bp-name>
where
<bp-name> is the name of a business process. Required.
/mailbox/<path>
where
<path> specifies a target mailbox accessible from the virtual root of the Sterling
B2B Integrator account. Optional. If omitted, the virtual root is assumed.
For examples, see Upload and Download Process Examples on page 188.
Syntax
The cdinterop-user-records.properties file may be modified while Sterling B2B Integrator is
running. Changes take effect a few seconds following the change committal step. To add or modify
entries in this file:
1. Make a copy of the cdinterop-user-records.properties file:
$ cd <install_dir>/properties
$ cp cdinterop-user-records.properties cdinterop-user-records.properties.copy
$ vi cdinterop-user-records.properties.copy
If cdsa-name is not specified, separate the User ID from the upload/download parameter name
with a slash (/).
4. Save the file.
$ cd <install_dir>/properties
$ cp cdinterop-user-records.properties.copy cdinterop-user-records.properties
Parameter Examples
✦ /mailbox/receipts as a download parameter value—When a remote node connects to
Connect:Direct Server Adapter CDSA.DALLAS using the Sterling B2B Integrator user
account purchasing, this download parameter value is used to compute the destination
directory where the transmitted file will be stored:
purchasing[CDSA.DALLAS]download=/mailbox/receipts
purchasing/upload=/mailbox/outbox
[CDSA-CHICAGO]upload=/businessprocess/DelinquentAccounts
download=/businessprocess/PO-Request
Configuration Settings
The following table describes properties contained in the cdinterop-proxy-records.properties file in
Sterling B2B Integrator:
Property Description
external-id An external, remote proxied user ID. It may be specified in any of the following
ways:
address-form: proxyid @nodename
where proxyid and nodename are specified. A match occurs only if the user
name and node name from the request exactly match proxyid and nodename.
Example:
john@company/upload=/mailbox/company/john/out
The upload path is prepended to the outbound target filename if
spoe-policy=yes and the remote userid is "john" and the remote pnode
name is "company."
domain-form: *@nodename
where only nodename is specified. A match occurs only if the node name from
the request exactly matches nodename. Example:
*@company/upload=/mailbox/company/out
The upload path is prepended to the outbound target filename if
spoe-policy=yes and no rule is found for this remote userid, but one is
found for the remote pnode name "company."
account-form: userid @*
where only proxyid is specified. A match occurs only if the user name from the
request exactly matches userid. Example:
john@*/upload=/mailbox/john/out
The upload path is prepended to the outbound target filename if
spoe-policy=yes and a rule is found for remote userid "john," but no rule is
found for the name of the remote pnode.
default-form: *@*
This rule always matches any user name from any node name. Example:
*@*/upload=/mailbox/default/out
parameter-name Specifies either the "download" or "upload" keyword. Keywords are not
case-sensitive. Required.
download—Designates that the parameter's value identifies the location where
the incoming file is to be stored. Default (when no other definitions match the
session's adapter or user account):
/businessprocess/PO-Request
upload—Designates that the parameter's value identifies the location from
which the outgoing file is to be obtained.
Property Description
gis-path-prefix Path used to store the incoming document or retrieve the outgoing one. Valid
values:
/businessprocess/<bp-name>
where
<bp-name> is the name of a business process. Required.
/mailbox/<path>
where
<path> specifies a target mailbox accessible from the virtual root of the
Sterling B2B Integrator account. Optional. If omitted, the virtual root is assumed.
Syntax
The cdinterop-proxy-records.properties file may be modified while Sterling B2B Integrator is
running. Changes take effect a few seconds following the change committal step. To add or modify
entries in this file:
1. Make a copy of the cdinterop-proxy-records.properties file:
$ cd <install_dir>/properties
$ cp cdinterop-proxy-records.properties cdinterop-proxy-records.properties.copy
$ vi cdinterop-proxy-records.properties.copy
$ cd <install_dir>/properties
$ cp cdinterop-proxy-records.properties.copy cdinterop-proxy-records.properties
TOGIS PROCESS
SNODE=CDSA.DALLAS
SNODEID=(cduser1,cduser1)
STEP1 COPY
FROM (
FILE=”payload.txt”
)
TO (
FILE=”po-12558-a202”
DISP=RPL
)
PEND
The Connect:Direct Server Adapter computes the destination filename by appending the local
filename po-12558-a202 to the cduser1 [CDSA.DALLAS] download parameter value:
Result: /mailbox/in/po-122558-a202
The Sterling Connect:Direct User Authorities for cduser1 contains the following Directory
Restrictions:
Directory Restriction
Sterling Connect:Direct computes the source filename by appending the local filename
payload.txt to user cduser1’s upload parameter value:
Result: C:\Connect Direct\data\upload\payload.txt
STEP1 COPY
FROM (
FILE=”po-12558-a202”
SNODE
)
TO (
FILE=”payload.txt”
PNODE
DISP=RPL
)
PEND
The Connect:Direct Server Adapter computes the source filename by appending the local filename
po-12558-a202 to the cduser1 [CDSA.DALLAS] upload parameter value:
Result: /mailbox/out/po-122558-a202
The Sterling Connect:Direct User Authorities for cduser1 contains the following Directory
Restrictions:
Directory Restriction
Sterling Connect:Direct computes the destination filename by appending the local filename
payload.txt to user cduser1’s download parameter value:
Result: C:\Connect Direct\data\download\payload.txt
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in other
countries. Consult your local IBM representative for information on the products and
services currently available in your area. Any reference to an IBM product, program, or
service is not intended to state or imply that only that IBM product, program, or service may
be used. Any functionally equivalent product, program, or service that does not infringe any
IBM intellectual property right may be used instead. However, it is the user's responsibility
to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in
this document. The furnishing of this document does not grant you any license to these
patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte character set (DBCS) information, contact the
IBM Intellectual
Property Department in your country or send inquiries, in writing, to:
Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan Ltd.
1623-14, Shimotsuruma, Yamato-shi
Kanagawa 242-8502 Japan
The following paragraph does not apply to the United Kingdom or any other country
where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS
MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT
NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,
Notices 191
Notices
192 Notices
Trademarks
This information is for planning purposes only. The information herein is subject to change
before the products described become available. This information contains examples of
data and reports used in daily business operations. To illustrate them as completely as
possible, the examples include the names of individuals, companies, brands, and products.
All of these names are ficticious and any similarity to the names and addresses used by an
actual business enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which illustrate
programming techniques on various operating platforms. You may copy, modify, and
distribute these sample programs in any form without payment to IBM, for the purposes of
developing, using, marketing or distributing application programs conforming to the
application programming interface for the operating platform for which the sample
programs are written. These examples have not been thoroughly tested under all conditions.
IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these
programs. The sample programs are provided "AS IS", without warranty of any kind. IBM
shall not be liable for any damages arising out of your use of the sample programs.
Each copy or any portion of these sample programs or any derivative work, must include a
copyright notice as follows:
© IBM 2011. Portions of this code are derived from IBM Corp. Sample Programs.
© Copyright IBM Corp. 2011.
If you are viewing this information softcopy, the photographs and color illustrations may
not appear.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International
Business Machines Corp., registered in many jurisdictions worldwide. Other product and
service names might be trademarks of IBM or other companies. A current list of IBM
trademarks is available on the Web at “Copyright and trademark information” at
www.ibm.com/legal/copytrade.shtml.
Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks
or trademarks of Adobe Systems Incorporated in the United States, and/or other countries.
IT Infrastructure Library is a registered trademark of the Central Computer and
Telecommunications Agency which is now part of the Office of Government Commerce.
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron,
Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks
of Intel Corporation or its subsidiaries in the United States and other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or
both.
Notices 193
Notices
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft
Corporation in the United States, other countries, or both.
ITIL is a registered trademark, and a registered community trademark of the Office of
Government Commerce, and is registered in the U.S. Patent and Trademark Office.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Java and all Java-based trademarks and logos are trademarks or registered trademarks of
Oracle and/or its affiliates.
Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in the United
States, other countries, or both and is used under license therefrom.
Linear Tape-Open, LTO, the LTO Logo, Ultrium and the Ultrium Logo are trademarks of
HP, IBM Corp. and Quantum in the U.S. and other countries.
Connect Control Center®, Connect:Direct®, Connect:Enterprise, Gentran®,
Gentran:Basic®, Gentran:Control®, Gentran:Director®, Gentran:Plus®,
Gentran:Realtime®, Gentran:Server®, Gentran:Viewpoint®, Sterling Commerce™,
Sterling Information Broker®, and Sterling Integrator® are trademarks or registered
trademarks of Sterling Commerce, Inc., an IBM Company.
Other company, product, and service names may be trademarks or service marks of others.
194 Notices