Copyright © Cloud Software Group, Inc. All Rights Reserved

Common Features Across ActiveEnterprise Activities

The activities in the ActiveEnterprise Adapter palette reference Adapter Configuration resources in your project. This section describes common features across all activities in this palette.

Support for Message Filter Resources

An Adapter Configuration resource can use a Message Filter resource. Message filters are used to provide custom, user-written code to transform the messages sent or received from an adapter, call out to TIBCO Adapter SDK functions, or perform other tasks. See TIBCO Designer Palette Reference for more information about Message Filter resources.

The activities in the ActiveEnterprise Adapter palette support the use of Message Filter resources. When using TIBCO Designer, the message filter is specified for the Adapter Configuration, and the ActiveEnterprise Adapter activities automatically make use of the class specified in the Message Filter resource.

When you deploy your project, however, you must ensure that the BusinessWorks process engine has access to any classes specified in a Message Filter resource. For example, if you have a Publish to Adapter activity in your process definition, the process engine must have access to the class used when executing the transformOutbound() message filter call. If you deploy your TIBCO Adapter and BusinessWorks process engine on the same machine, no additional configuration steps are required. If the components are installed on different machines, you must place your message filter class on the machine where your process engine is deployed and make certain the location of the message filter class is in the CLASSPATH for the process engine (this is set in the bwengine.tra file).

See TIBCO ActiveMatrix BusinessWorks Administration for more information about deploying process engines.

Internationalization Support

TIBCO ActiveMatrix BusinessWorks and TIBCO Adapter products can send text messages that are encoded using either the Latin-1 or UTF-8 character encoding. Both the sender and receiver of the message must use the same encoding. The character encoding sent by resources configured in TIBCO Designer is set at the project level during design time. For deployed projects, TIBCO Administrator allows you to set the message encoding.

At design time, the message encoding property can be set when creating a new project. In the Save Project dialog, choose either ISO8859-1 or UTF-8 in the TIBCO Messaging Encoding option list. See TIBCO ActiveMatrix BusinessWorks Process Design for more information about saving projects. After the messaging encoding is chosen, it will take effect at design time, such as in debug mode, or if the project is running in a standalone mode before deployment.

After the project is deployed, the messaging encoding is determined by the encoding property of the TIBCO Administrator domain. This property is set when the domain is created. ISO8859-1 and UTF-8 are the two supported character encoding options. The messaging encoding set for the domain overrides any encoding set for a project.

Refresh Adapter Service Button

All activities in the ActiveEnterprise Adapter palette can use preconfigured adapter services. These adapter service configurations can change after an adapter service is specified in the configuration of an ActiveEnterprise Adapter palette activity. Therefore, the configured adapter service may become inconsistent with your process definition.

The Refresh Adapter Service button is available on most activities in the ActiveEnterprise Adapter palette. This button allows you to synchronize your activities with the adapter service specified in the activity. Any changes that have occurred to the adapter service are reflected in the activity after the refresh completes.

For example, an adapter service may change the schema it uses for incoming or outgoing messages. When this schema change occurs, any activity using that adapter service may no longer have the correct input and output schemas. Clicking the Refresh Adapter Service button changes the activity to use the current configuration of the adapter service. This invalidate input mappings, and you may need to use the Mapper Check and Repair button on the Input tab to correct the activity input schemas.

The Refresh Adapter Service button is only enabled when you use all settings from the Adapter Service. That is, if you change the Transport Type on the Transport tab to anything other than Adapter Service Default, the Refresh Adapter Service button becomes disabled. If you want to keep your ActiveEnterprise Adapter activities synchronized with an adapter service, do not change the Transport Type. If you want to use a different transport configuration for the activity, you should check the Custom AESchema field on the Configuration tab and specify the adapter service schema in the Custom AESchema Reference field, and then modify the settings on the Transport tab.

Transport Tab

Transports specify the underlying communication characteristics for messages sent and received by adapter services. Normally, the activities of the ActiveEnterprise Adapter palette use the same transport configuration as the adapter service with which they are communicating. However, in some situations, you may want to override the transport configuration of the adapter service and use different transport parameters.

The Transport tab is available in activities in the ActiveEnterprise Adapter palette. This tab allows you to override the transport configuration of the adapter service. The Transport tab has different fields depending upon which transport is selected in the Transport Type field. Table 2 describes the fields of the transport tab.

 

Table 2 The Transport tab

