Skip to content

Install from the Command Prompt

The following example shows how to install an Agent using the Command Prompt.

Prerequisites

Before you install an Agent, see Agent Installation Prerequisites.

Install an Agent from the Command Prompt

  1. On the machine that you are going to install the agent on, open Command Prompt as an administrator.

    For example, in the Windows search bar, enter cmd, right-click on Command Prompt and select Run as administrator.

  2. In the command prompt, change directory to the location of the installer, then run with the -c console mode option.

    cd /
    cd <installer_directory>
    <apriori_agent_installer_name> -c
    

    Where <installer_directory> is the full path to the installer folder and <apriori_agent_installer_name> is the file name of the installer.

    For example, (adjust for the directory and file name applicable to your environment):

    cd /
    cd K:/aPriori/apriori-apc-agt
    apriori-apc-agt-installer-5.1.0.exe -c
    

  3. The license agreement appears in the Command Prompt window.

    To accept the agreement, enter 1.

  4. Choose whether to configure mutual TLS (mTLS) for the Agent connection.

    The installer displays the following options: Do not use mTLS [1, Enter], Use mTLS [2]

    • Enter 1 or press Enter to continue without mTLS.
    • Enter 2 to configure mTLS.

    If you choose to configure mTLS, the installer prompts for the following:

    • Private key: Enter the full path to the private key file.
    • Signed certificate: Enter the full path to the signed certificate file.

    Note

    Select Use mTLS if you have a valid signed certificate provided by aPriori and have configured your connector to Use certificate-based authentication (mTLS) instead of IP allowlisting

    Info

    mTLS configuration is not supported in unattended (-q) mode. Install using the Setup Wizard or console mode (-c) to configure mTLS.

  5. The installation configuration settings appear in the Command Prompt window.

    • If the settings are incorrect, enter e to exit the installer, update the options.ini with any missing or incorrect values and rerun the Agent installer.

    • If the settings are correct, enter y to complete the install.

Tip

Use the Agent installer -h option to view available command line options.

For example, apriori-apc-agt-installer-5.1.0.exe -h

After Agent Installation

After you install the agent:

  • If you want to enable compression between the Agent and the associated Connector in aP Connect, navigate to the agent installation folder, open the cic-connection.properties file and set enableCompression to true.
  • If you want change the maximum message size, navigate to the agent installation folder, open the cic-connection.properties file and specify a new value, in bytes, for maxMessageSize.
  • If the machine or server that you plan to install the Agent to uses a Hypertext Transfer Protocol Secure (HTPS) URL to access the machine or server that contains your PLM or, for a File System integration, the machine that you plan to create the aP Connect Root Folder on, prepare all the information that you need to load your JDK certificates to the Agent machine. For more information, see Importing Java Developer Kit Certificates.
  • As required, start or restart the service for the agent. For more information, see Stop, Start, or Restart an Agent.
  • Test the functionality of the connection between aP Connect, the Agent, and your PLM or File System. For more information, see Confirm Connectivity and Functionality.
  • If the Agent is for a File System integration, to populate the associated aP Connect Root Folder, create a Workflow that uses the Connector that is associated with the Agent. For more information, see Create Workflow Folders in the aP Connect Root Folder.