Installing the Windows Master

The installation procedure for installing Windows Master differs depending on whether the database being used is Microsoft SQL Server or Oracle.

Using a Microsoft SQL Database

To install the Master component using a Microsoft SQL database:

  1. Obtain the Tidal Automation Base Product software for your environment from the support portal. See Obtaining the Software.

  2. Extract the files onto the target machine.

  3. Navigate to the \Scheduler\<your platform> directory.

  4. Run setup.exe.

  5. Click Run on the Internet Explorer Security Warning dialog.

  6. Click Next on the Welcome panel. The TA installer is displayed in the Installation Type panel. On the Installation Type panel, choose Master.

    Note: If the Master is being installed on a Disaster Recover site, then choose Disaster Recovery checkbox.

  7. Click the Destination Folder panel and choose the directory where the TA files will reside, then click Next.

    • Accept the default location at C:\Program Files\TIDAL.

      OR

    • Click Change, locate a directory, choose the appropriate file and click Save.

  8. Click MSSQL Server on the Database Type panel. The AWS RDS option and Microsoft Azure SQL options are displayed.

    Note: To install an Oracle database, follow the instructions in Using an Oracle Database

  9. Click Next. The TA installer is displayed the Database Server panel:

  10. Enter these values:

    • Database HostName – Enter the hostname of the database server.

      Note: The Master should not be installed on hosts with underscores in their names or the JMS connections will fail between components.

      Note: If you are configuring with the SQL Server Cluster, then enter the Virtual IP address in the Database Hostname field.

    • Port – Enter the port number of the JDBC driver. The default port for MSSQL is 1433.

    • DB Instance (Service Name) – Ignore for MSSQL (Oracle only).

    • DB Login ID – Enter the login credentials for the database administrator.

    • Password – Enter the password for the database administrator.

    • Database Name – Enter the database name for MSSQL. By default, the database name is Admiral.

      Note: When the Master is installed in the DR mode, then the DB Login ID, Password and Database Name fields will not be displayed.

    • TLS Version – Click the one of these TSL versions:

    No TLS

    TLS 1.0

    TLS 1.1

    TLS 1.2

    The TA Master must have the specified Driver for the selected TLS version as specified below to connect to the Microsoft SQL Server:

    • No TLS or TLS 1.0 – Microsoft ODBC Driver for SQL Server or Microsoft OLE DB Driver 18 for SQL Server.

    • TLS 1.1 or TLS 1.2 – Microsoft OLE DB Driver 18 for SQL Server.

  11. Click Master on the Installation Type panel.

    Note: If the Master is being installed on a Disaster Recover site, then check Disaster Recovery checkbox.

  12. Click the Destination Folder panel and choose the directory where the TA files will reside, then click Next.

    • Accept the default location at C:\Program Files\TIDAL.

      OR

    • Click Change, locate a directory, choose the appropriate file, and click Save.

  13. Click MSSQL Server on the Database Type panel. The AWS RDS option and Microsoft Azure SQL options are displayed.

    Note: To install an Oracle database, follow the instructions in Using an Oracle Database

  14. Click Next. The TA installer is displayed the Database Server panel.

  15. Enter these values on the Database Server panel:

    • Database HostName – Enter the hostname of the database server.

      Note: The Master should not be installed on hosts with underscores in their names or the JMS connections will fail between components.

      Note: If you are configuring with the SQL Server Cluster, then enter the Virtual IP address in the Database Hostname field.

    • Port – Enter the port number of the JDBC driver. The default port for MSSQL is 1433.

    • DB Instance (Service Name) – Ignore for MSSQL (Oracle only).

    • DB Login ID – Enter the login credentials for the database administrator.

    • Password – Enter the password for the database administrator.

    • Database Name – Enter the database name for MSSQL. By default, the database name is Admiral.

      Note: When the Master is installed in the DR mode, then the DB Login ID, Password and Database Name fields will not be displayed.

    • TLS Version – Click the one of these TSL versions:

    No TLS

    TLS 1.0

    TLS 1.1

    TLS 1.2

    The TA Master must have the specified Driver for the selected TLS version as specified below to connect to the Microsoft SQL Server:

    • No TLS or TLS 1.0 – Microsoft ODBC Driver for SQL Server or Microsoft OLE DB Driver 18 for SQL Server.

    • TLS 1.1 or TLS 1.2 – Microsoft OLE DB Driver 18 for SQL Server.

  16. Click Next. The Database Read-Only User panel is displayed. Click Create Read-Only User option to create a read only user in the Master database. If read-only user already exists, then choose Read-Only User already exists option.

  17. Click Create Read-only User option and click Next, the Database Read-Only User creation panel is displayed.

    Enter these values:

    • Login ID – Enter the login ID to create read-only user.

    • Password – Enter the password to create read-only user.

    • Confirm Password – Reenter the password.

    Note: This user is created in Master database while installing Primary Master. This user is also used to connect Master database as read-only while installing Client Manager.

  18. Click Next. The TA Super User panel is displayed. Enter these details:

    • Domain – Enter the domain name for your Master into the Domain field.

    • Super user – Enter the name of the Super user for this Master.

    • If you have a demo code enter it here – Enter the code into the field and click Next.

    Note: The TA Super User screen is displayed only for the new database installation.

  19. Click Next. The Active Directory/LDAP Authentication panel is displayed.

  20. Choose the authentication type, then click Next.

    • If configuring the Client Manager to use the Active Directory option, the Active Directory Authentication panel is displayed.

    • If configuring the Client Manager to use the LDAP option, the LDAP Authentication panel is displayed.

  21. For Active Directory, enter the information:

    • Host – Enter the hostname or IP address for the Active Directory server.

    • Port – Enter the port number for the AD server.

    • User Search Prefix – Enter the location/prefix of the AD node containing user records.

    • Group Search Prefix – Enter the location/prefix of the AD node containing group records.

    AD Setting:

    Example:

    Security.Authentication=ActiveDirectory

    ActiveDirectory.Host=<ip address or your_hostname>

    ActiveDirectory.Port=389

    ActiveDirectory.UserSearchPrefix=DC=example,DC=com

    ActiveDirectory.GroupSearchPrefix=DC=example,DC=com

    OR

    For LDAP, enter the information:

    • Hostname – Enter the hostname or IP address for the LDAP server.

    • Port – Enter the port number for the LDAP server.

    • BindDN – Enter the RDN (Relative Distinguished Name) to be used in conjunction with the value of LDAP.UserIdentifierType to construct the DN (Distinguished Name) of the users to be authenticated. By default, LDAP.UserIdentifierType has the value uid. Therefore, for example, if the RDN is ou=people,dc=example,dc=com, the DN of the user becomes uid=<username>, ou=people,dc=example,dc=com.

    • UserObjectClass – Specify a valid object class for the user. Only users who posses one or more of these objectClasses will be permitted to authenticate to TA.

    • UserBindDN – Enter the RDN (starting from the root of the tree) in the LDAP server that contains user entries.

    • Index – Check this option if you have an index.

    • GroupBindDN – Enter the RDN (starting from the root of the tree) in the LDAP server that contains group entries.

    Note: To authenticate users across multiple domains rather than installing the Master in each domain, follow the instructions in Enabling Multi-Domain Authentication.

    An LDAP Setting:

    Example: Security.Authentication=LDAP

    LDAP.HostName=<ip_address or hostname> LDAP.Port=389

    LDAP.BindDN=ou=people,dc=example,dc=com LDAP.UserObjectClass=inetOrgPerson LDAP.UserBindDN=dc=example,dc=com LDAP.GroupBindDN=dc=example,dc=com

  22. Click Master on the Installation Type panel.

    Note: If the Master is being installed on a Disaster Recover site, then check Disaster Recovery checkbox.

  23. Click the Destination Folder panel and choose the directory where the TA files will reside, then click Next.

    • Accept the default location at C:\Program Files\TIDAL.

      OR

    • Click Change, locate a directory, choose the appropriate file and click Save.

  24. Click MSSQL Server on the Database Type panel. The AWS RDS option and Microsoft Azure SQL options are displayed.

    Note: To install an Oracle database, follow the instructions in Using an Oracle Database.

  25. Click Next. The TA installer is displayed the Database Server panel.

  26. Enter these values on the Database Server panel:

    • Database HostName – Enter the hostname of the database server.

      Note: The Master should not be installed on hosts with underscores in their names or the JMS connections will fail between components.

      Note: If you are configuring with the SQL Server Cluster, then enter the Virtual IP address in the Database Hostname field.

    • Port – Enter the port number of the JDBC driver. The default port for MSSQL is 1433.

    • DB Instance (Service Name) – Ignore for MSSQL (Oracle only).

    • DB Login ID – Enter the login credentials for the database administrator.

    • Password – Enter the password for the database administrator.

    • Database Name – Enter the database name for MSSQL. By default, the database name is Admiral.

      Note: When the Master is installed in the DR mode, then the DB Login ID, Password and Database Name fields will not be displayed.

    • TLS Version – Choose the one of these TSL versions:

    No TLS

    TLS 1.0

    TLS 1.1

    TLS 1.2

    The TA Master must have the specified Driver for the selected TLS version as specified below to connect to the Microsoft SQL Server:

    • No TLS or TLS 1.0 – Microsoft ODBC Driver for SQL Server or Microsoft OLE DB Driver 18 for SQL Server.

    • TLS 1.1 or TLS 1.2 – Microsoft OLE DB Driver 18 for SQL Server.

  27. Click Next. The Database Read-Only User panel is displayed. Choose Create Read-Only User option to create a read only user in the Master database. If read-only user already exists, then choose Read-Only User already exists option.

  28. If you choose Create Read-only User option and click Next, the Database Read-Only User creation panel is displayed:

    Enter these values:

    • Login ID – Enter the login ID to create read-only user.

    • Password – Enter the password to create read-only user.

    • Confirm Password – Reenter the password.

    Note: This user is created in Master database while installing Primary Master. This user is also used to connect Master database as read-only while installing Client Manager.

  29. Click Next. The TA Super User panel is displayed. Enter these details:

    • Domain – Enter the domain name for your Master into the Domain field.

    • Super user – Enter the name of the Super user for this Master.

    • If you have a demo code enter it here – Enter the code into the field and click Next.

    Note: The TA Super User screen is displayed only for the new database installation.

  30. Click Next. The Active Directory/LDAP Authentication panel is displayed.

  31. Choose the authentication type, then click Next.

    • If configuring the Client Manager to use the Active Directory option, the Active Directory Authentication panel is displayed.

    • If configuring the Client Manager to use the LDAP option, the LDAP Authentication panel is displayed:

  32. Enter this information for Active Directory:

    • Host – Enter the hostname or IP address for the Active Directory server.

    • Port – Enter the port number for the AD server.

    • User Search Prefix – Enter the location/prefix of the AD node containing user records.

    • Group Search Prefix – Enter the location/prefix of the AD node containing group records.

    AD Setting:

    Example: Security.Authentication=AD

    AD.HostName=<ip_address or hostname> AD.Port=389

    AD.BindDN=ou=people,dc=example,dc=com AD.UserObjectClass=inetOrgPerson AD.UserBindDN=dc=example,dc=com AD.GroupBindDN=dc=example,dc=com

    OR

    For LDAP, enter this information:

    • Hostname – Enter the hostname or IP address for the LDAP server.

    • Port – Enter the port number for the LDAP server.

    • BindDN – Enter the RDN (Relative Distinguished Name) to be used in conjunction with the value of LDAP.UserIdentifierType to construct the DN (Distinguished Name) of the users to be authenticated. By default, LDAP.UserIdentifierType has the value uid. Therefore, for example, if the RDN is ou=people,dc=example,dc=com, the DN of the user becomes uid=<username>, ou=people,dc=example,dc=com.

    • UserObjectClass – Specify a valid object class for the user. Only users who posses one or more of these objectClasses will be permitted to authenticate to TA.

    • UserBindDN – Enter the RDN (starting from the root of the tree) in the LDAP server that contains user entries.

    • Index – Check this option if you have an index.

    • GroupBindDN – Enter the RDN (starting from the root of the tree) in the LDAP server that contains group entries.

    Note: To authenticate users across multiple domains rather than installing the Master in each domain, follow the instructions in Enabling Multi-Domain Authentication.

    An LDAP Setting:

    Example: Security.Authentication=LDAP LDAP.HostName=<ip_address or hostname> LDAP.Port=389

    LDAP.BindDN=ou=people,dc=example,dc=com LDAP.UserObjectClass=inetOrgPerson LDAP.UserBindDN=dc=example,dc=com LDAP.GroupBindDN=dc=example,dc=com

  33. Click the Ready to Install the Program panel, click Install to start the installation process. The Installing Tidal Automation – Master panel is displayed. The progress of your Master installation is displayed in the form of a progress bar.

    Note: Do not click Cancel once the installation process begins copying files in the Setup Status panel. Canceling the installation at this point corrupts the installation program. You will not be able to install the component without the help of Tidal Support Center. If you decide you do not want to install the component, you must complete the installation and then uninstall.

  34. Choose the Launch TA Service Manager on the Setup Completed panel and then click Finish. The TA Service Manager window appears.

  35. Click Start on the TA Service Manger window to run the scheduler Master.