Field	Global Var?	Description
Transport Type	No	The transport on which the incoming request will be received. This is normally the transport used by the adapter service, but you can override this by specifying different transport parameters. The possible values for this field are: • Adapter Service Default • Tibrv Reliable • Tibrv Certified • Tibrv Certified Message Queue • JMS Topic • JMS Queue The sub-sections of this table describe the fields that appear when each of these options is selected as the transport type.
Tibrv Reliable Transport See the TIBCO Rendezvous documentation for more information about these fields.
Subject	Yes	The subject of the incoming request.
Service	Yes	The service parameter of the transport of the incoming request.
Network	Yes	The network parameter of the transport of the incoming request.
Daemon	Yes	The daemon parameter of the transport of the incoming request.
SSL	No	Specifies that SSL should be used when connecting to the TIBCO Rendezvous daemon. See Configure SSL Button for more information about configuring SSL parameters.
Message Format	Yes	Specifies the message format for the message. This can be either AE message format or AE XML format. This field is only available on the Transport tab of the following activities: • Adapter Subscriber • Publish to Adapter • Wait for Adapter Message
Tibrv Certified Transport See the TIBCO Rendezvous documentation for more information about these fields.
Subject	Yes	The subject of the incoming request.
Service	Yes	The service parameter of the transport of the incoming request.
Network	Yes	The network parameter of the transport of the incoming request.
Daemon	Yes	The daemon parameter of the transport of the incoming request.
SSL	No	Specifies that SSL should be used when connecting to the TIBCO Rendezvous daemon. See Configure SSL Button for more information about configuring SSL parameters.
CM Name	Yes	The CM name of the incoming request.
PreRegister Listeners	Yes	This field is only available on activities that publish messages (for example, Invoke an Adapter Request Response Service or Publish to Adapter). This field specifies the cmname(s) of the certified subscriber(s). This allows the publisher to pre-register with any expected listeners. If multiple cmnames are specified, separate each cmname with a comma.
Relay Agent	Yes	Name of the relay agent, if one is used.
Ledger File	Yes	Name and location of the ledger file. Warning: TIBCO ActiveMatrix BusinessWorks constructs the default value of this field from global variables and the Adapter Service configuration. The value of this field must result in a valid path on the filesystem where the process is run. You may need to modify the default value in this field or modify the global variables used in this field to make sure the field results in a valid filesystem path.
Sync Ledger	Yes	When checked, this specifies the ledger file should be kept synchronous (asynchronous ledger updates are performed, if this field is unchecked).
Default Time Limit	Yes	The default message time limit for certified messages specified in milliseconds.
Require Old Messages	Yes	Specifies that unconfirmed messages should be kept in the ledger file.
Message Format	Yes	Specifies the message format for the message. This can be either AERV or XML. This field is only available on the Transport tab of the following activities: • Adapter Subscriber • Publish to Adapter • Wait for Adapter Message
Tibrv Certified Message Queue Transport See the TIBCO Rendezvous documentation for more information about these fields.
Subject	Yes	The subject of the incoming request.
Service	Yes	The service parameter of the transport of the incoming request.
Network	Yes	The network parameter of the transport of the incoming request.
Daemon	Yes	The daemon parameter of the transport of the incoming request.
SSL	No	Specifies that SSL should be used when connecting to the TIBCO Rendezvous daemon. See Configure SSL Button for more information about configuring SSL parameters.
CMQ Name	Yes	The CMQ name of the incoming request.
Complete Time	Yes	The amount of time (in seconds) the scheduler waits for a worker process to complete. If the worker process does not complete in the specified period, the scheduler reassigns the message to another worker.
Scheduler Weight	Yes	The scheduler weight for the process engine.
Scheduler Heartbeat	Yes	The scheduler heartbeat interval (in milliseconds).
Scheduler Activation	Yes	The scheduler activation interval (in milliseconds).
Worker Weight	Yes	The worker weight for the process engine.
Worker Tasks	Yes	The maximum number of incoming adapter requests this process engine can accept.
Message Format	Yes	Specifies the message format for the message. This can be either AERV or XML. This field is only available on the Transport tab of the following activities: • Adapter Subscriber • Wait for Adapter Message
JMS Topic Transport See the TIBCO Enterprise Message Service documentation for more information about these fields.
Topic	Yes	The topic name of the incoming request.
Auto Confirm	No	Specifies whether the incoming request should be automatically confirmed. This field is only available for activities that receive messages (for example, Adapter Subscriber). If check box is not selected then the message will be acknowledged at a later point by using the Confirm activity. If the message is not confirmed before the process instance ends, the message is redelivered and a new process instance is created to handle the new incoming message. Ensure that your process definition confirms the message.
Transactional	No	This field is only available for activities that receive messages (for example, Adapter Subscriber). Check this field when a transaction that can process JMS messages is included in the process definition and you want the incoming message to be a part of the transaction. Any reply or exception message associated with the incoming message is also part of the transaction. The message is acknowledged when the transaction commits. Checking this field disables the Auto Confirm field. See TIBCO ActiveMatrix BusinessWorks Process Design for more information about creating transactions.
Override Transaction	No	This field is only available for activities that publish messages (such as Publish to Adapter or Invoke an Adapter Request-Response Service). By default, ActiveEnterprise Adapter activities that are included in the appropriate transaction group are included in the transaction. Check this field if you want to exclude the activity from the transaction.
Durable	No	Specifies whether the client making the request is a durable subscriber. The durable subscription name is a concatenation of the process definition name and the name of the activity. This field is only available on the Transport tab of the following activities: • Adapter Subscriber • Adapter Request-Response Server • Wait for Adapter Message • Wait for Adapter Request
Durable Name	No	When the Durable field is checked, you can specify the name of the durable subscription that is registered with the JMS server in this field. This field is only available when the Durable field is checked.
Delivery Mode	No	This field is only available on the Transport tab of the Publish to Adapter or Invoke an Adapter Request-Response Service activities. This field specifies the delivery mode of the published message. This can be either persistent or non-persistent.
Time To Live	Yes	This field is only available on the Transport tab of the Publish to Adapter or Invoke an Adapter Request-Response Service activities. This field specifies the expiration time (in milliseconds) for the message. Specifying zero signifies the message should never expire.
JNDI Lookups	No	Specifies that references to the JMS objects (ConnectionFactory, Topic, and so on) should be obtained from a JNDI server.
SSL	No	Specifies that SSL should be used when connecting to the JMS server. See Configure SSL Button for more information about configuring SSL parameters.
Topic Connection Factory Name	Yes	Specifies the Topic ConnectionFactory object.
Connection User Name	Yes	The user name to use when connecting to the JMS server.
Password	Yes	The password to use when connecting to the JMS server.
Provider URL	Yes	The URL for the JMS server.
JMS Application Properties	No	Any application-specific message properties that is part of the message. This is specified by the JMS Application Properties shared configuration resource. Once specified, these properties appear on the Input or Output tab as "OtherProperties".
Transacted Session	Yes	Specifies if the AE Event Source is a part of a transaction. When selected, this field disables Transactional and Auto Confirm. The fields Precreate Transactions and XA Transaction Manager is not visible.
Precreate Transactions	Yes	When selected this field specifies that the transaction is created before a message arrives at the JMS receiver. This field is available when Transactional field is selected. Note: The Precreate Transactions feature should be used only with IBM MQ Websphere.
XA Transaction Manager	Yes	Specifies the XA Transaction Manager Configuration used to create the XA transaction. This field is available when Precreate Transactions field is selected.
JMS Queue Transport See the TIBCO Enterprise Message Service documentation for more information about these fields.
Queue	Yes	The queue name of the incoming request.
Delivery Mode	No	This field is only available on the Transport tab of the Publish to Adapter or Invoke an Adapter Request-Response Service activities. This field specifies the delivery mode of the published message. This can be either persistent or non-persistent.
Time To Live	Yes	This field is only available on the Transport tab of the Publish to Adapter or Invoke an Adapter Request-Response Service activities. This field specifies the expiration time (in milliseconds) for the message. Specifying zero signifies the message should never expire.
Transactional	No	This field is only available for activities that receive messages (for example, Adapter Subscriber). Check this field when a transaction that can process JMS messages is included in the process definition and you want the incoming message to be a part of the transaction. Any reply or exception message associated with the incoming message is also part of the transaction. The message is acknowledged when the transaction commits. Checking this field disables the Auto Confirm field. See TIBCO ActiveMatrix BusinessWorks Process Design for more information about creating transactions.
Override Transaction	No	This field is only available for activities that publish messages (such as Publish to Adapter or Invoke an Adapter Request-Response Service). By default, ActiveEnterprise Adapter activities that are included in the appropriate transaction group are included in the transaction. Check this field if you want to exclude the activity from the transaction.
JNDI Lookups	No	Specifies that references to the JMS objects (ConnectionFactory, Queue, and so on) should be obtained from a JNDI server.
SSL	No	Specifies that SSL should be used when connecting to the JMS server. See Configure SSL Button for more information about configuring SSL parameters.
Queue Connection Factory Name	Yes	Specifies the Queue ConnectionFactory object.
Connection User Name	Yes	The user name to use when connecting to the JMS server.
Password	Yes	The password to use when connecting to the JMS server.
Provider URL	Yes	The URL for the JMS server.
JMS Application Properties	No	Any application-specific message properties that will be part of the message. This is specified by the JMS Application Properties shared configuration resource. Once specified, these properties appear on the Input or Output tab as "OtherProperties".
Transacted Session	No	Specifies if the AE Event Source is a part of a transaction. When checked, this field disables the Precreate Transactions at the receiver and the fields Precreate Transactions and XA Transaction Manager Reference are not visible.
Precreate Transactions	Yes	When checked, this field specifies that the transaction is created before a message arrives at the JMS receiver. This field is available when Transactional field is selected. Note: The Precreate Transactions feature should be used only with IBM MQ Websphere.
XA Transaction Manager Reference	Yes	Specifies the XA Transaction Manager Configuration used to create the XA transaction. This field is available when Precreate Transactions field is selected.

