--- title: "Service Automation Installation Guide" slug: "service-automation-installation-guide" updated: 2024-06-19T07:08:39Z published: 2024-06-19T07:08:39Z canonical: "help.symphonysummitai.com/service-automation-installation-guide" --- > ## 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 Installation Guide ## Installing Summit Service Automation ### Installation Overview This guide provides step-by-step instructions to install Summit Service Automation. ### Prerequisites This section describes the prerequisites of Summit Service Automation. - Summit Application (Supports Summit Version above DENALI HF15, DENALI SP1 HF15, DENALI SP3 HF11 & TAHOE). - Summit Web Service (Service that is used for Mobile Application). - Summit Application with the Service Automation License. ### Installing and Providing Access to Service Automation ### Pre-Installation Steps Perform the following steps before installation: 1. **Download the Summit Service Automation files from Release Notification e-mail.** 1. The following screen displays the different components of Service Automation for Installation. You can download the required components from the mail and unzip on the server. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701320407309.png)Figure: Summit Release notification email 2. **Host Service Automation API** Perform the following steps to host the Service Automation API: a. Download the **API** files from the Summit Release Notification E-mail. b. Go to Internet Information Services (IIS). c. Create a new Sub application under the default website by specifying the alias name and selecting the API folder path as the physical path. Hosting Service Automation API inside Summit Web is not allowed. 3. **Create or Upgrade Service Automation DB** Perform the following steps to create new Service Automation DB in SUMMIT DB Server: a. Download the **New DB Creation** file from the Summit Release Notification E-mail. b. Create Service Automation DB using this DB backup file. c. Create a New DB login credentials for the Service Automation DB. d. Update the Service Automation DB Connection String in Service Automation API Config file as follows: (*\Config\ConnectionStrings\Prod.Config*) Perform the following steps to update the existing Service Automation DB in Summit DB Server: a. Download the **Database Upgrade Scripts** from Service Automation Release Notification E-mail. b. Execute the scripts in Service Automation DB. 4. **Update Service Automation files in Summit Web Folder** Perform the following steps to update the Service Automation files in Summit Web folder: a. Download the Service Automation **Application** file (CTP) from the Release Notification E-mail. b. Copy the Orchestration folder to the following path of Summit Web Server. */app/*Note:If the Orchestration folder is already exists in the above mentioned path, delete the existing folder and add the copied folder. 5. **Execute Service Automation Integration Script in SUMMIT DB** Perform the following steps to execute the Service Automation Integration Script in Summit DB: a. Download the Service Automation Integration SQL script from the following URL and execute in Summit DB. https://summitbuild.blob.core.windows.net/orchestration/SUMMIT_Orchestration_Integr ationScript.sql b. In SUMMIT DB, open the Stored Procedure USP_ORC_ImportOrchestrationUsers. c. Change the following highlighted DB name with the new Orchestration DB name. set @ORC_DB_Name='[Orchestration_TAHOE].' d. Click Execute to update the changes. 6. **Enable new Service Automation in SUMMIT and update Role Template** Perform the following steps to enable new Service Automation in Summit and update the Role Template: a. Add the following key in the AppSettings section of the Summit Web.Config file: ** b. Log out and Log in to the Summit application. c. Select **Admin> Basic > Users > Role Template**. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701321675827.png)d. Add following keys in SUMMIT to specify Service Automation API URL, Token, and RabbitMQ details. | Sl No | For What | Where to add | File | Section | Key Details | Remarks | | --- | --- | --- | --- | --- | --- | --- | | 1 | To Enable the new Service Automation | SUMMIT - Web | Web.Config | AppSettings | | | | SUMMIT - Mobile App | Web.Config | AppSettings | | | SUMMIT - Jobs | ServerMonitor.exe.config | AppSettings | | | SUMMIT - Proxy | Summit_ProxyServer.exe.config | AppSettings | | | 2 | To connect with the Service Automation API from SUMMIT | SUMMIT - Web | Web.Config | AppSettings | | Specify the Service Automation API Base URL, without "/" at the end. | | 3 | To display the Service Automation execution details in IM/SR/WO | SUMMIT - Web | Web.Config | AppSettings | | Specify the token generated using "account/generatet oken" API for a specific Service Automation User Id or token specified in the Proxy configuration. | | 4 | To connect with the RabbitMQ | SUMMIT - Web | Web.Config | ConnectionStrings | | Create a new credentials for the RabbitMQ and specify in the key. Supports encrypted Connection String. | | SUMMIT - Mobile App | Web.Config | ConnectionStrings | | SUMMIT - Jobs | ServerMonitor.exe.config | ConnectionStrings | | SUMMIT - Proxy | Summit_ProxyServer.exe.config | ConnectionStrings | | 5 | To display the Service Automation UI | SUMMIT - Web | Web.Config | | | Check this tag under system.webserver-static content. If it does not exist, then add it. | | 6 | To enable API trigger | Orchestration API | Product.Config | ConnectionStrings | | | 7. **Export SUMMIT Users to Service Automation DB** Perform the following steps to export Summit Users to Service Automation DB: a. Log in to Summit application. b. Navigate to **Admin > Basic > Infrastructure > Custom Scheduler.** c. Create new custom scheduler job. Job option is “*Export Summit Users to Orchestration DB*”. d. Ensure that Job had run and users with Service Automation access are exported to the Service Automation DB. 8. **Install RabbitMQ in SUMMIT Application Server** Install RabbitMQ in SUMMIT Application Server with its pre-requisite. For more information, see Summit Service Automation Proxy Installation Guide. 9. **Install the Service Automation Proxy** Install the Service Automation Proxy. For more information, see Summit Service Automation Proxy Installation Guide. ### Configure Service Automation To configure Service Automation, perform the following steps: 1. Login to the Summit application. 2. Select **Orchestration > User > Orchestration**. A new tab is opened with the Service Automation application. Note:For previous versions, the following navigation steps can be followed. **Admin > Advanced > Automation > Orchestration.** 3. Select **Menu > Integrations > Manage Integrations > ITSM Configurations**. 4. Specify the **Product Name** as SUMMIT and the **API Base UR**L. For example, [http://localhost/Summit_WS/REST/Summit_RESTWCF.svc](http://localhost/Summit_WS/REST/Summit_RESTWCF.svc) Note:Replace “http://localhost/Summit_WS“ with the actual installed URL in the above URL. 5. Click **VALIDATE** to validate the API and then click **SUBMIT**. ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701323919859.png) Figure: ITSM Configurations 6. Navigate to **Integrations > Manage Integrations > API Configurations.** 7. Select an API from the list. Update the highlighted part with the base URL configured in ITSM Configurations. This has to be done for all the API’s. In the URL this part has to be updated with URL configured in previous screen [http://localhost/summitws/REST/Summit_RESTWCF.svc/](http://localhost/summitws/REST/Summit_RESTWCF.svc/) ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701324494548.png)Figure: API Configurations Note:Ensure that you do not delete the following text in the URL: /RESTService/CommonWS_JsonObjCall 8. Update the **APIKey** in the **Payload** with the SUMMIT API User key for all APIs. 9. Click **TEST** to validate the API and then click **SAVE**. 10. Select **Settings > Application Settings > Proxy.** ![](https://cdn.document360.io/62351b42-cfbd-43ad-8ce1-82b8f455337f/Images/Documentation/image-1701324668301.png)Figure: Proxy Configurations 11. Click on the **Host Name** to map the Proxy IP Range. 12. Start the **Service Automation Execution** and **Event Listener Services.** 13. Configure the **Skills** and **Workflows**. 14. Log Incidents or Service Requests or Work Orders. 15. Ensure that the Service Automation information is displayed in the Orchestration tab of an Incident or Service Request or Work Order.