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


To access a plug-in server, the AR System serverneeds its hostname and port number. The server searches for the hostname and port number in the following order:

  1. In the plug-in alias, if any.
  2. In 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. Against the local host and the port number that are specified by the Plugin-Port setting in the AR System Administration: AR System Configuration Generic UI form.
    For more information, see Specifying-passwords-and-properties-for-connecting-services-to-the-server.
  4. Against the port number that the plug-in server registered with the portmapper.

To access a C or Java plug-in server, consider the following use cases:

Plug-in server

Configuration

Single C or Java plug-in server

  • If no password is running on the same computer as the AR System server, use only the Plug-in Port option in the AR System Administration: AR System Configuration Generic UI form.
  • If a password is required for the plug-in server, make sure to include an entry on the Connection Settings tab of the AR System Administration: Server Information form.

Two or more plug-in servers

For example, to access both the C and Java plug-in servers or to access plug-in servers on two or more computers.

Define aliases for all the plug-ins other than those loaded by the plug-in server. 

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

Define plug-in aliases

You can define plug-in aliases in the AR System Administration: AR System Configuration Generic UI form. Use the following 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 (Optional)

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

For information about Server-Plugin-Alias, 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

The following examples show how you can use plug-in aliases to redirect a Vendor form or workflow to the correct plug-in:

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, a 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*