Using an Oracle Database

Note: The procedure for installing a Master running an Oracle database is very similar to the procedure used when running a Microsoft SQL database. The differences are described in the procedure.

To install the Master component using an Oracle database:

  1. Download the Tidal Automation Base Product software for your environment from the support platform.

  2. Extract the files onto the target machine.

  3. Navigate to the \Scheduler\<your platform> directory.

  4. Run setup.exe.

  5. Click Run on the File Download Security Warning panel.

  6. Click Run on the Internet Explorer-Security Warning panel.

  7. Click Next on the Welcome panel.

  8. Choose Master on the Installation Type panel.

    Note: If the Master is being installed on a Disaster Recover site, then check Disaster Recovery checkbox.

  9. Choose the directory on the Destination Folder panel where the TA files will reside, then click Next.

    • Click Browse, locate a directory, choose the appropriate file and click Save.

      OR

    • Accept the default location at C:\Program Files\TIDAL.

    Click Oracle Server on the Database Type panel to install on Oracle database.

    If the Oracle database server is:

    • A RAC (Real Application Cluster) setup, check the RAC checkbox.

    • An AWS RDS instance, check the AWS RDS checkbox.

    • A DBaaS instance on Oracle Cloud Infrastructure, check the DBaaS checkbox.

    • An Autonomous instance on Oracle Cloud Infrastructure, check the Autonomous Database checkbox.

    If you selected Autonomous Database:

    • Specify the wallet configuration path.

    • Specify the DB Login ID, Password, and Consumer Group to connect to the Oracle Autonomous database.

    • Click Next to display the Database Server screen.

  10. Specify the Oracle database and logon details and click Next.

    • Database HostName – Enter the hostname of the database server.

    • Port – Enter the port number of the JDBC driver. The default port for Oracle is 1521.

    • DB Instance (Service Name) – Name of the Oracle database instance.

      Note: The Service Name is case-sensitive. Specify the pluggable Database (PDB) name for Multi-Tenant/Oracle Database 21c/RAC/Data Guard.

    • Login ID – Enter the login credentials for the database administrator.

    • Password – Enter the password for the database administrator.

      Note: This information is available from the Oracle Database Administrator. The Login ID and the Password fields will not be displayed if Master is installed in the Disaster Recovery mode.

      Note: If you have selected RAC checkbox in the Database Type panel, then you should enter the Custom JDBC URL along with the database server details, A sample custom JDBC URL for RAC

      Example: jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=<node1>)(PORT=1521))(ADDR ESS=(PROTOCOL=TCP)(HOST=<node2>)(PORT=1521))(LOAD_BALANCE=ON)(FAILOVER=ON))(CONNECT_DATA=(SERVICE_N AME=<PDB Name>)))

  11. If you have selected DBaaS checkbox in the Database type screen the Get Database User screen appears after the Database Server screen.

    Enter these fields in the Database User screen:

    • Username: Enter a username to create a user.

      Note: The default username is Tidal. This username can be modified.

    • Password: Enter the password.

    • Confirm Password: Reenter the password.

  12. Specify the name and location of the Data on the Oracle Tablespace Datafiles panel, Index and Temp tablespaces so TA can access the files, then click Next. By default, TA calls the datafiles, ADMIRAL_DATA, ADMIRAL_INDEX and ADMIRAL_TEMP. You can retain the default name or replace the default values with different names but you must type the directory path to each datafile location.

  13. Click Next. The Database Read-Only User panel is displayed.

  14. Choose Create Read-Only User option to create a read only user in the Master database. If read-only user already exists, then choose Read-Only User already exists option.

    If you choose Create Read-only User option and click Next, the Database Read-Only User creation panel is displayed.

    Enter these values:

    • Login ID– Enter the login ID to create read-only user.

    • Password– Enter the password to create read-only user

    • Confirm Password– Reenter the password.

      Note: This user is created in Master database while installing Primary Master. This user is also used to connect Master database as read-only while installing Client Manager.

  15. Click Next. The TA Super User panel is displayed.

    Enter the details:

    • Domain– Enter the domain name for your Master into the Domain field.

    • Super user– Enter the name of the Super user for this Master.

    • If you have a demo code enter it here – Enter the code into the field and click Next.

    Note: The TA Super User screen is displayed only for the new database installation.

  16. Click Install on the Ready to Install the Program panel to start the installation process. The Installing TA – Master panel is displayed. The progress of your Master installation is displayed in the form of a progress bar.

    Note: Do not click Cancel once the installation process begins copying files in the Setup Status screen. Cancelling the installation at this point corrupts the installation program.

    You will not be able to install the component without the help of Tidal Support Center. If you decide you do not want to install the component, you must complete the installation and then uninstall.

  17. Click Launch TA Service Manager on the Setup Completed panel and then click Finish. The TA Service Manager window is displayed.

  18. Click Start on the TA Service Manger window to start the scheduler master.

