Prepare OPLA for the first use

The OPLA is located in the the OPLA directory of the CSDK package. It is a central licensing solution so it can run on any computer in the network. Any number of CSDK workers can connect to it on the same network.

OPLA communicates through the following interfaces:

  • Web interface: Browser based UI for managing licenses and configuring OPLA

  • Command line interface: Local command-line interface for managing licenses and configuring OPLA

  • Status API: HTTP based interface to monitor licensing status programmatically. It can be accessed on the following URL:

    http://{MY_SERVER}:5000/Api/Licenses/ListLicenses?StatusServiceKey=<My license key>

  • CSDK inteface: a TCP socket where CSDK communicates with OPLA for licensing, entitlement, and usage reporting.

  • Activation Server: The global portal where licenses can be obtained and activated.

  1. Copy the whole OPLA directory to any location on the selected central licensing computer.
  2. Open and configure the appsetting.json file.

    This file represents OPLA side of the connection. It contains the following information:

    Table 1. Parameters of the appsettings.json file
    Parameter Description Default value
    Port The TCP port for the CSDK interface.
    Note Verify that this port is not occupied by other applications.
    WebPort The TCP port for the web interface.
    Note Verify that this port is not occupied by other applications.
    ApplicationDataFolder The location where OPLA stores its information on the system. {ProgramDataFolder}\OmniPage\LicensingAgent
    ReportFolder The location where OPLA saves report files
    Important Regularly backup this folder. It can be required for support cases.
    LogFolder The location where OPLA creates log files {ApplicationDataFolder}\Log

    Level of logging. The supported values are ERROR, WARN, and INFO.

    Note The INFO log level can significantly affect performance.
    StatusServiceKey This key needs to be set to enable Status API. N/A

    The TCP port for HTTPS Web interface.

    If this parameter is set, remote connection to the web interface is allowed only through HTTPS connection.

    Note Verify that this port is not occupied by other applications.
    SSLPfx The location of the SSL certifiacte PFX file for HTTPS connections. N/A
    SSLPassword The password of the given SSL certificate PFX file. N/A

  3. Register the OPLA as a Windows service with the following command:
    opla service -register
  4. Start OPLA with the following command:
    Opla.exe Service -start
  5. If you want to use the web interface of the OPLA, create a user.

    The OPLA WEB interface is available by default at http://localhost:5000.

    The first user can be created on the web interface at the first time or from command line with the following command:

    Opla.exe User -create -username="<>" -password=<mypassword>

You can use OPLA to perform the following actions:

Note If the central licensing server you created does not have connection to the Activation server, then OPLA works in offline mode.