Go to the latest v7.6 documentation →
Using Instance Preferences an admin pro-user can configure the following settings:
- Global Settings-A toggle switch to ON/OFF the Scheduler and the Exception Control settings.
- Email Settings-Allows to either choose the RightData (DataTrust) SMTP or the Custom SMTP settings.
- LDAP Settings-Allows to use AD Authentication and SSO Enable options.
- FTP Settings- Add an FTP by adding the Connection Name, Host, User, Password, and Folder field options.
To learn about the Instance Preferences tile, let us walk through the below procedure:
1. Global Settings:
- Click the ‘ADMIN CONSOLE’ tab.
- Hover on the left-hand side of the application to view available options.
- Click the ‘System Preferences’ option.
Path: ADMIN CONSOLE > System Preferences
- Now the user can view the ‘Preferences’ page.
- Under the ‘Preferences’ page, a couple of tiles are displayed.
- Click the ‘Instance Preferences’ option.
- An ‘Instance Preferences’ session page is displayed.
- Under Instance Preferences, various tabs namely Global Settings, Email Settings, LDAP Settings, and FTP Settings are displayed.
Note: By default, the ‘Global Settings’ tab is selected with the ‘Scheduler’ and ‘Exception Control’ settings are toggled ON (Enabled).
Path: ADMIN CONSOLE > System Preferences > Instance Preferences
- Let’s suppose disable the ‘Scheduler’ option and click the ‘Save’ button.
- Two messages ‘System Preference Updated successfully’ and ‘Successfully Saved’ are displayed on the top right corner of the page.
- Click the ‘Email Settings’ tab.
2. Email Settings:
- Under Email Settings, ‘RightData SMTP Settings’ and ‘Custom SMTP Settings’ options are displayed.
Note: By default, the ‘RightData SMTP Settings’ option is selected.
- Now click the ‘Save’ button, to save the Right data SMTP Settings.
- A message ‘Email Settings Saved Successfully’ is displayed on the top right corner of the page.
- Click the ‘Test Email’ button.
- An ‘Email’ pop-up window is displayed.
- Let’s suppose add an email address in the Email pop-up window text field and click the Send button.
Note: Since the typed text is confidential, hence it is cropped.
- A message “Email sent successfully” is displayed on the top right corner of the page.
- The user can verify that the “Test email from RightData” is successfully received by the above-specified email address recipient.
- Now, select the ‘Custom SMTP Settings’ radio button.
- Under ‘Custom SMTP Settings’, a text field with Your Email Address is displayed. The user can add the desired email address here.
Note: By default, the support@getrightdata.com email address is displayed.
Under ‘Deliver Email To SMTP Server:’ option, the user can view the following options:
- SMTP Server- The SMTP server details can be added here. When hovered on the information icon against SMTP Server text field ‘SMTP server address set by the mail client’ is displayed.
Note: By default, ‘localhost’ text is displayed in the text field provided.
- Use SSL- A checkbox option is provided. When hovered on the information icon against Use SSL checkbox ‘Set a secure SMTP with SSL encryption protocol’ is displayed.
Note: By default, Use SSL is checked.
- Port- The SMTP Server port details can be added here. When hovered on the information icon against Port text field ‘Specify a port(default is 587)’ is displayed.
Note: By default, the Port text field added here is 587.
Similarly, under the Authentication Settings option, the user can view the following options:
- Not required- This option is selected if Authentication is not required.
- Specify credentials- The user can enter the details such as User Name/Email Address, Password, and Confirm Password.
Note: By default, ‘Specify credentials’ radio button option is selected.
- Let’s suppose if the ‘Not required’ radio button is selected and the ‘Save’ button is clicked.
- A message ‘Email Settings Saved Successfully’ is displayed on the top right corner of the page.
- Similarly, you can also test email using the ‘Test Email’ button as performed previously with the RightData SMTP Settings option.
- Click the ‘LDAP Settings’ tab.
3. LDAP Settings:
- Two options namely ‘AD Authentication’ and ‘SSO Enable’ are displayed.
Note: By default, ‘AD Authentication’ is Toggled ON and ‘SSO Enable’ is toggled OFF.
- The ‘Authentication Type’ can be selected from the drop-down list.
Note: By default, ‘Simple’ is selected.
- Let’s suppose, toggle switch Turned Off to ‘AD Authentication’.
- Click the ‘Save’ button.
- A message ‘Settings saved successfully’ is displayed on the top right corner of the page.
- Let’s suppose toggle switch ON to ‘SSO Enable’.
Note: The following options namely Login URL Type, Login URL, and Logout URL are displayed when SSO Enable is Turned On.
- ‘Login URL Type’ displays drop-down options namely ‘GET’ and ‘POST.’
- Let’s suppose select the Login URL Type as ‘GET’ from the drop-down list.
- Then, enter the ‘Login URL’ and ‘Logout URL’ text fields.
- Click the ‘Save’ button.
- A message ‘Settings saved Successfully!’ is displayed on the top right corner of the page.
- When the user clicks the FTP Settings tab, a tabular grid displaying Connection Name, Host, User, Folder, and Controls column names are displayed.
- Click the ‘Add’ button.
4. FTP Settings:
- An ‘Add FTP’ pop-up window is displayed with the following text fields namely Connection Name, Host, User, Password, and Folder. Once the user fills in all the required fields he/she can add a new FTP Setting.
- Click the ‘Save’ button to save the FTP Settings.
Note: Hover on the Information icon placed against each text field to get more information.
- Click the ‘Menu’ button to navigate back to the ‘System Preferences’ page.