diff --git a/docs/administration/configuration-file.md b/docs/administration/configuration-file.md index 1245aa2..7de759e 100644 --- a/docs/administration/configuration-file.md +++ b/docs/administration/configuration-file.md @@ -26,7 +26,7 @@ The Configuration Directory is based on where you installed your programs. For m The following settings are critical to the operation of the agent with OpCon: - **MaximumNumberOfJobs**: Determines the maximum number of jobs the agent is allowed to process concurrently -- **SocketNumberToSAM**: Used for communication between the agent and SMANetCom; this value must match the socket number on the Machines screen in the Enterprise Manager +- **SocketNumberToSAM**: Used for communication between the agent and SMANetCom; this value must match the socket number defined for the machine in the Enterprise Manager - **JORSSocket**: Used for communicating job output information with the Enterprise Manager ## General settings @@ -44,7 +44,7 @@ The table contains the network settings for the Java Agent. | [TCP/IP Parameters] | Default | Description | |--- |--- |--- | | SocketNumberToSAM | 17100 | Defines the socket number through which the agent and SMANetCom communicate. This number must match the machine's socket number defined in the Enterprise Manager. If there are multiple agents installed on one machine, each agent must have a unique value. For an up-to-date list of unused ports, refer to the Internet Assigned Numbers Authority at www.iana.org. | -| AllowedIPAddress_1 | ANY | Determines if communication from SMANetCom to the agent is restricted to one or more TCP/IP addresses. If ANY is specified, the agent accepts communication from any TCP/IP address. If a specific TCP/IP address is defined (for example, `126.40.90.231`), the agent only accepts communication from the specified address. The agent refuses a connection if communication is attempted from another address. This definition enhances communication security by refusing communications from other TCP/IP addresses. If multiple SAMs are on a network, this address ensures the agent only accepts messages from the intended SMANetCom. This parameter is case-sensitive. | +| AllowedIPAddress_1 | ANY | Determines if communication from SMANetCom to the agent is restricted to one or more TCP/IP addresses. If ANY is specified, the agent accepts communication from any TCP/IP address. If a specific TCP/IP address is defined (for example, `192.0.2.10`), the agent only accepts communication from the specified address. The agent refuses a connection if communication is attempted from another address. This definition enhances communication security by refusing communications from other TCP/IP addresses. If multiple SAMs are on a network, this address ensures the agent only accepts messages from the intended SMANetCom. This parameter is case-sensitive. | | AllowedIPAddress_2 | Blank | Same as AllowedIPAddress_1. | | AllowedIPAddress_3 | Blank | Same as AllowedIPAddress_1. | | AllowedIPAddress_4 | Blank | Same as AllowedIPAddress_1. | @@ -166,7 +166,7 @@ JobStatusCheckInitialPollDelay=5 **What happens if SocketNumberToSAM does not match the socket number in OpCon?** The agent and OpCon will not be able to communicate. Jobs will not start, and the machine will show as not connected in the Enterprise Manager. Ensure the value in `Agent.config` matches the socket number on the machine record in OpCon. -**Why is job output not appearing in the View Job Output screen?** +**Why is job output not appearing in View Job Output?** The `CaptureJobOutput` setting must be set to `TRUE`. If it is set to `FALSE`, the agent does not write job output files and the View Job Output feature has no data to display. **Can I allow connections from multiple specific IP addresses?** diff --git a/docs/index.md b/docs/index.md index 56936d4..3ca4db7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,13 @@ --- slug: '/' sidebar_label: 'Java Agent' +title: Java Agent +description: "OpCon agent that allows OpCon to schedule Java classes and scripts or programs within a Java environment. Covers installation, configuration, operations, and reference." +tags: + - Conceptual + - System Administrator + - Automation Engineer + - Agents hide_table_of_contents: true displayed_sidebar: null --- diff --git a/docs/installation/installation.md b/docs/installation/installation.md index 3b13b4e..adc7165 100644 --- a/docs/installation/installation.md +++ b/docs/installation/installation.md @@ -41,19 +41,19 @@ To install the Java Agent, complete the following steps: 1. Log in to the Windows machine as a Local Administrator. 2. Exit all running applications on the desktop, including OpCon applications. -3. Open **setup.exe** on the root of the OpCon installation media. The **Choose Setup Language** screen displays. -4. Select the desired language and select **Next**. The **Welcome** screen displays. -5. Select **Next**. The **Select Components** screen displays. +3. Open **setup.exe** on the root of the OpCon installation media. The **Choose Setup Language** step displays. +4. Select the desired language and select **Next**. The **Welcome** step displays. +5. Select **Next**. The **Select Components** step displays. 6. Select the Java Agent option that matches your CPU type: - - **SMA OpCon Agents > SMA OpCon Agent for Java x64** — for 64-bit systems - - **SMA OpCon Agents > SMA OpCon Agent for Java x86** — for 32-bit systems -7. Select **Install**. The component installer opens and the **Welcome** screen displays. -8. Select **Next**. The **Destination Folder** screen displays. -9. Accept the default installation path or enter a new location, then select **Next**. The **Select Path for Output Files** screen displays. -10. Accept the default output path or enter a new location, then select **Next**. The **Setup Type** screen displays. -11. Select **Complete** or **Custom**, then select **Next**. The **Ready to Install the Program** screen displays. + - **SMA OpCon Agents** > **SMA OpCon Agent for Java x64** — for 64-bit systems + - **SMA OpCon Agents** > **SMA OpCon Agent for Java x86** — for 32-bit systems +7. Select **Install**. The component installer opens and the **Welcome** step displays. +8. Select **Next**. The **Destination Folder** step displays. +9. Accept the default installation path or enter a new location, then select **Next**. The **Select Path for Output Files** step displays. +10. Accept the default output path or enter a new location, then select **Next**. The **Setup Type** step displays. +11. Select **Complete** or **Custom**, then select **Next**. The **Ready to Install the Program** step displays. 12. Select **Install** to begin copying files. -13. Select **Finish** on the **InstallShield Wizard Completed** screen. +13. Select **Finish** on the **InstallShield Wizard Completed** step. :::note The installer writes a log file named `SMA_OpCon_Agent_for_Java__Install.log` to the Windows directory. Consult this file if you suspect installation problems. @@ -71,8 +71,8 @@ SMA recommends keeping the service set to **Automatic (Delayed Start)**. Changin To change the service startup settings, complete the following steps: -1. Go to **Start > Control Panel > Administrative Tools** and open **Services**. -2. Open the **SMA OpCon Java Agent \** service. The **Properties** dialog displays with the **General** tab in focus. +1. Go to **Start** > **Control Panel** > **Administrative Tools** and open **Services**. +2. Open the **SMA OpCon Java Agent \** service. The **Properties** window displays with the **General** tab in focus. 3. Select the desired **Startup type**: - **Automatic (Delayed Start)** *(recommended)* - **Automatic** @@ -88,32 +88,38 @@ To change the service startup settings, complete the following steps: Create a machine record so OpCon can communicate with the newly installed agent. If this machine was previously defined in OpCon, skip this procedure. -**Step 1 — Define the machine** +#### Define the machine -1. Open **Start > Programs > OpConxps > Enterprise Manager** and log in. +To define the machine, complete the following steps: + +1. Open **Start** > **Programs** > **OpConxps** > **Enterprise Manager** and log in. 2. Open **Machines** under the **Administration** topic in the Navigation Panel. 3. Select **Add** on the **Machines** toolbar. 4. Enter the agent machine's hostname or alias in the **Name** field. -5. Optionally enter documentation notes in the **Documentation** field. +5. (Optional) Enter documentation notes in the **Documentation** field. 6. Select **Java** in the **Machine Type** list. -7. Enter a unique port number (for example, `3100`) in the **Socket Number** field. -8. Optionally enter an IPv4 or IPv6 address in the **IP Address** field. -9. Optionally enter the fully qualified domain name in the **Fully Qualified Domain Name** field. +7. Enter the socket number in the **Socket Number** field. It must match `SocketNumberToSAM` in `Agent.config`, which defaults to `17100`. If multiple agents are installed on one machine, each needs a unique socket number. +8. (Optional) Enter an IPv4 or IPv6 address in the **IP Address** field. +9. (Optional) Enter the fully qualified domain name in the **Fully Qualified Domain Name** field. 10. Select **Save** on the **Machines** toolbar. -**Step 2 — Configure Java advanced settings** +#### Configure the Java advanced settings + +To configure the Java advanced settings, complete the following steps: -1. Select **Open Advanced Settings Panel** under the **Advanced Settings** frame. The **Advanced Machine Properties** dialog displays. +1. Select **Open Advanced Settings Panel** under the **Advanced Settings** frame. The **Advanced Machine Properties** window displays. 2. Select the **Java Settings** tab. 3. Enter the TCP/IP address of the Java system in the **Java IP Address** field, then select **Update**. 4. Enter the communication port number in the **Java Socket Number** field, then select **Update**. 5. Select **Save**. -**Step 3 — Start communication (optional)** +#### Start communication (optional) + +To start communication with the agent, complete the following steps: 1. Right-select the graphic in the **Communication Status** frame to open the menu. 2. Select **Start Communication**. -3. Select **X** next to the **Machines** tab to close the screen. +3. Select **X** next to the **Machines** tab to close it. ## Upgrade installation diff --git a/docs/operations/java-classes.md b/docs/operations/java-classes.md index 2d9ae42..1cfd09b 100644 --- a/docs/operations/java-classes.md +++ b/docs/operations/java-classes.md @@ -17,7 +17,7 @@ The Java Agent runs Java classes defined in OpCon job definitions. It supports t - Use named method when the class contains specific business logic methods you want OpCon to call directly - Use main method when the class follows a standard command-line entry point pattern or accepts arguments as a string array -When the Java Agent is installed on the same system as the Java classes, the agent needs access to the Java libraries (`.jar` files) that contain the classes. All required libraries must be loaded into the agent's class path before a job runs. For information on loading libraries, refer to [Managing Software Libraries](managing-software-libraries). +When the Java Agent is installed on the same system as the Java classes, the agent needs access to the Java libraries (`.jar` files) that contain the classes. All required libraries must be loaded into the agent's class path before a job runs. For information on loading libraries, refer to [Managing Software Libraries](managing-software-libraries.md). The Java Agent can run classes that contain either a named method or the default main method of the class. diff --git a/docs/operations/managing-software-libraries.md b/docs/operations/managing-software-libraries.md index 9d1ea44..183bcd4 100644 --- a/docs/operations/managing-software-libraries.md +++ b/docs/operations/managing-software-libraries.md @@ -17,7 +17,7 @@ For the Java Agent to run a Java class, the required library files (`.jar` files - Use the library directory approach when you want a simple, folder-based method of managing libraries — copy `.jar` files into the directory and the agent picks them up automatically - Use the library file approach when you need precise control over which libraries are loaded and where they are located on the file system -During the Java Agent startup, the library files (`.jar` files) are loaded into the class path by either placing a copy of the required `.jar` files in a defined library directory or entering the full path and filename in a file that the agent uses to determine where the `.jar` files are located. For configuration details, refer to [Java Agent Configuration](../administration/configuration-file). +During the Java Agent startup, the library files (`.jar` files) are loaded into the class path by either placing a copy of the required `.jar` files in a defined library directory or entering the full path and filename in a file that the agent uses to determine where the `.jar` files are located. For configuration details, refer to [Java Agent Configuration](../administration/configuration-file.md). The Java Agent includes listeners that monitor either the directory containing the `.jar` files or the file listing the `.jar` file information for changes. When changes occur, the agent adds the new information to the class path automatically. diff --git a/docs/release-notes.md b/docs/release-notes.md index 3041cca..fa8af66 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -10,6 +10,11 @@ tags: # Java Agent release notes +This page lists changes for each Java Agent release. Each entry is prefixed with one of the following indicators: + +- :eight_spoked_asterisk: — New feature or enhancement +- :white_check_mark: — Bug fix + ## 21 ### 21.0.0