Register the components

The Registry file contains information about each of the installed components that use Configuration Repository.

Structure

The Registry file contains a list of:

  • components parameters
  • PassPort parameters.

Example:

<?xml version="1.0" encoding="UTF-8"?>

<registry>

<components>

<component>

<componentName>Designer</componentName>

</component>

<component>

<componentName>InterplayRuntime1</componentName>

</component>

</components>

<passportSettings>

<passportParameters>…</passportParameters>

<passportParameters>…</passportParameters>

</passportSettings>

Component settings

Fixed settings

Fixed settings can be mandatory or can depend on the implementation type (Web or standalone application).

 

Field Sub-field Description

<componentName>

(Mandatory)

 

Must be provided when a component:

  • Registers itself into the configuration repository.
  • Gets its configuration from repository.

It must be unique within the Registry,

<applicationName>

(Mandatory)

 

Used to get settings from the Configuration Repository (Object Types, Collection Types, user interface configuration, libraries, etc.)

Default values are depending on application type:

  • Designer: designer
  • Others: default
<implementationType>  

Defines how the application will run:

  • In a J2EE Web server: WEB_APPLICATION
  • As a standalone Java application: STANDALONE_APPLICATION
<license>   Set at installation time, it can be updated later using Administration.
<componentGroup>  

Contains cluster name if several components are grouped into a cluster.

<passportEnabled>  

Indicates how security is managed:

  • Set to true, security is handled using Passport
  • Set to false, security is handled using the default component security implementation

When Passport is enabled, Passport settings that correspond to the application name are used to create a connection.

<host>  

Web applications only

Indicates host name, IP address or fully qualified domain name of the computer that hosts the application. It is only set for Web applications.

<port>  

Web applications only

Port where the server listens for incoming connections. It is only set for Web applications.

<url>  

Web applications only

Location of the Web application.

<workManager>  

Thread pool the application uses to execute jobs.

  <jndiName> JNDI name of the work manager resource that the Web Administrator has created on the Web server.
  <parameters> List of extra work manager parameters usually used to tune number of working threads.
<timer>   Timer implementation the application uses to schedule actions/jobs.
  <jndiName> JNDI name of the work manager resource that the Web Administrator has created on the Web server.
  <parameters> List of extra timer parameters.
<databases>   List of database settings. A component can use more than one database schema. Each of the database settings will contain sub-fields.
  <jndiName> JNDI name of the Datasource resource that the Web Administrator has created on the Web server.
  <user> Database user name
  <password> Database user password that must be encrypted.
  <url> JDBC location
  <parameters> List of extra database parameters usually used to tune the database connection pool parameters.

Variable settings

You can use variable settings to store and retrieve custom configuration properties for a component using name and value parameters.

Values are stored as strings and the component will convert them if necessary.

Example of the structure of a component custom parameter:

<parameter>

<name>pageSize</name>

<value>1</value>

</parameter>

PassPort settings

You define the Passport parameters per application name. Each Passport enabled component uses the parameters that correspond to its application name.

Passport self-registration must be executed only once per component and the certificate must be shared between components when a Passport connection is created. The certificate is stored in the Configuration Repository and the synchronization between components to execute self registration only once will be done using the database.

The Truststore and later on, at registration time, Keystore will be stored into the database.

Example of Passport connection parameters

<applicationName>myApp</applicationName>

<amServerHost>passportHost</amServerHost>

<amServerPort>6090</amServerPort>

<amComponentGroup>Axway</amComponentGroup>

<amComponentId>default</amComponentId>

<amUseSecuredConnection>false</amUseSecuredConnection>

<amComponentUserDomain>Axway</amComponentUserDomain>

<amSSOPort>0</amSSOPort>

<amcsdName>csd_InterPlay.xml</amcsdName>

<amTrustStoreName>truststore.jks</amTrustStoreName>

Field Value Description

<applicationName>

 

Mandatory application name that must be unique within the Registry.

<amServerHost>  

Host of the machine where the PassPort AM server is installed.

<amServerPort>  

Port on which the PassPort AM server is installed.

<amComponentGroup> Axway

Component group

<amComponentId> default Identifier the component takes after importing the CSD file.
<amUseSecuredConnection> false or true

Set if the connection is to be secured.

<amComponentUserDomain> Axway

 

<amSSOPort>  

Port to use when AccountingIntegrator is accessed from a SSO page.

<amcsdName>
  Name of the CSD configuration file that will be imported from and exported into a separate file.
<amTrustStoreName>  

Name of the Truststore that will be imported from and exported into a separate file.

 

Related Links