Before you start using Orchestration apps such as MS Active Directory that require you to connect to a private on-premise network, you need to download and install the Orchestration server on one of the systems in that network. The Orchestration server needs a Windows system to work. Make sure you go through the minimum requirements and identify the right computer to run the Orchestration server.
Operating System: Windows Server 2016, Windows Server 2019
CPU: 4 cores
RAM: 8GB of RAM or more
Storage: 10 GB of free space in your hard drive
Admin Access required to run the orchestration server’s Installer (FO-OSR.msi)
Enable .NET 3.5 windows feature.
Click on Start button and search server Manager
Go to Server manager
In the top right corner Click on Manage tab
Click on Add Roles and Feature
Click on Next (In before you begin page)
Click on Next (In Installation type page after selecting radio button Role-based or feature-based installation)
Click on Next (In Server selection page, after selecting a radio button, select a server from the server pool and then select your windows server from the list below)
Click on Next (In Server Roles page after selecting checkbox File and Storage Services )
Click on Next (In Feature Page Expand .NET Framework 3.5 Feature and select checkbox .NET Framework 3.5 (includes .NET 2.0 and 3.0))
Note: We highly recommend using an independent server (with configs provided in the document) and it should not be used for any other purpose. i.e No other app should be installed on the OSR server.
Here’s how you can set up an Orchestration Server:-
1. Create an Orchestration Server on the Freshservice portal
- Head over to Admin-> Orchestration Center
- Click on the Orchestration Server Tab
Hit the Create Server button and fill in the form with the necessary details
Name- Give your server a meaningful name for example: Based on the location of the network.
Description- Add a description (optional)
Secret Key- This will be auto-generated once the Orchestration Server is created successfully. (Note: You’ll need this key during the installation phase)
2. Download and Install the Orchestration Server
Under the Orchestration Server tab, click on Download Windows Installer
Once your download is complete, click on the setup file “FO-OSR.msi” to start the installation wizard.
Proxy Server Configuration: You can select checkbox Use a Proxy Server’ to use this feature
Q) Why is the Proxy setting included in the installation wizard?
→ Many enterprises don’t allow direct communication with the server, they use a proxy-server as an intermediate.
To fulfil this requirement we have introduced a checkbox ‘Use a Proxy Server’ under ‘Proxy Setting’ page
If selected ‘Use a Proxy Server’ in Proxy Setting page then
Hostname: Give the private IP of the proxy server.
Port: Give the port number of the proxy server
Username: Give the username of the proxy server
Password: Give the password of the proxy server.
Type: Give the Protocol used (generally http, socks4, socks5)
Q) What is the Secret Key in the Account Configuration installation wizard?
→ It is a token used for authorization of each and every request originated from Orchestration Server to Freshservice Account.
Q) Where will I find the Secret Key in the Freshservice Account?
Head over to Admin-> Orchestration Center.
Click on the Orchestration Server Tab
Select one of the Orchestration Server from the list shown
Copy the Secret Key
Select the folder
By default, Orchestration Server will be Installed inside C:\Program Files\Freshworks\
Click on the ‘Change’ button to change the destination folder.
Complete the installation
Verify if services (‘Orchestration Server’ and ‘Orchestration Server - WinRM_SSH’) are running in your Services tray.
See how to install and use the MS Active Directory Orchestration App by leveraging the Orchestration Server.