Information
This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

Configuring the AR System server to access a plug-in server


To access a plug-in server, the AR System server needs its host name and port number. The server searches for the host name and port number in this order:

  1. The plug-in alias, if any.
  2. The plug-in server entry on the Connection Setting tab of the AR System Administration: Server Information form. (This entry is also required to set a password for a plug-in server.)
  3. The local host and the port number specified by the Plugin-Port setting in the AR System Administration: AR System Configuration Generic UI form. (See Specifying-passwords-and-properties-for-connecting-services-to-the-server.)
  4. The port number that the plug-in server registered with the portmapper.

To access one C or Java plug-in server with no password running on the same computer as the AR System server, only the Plugin-Port option in the AR System Administration: AR System Configuration Generic UI form is required. To specify a password for a plug-in server, an entry on the Connection Settings tab of the AR System Administration: Server Information form is required.

To access two or more plug-in servers (for example, to access the C and Java plug-in servers or to access plug-in servers on two or more computers), define aliases for all plug-ins other than those loaded by the primary plug-in server that is set up as described in the previous paragraph.

For more information on using AR System Administration: Server Information form, see Updating-configuration-settings-by-using-the-AR-System-Configuration-Generic-UI-form.

Defining plug-in aliases

You define plug-in aliases in the AR System Administration: AR System Configuration Generic UI form. Use this format:

Server-Plugin-Alias: aliasName realName hostName[:portNumber]

Parameter

Description

aliasName

Name referenced in AR System applications. AR Filter API calls and vendor forms reference this alias name. This is an arbitrary string, but it cannot include semicolons or blank-space characters, such as spaces, tabs, or new lines.

realName

Actual name that the plug-in exposes to the plug-in server.

hostName

Name of the host the AR System server accesses to find the associated plug-in server.

portNumber

Port number the AR System server connects with when accessing the associated plug-in server. This is optional. If you do not specify a port number, the Plugin-Port is used.

See the Server-Plugin-Alias option in Configuration-settings-S-Z. For more information, see Updating-configuration-settings-by-using-the-AR-System-Configuration-Generic-UI-form.

Plug-in aliases examples

Following are examples of plug-in aliases.

Vendor form accessing the ARDBC plug-in

In the following example, a vendor form that accesses the ARDBC plug-in named RMDY.ARDBC.XML is redirected to the plug-in by the same name on the plug-in server running on myhost.

Server-Plugin-Alias: RMDY.ARDBC.XML RMDY.ARDBC.XML myhost 

Workflow accessing the ARF plug-in

In the following example, workflow that accesses the ARF plug-in named RMDY.ARF.PERL.myhost is redirected to the RMDY.ARF.PERL plug-in on the plug-in server running on myhost.

Server-Plugin-Alias: RMDY.ARF.PERL.myhost RMDY.ARF.PERL myhost 

Vendor form accessing the ARDBC plug-in

In the following example, a vendor form that accesses the ARDBC plug-in named RMDY.ARDBC.LDAP.myhost.1 is redirected to the RMDY.ARDBC.LDAP plug-in on the plug-in server running on myhost and listening at port number 11001.

Server-Plugin-Alias: RMDY.ARDBC.LDAP.fred RMDY.ARDBC.LDAP
myhost:11001 

AR System server accessing the AREA plug-in

When the AR System server accesses the AREA plug-in, it connects to the plug-in on the plug-in server that is running on myhost. As shown in the following example, only one AREA plug-in can exist, so the reserved name AREA is used for the alias.

Server-Plugin-Alias: AREA AREA myhost 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

AR System 21.3