The PlaidLink Agent works in conjunction with PlaidCloud service. The PlaidLink Agent enables remote operations for extracting, loading, and sourcing data along with interacting with an SAP Profitability and Cost Management (PCM) system if PCM is installed.
PlaidLink Agent management takes place within the Analyze tab of PlaidCloud. The first step is to create a new PlaidLink Agent instance on PlaidCloud.
To create a new PlaidLink Agent:
To view the Agent public and private keys:
To randomly generate new keys:
Note: Retain the public and private keys for configuring the remote agent in the next step.
If the agent will need to have access to a Document account for uploading or downloading files, it must be granted permission to access the Document account.
To grant account access:
Note: Agents can only upload and download files if the agent has been granted access to one or more Document accounts.
If the agent will need to have access to a data connection such as a database, it must be granted permission to access the external data connection information.
To grant connection access:
Note: Agent data connection credentials are managed in the External Data Connections.
The PlaidLink Agent handles initiating all contact with PlaidCloud and does not require opening any ports in the firewall for performing operations. The connection occurs over an encrypted communication channel at all times. Standard HTTPS connections or secure websocket connections are used.
Note: Allowing Git use from both git bash and the Windows command line is recommended, but overwriting Windows CLI tools with Unix tools IS NOT recommended.
From the .ssh directory copy the id_rsa.pub file and email to your Tartan Solutions contact for addition to the installer access list. This key will be registered for the specific server being installed.
Note: If you cannot use a direct or proxy connection to perform conda or pip install operations, please scroll to the bottom of the installation guide below for a manual installation process.
If http connections require passing through an authenticated proxy, you will need to set up the .condarc file in the user’s home directory. The file should have the following lines: proxy_servers: ` http: http://user:email@example.com:8080` ` https: https://user:firstname.lastname@example.org:8080`
The following should be installed using pip: pip install websocket-client pip install gitpython
If you need to use a proxy server for the pip installs then they should follow this syntax instead: pip install –proxy http://user:email@example.com:8080 websocket-client pip install –proxy http://user:firstname.lastname@example.org:8080 gitpython
Once you receive a confirmation response from Tartan Solutions that your id_rsa.pub key has been added to the access list, you can proceed with this next step.
Note: If http connections require passing through an authenticated proxy, you will need to use the proxy switch in the pip command pip install and proxy http://user:email@example.com:8080 -e git+ssh://firstname.lastname@example.org/PlaidCloud/profitagent.git#egg=profitagent
This will create a src/profitagent directory with respect to your current working directory.
An initial configuration file is included in the package, named config-dist.json. Make a sibling copy to edit:
This will be in the following directory relative to the user base directory: src/profitagent/profitagent cp config-dist.json config.json
Copy the agent settings from PlaidCloud into the configuration file. Also set any proxy information required to make an external connection.
To install a Windows service, you must have administrative privileges.
The new Windows service should now appear in the list of services on the server. It will be listed as PlaidCloud Agent in the services. The Windows application logs will list the reporting application as PlaidCloudAgent.
If there are network settings that prevent the use of direct connections or proxied connections to perform Conda and PIP installations, a manual process must be followed. This process will manually install the following packages:
For each of the installations above, the first step is download the package via a web browser and place it in the user directory where the PlaidLink service will operate.
Once all zip files are downloaded they should be unzipped into the same parent directory. For example: c:usersagentpython_packages
Now that all the packages are present on the server locally, the next step is to PIP install them so they are properly registered with the system Python process.
The PlaidLink zip file must be provided by a Tartan Solutions contact since direct access is not authorized except through the automated installation process. If the Tartan Solutions contact has not already provided the installation package, please contact them.
Now follow the instructions for updating the config file and registering the process as a Windows Service, as described in the two sections before this Manual Install section.