Skip to content

Configure the Installation Properties for a PLM Agent

This example shows how to configure the Agent Installation Properties for an aP Connect PLM Agent installation.

The properties that you must configure depend on the type of PLM Agent that you are preparing to install.

For more information, see Installation Configuration Properties.

Windchill Tomcat compatibility note

See Important Information regarding the Windchill Tomcat security patch

Prerequisites

Before proceeding, complete all the preceding prerequisites for installing a PLM Agent that are listed in PLM Agent Installation Prerequisites.

Configure Installation Properties

  1. Navigate to the installer folder that you created on the machine or server that you are going to install the Agent to.
  2. Open the options.ini file.

  3. In the [General] section specify values for these properties:

    Property Description Required (R) or Optional (O) Preset / Default
    installDirectory Appended full path to the Agent installation folder R –
    port Agent communication port O 8820
    auth-token-header-name Authentication token header name O Authorization
    auth-token Authentication API key R –

  4. For the [CostInsightConnectProperties] section, specify these values.

    Tip:

    You can copy and paste the values for some propertiesfrom, the Connection information for the Connector that you created in aP Connect. For more information, see Create a File System Connector.

    Property Description Required (R) or Optional (O) Preset / Default
    url aP Connect web address (URL) R –
    appKey Application Key to connect to aP Connect R –
    scanRate Connectivity scan rate R –
    reconnectionInterval Reconnection interval, in seconds, if a disconnection occurs O 3
    agentId ID of the associated Connector in aP Connect R –
    plmType Type of agent (teamcenter, or windchill) R –

    Windchill Tomcat compatibility note

    See Important Information regarding the Windchill Tomcat security patch

  5. For the [PLMProperties] section, specify the values for properties that are applicable to your PLM system.

    This table describes the properties for different PLM systems and indicates whether it is required (R), optional (O), or not applicable (–) for TeamCenter® (TC) and Windchill® (WC) integrations.

    Property Description Required (R) or Optional (O) – TC Required (R) or Optional (O) – WC Required (R) or Optional (O) – EN Preset / Default
    hostName Name of the machine that the Agent is installed on. R R R –
    user PLM system log-in username R R R –
    password PLM system password R R R –
    fscurl File Management System Server Cache URL R – – –
    rootFolderPath Appended full path to the aP Connect Root Folder O O O –
    csrfTokenTimeoutSeconds CSRF token timeout in seconds – O – 7200
    maxPartsToReturn Maximum number of components that a Workflow query can return. The upper bound is 250. O O O 250
    itemTypeRevisions List of item type revisions to be processed O – – ItemRevision
    authenticationProtocol Authentication protocol used to authenticate against PLM system. Valid options: basic or oauth – O – basic
    windchill.plmHealthEndpoint Allows Windchill PLM integrations to specify the endpoint that the aP Connect Agent pings to validate its connection to your Windchill PLM system. – – R –

  6. For a Windchill® PLM integration for which the authenticationProtocol property is set to oauth, specify values for these properties.

    Property Description Required (R) or Optional (O)
    tokenUrl OAuth token URL R
    clientID Client ID to be used R
    clientSecret Client Secret to be used R
    tokenScopes Comma separated list of Token Scopes to be used O
    tokenAudience Token audience to be used O

  7. Save and close the options.ini file.