Configure SSL Button

The Configure SSL button allows you to configure the SSL parameters when the transport supports SSL and the SSL field is checked. The following are the fields of the Configure SSL dialog.

Basic

The Basic tab of the SSL Configuration dialog allows you to specify the simplest required SSL configuration parameters for the connection. The Basic tab has the following fields:

Field	Description
Trusted Certificates Folder (JMS Transports)	Location of the trusted certificates on this machine. The trusted certificates are a collection of certificates from servers to whom you will establish connections. If the server you want to establish a connection to presents a certificate that does not match one of your trusted certificates, the connection is refused. This prevents connections to unauthorized servers.
Daemon Certificate (TIBCO Rendezvous transports)	File containing one or more certificates from trusted certificate authorities. This file is checked when connecting to a daemon to ensure that the connection is to a daemon that is trusted. This prevents connections to rogue TIBCO Rendezvous daemons that attempt to impersonate trusted daemons. You can retrieve a daemon’s certificate using the administration interface in TIBCO Rendezvous. See the TIBCO Rendezvous documentation for more information about obtaining certificates through the administration interface. Once retrieved, you can select a folder in your project and import this certificate into the folder using the Tools>Trusted Certificates>Import Into PEM Format menu item.
Identity	This is an Identity resource used to authenticate to the JMS server or TIBCO Rendezvous daemon. The Browse button allows you to select from a list of appropriately configured Identity resources. For TIBCO Rendezvous transports, only Identity resources with the Type field set to Identity File or Username/Password are listed. See TIBCO Designer Palette Reference for more information.

