System Configuration

Admin User Creation

The FMC connects to the server over a secure authenticated connection. The default user is admin. The password must be created in file user.cfg on the machine on which the server is installed prior to connecting to the FMS server. This is done as follows

FMC

FMC is the primary administration interface for administering the FMS server. Invoke FMC as follows

Server Administration

The FMS server configuration is stored in an XML file typically called ConnectionConfiguration.xml. The configuration can be accessed either via connecting the FMS Management Console (FMC) to an FMS server or by directly editing the FMS configuration file using a standard text editor and the fmsconf utility as described in section the Section called fmsconf Server Configuration Utility in the Chapter called FMS Tools and Utilites.

Command Descriptions:

• MOTD

  View the Message Of The Day as set in the administration interface.

• Refresh Configuration

  Reload the Configuration file but do not reload the live connections, useful when adjusting Partner Identifiers, Processing Modes/Events and other business orientated configurations.

• Log Level

  Adjust the current server logging level. The previous log level will be indicated by the selected button in the list of log levels.

• Reload Interfaces

  Close all the current connections and reload the Interface Configuration, useful when updating port numbers, hostnames, or security requirements, refer to the Section called FMS Messaging Configuration for more information.

• Close Interfaces

  Close all the current interfaces. Warning: All the interfaces will be shut down, including the administration interface (excluding current sessions). A server restart will be required to re-establish the interfaces should the management console disconnect while the interfaces are closed.

Server Settings

The server initial settings, typically stored in main.conf, can be viewed by right clicking on the Server connection node and selecting Properties.

The detail of the main configuration is as follows

FMS Messaging Configuration

After a Business to Business (B2B) Messaging Agreement has been proposed the messaging configuration settings in accordance with the messaging protocol and partner agreements must be defined in order to receive and send B2B Messages.

Messaging configuration details may be configured using the FMC or directly using a text editor in the server ConnectionConfiguration.xml file.

The Interface Configuration node of the FMC enables a fast and efficient way of configuring FMS interfaces. This configuration can also be performed manually by editing the file ConnectionConfiguration.xml, note that this is only recommended for advanced administrators.

New Configurations are created by selecting the New toolbar button and clicking on the New Interface option. This is only necessary for advanced customisation when adding a new protocol to FMS. Typically this is not required because the default interfaces can simply be edited. The security and database settings can be configured on a per Interface Configuration basis as per the above configuration screen shot should these be required. The Interface security level sets a minimum security level for all messages sent using this interface. Note that higher values will override Processing Mode Event Security level settings.

After the server has been started or initialised, all the enabled listener/sender configurations will be populated with default values. This screen is accessible by selecting the node for each listener/sender.

Partner Identifier Configuration

A mapping of a Partner Identifier (eg. DUNS number) to other relevant partner information needs to be created for use within the system. A default local and remote partner is automatically created by the system on startup. These should be modified according to requirements.

Create or modify an existing Partner Identifier entry by selecting New from the main menu or toolbar. Select New PartnerIdentifier. Complete the required information as follows and select Save to finalise the changes.

• Identifier - The actual value, or name, of the partner identifier. The partner identifier on the local side (producer) must correspond with the partner identifier on the remote side (consumer) and vice versa.

• Partner Type - The type of the partner identifier being either a LOCAL_PARTNER or REMOTE_PARTNER.

• Identifier Type - The type of the partner identifier (urn:oasis:names:tc:ebxml-cppa:partyid-type:duns is used in this example). The type must match the type of the PartyID in the PartyInfo section of the CPA if used with the ebMS specification.

• Keystore Alias - The Keystore Alias entry stores an Alias name in the Keystore referring to a remote partner's public certificate and the local partners private key. The public key is used to encrypt a message to be sent to the corresponding remote partner where it will be decrypted using the private key. The local partner private key is used to generate digital signature which may be attached to the message[s] and/or to the envelope containing the set of messages and optional attachments. The remote partner MSH uses the local partner public key to verify the signatures.

• Alias Password - A password is required if the above alias refers to a Private Key and is used to retrieve the key during envelope and message signing and message decryption.

