Windchill Adapter Properties
The Windchill adapter properties form is comprised of common properties and properties specific to the adapter.
Common properties are at the top of the form. These fields define the attributes associated with the LDAP entry. See
Common Properties and Actions for information about properties not listed here, as well as instructions on using the form and importing and exporting LDAP entries.
The following topics might be helpful when specifying property values:
• “Specifying URIs and URLs” in the Info*Engine User's Guide
• “Credentials Mapping for MOMs” in the Info*Engine User's Guide
• “Implementing Task Queuing” in the Info*Engine Implementation Guide
• “Implementing Messaging and the Web Event Service” in the Info*Engine Implementation Guide
General Properties
To specify general properties, use the following fields:
Home Directory
home
The Info*Engine root installation directory. The root installation directory for Info*Engine is the same as the root installation directory for Windchill (wt.home).
Load Balancer
load.balancer
The load balancer implementation that Info*Engine clients should use when communicating with the Windchill adapter. This value is typically set to wt.adapter.LoadBalancer, which leverages Windchill RMI in a multi-method server environment to select the best method server to process the next request.
Secret
secret.text
A string used to sign and validate requests sent to the adapter. The value you enter acts as a password and is used to authenticate your request.
This property is not required, but adds additional security to the LDAP entry. If you enter a value, the out-of-process adapter name specified in the webject INSTANCE parameter must identify an LDAP entry that has this secret password set.
For information about validating requests, see “Credentials Mapping for Adapters” in the Info*Engine User's Guide. and “Changing Info*Engine Request Validation Properties”.in the Windchill Administration - Configuring Your Windchill Environment.
Secret 2
secret.text2
Another string used to sign and validate requests sent to the adapter. This property generates a more comprehensive request signature, and can be used instead of or in addition to the Secret property.
For information about validating requests, see “Credentials Mapping for Adapters” in the Info*Engine User's Guide. and “Changing Info*Engine Request Validation Properties”.in the Windchill Administration - Configuring Your Windchill Environment.
Secret Algorithm
secret.algorithm
The algorithm used to encrypt the values of the Secret and Secret 2 properties.
Valid values are SHA-1, MD2, and MD5. The default for this property is SHA-1. The default value is SHA-1.
Default JMS Service
jms.defaultService
The name of the JMS service that should be used for any MSG and WES webjects that are invoked without a SERVICE parameter.
Core JMS Properties
The following properties are commonly set when configuring Info*Engine with a Java Messaging Service (JMS). Property descriptions are grouped based on the location of the properties in the form and the function they perform.
|
|
When configuring Info*Engine with a JMS MOM, it is best to instead create a new JMS service entry. You can specify core and additional properties using the property editor for that JMS service entry.
You can then enter the service name of that JMS service as the SERVICE parameter for MSG and WES webjects. Or you can enter it as the value of the Default JMS Service property for the Info*Engine server or adapter.
|
JMS Context Provider Factory
jms.CtxFactory
The class name of the factory used to return the initial JNDI context during administered object lookup. If not specified, it is assumed administered objects are stored in the LDAP.
The default value is com.sun.jndi.ldap.LdapCtxFactory.
JMS Base URI
jms.baseUri
The LDAP Uniform Resource Indicator (URI) to which JMS-related URIs are relative.
This serves as a base location where JMS-related administered objects can be found.
JMS Base URI Principal
jms.baseUri.principal
The username provided to authenticate the associated JNDI user to the JMS Base URI.
JMS Base URI Password
jms.baseUri.password
The password associated with the JMS Base URI Principal.
JMS User
jms.username
The default user associated with the JMS provider or MOM.
JMS Password
jms.password
The default password used to connect to the JMS provider or MOM.
Queue Connection Factory
msg.queueConnectionFactory
The location of an administered JMS queue connection factory used by the JMS MOM.
Topic Connection Factory
wes.topicConnectionFactory
The location of an administered JMS topic connection factory. This value can be a fully qualified URI or can be a distinguished name relative to a configured base URI. For more information, see “Implementing Messaging and the Web Event Service” in the Info*Engine Implementation Guide.
WES Subscription Identifier
wes.subscriptionIdentifier
Unique identifier used when creating topic subscriptions. Set this property if multiple Info*Engine processes on a single host want to generate a subscription to the same topic.
Each separate Info*Engine service must have its own unique identifier. If this property is not specified, an identifier is generated based on the host name and event name.
JMS Library Directory
jms.lib
The directory in which the third-party JAR files required to communicate with a JMS service are located. If the JAR files are already included in the service classpath, this property is optional.
Additional JMS Properties
The following properties can also be set when configuring Info*Engine with a JMS service. Property descriptions are grouped based on the location of the properties in the form and the function they perform.
JMS Recovery Retry Interval
jms.recoveryRetryInterval
The amount of time in seconds to wait between attempts to re-establish a connection if the MOM becomes disconnected.
The default value is 30.
JMS Bad Message Queue
jms.badMessageQueue
If a message is received that cannot be translated into an Info*Engine request, this property defines the queue where the message is placed for an administrator to handle. If this property is not defined, the bad message is discarded.
WES Context Provider Factory
wes.CtxFactory
The class name of the factory used to return the Windchill initial context during administered object lookup.
The default value is com.sun.jndi.ldap.LdapCtxFactory.
WES Base URI
wes.baseUri
The LDAP Uniform Resource Indicator (URI) (a subtree within an LDAP directory) where WES-related administered objects can be found.
If not specified, the jms.baseUri property is used.
WES User
wes.username
The WES username that should be provided when connecting to a JMS MOM.
If not specified, the jms.username property is used.
WES Password
wes.password
The password associated with WES User.
If not specified, the jms.password property is used.
WES Bad Message Queue
wes.badMessageQueue
If a message is received that cannot be translated into an Info*Engine request, this property defines the queue where the message is placed for an administrator to handle. If this property is not defined, the bad message is discarded.
If not specified, the jms.badMessageQueue property is used.
MSG Context Provider Factory
msg.CtxFactory
The class name of the factory used to return the initial JNDI context during administered object lookup.
The default value is com.sun.jndi.ldap.LdapCtxFactory.
Queue Base URI
msg.baseUri
The LDAP Uniform Resource Indicator (URI) (a subtree within an LDAP directory) where queue-related administered objects can be found.
If not specified, the jms.baseUri property is used.
Queue User
msg.username
The username that should be provided when connecting to a JMS MOM.
If not specified, the jms.username property is used.
Queue Password
msg.password
The password associated with Queue User.
If not specified, the jms.password property is used.
MSG Bad Message Queue
msg.badMessageQueue
If a message is received that cannot be translated into an Info*Engine request, this property defines the queue where the message is placed for an administrator to handle. If this property is not defined, the bad message is discarded.
If not specified, the jms.badMessageQueue property is used.
Default Subscribe/Submit Queue
msg.defaultExecutionQueue
The LDAP distinguished name of an administered queue. The value can be an LDAP distinguished name relative to a configured base URI or a fully qualified LDAP distinguished name. If relative, the cn= (common name attribute) is implicit if not explicitly specified.
This queue location is used with the following webjects:
◦ Queue-Task—The location where queued tasks are placed. If this property is not specified, the webject QUEUE parameter must be specified.
◦ Subscribe-Queue—The queue to subscribe to when using the webject. If this property is not specified, the webject QUEUE parameter must be specified.
For more information on webjects, see the Info*Engine User's Guide.
Default Results Queue
msg.defaultResultsQueue
The LDAP distinguished name of an administered queue. The value can be an LDAP distinguished name relative to a configured base URI or a fully qualified LDAP distinguished name. If relative, the cn= (common name attribute) is implicit if not explicitly specified.
This queue location is used with the following webjects:
◦ Query-Results—The queue location where results are placed. If this property is not specified, the webject QUEUE parameter must be specified.
◦ Delete-Results—The queue location where results are placed. If this property is not specified, the webject QUEUE parameter must be specified.
◦ Queue-Task—The queue location where results are placed. If this property is not specified, the webject DESTINATION parameter must be specified.
For more information on webjects, see the Info*Engine User's Guide.
Dynamic Properties Configuration
Configuration information for a service or adapter can be updated while the service or adapter is running, allowing you to update properties without requiring a restart.
The Time To Live property specifies the time that elapses, in minutes, before the properties for a service or adapter are automatically reloaded. Properties are only automatically reloaded if they are being accessed. By default, the properties do not expire.
Additional Properties
If a property is not defined on the form, you can add it in the Additional Properties field. When adding additional properties, the property name format includes the name of the adapter entry (the service name) followed by the property name. For example:
<service_name>.dbuser
In the appropriate fields, specify the property used by the service or adapter and the value of that property. Click Add next to the new property name to open a text box in which you can modify the property value.
If the value becomes too long to view in its entirety, an Edit action appears. Click Edit to open a new browser window with a larger text area.
