Installation Configuration Properties¶
To configure an aP Connect Agent, you must provide properties that allow the Agent to communicate with other machines. There are four types of properties:
- General – Specified for the agent installation in the [General] section of the options.ini.properties file; built to and stored in the application.properties file in the agent install folder.
-
aP Connect – Specified for the agent installation in the section of the [CostInsightConnectProperties] options.ini.properties file; built to and stored in the cic-connection.properties file in the agent install folder. Some aP Connect properties are generated when you create a connector. Therefore, before you install an Agent, you must create a Connector in aP Connect.
-
PLM – Specified for the agent installation in the [PLMProperties] section of the options.ini.properties file; built to and stored in the plm-connection.properties file in the agent install folder. For a File System integration, the PLM properties contain information about the file system.
-
OAuth – Specified for the agent installation in the [OAuthProperties] section of the options.ini.properties file; built to and stored in the plm-connection.properties file in the agent install folder.
Note:
For this release, these aP Connect properties are not specified in the options.ini properties file. Instead, they are stored in the cic-connection.properties file:
-
maxMessageSize -
enableCompression
This table describes the properties for an aP Connect Agent and indicates whether it is required (R), optional (O), or not applicable (–) for TeamCenter® (TC), Windchill® (WC), and File System (FS) integrations.
| Category | Property | Description | TC | WC | EN | FS | Preset / Default |
|---|---|---|---|---|---|---|---|
| General | installDirectory |
Appended full path to the Agent installation folder | R | R | R | R | – |
| General | port |
Agent communication port | O | O | O | O | 8820 |
| General | auth-token-header-name |
Authentication token header name | O | O | O | O | Authorization |
| General | auth-token |
Authentication API key | R | R | R | R | – |
| Cost Insight Connect | url |
aP Connect web address (URL) | R | R | R | R | – |
| Cost Insight Connect | appKey |
Application Key to connect to aP Connect | R | R | R | R | – |
| Cost Insight Connect | scanRate |
Connectivity scan rate | R | R | R | R | – |
| Cost Insight Connect | reconnectionInterval |
Reconnection interval, in seconds, if a disconnection occurs | O | O | O | O | 3 |
| Cost Insight Connect | agentId |
ID of the associated Connector in aP Connect | R | R | R | R | – |
| Cost Insight Connect | plmType |
Type of agent (teamcenter,windchill, or file_system) |
R | R | R | R | – |
| Cost Insight Connect | maxMessageSize |
Maximum message size, specified in bytes. | O | O | O | O | 10485760 (10MB) |
| Cost Insight Connect | enableCompression |
Enables (true) or disables (false) compression between the Agent and the associated Connector in aP Connect | O | O | O | O | false |
| PLM | hostName |
Name of the machine that the Agent is installed on. | R | R | R | – | – |
| PLM | user |
PLM system log-in username | R | R | R | – | – |
| PLM | password |
PLM system password | R | R | R | – | – |
| PLM | fscUrl |
File Management System Server Cache URL | R | – | – | – | – |
| PLM | rootFolderPath |
Appended full path to the aP Connect Root Folder | O | O | O | R | – |
| PLM | csrfTokenTimeoutSeconds |
CSRF token timeout in seconds | – | O | – | – | 7200 |
| PLM | maxPartsToReturn |
Maximum number of components that a Workflow query can return. The upper bound is 250. |
O | O | O | – | 250 |
| PLM | itemTypeRevisions |
List of item type revisions to be processed | O | – | – | – | ItemRevision |
| PLM | authenticationProtocol |
Authentication protocol used to authenticate against PLM system. Valid options: basic or oauth | – | O | – | – | basic |
| PLM | 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 | – | – |
| OAuth | oAuthBaseUrl |
OAuth provider base URL. (Without the token endpoint because the aP Connect Agent will identify the token endpoint) |
– | R | – | – | – |
| OAuth | clientID |
Client ID to be used | – | R | – | – | – |
| OAuth | clientSecret |
Client Secret to be used | – | R | – | – | – |
| OAuth | tokenScopes |
Comma separated list of Token Scopes to be used | – | O | – | – | – |
| OAuth | tokenAudience |
Token audience to be used | – | O | – | – | – |