Edit

Remote Executor

Connect your on-premises software installations to the Aisera platform with the Remote Executor

Overview

The Aisera Remote Executor (RE) is a proprietary tool used to connect your on premises installations of software to the Aisera Platform. This allows the Aisera Platform to access your software's data and take actions as if it were cloud-based.

How it Works

The Remote Executor is registered as a service on a machine within your intranet that has access to the data you want to ingest. This feature enables the Remote Executor to start, restart, and manage reboots smoothly, eliminating the need for manual operations.

Once you've set up the Remote Executor, it creates a secure link to the Aisera Platform. This link connects your internal network to Aisera, enabling the platform to access information, review data, interact with on premises installations of software, and perform automated tasks.

Requirements

The Remote Executor is installed on and run from a machine within your network that has access to your internal network resources as well as internet access. Ensure that the machine the Remote Executor will be run on meets the following requirements.

System Requirements

  • Operating System: Windows

  • CPU: 2 Cores

  • Memory: 4GB

  • Disk Storage: 20GB

  • Network: Outbound HTTPS connectivity and connectivity to on-premises applications/services for automation.

Allow listed IPs

The following IPs need to be allowlisted for the Aisera Platform to connect with the remote executor. These IPs will correlate the the cluster your tenant is running in. Reach out to your Aisera team to learn what IPs need to be allowlisted for the environment you are running on.

Java Installation

You will need a Java installation of version 1.8.0_265 or higher.

You can check the version of Java running on you machine by running the following in the command line: java -version

Valid installations of Java can be found at: https://docs.aws.amazon.com/corretto/latest/corretto-8-ug/downloads-list.html

Credentials

You will need an API key for authentication with the Aisera platform. This can be obtained through a request made to Aisera.

Software Bundle

Aisera will provide you with the Remote Executor software bundle. This bundle will contain the necessary components and configurations to configure your Remote Executor. Download the software bundle provided by Aisera. If the bundle is zipped, be sure to unzip the file.

The software bundle will contain a folder titled opt. Copy or move this folder to the C:\ drive.

Verify The Jar

Once you have moved the opt folder to the C:\ drive open a command prompt run the following command to navigate to the folder with the Remote Executor jar file: cd C:\opt\aisera

Run the following command in the command prompt to verify the jar: jarsigner -verify aisera-remote-executor-<version>.jar -verbose:summary

Ensure that the jar is signed by Aisera Inc. and the command outputs jar verified.

Always Up

AlwaysUp is software that is used to publish the Remote Executor as a Window service. This allows the Remote to automatically run or restart after failure, system outages, or system reboots.

Run the AlwaysUp_Installer.exe from the Remote Executor software setup bundle received from Aisera. The application has a free 30 day trial, after which he application will require a license key. Aisera will provide you with a the license key. To get a license key you will need to provide the serial number for the installation of AlwaysUp to Aisera.

To register your installation of AlwaysUp:

  1. Start AlwaysUp

  2. Click the Register Now >> button

  3. Copy the Serial Number and send it to Aisera

  4. Copy the license key received from Aisera

  5. Return to the Register Page by either clicking << Back or restarting the application.

  6. Click Enter Code >> in the registration window

  7. Enter the license key received from Aisera and click Next >>

Installing the Remote Executor

Ensure that you have the Remote Executor software bundle provided to you by Aisera, and that you have met all the requirements before attempting to configure the Remote Executor.

If you are configuring the RE to connect to staging use the related staging files. For example, use configuration-staging0.yaml instead of configuration-prod0.yaml and run_staging.bat instead of run_prod.bat

To configure the Remote Executor:

  1. Log into the machine the Remote Executor will run on with Administrator privileges.

  2. Go to AlwaysUp and stop the aisera service it exists.

  3. Add your API key as an environment variable.

    1. You can set the environment variable by running setx aisera_apiKey "<API_key>" in a command terminal. Alternatively you can edit environment variables by navigating to the Advanced System Settings and going into the Environment Variables window.

  4. Open the configuration-prod0.yaml

  5. Replace {tenant} for the host field with the Aisera tenant name for you organization as provided by Aisera. Save your changes and close the YAML file.

  6. Verify the network connectivity with the prod instance by running C:\opt\run_prod.bat script. This will eventually return INFO c.a.a.r.e.c|.HeartBeatListener - Connection to Server Opened.

    1. If you get the Could not start the server because the api key is missing message, the environment variable is not set correctly or it is not accessible from the batch file.

    2. If you get the Invalid user credentials message please verify that environment variable is set correctly. If this error does not go away, please contact Aisera.

  7. Verify API access by opening a web browser and navigating to https://<tenant>.api.aisera.net. This will return 404 page not found. This is not an error.

  8. Once connectivity is verified, open AlwaysUp.

  9. Select Add Application.

  10. Name the application aisera-prod. Browse to C:\opt\aisera and select run_prod.bat for the application. Start in the C:\opt\aisera directory. Clear the Arguments if there are any.

  11. Click Save >> to save the new application.

  12. Start the new service in AlwaysUp.

If the service is running aisera-log-prod.log will appear in the C:\opt\aisera folder. Check this log to ensure that the connection has succeeded.

PreviousIntegration ReauthorizationNextConnectors

Last updated

Was this helpful?