Info*Engine Server
The Info*Engine server provides a mechanism for retrieving and manipulating the data that users or custom applications want to view or receive.
 |
The Info*Engine Server entry is no longer used by default. However, you can create an entry to integrate with a legacy standalone installation of Info*Engine.
The Windchill adapter is now used instead.
|
See Common Properties and Actions for information about properties that are not listed here, as well as instructions on using available form buttons and correctly entering attribute values.
Credentials Mapping Properties
You can set up authentication mapping through the server by specifying the credentials files to use. Credentials files allow a user to be logged in to a server with credentials that are appropriate for one or more adapters.
Credentials mapping properties are typically configured in the wt.properties file rather than through the Property Administration utility. However, you can use the Property Administration utility to set some credentials mapping properties when configuring a new adapter.
For more information, see Credentials Mapping.
Credentials Mapper
credentialsMapper
The relative path to the authentication task that your site has created for authenticating users through Info*Engine. This path is relative to the configured task root. This property is optional.
When the business task processor is called to execute a business task, it checks for the credentialsMapper property. If the property has been set, the task processor executes the authentication mapping task before executing its assigned task. The authentication mapping task can use the username as a key to obtain user-specific authentication information from one or more adapter-accessible information systems. It can then create an output group from that authentication information.
If you do not specify the credentialsMapper property, Info*Engine does not execute a server-based authentication mapping task before executing the specified task.
Credentials Files
credentialsFiles
The relative path to the directory that your site has created for storing an authentication mapping file for each user. The name of each mapping file must match the authenticated username passed to Info*Engine. The directory path is relative to the configured task root. This property is optional.
◦ If this property is not specified, Info*Engine does not look for an authentication mapping file.
◦ If specified, Info*Engine attempts to open and read an authentication mapping file that corresponds to the username provided
The file is opened before executing a business task and before executing the task named in the credentialsMapper property.
Credentials Time To Live
credentialsTimeToLive
This property improves performance by allowing the task processor to read authentication information from a cache. Otherwise, the task processor sends for authentication information each time authentication files are read or authentication map tasks are executed.
The value of this property is the number of milliseconds for which authentication information is cached before being refreshed. The value must be a positive integer or it is ignored. If this property is not defined, the authentication group information is not cached and performance remains the same.
Task Compiler Properties
By specifying compiler properties, you can set the location of compiled tasks, as well as any additional files that need to be added to the classpath.
For more information, see About Info*Engine Tasks and Task Rules.
Codebase
codebase
The directory where compiled tasks are located.
Compiler Classpath
compiler.classpath
Additional JAR and class files to add to the classpath when compiling tasks. Enter a standard Java classpath. For a Windows system, use a semicolon (;) as the path separator. For a Unix system, use a colon (:) as the path separator.
Lib Directory n
compiler.libDirectoryn
If additional JAR and class files are added to the classpath, use this field to specify the directory where those files are located.
The first value of n must be 1 and its value must increase sequentially.
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).
Startup Task n
startupTaskn
You can configure Info*Engine to execute specific tasks at startup. For example, you can automatically generate Queue or Event subscriptions. The first value of n must be 1 and its value must increase sequentially, such as the following example:
com.infoengine.startupTask1=msg/subscribeQueue.xml
The value for this property is the path for the task that is initiated when Info*Engine starts.
For more information, see Info*Engine Tasks.
XML Parser Debug
request.xmlParser.debug
Enable XML parser debugging. This prints information when parsing incoming XML for debugging purposes.
Request Debug
request.xmlStream.debug
Enable XML logging requests. This prints incoming XML for debugging purposes.
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. You can also enter it as the value of the Default JMS Service property for the Info*Engine server or adapter.
|
For more information, see the following topics:
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.
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 in the message is placed. 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 in the message is placed. 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 in the message is placed. 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.
Default Results Queue
msg.defaultResultsQueue
The LDAP distinguished name of an administered queue. The value can be an LDAP dname 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 DESTINATION parameter must be specified.
Send-Mail Webject Properties
The Send-Mail webject creates and sends email messages. Configuring the Send-Mail webject properties allows you to set certain default values when executing the webject.
For more information, see Configuring Send-Mail Properties and the Send-Mail webject description.
To configure Send-Mail default settings, set the following properties:
Default Mail Originator
mail.originator
The default originator (the email address sending the message) used by the Send-Mail webject.
Corresponds to the FROM webject parameter.
Default SMTP Server
mail.smtp.server
The default server used by the Send-Mail webject.
Default SMTP User Name
mail.smtp.username
The default username provided when connecting to the SMTP server.
Corresponds to the USERNAME parameter.
Default SMTP Password
mail.smtp.password
The default password associated with the Default SMTP User Name.
Corresponds to the PASSWORD parameter.
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.