General FAQ for Orchestrator Installation issues.
Issue Description: General Orchestrator Installation Troubleshooting
Background: This KB article is not meant to debug specific issues but given an overview of how to debug installation issues.
Diagnosing Steps
- When an installation fails it is important to take a look at the logs. The logs will always be generated at %temp%. This is an environment variable that represents the temp directory. In file explorer go to %temp% as the location after a failed install. The installer will be some random combination of numbers and end with msi.log (i.e. c1235213msi.log)
- Note: Sometimes %temp% will to resolve to C:\users\\appdata\Local\temp\
- Go up one directory to find the log
- If it is difficult to find the log consider running the installer from the command line with the option /l*vx
- i.e. UiPathOrchestrator.msi /l*vx log.txt
- Once the install logs are generated, look the number 1603. The number 1603 represents a fatal error. Typically the number will pop up at the end of the installation log and where the error was encountered.
- From the top of the file, look for the number 1603. Above the first instance, should be the error. Normally it will show as a exception with a stack trace but it might just be a message that does not look like an error.
- i.e. In the below example the issue was that the user ran the installer with a parameters file where insights was enable but no DB was provided
-
MSI (s) (64!94) [15:21:12:069]: Creating MSIHANDLE (53) of type 790531 for thread 1940 'Insights SQL Server host' is required. MSI (s) (64!94) [15:21:12:069]: Closing MSIHANDLE (53) of type 790531 for thread 1940 'Insights SQL Server host' is required. MSI (s) (64:50) [15:21:13:399]: Closing MSIHANDLE (48) of type 790542 for thread 1220 CustomAction ValidateAndSetProperties returned actual error code 1603 (note this may not be 100% accurate if translation happened inside sandbox) Action ended 15:21:13: ValidateAndSetProperties. Return value 3.
-
- Notice in the above, the issue does not look like an error, the message represented a fatal exception.
- It is also possible to just search for 'Return value 3.'
- i.e. In the below example the issue was that the user ran the installer with a parameters file where insights was enable but no DB was provided
- With the above information in hand, it should be possible to identify why the installer is failing.
- If the issue is still not clear, open a ticket with UiPath. On the ticket include the following:
- The installation log
- Version of Orchestrator currently installed
- Version of Orchestrator being installed.
- Mention this KB article.
Appendix
This is a list of common things that can be checked when an Orchestrator install is failing. NOTE: For each one of these items, the log has a specific error message. So its better to check the log then go through this list. However, sometimes if the error is confusing, this list can help.
Verification:
- Verify version of IIS and server roles and features prerequisite.
-
Go to IIS 'server' click on 'Help' from the menu tab
-
Click on 'About Internet Information Service' and information on the IIS server will be obtained
-
As recommended, the IIS version should be 7.5 and above to support the UiPath Orchestrator.
-
-
Verify the appropriate features are installed in the server using power shell
-
Open PowerShell with administrator privileges and run the command Get-WindowsFeature Web*
-
See all currently installed web roles and features as shown in the screenshot below
-
Click Server Roles and Features to verify the roles and features returned
- Verify URL IIS URL Rewrite module.
-
Go to 'Control Panel' and select 'Programs and Features' check that the 'IIS URL rewrite Module' is installed.
-
If installed, skip this step.
-
If not installed download and proceed with installation.
-
- Verify the .NET version
-
Open 'command prompt' as administrator.
-
Navigate to the default .NET installation folder.
-
cd C:\Windows\Microsoft.NET\Framework64\v4.0.30319
-
Use the below command to check the version:
-
.\MSBuild.exe -version
-
If the appropriate .NET version is not available on the server as outlined in the Software Requirements for your version of Orchestrator, click here to download and install it.
- Verify the Application pool identity user
- Change the app pool identity to custom user if using the server in a domain. To change the application pool identity user, perform the below steps
-
Open IIS manager or Windows+r for the Run command window. Type inetmgr and enter
-
Click on 'Application Pools' Ă Select 'UiPath Orchestrator' Ă Click on 'Advance Settings' as shown in above screenshot
- Click on the 'identity' and select the "..." as shown in the screen shot.
-
Select 'Custom Account' and click on set to provide the credentials as shown in the below screenshot
Note: If the username and password are not correct, the 'Application Pool' will not start and you will get a “503 server unavailable” error when you hit the Orchestrator URL
- Verify SSL certificate validity
- Go to the IIS server Ă Click on 'Server Certificates' as shown in the below screenshot
-
Check the certificate imported to the UiPath Orchestrator website and ensure the expiration date is acceptable
-
If the certificate is expired, create a new domain or self-signed certificate and start installation
- Verify the path in IIS and Registry
-
Go to 'IIS' Ă Select the 'UiPath' website Ă 'Advance settings' in the right pane and check the physical path as shown in the screenshot below.
-
The path mentioned here and registry should be same.
-
Go to 'regedit' and verify the configuration in the below registry path.
-
Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\UiPath\UiPath Orchestrator
-
Open the database server and navigate to the user which is communicating with IIS.
-
Click 'Properties' as shown in the screenshot. Verify the below permissions.
-
Provide the db_owner membership in User Mapping.
-
Note: db_create permission is required for new installations.Check this permission in the Server Roles page within the same properties window.