User manual

System Settings


"Mail server(s)" , "Internal network" , "Notifications", "SFTP transfer" , "System Information", "System preferences", "Theme", "Proctoring settings", "Proctorio settings", "Additional modules" ,"System support" and "Single sign-on" are located in the "System settings" page.

  1. Accessing the page

    To access the "System settings" page, you should click on the "System" menu and select "System settings".

  2. Page layout
  3. On the "System settings" page you will find twelve tabs: "Mail server", "Internal network", "Notifications", "SFTP transfer", "System information", "System preferences", "Theme", "Proctoring settings", "Proctorio settings", "Additional modules","System support" and "Single sign-on" .


    1. Mail server

      The "Mail server" tab serves to set parameters for a mail server that will be used for sending various notifications to administrators and users via email. There is no limit regarding the number of mail servers which can be set.

      1. The "Mail server" drop-down list determines the mail server from which the parameters are displayed.
      2. The "Server status": only one mail server can be active at a time. You can set a mail server to be active by clicking on the "Activate" button in the form of an inactive mail server. Only inactive mail servers can be deleted by clicking on the "Delete" button in the form of the inactive mail server.
      3. Also, you can test if the mail server works by sending an email to the address you specify in the "Send test email to" field and by clicking the "Send" button.
      4. This is the host name of the mail server.
      5. This is the port number of the mail server.
      6. These are security parameters.
      7. This is the username of the mail server.
      8. This is the password for the mail server.
      9. This is the system email of the mail server.
      10. This is the support email of the mail server. IMPORTANT: Make sure that your support email is: ytm.system@gmail.com if you want to contact the GetCertified support team.
      11. By clicking the "Update existing" button the entered parameters will be applied to the selected mail server.
      12. By clicking on the "Create new" button you will create a new mail server with the entered parameters.

    2. Internal network

      The "Internal network" tab allows you to define the IP addresses within your local network from which certain parts of the application can be accessed.

      1. This is the IP mask of the internal network, only machines with IP addresses starting with this prefix will be allowed access.
      2. This is the client's IP address.
      3. Clicking the "Confirm" button will save the changes you have made.
      4. Clicking the "Cancel" button will invalidate all the changes you have made.

    3. Notifications

      The "Notifications" tab contains email and in-application notification templates that are sent automatically when a certain action is made inside the application. The emails and application notifications are predefined but can be edited by changing email/application notification templates. When editing the templates, the variables (text between $ signs) cannot be edited, added or removed.

      1. The notification name serves to identify a particular event. Here you will be able to find all notifications available in the system.
      2. The application notification section is used to configure notifications and templates in the application.
      3. The email notification section is used to configure notifications and templates that will be sent to users via email.
      4. The "Status" column has options "Enable/Disable".
      5. The "Edit" option prompts a dialog for a selected mail/application notification.
      1. This is the body of the email. The text can be edited, but all the variables must remain the same because the system replaces them with specific data.
      2. This is the list of all variables of a selected email template.
      3. This is the "Mail subject name" box where you can change the email subject.
      1. This is the body of the application notification. The text can be edited, but all the variables must remain the same because the system replaces them with specific data.
      2. This is the list of all variables of a selected application notification template.
      3. This is the "Notification title" which can be configured for the selected notification.

      To save the modified email/application template, click on the "Save" button. If some of the variables are missing, you will be prompted with an error message.

      If you accidentally delete any of the variables, it will be shown in the list of the missing variables.

      Clicking the "Cancel" button will close the opened dialog.

    4. SFTP transfer

      On the "SFTP Transfer" tab, you can activate sending test completion reports, stored in a CSV format. If activated, reports will be sent at regular intervals and will contain information that refers to all new successfully completed test attempts (an empty CSV file will be sent if none of the test attempts were completed successfully in a defined interval).
      Note: This tab is visible only to the clients who requested this module to be activated.

      1. Here you can adjust if the transfer is "Active" or "Inactive".
      2. Here you should enter the IP address.
      3. Here you should enter the port.
      4. Here you should enter the username.
      5. Here you should enter the password.
      6. Here you should enter the time interval (in minutes).
      7. Displayed here is the time when the last report was sent.
      8. Click the "Confirm" button if you want to save the changes you have made.
      9. If you are not satisfied with the changes you have made click the "Cancel" button.

    5. System information

      Basic information about your system is displayed on the "System information" tab.

      You can access release info by clicking on the link "Open Release Info" and it will open in new tab.


    6. System preferences

      On the "System preferences" page you can customize certain elements of the application.

      1. The date format in the application is displayed here.
      2. The time format in the application is displayed here.
      3. You can modify the web browser tab title text.
      4. You can modify the text next to "Copyright" on the login page.
      5. You can modify the confirmation text on the instruction screen dialog of "All assignments".
      6. You can modify the $from$ parameter in the system emails for all emails sent from the application.
      7. You can modify the URL of the application in the emails sent from the system.
      8. You can choose to display the YouTestMe privacy policy.
      9. If you click "Change logo" you can change the logo at the login page.
      10. If you click "Default logo" the logo at the login page will change to the default "YouTestMe" logo.
      11. If you click "Change favicon" you will change the icon next to the web browser title text.
      12. If you click "Cancel" you will cancel the change of the favicon.
      13. Configure the length of the session timeout in minutes.
      14. Configure the length of user password lockout.
      15. If you are satisfied with the changes you have made click on the "Confirm" button.
      16. If you are not satisfied with the changes you have made click on the "Cancel" button.

    7. Theme

      On the "Theme" tab you can:

      1. Make application rebranding according to your company/organization colors.
      2. After making the desired changes click the "Confirm" button.
      3. If you want to discard your changes, click the "Cancel" button.

    8. Proctoring settings

      Please note that the Proctoring service can be enabled only upon your request. For more information, contact the YouTestMe team at sales@youtestme.com. Upon the activation, you will be provided with all necessary parameters for configuring the proctoring service. In case you request the proctoring service before the application delivery, all settings will already be configured.

      1. To configure the Proctoring service, choose the "Proctoring settings" tab on the "System settings" page.
      2. Enter the "Proctoring server URL." This parameter represents the Web address of the Proctoring server, and is provided by YouTestMe.
      3. Enter the "Secret key." provided by YouTestMe.
      4. Enter the "Session template" name. This parameter represents the name of the proctoring session template created in the Proctoring application. The session template specifies additions (5) and metrics (6) of the Proctoring session. Enter the "default" for the default session template.
        * In the newer versions of the Proctoring service, this is the only way to specify the proctoring session, chosen additions (5), and metrics (6) will not be considered.
      5. Choose the "Session metrics" from the dropdown menu. The session metrics represent the events that the service tracks and penalizes during the proctoring session.
        * This configuration will be considered only for the older versions of the Proctoring service.
      6. Choose the "Session additions" from the dropdown menu. The session additions represent the additional proctoring features that will be included in the proctoring session.
        * This configuration will be considered only for the older versions of the Proctoring service.
      7. Enter the "API address." provided by YouTestMe. Typically,it is a combination of the URL address of the YouTestMe GetCertified application and one of the endpoints (/proctoringResultsNew, /proctoringResults), depending on the version of the Proctoring service.
      8. Click the "Confirm" button if you want to save the Proctoring configuration.
      9. To reset the changes you have made, click the "Cancel" button.

    9. Additional modules

      On the "Additional modules" tab, by enabling next options you can:

      1. Hide users private information.
      2. Configure SFTP Protocol and automatically receive test results on your FTP server.
      3. Show or hide passed and failed labels through the application.
      4. Allow users to register in the application without administrator's approval.

    10. System support

      The "System support" tab serves to enable customized support. You can provide useful information such as support email, support phone number, as well as additional description for users support page.

      1. Describe the purpose of email and phone.
      2. Provide desired support email.
      3. Provide desired support phone number.
      4. Here you can define useful details about support contact. For example, expected email response time to customers' issues or business hours when support is available, etc.
      5. "Confirm" button will apply the changes.
      6. "Cancel" button will delete everything entered before saving.

    11. Single sign-on

      GetCertified can act as a Service Provider through the SAML 2.0 protocol, which allows the exchange of authorization data with an Identity Provider. GetCertified supports OneLogin, Okta, SSO Circle, and many other Identity Providers.

      SAML 2.0 based Single Sign-on (SSO) can be configured for multiple identity providers simultaneously. You need to create a SSO configuration and define the parameters of the identity provider. Each created SSO configuration you create has an assertion consumer service end-point that will process the SAML response.

      1. To access the Single sign-on configuration panel, choose the "Single Sign-on" tab on the "System settings" page.
      2. By clicking the "Add new configuration" button, new pop-up window will appear where you can enter the parameters of the new SSO configuration.
      3. All existing Single sign-on configurations are displayed in the table with their names, descriptions, statuses and available actions.
      4. By clicking the edit icon, a pop-up window will appear, where you can change the parameters of the selected SSO configuration.
      5. SSO configuration can be deleted by clicking the trash can icon.

      When creating a new or updating an existing SSO configuration, you need enter the parameters for configuring the service provider’s side. GetCertified provides the parameters that you need to configure the identity provider’s side..

      1. Enter the "Name" of the SSO configuration. The name must be unique for each SSO configuration since it identifies the SSO configuration.
      2. Optionally enter the "Description" of the SSO configuration.
      3. Choose the "Status" of the SSO configuration. If the status is "Enabled," users will be able to sign in with the identity provider specified in the configuration. Otherwise, they will not be able to do so.
      4. Use the provided "Service provider Entity ID" URL to configure the service provider on the identity provider’s side. The value represents the service provider’s identifier.
      5. Use provided "Assertion consumer service URL" to configure the service provider on the identity provider side. The field's value represents the URL of the end-point, where the SAML response from the identity provider will be returned.
      6. Choose the "Assertion consumer service binding" that is suitable for the identity provider. The field's value represents the SAML protocol binding to be used when returning the SAML response from the identity provider.
      7. Enter the "Identity provider Entity ID," identifier of the provider entity. The entered value must be an URL.
      8. Enter the "Single sign-on service URL," an URL of the identity provider’s single sign-on service end-point, where the service provider will send the authentication request.
      9. Choose the "Single sign-on service binding," a SAML protocol binding to be used when the service provider sends the authentication request to the identity provider.
      10. Input the "Certificate," the public x509 certificate of the identity provider. The certificate must be in a string format without headers. Use the tool on the following link to convert the certificate to a string format without headers.
      11. Enter the "Username attribute," the name of the assertion in the SAML response whose value will be used as the GetCertified user's username.
      12. Enter the "Email attribute," the name of the assertion in the SAML response whose value will be used as the GetCertified user's email.
      13. Optionally enter the "First name attribute," the name of the assertion in the SAML response whose value will be used as the GetCertified user's first name.
      14. Optionally enter the "Last name attribute," the name of the assertion in the SAML response whose value will be used as the GetCertified user's last name.

    12. Proctorio settings

      Please note that the Proctorio can be enabled only upon your request. For more information, contact the YouTestMe team at sales@youtestme.com. Upon the activation, you will be provided with the necessary parameters to configure the integration with Proctorio.

      1. To configure the integration with Proctorio automated proctoring service, choose the "Proctorio settings" tab on the "System settings" page.
      2. Enter the "API endpoint." This parameter represents the URL of the Proctorio API endpoint, and is provided by YouTestMe or Proctorio.
      3. Enter the "Secret key." provided by YouTestMe or Proctorio.
      4. Enter the "Consumer key." provided by YouTestMe or Proctorio.
      5. Choose the "Exam settings" from the dropdown menu. Exam settings enable you to choose the Proctorio features you want to add and control during the proctoring session.
      6. Click the "Confirm" button if you want to save the Proctorio integration settings.
      7. To reset the changes you have made, click the "Cancel" button.

    13. Active Directory

      Please note that the Active Directory can be enabled only upon your request. For more information, contact the YouTestMe team at sales@youtestme.com.

      1. To configure the integration with Active Directory or other directory services that support LDAP protocol, choose the "Active Directory" tab on the "System settings" page.
      2. Enter the "LDAP server" address. This parameter is the LDAP URL address of the directory’s domain controller. It is usually a combination of LDAP protocol, a host of the directory's domain controller, and the LDAP port:
        [ldap|ldaps]://{DOMAIN_CONTROLLER_HOST}:{LDAP_PORT} (for example: ldap://mydomain.org:389)
      3. Enter the "Search Base" parameter, which represents the node under which the users will be searched for. It is usually a distinguished name of a root node or a node of an organizational unit or group.
        For example: OU=Testing Center,DC=mydomain,DC=org
      4. Optionally enter the "Search filter," a parameter that is used for filtering the users for synchronization within the Search Base node to be synchronized in GetCertified. A filter has to be in the format specified here. Usually, it is a filter that will match the users from a directory group or users with specific values of attributes.
        By the default (&(objectClass=user)(samaccountname=*)(sn=*)(givenName=*)(mail=*)(objectGUID=*)) is applied to match only users with non-null parameters required for GetCertified user creation.
        For example: (memberOf=CN=YTM users,OU=Testing Center,DC=server,DC=net) - Only the users that belong to the "YTM users" group will be synchronized and able to sign into GetCertified with the Active Directory credentials. If you change the Search Filter or Search Base. In that case, all users that are synchronized and don't match the new Search Filter and Search Base will will remain in GetCertified, but will not be able to sign in using the Active Directory account credentials anymore.
      5. Enter the "Service account." , a distinguished Name or User Principal Name of the Active Directory account, which is used used for establishing the LDAP connection and synchronizing the users. This account does not have to match the Search Filter.
      6. Enter the "Password" of the service account.
      7. Click the "Confirm" button if you want to save the Active Directory integration settings.
      8. To reset the changes you have made, click the "Cancel" button.


YouTestMe Wiki - Powered by YouTestMe