Skip to main content

Installation

The Asysco AMT Connector installation consists of multiple steps that are required to complete the installation successfully. The connector requires an OpCon Windows Agent and communicates with the Asysco AMT Batch environment through a RESTful web services interface. A separate connector should be installed for each Asysco AMT environment.

Use this guide when you:

  • Install the connector for the first time in an OpCon environment
  • Add a connector instance for a new or separate AMT environment

Two points are worth knowing before you begin:

  • A separate connector instance per AMT environment keeps each environment's configuration isolated, reducing the risk of cross-environment job submissions
  • Encoding the AMT credentials with Encrypt.exe keeps plain-text authentication values out of Connector.config

How to implement it

Prerequisites

The following software levels are required before beginning the installation.

  • OpCon release 17.0 or higher
  • Embedded Java OpenJDK 11 (part of installation — no separate install required)
  • The Asysco AMT environment must support the required web services (AmtOpConService)
  • The user code required to connect to the web services must be defined within AMT Control Center

Installation steps

To install the connector, complete the following steps:

  1. Copy the downloaded install file AsyscoAmtConnector-win.zip to a temp directory (for example, c:\temp).
  2. Extract the contents, including sub-directories, into the required directory.

After installation, the root directory contains the connector executable, the credential encoding utility, the Connector.config file, a java directory containing the required Java environment, and an emplugins directory containing the job subtype.

To install the job subtype, complete the following steps:

  1. Copy the Enterprise Manager plug-in from the installation emplugins directory to the dropins directory of the Enterprise Manager installation. If the dropins directory does not exist, create it off the root directory.

  2. Restart Enterprise Manager. The Asysco AMT Windows job subtype is now visible.

    If the subtype is not visible, restart Enterprise Manager using Run as Administrator. After this step, Enterprise Manager can be used normally.

  3. Create a global property AMTPath that contains the full path of the installation directory.

To configure the connector, complete the following steps:

  1. Encode the USER and PASSWORD values using Encrypt.exe. See Encrypt utility below for instructions.
  2. Open Connector.config in the installation directory and set the values described in the Configuration options section below.

Encrypt utility

The Encrypt utility encodes a credential value so that it is not stored in plain text, and supports a -v argument that displays the encoded value.

On Windows, the following example encodes the value abcdefg:

Encrypt.exe -v abcdefg
caution

Encoding obscures a credential; it does not protect it. Treat Connector.config as a file that contains credentials, and restrict access to it using file system permissions so that only the account running the connector and the administrators who maintain it can read the file.

Example configuration

The following Connector.config shows a complete configuration for an AMT environment reached at amt.example.com on port 4004 with TLS enabled. Replace every value with one from your own environment; the USER and PASSWORD values shown are placeholders, not working encoded credentials.

[CONNECTOR]
NAME=Asysco AMT Connector
STATUS_CHECK_POLL_INTERVAL=5
STATUS_CHECK_INITIAL_POLL_DELAY=5
DEBUG=OFF

[AMT BATCH SERVER]
SERVER_ADDRESS=amt.example.com:4004
SERVER_USE_TLS=True
USER= <encoded AMT user>
PASSWORD= <encoded AMT password>

Configuration options

The Connector.config file contains the following settings.

SettingWhat It DoesDefaultNotes
[CONNECTOR]Section header
NAMEThe name of the connectorNoneOptional
STATUS_CHECK_POLL_INTERVALTime in seconds between status checks of a submitted web service requestNoneRequired
STATUS_CHECK_INITIAL_POLL_DELAYTime in seconds to wait before the first status checkNoneRequired
DEBUGEnables verbose debug loggingNoneRequired. Set to ON to capture error conditions; use OFF in production
[AMT BATCH SERVER]Section header
SERVER_ADDRESSAddress and port number of the Asysco AMT web serverNoneRequired. Example: hostname:4004
SERVER_USE_TLSWhether TLS is used for communication between the connector and the AMT web serverNoneRequired. Values are True or False
USERThe AMT user with privileges to interact with the AMT Batch environment via web servicesNoneRequired. Must be encoded using Encrypt.exe; user must be defined in AMT Control Center
PASSWORDThe password of the AMT userNoneRequired. Must be encoded using Encrypt.exe
Note

