Configuring and Applying Templates

Download

Configure the template to specify what data needs to be logged and how it is to be processed. To do this, open the Recording Service website and go to the Template tab. Here you can add, change, or remove a template. A Default template is created during the Recording Service installation process. You can add and customize new templates.

Go to the Templates tab on the Recording Service website to see basic information on templates, review the Default template setting or add a custom template. For detailed information on the Default template and available settings, see below. All options available in the Default template you can set in your custom template.

Before you begin

Role required: admin

Note. If your account is not added to the Admin AD Security group specified during the Recording Service installation, you will not have access to the site.

Basic steps

  1. Open the Recording Service website and go to Templates.
  2. Click Default in the Template name column. Review and modify the options if needed.
    Note. The Default template cannot be renamed or deleted.
    1. Start recording when assigned to recorder
      If you need to start to record user actions after you assigned a template to a recorder, turn this toggle switch on.
      By default, the automatic start record is disabled.
    2. Record screenshots
      By default, user activity and screenshots of the applications the user uses are recorded in logs.
      Screenshots will help you better understand the scenarios in which these events occurred when analyzing the recorded events. Disable this option if you do not need to save screenshots.
    3. Record extended application info
      Enable this option if you plan to export processes from Timeline for further import and refinement in Blue Prism applications. This option allows to log additional information required to generate a Blue Prism JSON file.
    4. Obfuscate user data
      This option allows to protect sensitive information and ensure data security. By default, this option is turned on. This means records in text logs are encrypted, and data in screenshots is blurred.  If the option is disabled, you can easily read all the texts and see data in the screenshots. To do this just go to the Logs tab and click LogID.
    5. Scheduled recording
      Turn on this option to schedule recording sessions of user activity for the Recorder instance.
    6. Merge data from multiple hosts
      This option allows to log a user activities in one log, if user works on multiple computers. For example, they works on their PC, and then switches to RDP and works there.
      Note. If different tags were added during the installation to each Recorder instances, all tags will be listed separated by commas for the resulting log. During the logging process, the list of tags may not appear immediately, but with some delay.
      Before using this option, make sure the following conditions are met:
      1. Recorder is installed on every computer a user works on and all recorder instances display on the Recorders tab. In the Host column you can see a computer name visible on the network within the Active Directory domain
      2. Each of the Recorder instance must be set the same template.
    7. Application list
      The use Included and Excluded lists can significantly reduce the amount of unwanted data in the project and make analyzing tasks and processes easier. This becomes very important when dealing with large datasets that include important events which can be made harder to understand and analyze when there are a lot of case and path variants and deviations which are further complicated by unnecessary data.
      The default template contains a predefined excluded list. It includes the most popular messengers. Correspondence in them may not be related to the tasks that a user performs. To exclude the logging in the desired messenger, turn the EXCLUDED LIST on and mark an item.

      For details on setting up Excluded and Included lists, see the 'Excluding and Including Applications' and 'Examples' sections.
    8. Transformations
      Transformations allow finding and replacing text in logs in order to redact sensitive information, such as email addresses or IDs. This option complements the Obfuscate user data feature. For example, transformations allow you to replace an URL or some text in logs that should remain confidential, while obfuscation allows you only to mask text data or blurs information in pictures.
      By default, there are no transforms specified. To add transformations to the template, add them on the Transformations tab in advance. During adding a transformation, you must specify:
      1. Regular expression
        It will be used to search for the text in the recorded logs.
      2. Replacement
        A string to replace the found text.

        Important. Transformations added to a template are applied during the log recording the template is assigned to. It is impossible to undo transformations.

        For detailed instructions on using transformation see 'Transformations'.
  3. Go to Recorders to assign the template to a recorder instance.
    You will see the list of connected recorders.
    1. Check the recorder instance, you want to configure with a template and start recording.
      The Host column displays computer names that are visible on the network in the Active Directory domain. The Tag column displays tags added during the installation of recorder instances.
    2. Click Set Template.
      In the opened list chose the template, and then click Select.
    3. The recording runs automatically when the Start recording when assigned to recorder is enabled in the template. Otherwise, click Start to run the recording.

22.09.2023 8:59:47

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.