Installing a PostgreSQL Database

To install the Master component using a Postgres database:

  1. Obtain the Tidal Automation Base Product software for your environment from the support portal.

  2. Extract the files onto the target machine.

  3. Navigate to the \Scheduler\<your platform> directory.

  4. Run setup.exe.

  5. Click Run on the Internet Explorer Security Warning dialog.

  6. Click Next on the Welcome panel.

  7. Choose Master in the Installation Type panel.

    If the Master is being installed on a Disaster Recovery site, then choose Disaster Recovery checkbox.

  8. Click the directory where the TA files will reside on the Destination Folder panel, then click Next.

    • Accept the default location at C:\Program Files\TIDAL.

      OR

    • Click Change, locate a directory, choose the appropriate file and click Save.

  9. Choose PostgreSQL Server on the Database Type panel. If the PostgreSQL database server is an RDS instance on PostgreSQL Cloud Infrastructure, check the AWS RDS checkbox.

    Note: To install MSSQL database, follow the instructions provided in Using a Microsoft SQL Database, and to install an Oracle database, follow the instructions provided in Using an Oracle Database.

  10. Click Next. The Database Server screen is displayed.

  11. Enter these values in the Database Server screen:

    • Database HostName – Enter the hostname of the database server.

      Note: The Master should not be installed on hosts with underscores in their names or the JMS connections will fail between components.

    • Port– Enter the port number of the JDBC driver. The default port for Postgres is 5432.

    • DB Instance (Service Name)– Ignore for PostgreSQL (Oracle only).

    • DB Login ID– Enter the login credentials for the database administrator.

    • Password– Enter the password for the database administrator.

    • Database Name– Enter the database name for PostgreSQL. By default, the database name is Admiral.

    Note: When the Mater is installed in the DR mode, then DB Login ID, Password and Database Name fields will not be displayed.

  12. Click Next. The Database Read-Only User panel is displayed.

    Choose Create Read-Only User option to create a read only user in the Master database. If read-only user already exists, then choose Read-Only User already exists option.

  13. If you choose Create Read-only User option and click Next, the Database Read-Only User creation panel is displayed.

    Enter these values:

    • Login ID – Enter the login ID to create read-only user.

    • Password – Enter the password to create read-only user.

    • Confirm Password – Reenter the password.

    Note: This user is created in Master database while installing Primary Master. This user is also used to connect Master database as read-only while installing Client Manager.

  14. Click Next. The TA Super User screen is displayed. In the TA Super User panel, enter the information, then click Next.

    • Domain – Enter the domain name for your Master into the Domain field.

    • Super user – Enter the name of the Super user for this Master.

    • If you have a demo code enter it here – Enter the code into the field and click Next.

      Note: The TA Super User screen is displayed only for the new database installation.

  15. Click Next. The Active Directory/LDAP Authentication panel is displayed.

  16. Choose the authentication type, then click Next.

    • If configuring the Client Manager to use the Active Directory option, the Active Directory Authentication panel is displayed.

    • If configuring the Client Manager to use the LDAP option, the LDAP Authentication panel is displayed.

  17. Enter this information for Active Directory:

    • Host – Enter the hostname or IP address for the Active Directory server.

    • Port – Enter the port number for the AD server.

    • User Search Prefix – Enter the location/prefix of the AD node containing user records.

    • Group Search Prefix – Enter the location/prefix of the AD node containing group records.

    An AD Setting:

    Example: Security.Authentication=ActiveDirectory ActiveDirectory.Host=<ip address or your_hostname> ActiveDirectory.Port=389
    ActiveDirectory.UserSearchPrefix=DC=example,DC=com
    ActiveDirectory.GroupSearchPrefix=DC=example,DC-com

    OR

    For LDAP, enter this information:

    • Hostname – Enter the hostname or IP address for the LDAP server.

    • Port – Enter the port number for the LDAP server.

    • BindDN – Enter the RDN to be used in conjunction with the value of LDAP.UserIdentifierType to construct the DN of the users to be authenticated. By default, LDAP.UserIdentifierType has the value uid. Therefore, for example, if the RDN is ou=people,dc=example,dc=com, the DN of the user becomes uid=<username>,ou=people,dc=example,dc=com.

    • UserObjectClass – Specify a valid object class for the user. Only users who posses one or more of these objectClasses will be permitted to authenticate to TA.

    • UserBindDN – Enter the RDN (starting from the root of the tree) in the LDAP server that contains user entries.

    • Index – Check this option if you have an index.

    • GroupBindDN – Enter the RDN (starting from the root of the tree) in the LDAP server that contains group entries.

    Note: To authenticate users across multiple domains rather than installing the Master in each domain, follow the instructions in Enabling Multi-Domain Authentication.

    An LDAP Setting

    Example: Security.Authentication=LDAP LDAP.HostName=<ip_address or hostname> LDAP.Port=389
    LDAP.BindDN=ou=people,dc=example,dc=com LDAP.UserObjectClass=inetOrgPerson LDAP.UserBindDN=dc=example,dc=com LDAP.GroupBindDN=dc=example,dc=com

  18. Click Install on the Ready to Install the Program panel to start the installation process. The Installing Tidal Automation – Master panel is displayed. The progress of your Master installation is displayed in the form of a progress bar.

    Note: Do not click Cancel once the installation process begins copying files in the Setup Status panel. Canceling the installation at this point corrupts the installation program. You will not be able to install the component without the help of Tidal Support Center. If you decide you do not want to install the component, you must complete the installation and then uninstall.

  19. Choose Launch TA Service Manager on the Setup Completed panel, and then click Finish. The TA Service Manager window is displayed.

  20. Click Start on the TA Service Manger window to run the scheduler Master.