The WebPlatformConfig Table

This table, located under System | Integration in the customization manager, is the main configuration tool for ILLiad/Aeon integration and is found in both the ILLiad and Aeon configuration manager.

The WebPlatformConfig table serves three main purposes:

• Controls security - Validates which systems can communicate with your platform
• Provides ID information - Allows applications to authenticate with both their own platforms and external systems
• Creates field mapping references - Provides reference points for mapping objects from one system to another

Each entry in the table represents a system that can access your web platform, be accessed by the system, or both. For example, ILLiad can both send and receive information from the external system (Aeon) through the local Aeon platform, so there needs to be an entry for that platform.

Platform Communication Requirements

ILLiad Requirements

Your system's ILLiad client needs to talk to the web platform to request information from external sources. Therefore, ILLiad needs an entry for the ILLiad web platform.

Aeon Requirements

Because the Aeon client does not request information from external sources, Aeon does not need to include an entry in the WebPlatformConfig table for the Aeon web platform.

How the Systems Communicate

The fields included in the WebPlatformConfig table are:

• ID
• NVTGC (ILLiad only)
• API Key
• Base Webservice URL
• Description

When the ILLiad system (either the platform or system manager) needs to talk to an external system (currently only Aeon), it uses this table to:

1. Determine where the system lives (Base Webservice URL)
2. Identify itself with that system (API Key)

Security and Validation

When another system (currently only Aeon) tries to talk to the ILLiad platform, the platform will:

1. Look up the key provided by that system
2. Validate that the external system is allowed to communicate
3. Determine which platform configuration entry to use

If the external system provides a key that doesn't exist in the WebPlatformConfig table, ILLiad and Aeon will reject the request.

warning

SSL Protection Required

Because API Keys are used to validate requests and are not encrypted before sending, SSL protection is necessary to maintain security. While most critical operations are protected by a second level of security (available only with Atlas products), some operations are protected by API only.

All platforms must use SSL - all Base Webservice URL entries must contain the https protocol identifier.

Fields in the WebPlatformConfig Table

The fields in the WebPlatformConfig table have the following functionality:

Field	Description
ID	An auto-generated value used to reference the web platform configuration from other places within the ILLiad or Aeon system.
NVTGC	The NVTGC symbol that the web platform can access (The NVTGC column is present only in the ILLiad WebPlatformConfig table).
API Key	This key tells you which specific ID you should use when talking to a system. The value is populated with a randomly generated global unique identifier. To obtain the value, open the entry for editing (click New Record) and click the . . . button that appears to the right side of the API Key field.
Base Webservice URL	The Base Url of the system identified by the entry.
Description	A text field for you to add helpful identifying information, such as "Local Aeon Platform" or "Local ILLiad Platform".

There should be two entries in the ILLiad WebPlatformConfig table. One that enables your ILLiad client to talk to the ILLiad platform and one that enables ILLiad to send and receive from the Aeon platform. The Aeon WebPlatformConfig table needs an entry for the ILLiad platform so that Aeon can send and receive from ILLiad. See the tables above for examples.

Note that setting up integration between ILLiad and Aeon requires that the API Key entries for each of the platforms be identical in each customization manager so that the two-way communication between the systems uses the same key. The entry in the Aeon table can be cut and pasted from the entry in the ILLiad table. See the bolded API Key entries in the table above for an example.

Sample WebPlatformConfig Tables in ILLiad and Aeon

In ILLiad, this table may look like this:

ID	NVTGC	API Key	Base Webservice Url	Description
1	ILL	93c-79bca-2eca-40cb-883d-111c895c0643	https://your.ILLiad.server.name/ ILLiadWebPlatform/	Local ILLiad Platform (for client access to the platform)
2	ILL	be6c0010-f8df-4318-9830-a331bd10702d	https://your.Aeon.server.name/ aeon/aeonWebPlatform/	Local Aeon Platform (for access to Aeon)

In Aeon, the table would look like this.

ID	NVTGC	API Key	Base Webservice Url	Description
1	ILL	93c-79bca-2eca-40cb-883d-111c895c0643	https://your.ILLiad.server.name/ ILLiadWebPlatform/	Local ILLiad Platform (for access to ILLiad)