The API service is an active – active component and may be installed on any machine that has IIS configured.

Refer to the TeamManager API section on how to use the API.

Installation

  1. Run the  TM.API.Setup.msi

  2. On Luware-TM-API Configuration Settings screen fill in the following settings

    Eample of filled Luware-TM-API Configuration Settings screen

The TM API  installation wizard settings:

Key in TM API Configuration SettingsHow to get the value
Instance NameEnter the server instance name


The setting is stored in  C:\Program Files\Luware AG\API\AppSettings.config as

<add key=‘InstanzName’ value=‘TM’/>

Port NumberEnter the server port number


The setting is stored in  C:\Program Files\Luware AG\API\AppSettings.config as

<add key=‘PortNumberToAdd’ value=‘3500’/>

API Port NumberEnter the site port number. The port number 80 is recommended for http and 443 for https. The used site port number should be not used by other sites.


Please note:  For TM-FE and TM-API installed on the same machine a site port numbers have to be different.

The setting is stored in  IIS.

Security ProtocolChoose the security protocol between http and https


The setting is stored in  IIS.

Configure Certificate SecurityFor security reason the system provides possibility to use certificate-based encryption and verification during the components communication. To configure certificate based authentication, select ‘Configure Certificate Security’ check box and press ‘Next’ button to open a page with server certificate settings.


If the check box is ‘true’  the certificate settings has to be defined during the installation:

– client settings specify which settings API will use while connecting to PS

Note: The system reports all errors related to  connection or certificate issues to a log file‘C:\Program Files\Luware AG\TM-ICH\log\connectionIssues.log’.


Configuration

In the TM Configurator application:

  1. Open  Topology -> Components (Server)

    WebConfigurator - API Component Configuration

  2. Add  API component as it is shown in the example (select the API Server Type, System Instance, Activity Order and fill the service’s Settings according to the table below

    KeyDescription
    ApiAddressThe address under which the API will be responding to external requests.
    ClientKeepaliveIntervalTimeout between requests. Value is set in seconds.
    ClientKeepaliveIntervalTimeoutTimeout between the reconnections. Value is set in seconds.
    MaximumPollingTimeoutInMinIf no polling happened during this timeframe the task gets disposed.
    Timeout is set in minutes.

    After Configuration of the API component, further settings are required to start using it. Head to the the TeamManager API page for more instructions.

Functionality Check

When installation and configuration are done, open Internet Information Services (IIS) Manager and make sure that the Luware-API is started:

Luware-TM-API started in IIS

Quick functionality check

Considering you have configured the necessary Network Ports you can test the API response by clicking the "Browse Website" link shown above. 
→  A website should open with the following message: 

This shows that the API is responding, but requiring a key.

  • If yes, read the TeamManager API for more instructions.
  • If no response is sent the component is not properly configured. → Read the "Configuration" chapter below.