Info*Engine Servlets
An Info*Engine servlet provides an interface between Info*Engine and a web server. You can use the servlet to invoke Info*Engine tasks directly over HTTP or HTTPS. When tasks are invoked through an Info*Engine servlet, the Info*Engine Virtual Database (VDB) is rendered as XML in the response.
This form also provides the default configuration for the SOAP RPC servlet. SOAP (Simple Object Access Protocol) is a lightweight, XML-based protocol that can be used by third-party applications. The
Info*Engine SOAP servlets catch and process
Info*Engine SOAP requests that are made over the web, allowing you to exchange information and execute customized
Info*Engine business tasks remotely. For more information, see
SOAP Services.
See
Common Properties and Actions for information on 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.
Task Root
taskRootDirectory
The path to the root of the XML business tasks.
The root file system directory under which the servlet can find all XML business tasks. This allows the servlet to compile and execute the tasks locally.
This property is useful when the servlet is run without a task processor.
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).
Server Name
ieServerName
The name of the Info*Engine server or task processor used by the servlet. This value is supplied by default.
Task Prefix
taskPrefix
The prefix used in URLs that reference XML business tasks. This prefix helps the servlet determine whether to send requests to the task processor or the template processor. The default value is /infoengine/servlet/IE/tasks/.
The Info*Engine servlet provides URLs that start with this prefix to the task processor. For example, if the default prefix is used, the web server is named “myServer”, and a user enters the following URL:
http://myServer/infoengine/servlet/IE/tasks/myTask.xml
The Info*Engine servlet hands off the URL to the task processor, which locates and executes “myTask.xml”.
The first entry in the prefix must be set to the same value that you entered for the application URL. This is set when configuring the servlet engine to run with the Info*Engine servlet. For the JRun and Tomcat servlet engines, Windchill sets the prefix value and the corresponding servlet engine settings for you.
|
|
PTC recommends that you do not change the /servlet/IE/tasks/ part of the prefix. If you change this part of prefix, you must make manual changes in the servlet engine. If you want to allow other URL reference prefixes, you can set up URL redirection in your web server.
|
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.
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.
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.
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.
Property Administrator Properties
When you first
log on to the Property Administration utility, the
Base URI value is automatically generated. This information can later be configured in the servlet settings.
Administration Base URI
The default base URI for the Property Administration utility user interface. This value determines which services, adapters, and property sets are listed on the Property Administration main page.
Specify a fully qualified LDAP URL that points to the location of the properties that can be configured.
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.
