Step 4: Runtime configuration - Intergraph Smart API Manager - Installation & Upgrade - Intergraph

Smart API Manager Installation and Configuration

PPMProduct
Intergraph Smart API Manager
PPMCategory_custom
Installation & Upgrade

These steps are completed on the Runtime Configuration page of the Smart API Manager Configuration Utility wizard.

  1. Enter or select a domain name in the Domain Name box:

    • If you are creating a new domain—either the first domain or an additional domain—enter the new domain name.

    • If you are joining an existing domain, select the domain name for the Smart API Manager instance you are duplicating. For example, select this option if the new Smart API Manager instance will run in a web farm or behind a load balancer.

  2. The Management Service displays details about the Management API that Smart API Manager uses:

    • If you are creating a new domain, the Register new management service instance is selected. This option registers a new Management API instance with the database. The Smart API Manager instance you are configuring will use this new Smart API service instance.

    • If you are joining an existing domain, the Use already registered management service instance is selected. In the Service Instance box, the Management API service instance that is already registered with the database is displayed. The Smart API Manager instance you are configuring will use this existing Smart API service instance.

      Typically, joining an existing domain means that you are either:

      • Configuring the Smart API Manager instance to run in a web farm or behind a load balancer

      • Re-configuring an existing instance of Smart API Manager

  3. Enter or review the Management API service credentials, where:

    Service Secret

    The secret used to authorize the Management API service.

    Instance Name

    The name used to identify this instance of the Management API service.

    An instance name is required only if another instance of the Management API web service writes monitoring data to the same domain in the database. If you do not enter a value, a default is provided.

    Service Prefix

    The path appended to the base address, representing the route to the service document for the Management API.

    This value cannot be changed and is provided for information only.

    • If you are creating a new domain, enter the credentials in the Service Secret and Instance Name boxes.

      Click Generate to have a secret created for you.

    • If you are joining an existing domain, the Service Secret and Instance Name boxes are automatically populated with the credentials of the Management API service instance you selected.

  4. In the Data Retention Policy section, enter the number of days to preserve historical monitoring and log data in the Smart API Manager database/server. The default value is 30 days.

  5. Click Next, and continue with Step 5: Security configuration.