Service Automation Proxy Installation Guide

Installing Apex Service Automation Proxy Server

Installation Overview

This guide provides step-by-step instructions to install Service Automation Proxy Server.

Prerequisites

This section describes the prerequisites of Service Automation Proxy Server.

Erlang OTP and RabbitMQ Requirements

Minimum Software Requirements:

1. Erlang OTP 26.2.5.5 or higher (32-bit or 64-bit, Recommended 64-bit for better performance).
   a. Download the 32-bit from the below URL:
   https://summitbuild.blob.core.windows.net/orchestration/otp_win32_26.2.5.5.zip
   b. Download the 64-bit from the below URL:
   https://summitbuild.blob.core.windows.net/orchestration/otp_win64_26.2.5.5.zip
   

2. RabbitMQ Server 4.0.3 or higher.
   a. Download the RabbitMQ Server from the below URL:
   https://summitbuild.blob.core.windows.net/orchestration/rabbitmq-server-4.0.3.zip

Post Installation Tasks

Enabling RabbitMQ Management Plugin

After downloading and installing the Erlang OTP and RabbitMQ, enable the RabbitMQ Management Plugin as follows:

1. Open Command Prompt in Administrator mode.

2. Go to the RabbitMQ install location:
   [C:\Program Files\RabbitMQ Server\rabbitmq_server-4.0.3\sbin]

3. Enter the following command that is highlighted:
   [C:\Program Files\RabbitMQ Server\rabbitmq_server-4.0.3\sbin]>rabbitmq-plugins enable rabbitmq_management

4. The above-mentioned command runs the rabbitmq-plugins batch file that is located inside the sbin folder.

Configuring the RabbitMQ Admin Portal

To configure the RabbitMQ Admin Portal, perform the following steps:

1. Open the browser and enter the URL http://localhost:15672/

2. Specify the Username and Password.

Figure: RabbitMQ Log in page

Figure: RabbitMQ configuration page

3. Navigate to Admin.

4. Provide the Username and Password.

5. Select the Tag as Admin in the drop-down list.

6. Click Add user.

Figure: Admin - Users

Figure: Permissions

7. Guest credentials cannot be used remotely.

8. Username is case sensitive.

Creating Virtual Host

The RabbitMQ Virtual Host feature support multiple instances of Service Automation environment with one instance of RabbitMQ installation.
To create new virtual host, perform the following steps:

1. Login in to RabbitMQ instance with the given access credentials.
   

2. Navigate to Admin > Virtual Hosts. The Virtual Hosts screen appears.
   Figure: Admin page - Virtual Hosts

3. Enter the required details and click Add virtual host to create a new Virtual Host.

4. Select the newly created Virtual Host in the Grid.
   Figure: Virtual Hosts
   

5. Specify the Permission with default values and click Set permission. The Permission section appears for the selected virtual host name.
   Figure: Current permissions window

The following table describes the various functions you can perform on this screen:

Configure Firewall Rules

To configure the Firewall Rules, perform the following steps:

1. Add Inbound Rules to connect the RabbitMQ remotely by doing the following:

   1. In the Control Panel, click System and Security > Windows Firewall. The Windows Firewall window appears.

   2. In the Windows Firewall window, make sure the firewall is On. If not, turn on the Windows Firewall.

   3. Click Advanced Settings.
      The Windows Firewall with Advanced Security window appears.

   4. In the left pane, click Inbound Rules. The Inbound Rules pane appears.
      Figure: Windows Firewall- Inbound Rules

   5. In the Actions pane, select New Rule.
      The New Inbound Rule wizard opens, and the Rule Type window appears.
      Figure: New Inbound Rule Wizard
      

   6. Specify the values as per the below table and click Finish.

2. Specify the following ports:
   15672,5672,5671

3. Ensure the following Port details:

   2. RabbitMQ Management: 15672.

   3. http Port: 5672 (Without TLS Enabled).

   4. Required SSL :5671 (With TLS Enabled).

Installing Service Automation Proxy Setup

To install the Service Automation Proxy Setup, perform the following steps:

1. Download the Orchestration (Service Automation) Proxy Installer.

2. Double-click on the MSI file to start the installation

3. Continue the installation by following the on-screen instructions

4. This installer installs Orchestration (Service Automation) Proxy and Event Listener service.

5. Do not validate the following screen in the Setup (If any one service is selected, both services get installed).

Figure: Orchestration Proxy

Post Installation Tasks

After installing the Service Automation Proxy, open the same for configuration.
Figure: Service Automation Proxy setup tool

I. Service Automation API Authentication

Specify the Service Automation API URL.
For example: http://localhost/summitweb/api_orchestration

II. Specify the Token

You can generate the Token with Postman as follows:

1. Select the Request type as POST and specify the Service Automation URL http://localhost/summitweb/api_orchestration/api/account/generatetoken

2. Click Body.

3. Select Raw.

4. Select the content-type as JSON.

5. Specify the Service Automation user ID from the Service Automation table (orc_users) as follows:
   {"UserName": "fredrick.norton@zacme.com",
    "Password": "password@123",
     "ClientType":"SA:PROXY"}

6. Click Send.

7. Copy the token from the response (ignore double quotes “ ”).

Figure: Postman tool

III. Configure RabbitMQ

To configure the RabbitMQ, specify the following details:

1. Host Name of the RabbitMQ Server.

2. Newly created User Name and Password.

3. Port as follows:

   1. HTTP Port: 5672 (Without TLS Enabled).

   2. Required SSL: 5671 (With TLS Enabled).

4. Click Save.
   The configuration is saved.

Figure: Service Automation Proxy setup tool

Generating Tokens for Summit/HTTP Client Integration with Postman

Specify the Token

You can generate the Token with Postman as follows:

1. Select the Request type as POST and specify the Service Automation URL http://localhost/summitweb/api_orchestration/api/account/generatetoken

2. Click Body.

3. Select Raw.

4. Select the content-type as JSON.

5. Specify the Service Automation user ID from the Service Automation table (orc_users) as follows:
   {"UserName": "fredrick.norton@zacme.com"
    "Password": "password@123"}

6. Click Send.

7. Copy the token from the response (ignore double quotes “ ”).

Figure: Postman Tool