Setting up targets
Targets are the locations on the hub where documents are
received. These documents can come from community participants (for
eventual delivery to the Community Manager) or from the Community
Manager (for eventual delivery to participants).
You set up at least one target for each type of transport over
which documents will be sent to the hub. For example, you will have
an HTTP target to receive any documents sent over the HTTP or HTTPS
transport. If your community participants will be sending documents
over FTP, you will set up an FTP target.
This illustration shows how four targets are set up to handle
documents coming in to the hub. Two of the targets are for documents
coming from participants, and two are for documents originating
from the Community Manager. (Note that you can add transports to
the list of those supported, by default, by WebSphere Business Integration
Connect.)
Figure 21. Transports and associated targets
To set up your targets, perform the following steps:
- Click Hub Admin > Hub Configuration > Targets.
- If you want to upload a user-defined transport, perform the
following steps. Otherwise, go to 3.
- Click Import Transport Type.
- Enter the name of an XML file that defines the transport (or
use Browse to navigate to the file).
- Click Upload.
Note: From the Target List, you can also delete a user-defined
transport type. You cannot delete a transport provided by WebSphere
Business Integration Connect. Also, you cannot delete a user-defined
transport after it has been used for creating a target.
-
Click Create Target.
- Type a name for the target. For example, you might call the
target HttpTarget. This is a required field. The name you enter
here will be displayed on the Targets list.
- Optionally indicate the status of the target. Enabled is
the default. A target that is enabled is ready to accept documents.
A target that is disabled cannot accept documents.
- Optionally enter a description of the target.
- Select a transport from the list. Note that, if you imported
a user-defined transport, it appears on the list
The steps shown are common to all targets. After you select a
target, however, additional fields are displayed on the page. The
fields vary, depending on which transport you have chosen.
Here are the additional steps you take to configure the target,
based on its transport type. After you provide the transport-specific
information to define an HTTP/S or user-defined target, you can
modify configuration points for the target. See Modifying configuration points.
Setting up an HTTP/S target
The Receiver component has a predefined bcgreceiver servlet
that is used to receive HTTP/S POST messages. You create an HTTP
target to access the messages received by the servlet.
The following steps describe what you need to specify for an
HTTP/S target:
- Optionally, indicate the gateway type. The gateway type defines
the nature of the transmission. For example, if you want to test
a document exchange before putting it into production, you would
enter Test. The default is Production.
- Enter the URI for the HTTP/S target. The name must begin with bcgreceiver.
For example, you might enter bcgreceiver/submit. Documents coming
into the server over HTTP/S would then be received at bcgreceiver/submit.
- Optionally change the sync routing values:
- For Max Sync Timeout, enter the number
of milliseconds a synchronous connection will remain open. The default
is 600000.
- For Max Sync Sim Conn, enter the maximum
number of synchronous connections the system will allow. The default
is 100 (for the maximum number of simultaneous synchronous connections).
- If you want to modify the configuration points, or if you are
setting up a target for an AS2, cXML, RNIF, or SOAP document that
will be involved in a synchronous exchange, see Modifying configuration points.
Setting up an FTP target
The following steps describe what you need to specify
for an FTP target:
- In the FTP Route Directory field, enter
the root directory of the FTP server. Refer to Configuring the FTP server for receiving documents for information on setting up the directory for an
FTP server.
- Optionally, enter a value for File Unchanged Interval to
indicate the number of seconds the file size must remain unchanged
before the Document Manager will retrieve the document for processing.
The default value is 3 seconds.
- Optionally enter a value for Thread Nbr,
to indicate the number of documents the Document Manager will process
simultaneously. The default value of 1 is recommended.
- Optionally enter a value for Exclude File Ext to
indicate the types of documents the Document Manager should ignore
(exclude from processing) if it finds the documents in the FTP directory.
For example, you might want the Document Manager to ignore spreadsheet
files, in which case you would enter the extension associated with
them. The default is that no file types are excluded.
Setting up an SMTP target
The following steps describe what you need to specify
for an SMTP (POP3) target:
- Optionally indicate the gateway type. The default is Production.
- Enter the location of the POP3 server where mail is delivered.
- Optionally enter a port number. If you do not enter anything,
the value of 110 is used.
- Enter the user ID and password required to access the mail server,
if a user ID and password are required.
- Optionally enter a value for Timeout,
to indicate the number of seconds the target will monitor the POP3
server for documents. This field is optional. The default is 1 ms.
- Optionally enter a value for Thread Nbr,
to indicate the number of documents the Document Manager will process
simultaneously. The default value of 1 is recommended.
- Optionally select the time of day (hours and minutes) when the
SMTP target should poll the POP3 server for documents.
- Optionally select the days of the week when polling should occur.
The default is to poll on a daily basis.
- Optionally select the days of the month when polling should
occur. The default is to poll on daily basis.
Setting up a JMS target
The following steps describe what you need to specify
for a JMS target:
- Optionally indicate the gateway type. The default is Production.
- Enter the JMS provider URL. This should match the value you
entered (the file system path to the bindings file) when you configured
WebSphere Business Integration Connect for JMS, as described in Configuring the hub for the JMS transport protocol.
- Enter the user ID and password required to access the JMS queue,
if a user ID and password are required.
- Enter a value for JMS queue name. This is a required field.
- Enter a value for the JMS factory name. This is a required field.
- Optionally enter the Provider URL package.
- Enter the JNDI factory name. If you do not enter anything, the
value com.sun.jndi.fscontext.RefFSContextFactory is used. This is
a required field.
- Optionally enter a value for Timeout, to indicate the number
of seconds the target will monitor the JMS queue for documents.
This field is optional.
- Optionally enter a value for Thread Nbr,
to indicate the number of documents the Document Manager will process
simultaneously. The default value of 1 is recommended.
For example, if you wanted to set up a JMS target to match the
JMS configuration example in Preparing to configure the hub,
you would:
- Enter the value JMSTarget in the Target Name box.
- Enter the value file:/C:/TEMP/JMS/JMS in
the JMS Provider URL box
- Enter the value inQ in the JMS Queue Name box.
- Enter the value WBICHub in the JMS Factory Name box.
Setting up a File-system target
The following steps describe what you need to specify
for a file-system target:
- Optionally indicate the gateway type. The default is Production.
- Enter a value for Document Root Path to
indicate the directory where the documents will be received.
- Optionally enter a value for Poll Interval,
to indicate how often the directory should be polled for new documents.
If you do not enter anything, the directory will be polled every
5 seconds.
- Optionally, enter a value for File Unchanged Interval to
indicate the number of seconds the file size must remain unchanged
before the Document Manager will retrieve the document for processing.
The default value is 3 seconds.
- Optionally enter a value for Thread Nbr,
to indicate the number of documents the Document Manager will process
simultaneously. The default value of 1 is recommended.
Modifying configuration points
For certain business protocols (RosettaNet, cXML, SOAP,
and AS2) that will be involved in synchronous exchanges, you must
specify a handler for the SyncCheck configuration point. You can
also modify the way an HTTP/S or user-defined target processes documents
by applying an uploaded user-defined handler (or a system-supplied
process) to other configuration points of the target.
To apply a user-written handler for these configuration points,
you must first upload the handler, as described in Uploading user-defined handlers. You can also use a system-supplied handler, which
is already available and does not have to be uploaded.
To modify the configuration points, perform the following steps:
- If you are in the process of creating a target, continue to
step 2. If you are updating
a target configuration, click Hub Admin > Hub Configuration > Targets.
Then click the magnifying glass icon next to the target. Finally,
click
.
-
If you are specifying a handler for AS2,
cXML, SOAP, or RNIF synchronous transactions, perform the following
steps:
- Select SyncCheck from the Configuration Point Handlers list.
- Add the appropriate handler to the Configured List by
selecting the handler from the Available List and
clicking Add.
Repeat this step if you want to add other handlers to the list.
Remember that for targets, the handlers are called in the order
in which they appear on the Configured List.
The first available handler processes the request, and subsequent
handlers on the list are not called. It is a good practice to list
the specific SyncCheck handler (for example, com.ibm.bcg.server.sync.As2SyncHdlr
for AS2 transactions) before listing the default SyncCheck handlers.
- If you are finished defining handlers for this target, click Save.
Otherwise, go on to step 3.
-
Select from the Configuration Point Handlers list
the configuration point to be modified. The configuration points
that can be modified for targets are Preprocess, SyncCheck,
and Postprocess.
Figure 22. Target configuration point handlers
- Perform one or more of the following steps for each handler
you want to modify.
- Add a handler by selecting the handler from the Available Handlers list
and clicking Add. The handler is moved to
the Configured Handlers list.
- Remove a handler by selecting the handler from the Configured Handlers list and
clicking Remove. The handler is moved to the Available Handlers list.
- Rearrange the order in which the handler is used by selecting
the handler and clicking Move Up or Move Down.
- Cause a handler to be processed more than once by selecting
it and then clicking Repeat.
- Configure the handler by selecting it from the Configured List and
clicking Configure. The list of attributes
that can be configured will be displayed.
- Click Save.