Advanced

The Advanced tab of the SSL Configuration dialog allows you to specify more advanced SSL configuration parameters for the connection. The Advanced tab is available only for JMS transports.

Field	Description
Trace	Specifies whether SSL tracing should be enabled during the connection. If checked, the SSL connection messages are logged and sent to the console.
Debug Trace	Specifies whether SSL debug tracing should be enabled during the connection. Debug tracing provides more detailed messages than standard tracing.
Verify Host Name	Specifies whether to verify that the host you are connecting to is the expected host. The host name in the host’s digital certificate is compared against the value you specify in the Expected Host Name field. If the host name does not match the expected host name, the connection is refused.
Expected Host Name	Specifies the name of the host you are expecting to connect to. This field is only relevant if the Verify Host Name field is also checked. If the name of the host in the host’s digital certificate does not match the value specified in this field, the connection is refused. This prevents other hosts from attempting to impersonate the specified host.
Strong Cipher Suites Only	When checked, this field specifies that the minimum strength of the cipher suites used can be specified with the bw.plugin.security.strongcipher.minstrength custom engine property. See TIBCO ActiveMatrix BusinessWorks Administration for more information about this property. The default value of the property disables cipher suites with an effective key length below 128 bits. When this field is unchecked, only cipher suites with an effective key length of up to 128 bits can be used.

Copyright © Cloud Software Group, Inc. All Rights Reserved