---
title: "Service Automation Proxy Installation Guide"
slug: "clone-service-automation-proxy-installation-guide"
tags: ["Proxy Installation Guide"]
updated: 2026-05-08T06:04:48Z
published: 2026-05-08T06:04:48Z
canonical: "help.symphonysummitai.com/clone-service-automation-proxy-installation-guide"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://gbr01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fsummitbuild.blob.core.windows.net%2Forchestration%2Fotp_win32_26.2.5.5.zip&data=05%7C02%7Csushmitha.c%40symphonyai.com%7Cd9abb1b65d6f459c4f1908dd9eac4108%7C4bfc8473b4f84a6883c66b4fc5438261%7C0%7C0%7C638841184857233188%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=fLypXhfWkbCyzQTPkWT%2BmBZnYdZx2av7HBRPLMOQRFk%3D&reserved=0) b. Download the 64-bit from the below URL: [https://summitbuild.blob.core.windows.net/orchestration/otp_win64_26.2.5.5.zip](https://gbr01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fsummitbuild.blob.core.windows.net%2Forchestration%2Fotp_win64_26.2.5.5.zip&data=05%7C02%7Csushmitha.c%40symphonyai.com%7Cd9abb1b65d6f459c4f1908dd9eac4108%7C4bfc8473b4f84a6883c66b4fc5438261%7C0%7C0%7C638841184857251823%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=E5lPdpsPDe%2Bk4MYSmgP4zWAPXYdSq1NN8u%2FnYTD6oiA%3D&reserved=0)
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](https://gbr01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fsummitbuild.blob.core.windows.net%2Forchestration%2Frabbitmq-server-4.0.3.zip&data=05%7C02%7Csushmitha.c%40symphonyai.com%7Cd9abb1b65d6f459c4f1908dd9eac4108%7C4bfc8473b4f84a6883c66b4fc5438261%7C0%7C0%7C638841184857271866%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=Ymvj0LIY2NFLw7ES%2FfkdpGO5z6ncMAc%2FRZBBWm8q8Xg%3D&reserved=0)

### 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.

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/Sauto%20guide%20new%20screenshot.jpg)

### 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/](http://localhost:15672/)
2. Specify the Username and Password.

Note:

By default, the Username and Password are **guest**.

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701325393013.png)

Figure: RabbitMQ Log in page

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701325429971.png)

Figure: RabbitMQ configuration page

1. Navigate to **Admin**.
2. Provide the Username and Password.
3. Select the Tag as **Admin** in the drop-down list.
4. Click **Add user**.

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701325897835.png)Figure: Admin - Users

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701325930018.png)Figure: Permissions

1. Guest credentials cannot be used remotely.
2. 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. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701326061804.png)Figure: Admin page - Virtual Hosts

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

| Sl No | Field | Description |
| --- | --- | --- |
| 1 | Name | Enter a unique name for the virtual host. |
| 2 | Description | Enter the description for the criteria. |
| 3 | Tags | Enter the tag name for the virtual host. |

1. Select the newly created Virtual Host in the Grid. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701326305048.png) Figure: Virtual Hosts
2. Specify the Permission with default values and click **Set permission**. The Permission section appears for the selected virtual host name. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701326355378.png)Figure: Current permissions window

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

| Click | To |
| --- | --- |
| Set permission | Set the permission for the selected virtual host. |
| Set topic permission | Set the topic permission for the selected virtual host. |
| Delete this virtual host | Delete the selected virtual host. |

### 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. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701326575255.png) 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. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701326641204.png) Figure: New Inbound Rule Wizard
  6. Specify the values as per the below table and click **Finish**.

| **Rule Type** | Port |
| --- | --- |
| **Protocols and Ports** | TCP |
| **Specified Local Ports** | 5672, 15672 |
| **Action** | Allow the connection |
| **Profile** | Domain, Private, Public |
| **Name** | RabbitMQ |

1. Specify the following ports: 15672,5672,5671
2. Ensure the following Port details:
  1. RabbitMQ Management: 15672.
  2. http Port: 5672 (Without TLS Enabled).
  3. Required SSL :5671 (With TLS Enabled).

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701327417175.png)

### 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).

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701327493547.png)Figure: Orchestration Proxy

### Post Installation Tasks

After installing the Service Automation Proxy, open the same for configuration. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/SAuto%20Proxy%20setup%20tool.jpg)Figure: Service Automation Proxy setup tool

#### I. Service Automation API Authentication

Specify the Service Automation API URL. For example: [http://localhost/summitweb/api_orchestration](http://localhost/summitweb/api_orchestration)

Note:

API URL may change based on the hosting.

#### II. Specify the Token

You can generate the Token with Postman as follows:

Note:

Tokens created with the `ClientType: "SA:PROXY"` setting are not intended for use with Summit or HTTP Client applications. Refer to [Generating Tokens for Summit/HTTP Client Integration with Postman](/apex/docs/service-proxy-installation-guide-1#generating-tokens-for-summithttp-client-integration-with-postman) for more information.

1. Select the Request type as *POST* and specify the Service Automation URL [http://localhost/summitweb/api_orchestration/api/account/generatetoken](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 “ ”).

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image%20(4)(1).png)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.

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/SAuto%20Proxy%20setup%20tool(1).jpg)

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](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 “ ”).

![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image%20(16).png)Figure: Postman Tool