Apart from NAME, every setting in Connector.config is required and has no default value. Use the example configuration above as the reference for a complete file, and set every value for your own environment.

Exception handling

SymptomMeaningFix
The Asysco AMT Windows job subtype is not visible in Enterprise Manager after restartEnterprise Manager was not restarted with administrator privilegesRestart Enterprise Manager using Run as Administrator
The connector fails to connect to the AMT web serverThe SERVER_ADDRESS value is incorrect, or SERVER_USE_TLS does not match the AMT server configurationVerify SERVER_ADDRESS and SERVER_USE_TLS in Connector.config
Jobs fail with authentication errors (exit code 24)The USER or PASSWORD value in Connector.config is incorrect or was not encodedRe-encode the credentials using Encrypt.exe and update Connector.config

Administration

Enabling and disabling debug mode: Set DEBUG=ON in Connector.config to enable verbose logging for troubleshooting. Set DEBUG=OFF for production use.

Roles: System Administrators are responsible for installing and configuring the connector, managing the Connector.config file, and maintaining the AMTPath global property.

Maintenance: When AMT credentials change, re-encode the new USER and PASSWORD values using Encrypt.exe and update Connector.config. Update the AMTPath global property if the connector installation directory changes.

Security considerations

Authentication: The connector authenticates to the Asysco AMT web services using a USER and PASSWORD defined in Connector.config. Both values must be defined in AMT Control Center before the connector can authenticate.

Authorization: The AMT user must have the required privileges to interact with the AMT Batch environment via the web services interface. Permissions are managed in AMT Control Center.

Data security: Setting SERVER_USE_TLS=True in Connector.config sends traffic between the connector and the AMT web server over TLS rather than in the clear. Deploy the connector on a network segment you trust to reach the AMT web server, and treat that path as you would any other link carrying credentials.

Sensitive data: The USER and PASSWORD values are credentials. Do not store plain-text values in Connector.config. Always encode them using Encrypt.exe before saving, and restrict access to the file using file system permissions.

Operations

Monitoring: The connector writes a log entry for each job submitted to the AMT environment. Job output is retrieved from the AMT database when the job completes and is accessible through the JORS system in OpCon.

Alerts: Configure OpCon job failure criteria to treat exit code 4 (DONE) as success. All other AMT completion codes indicate non-successful states. See Asysco AMT job definitions for the complete list of completion codes.

Performance and scaling: Deploy one connector instance per AMT environment. Adjust STATUS_CHECK_POLL_INTERVAL and STATUS_CHECK_INITIAL_POLL_DELAY to tune how frequently the connector polls the AMT web server for job status.

FAQs

Can I install a single connector to manage multiple AMT environments?
No. A separate connector must be installed for each Asysco AMT environment. Create a unique global property for each installation path.

What Java version does the connector require?
The connector bundles embedded Java OpenJDK 11 as part of the installation. No separate Java installation is required on the host server.

How do I update the AMT credentials after the initial installation?
Re-encode the new values using Encrypt.exe and replace the USER and PASSWORD entries in Connector.config.

Examples

Scenario: Deploying the connector for a test AMT environment with TLS enabled.

  1. Install the connector to C:\connectors\asysco.amt\.
  2. Create the AMTPath global property with the value C:\connectors\asysco.amt\.
  3. Encrypt the AMT user credentials using Encrypt.exe.
  4. Set SERVER_ADDRESS to the AMT web server address and port.
  5. Set SERVER_USE_TLS=True.
  6. Set DEBUG=OFF.

The connector is now ready to accept job submissions from OpCon. Verify by running a test job in OpCon and confirming the job log appears via JORS.

Glossary

AMTOpCon interface — The RESTful web services API that allows OpCon to communicate directly with the Asysco AMT database for job submission, status monitoring, and log retrieval.

AMTPath — The OpCon global property that stores the full path to the connector installation directory, referenced by job definitions in the Connector Path field.

Connector.config — The configuration file in the connector installation directory that stores connection settings and encoded credentials for the Asysco AMT environment.

Encrypt.exe — The command-line utility bundled with the connector, used to encode credential values so that they are not stored in plain text in Connector.config. Encoding obscures a credential; it does not protect it.