• Keystore ID - The reference to a KeyStore from the server configuration which contains the above Private and/or Public Keys.

• Partner mailBox ID - the optional configurable inbound message mailbox for local partners, LOCAL_PARTNER, and outbound message mailbox for remote partners, REMOTE_PARTNER. The mailBox setting will override the interfaceConfig.deliveredContent directory.

  Mailbox directories starting with the directory separator will be treated as absolute. Directories starting without a directory separator will be saved in the FMS installation directory.

  Mailbox directories may either be explicit directory names or customised using the following variables determined from inbound messages for local partners.

  • $toPartner - message to partner identifier with any preceding URI elements removed to ensure a consistent directory structure.

  • $fromPartner - message from partner identifier with any preceding URI elements removed to ensure a consistent directory structure.

  • $messageID - message identifier with any preceding URI elements removed to ensure a consistent directory structure.

  • $conversationID - message conversation identifier with any preceding URI elements removed to ensure a consistent directory structure.

  • $service - message service with any preceding URI elements removed to ensure a consistent directory structure.

  • $action - message action identifier with any preceding URI elements removed to ensure a consistent directory structure.

• Endpoint URL - The Endpoint URL entry stores the endpoint URL of the partner. This being the URL of the remote service that the partner will be invoking. This entry is used in the send or response action during asynchronous service interaction with a remote partner service.

  The actual endpoint used depends on several conditions being as follows

  Processing Mode CPP/A Agreement

  The endpoint used will be as per the CPP/A agreement value in PRODUCTION mode for the ebXML specification if the processing mode agreement configuration setting is defined.

  Processing Mode Event Endpoint

  The endpoint defined in the processing mode event will be used if no overriding processing mode CPP/A agreement in PRODUCTION mode is defined.

  Partner Endpoint

  The endpoint defined for the partner will be used if neither the processing mode event configuration setting is defined nor the CPP/A agreement value in PRODUCTION mode is defined.

• Authorisation List - The section Authorisation List stores a list of Schema Codes. A client will be restricted to only send items in this authorisation list. If the list is empty then no restrictions exist.

• Partner Type - This is an enumeration of the following values {REMOTE_PARTNER, LOCAL_PARTNER, PULL_PARTNER}.

  • REMOTE_PARTNER - Defines that this server IS NOT responsible for this Partner Identifier and any incoming messages destined for this Partner Identifier must be delegated to the responsible endpoint URL.

  • LOCAL_PARTNER - Defines that this server IS responsible for this Partner Identifier and any incoming messages for this Partner Identifier will be stored locally for retrieval at a later stage.

  • PULL_PARTNER - The same as LOCAL_PARTNER, however, the message is stored in a form in which the Partner can perform a Pull Request for retrieval.

• Triggers - A list of triggers associated with this PartnerIdentifier, refer to the Section called Triggers for more information.

Processing Modes

Processing Modes (as defined by the ebMS Specification) provide a centralized configuration for business messages. Processing Modes consist of the following

• General section - Contains the message pattern, CPA configuration, and partners involved in this processing mode.

• Events section - Defines the endpoint of a message, payload profiles, and other information.

  • Protocol - Contains information for the endpoint, http compression, and message retry configuration.

  • Business Information - Business centric information such as the Service and Action for this message sequence.

  • Security - Security information including digital encryption/signatures, and UsernameToken management.

  • Reliability - WS-ReliableMessaging configuration.

  • Error Handling - Who and where to send error messages to.

Messaging Security

B2B Messages can be secured using message signing and/or encryption of various elements of both inbound and outbound messages. This section provides the necessary detail of how messages may be sigined and or encrypted.

Package Manager Configuration

Additional messaging specifications in the form of Package Managers are supported by FMS. These package managers MUST be configured in the file ConnectionConfiguration.xml. The Packager Configuration section contains a simple mapping between a key name and a Java class path denoting the location of the relevant package manager in the classpath. These Package Managers can have their own configuration sections in the ConnectionConfiguration.xml file. By default RosettaNet and ebXML packaging specifications are included in FMS, refer to the Section called RosettaNet Package Configuration and the Section called ebXML Package Configuration.