Common Configuration Entry Properties
The Info*Engine Property Administration utility includes several properties that appear on most service and adapter forms, such as component identification and supporting services information. There are also several buttons and actions that are commonly available in the Property Administration utility, regardless of the specific service or adapter.
For more information, see the following topics:
Entering Values
When entering values such as URIs and URLs into the Property Administration utility, note that Info*Engine identifies filepaths using the forward slash (/) as the separator in configuration entries. The back slash (\) character is used as an escape character.
 |
The back slash (\) is the directory separator used on Windows systems. If you prefer to use the back slash in filepaths, you must escape it by entering two back slashes (\\) for each back slash (\) in the path.
|
The URI or URL can be relative or absolute:
• Relative URIs and URLs reference files that reside under the root file system directory that is defined for the local Info*Engine task processor.
• Absolute URIs and URLs reference files that reside in the local file system, reside on a remote HTTP server, or are referenced through an accessible JSON configuration files.
For more information, see Specifying URIs and URLs.
Common Properties
The following properties commonly appear when creating and editing a service or adapter. If a property does not appear as an available field, it might be available using the form editor. For more information, see Using the Form Editor.
|
Field
|
Description
|
||
|---|---|---|---|
|
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.
|
||
|
Additional Services
|
Additional services are JSON entries that are read concurrently with the service or adapter. These entries can share properties and are helpful when multiple directories are in use. This allows Info*Engine to retrieve properties from more than one repository, as well as properties from other remote subtrees within the same LDAP repository.
|
||
|
Co-Resident Services
|
A co-resident service is an Info*Engine service that is allowed to call on the adapter or service as an in-process component. Enter the distinguished name of the co-resident service.
|
||
|
Distinguished Name
|
The Info*Engine Property Administration utility suggests a default value based on the JSON directory structure identified in the base URI.
If you modify the Service Name field, the ptcServiceName attribute in the distinguished name is updated to include the service name changes.
|
||
|
Host and Port
|
These fields are required when running an adapter out of process.
If the specified component is associated with a service that is configured to run independently in its own Java Virtual Machine, it will have one or more host names and port numbers associated with it.
If only one host name and port number is defined for the service, the Naming Service returns that one combination. If more than one combination of host names and port numbers are defined for a service, the Naming Service randomly selects and returns one of the combinations.
|
||
|
Runtime Service Name
|
The runtime service name defines the prefix of the properties for the service. This name is also used when starting the component through a Java command argument or a servlet engine initialization parameter.
By default, the runtime service name is the same as the service name. If the runtime service name is not set, the service name is used as the prefix for the properties.
|
||
|
Serialization Type
|
The Serialization Type field allows you to change the type of data serialization Info*Engine uses when passing data to an out-of-process adapter or an external task processor.
By default, Info*Engine components use Java serialization when passing data between components. Java serialization preserves data type information so that the data can be easily manipulated from within an Info*Engine custom application, task, or Java Server Page.
The default value is java. This sets the ptcObjectSerializationType attribute to application/java-serialization-object.
You only need to change the serialization type is in the following cases:
• You are configuring an out-of-process adapter or external task processor whose Java classes are incompatible with the client Java classes.
• You are configuring a custom adapter that only accepts XML.
In these cases, set the value to xml. This sets the ptcObjectSerializationType attribute to text/xml.
|
||
|
Service Class
|
The supporting Java class name for the adapter or service.
If the specified component name is associated with a co-resident service, such as an adapter that has been configured to run in the same Java Virtual Machine (JVM) as the server, it has a class name associated with it. In this case, the Naming Service returns the class name associated with the service. This provides the component querying the Naming Service with the information it needs to call the service directly without having to create a TCP connection to it.
If you are configuring an in-process service or adapter:
• Leave the default service class name in the Service Class field
If you are configuring an out-of-process service or adapter:
• Delete the name in the Service Class field
• Add the host and port used to access the adapter in the Host and Port fields
|
||
|
Service Name
|
The service name is used to identify a service or adapter. If this name is specified in more than one component definitions, the multiple definitions are assumed to provide alternate, but equivalent, paths to the same component. The Naming Service then implements load balancing by randomly selecting the returned component address. The service name can also be specifically used to implement load balancing.
You can use the same service name in separate component entries, but these entries must be placed in different structures within the directory. Otherwise, you can place each component in different entries within the same directory structure. In this case, each component can have both a unique service name and a common service name. The unique service name is specified when the component is created. The common service name can be added by clicking an existing component as it appears on the main page of the Property Administration utility.
|
Connection Pooling
The following properties affect connection pooling between an Info*Engine server or servlet and out-of-process adapters. These are global properties affecting every service that might be running in a JVM.
If they must be specified, they should be specified in the -D command line option of the Java command that initiates the JVM. This ensures that they are registered in the initial system properties object.
|
Property
|
Description
|
|---|---|
|
com.infoengine.maxConnectionAge
|
The maximum amount of time, in seconds, that a connection can remain idle before being removed from the pool.
The default value is 60.
|
|
com.infoengine.maxConnectionCacheSize
|
The maximum number of connections that the pool can contain.
The default value is 50.
|