{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":22132,"path":"integrate-applications/select-botprocess.md","title":"Associate a bot process to a bot process configuration record","bundle":null,"doc_type":null,"release":"australia","body":"\n# Associate a bot process to a bot process configuration record\n\nSelect a bot process configuration record to associate it with a bot process. This action creates a bot process record in RPA Hub.\n\n## Before you begin\n\nCreate a package. For more information, see [Create a package to assign to a bot process](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/create-package.md).\n\nCreate a robot. For more information, see [Robots in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/robots-rpa-hub.md).\n\nConfigure the related system property to view the activity stream. For more information, see [Display an activity stream for bot processes and robots in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/display-activity-stream-sys-property-rpahub.md).\n\nBefore you can access a bot process, ensure that the RPA business user \\(sn\\_rpa\\_fdn.rpa\\_business\\_user\\), RPA developer \\(sn\\_rpa\\_fdn.rpa\\_developer\\), or the RPA support user \\(sn\\_rpa\\_fdn.rpa\\_support\\_user\\) are in the Managed by Group list.\n\nRole required: sn\\_rpa\\_fdn.rpa\\_release\\_manager or sn\\_rpa\\_fdn.rpa\\_admin\n\n## About this task\n\nA bot process is a predefined sequence of actions that a robot follows to accomplish a specific task or achieve a particular goal.\n\nA bot process configuration record contains the bot process settings. The bot process configuration record is mapped to a bot process record. It is a one to one mapping. You can only select one bot process record to associate with a bot process configuration record. You can't edit a bot process configuration record that is associated with a bot process.\n\nWhen you retire a bot process record, you can't associate the related bot process configuration record to other bot processes.\n\nYou can create a bot process configuration record in two ways. The first way is when you create and save a bot process configuration record.\n\nThe second way is when you move an update set from a lower environment to a higher environment, an orphan bot process configuration record is created. After you select the **Assign Configuration** button and its record, the bot process record that is associated to the bot process configuration is created.\n\nFor more information about migrating your metadata from a lower environment to a higher environment, see [Migrating your data from a lower environment to a higher environment in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/migrate-data-rpa-hub.md).\n\n## Procedure\n\n1.  You can associate a bot process to a bot process configuration record by choosing one of these options.\n\n<table id=\"choicetable_nkf_c3k_xvb\"><thead><tr><th align=\"left\" id=\"d625847e162\">\n\nOption\n\n</th><th align=\"left\" id=\"d625847e165\">\n\nAction\n\n</th></tr></thead><tbody><tr><td id=\"d625847e171\">\n\n**Perform this task in workspace**\n\n</td><td>\n\n1.  Navigate to **All** &gt; **Robotic Process Automation** &gt; **RPA Hub Workspace**.\n2.  Select the list icon \\(\\[Omitted image \"rpahublist-icon.png\"\\] Alt text: List icon.\\).\n3.  On the **Lists** tab, under **Build**, select **Bot Process**.\n4.  In the form header, select the down arrow in the **Create Configuration** button.\n\n\\[Omitted image \"down-arrow-create-config-rpa.png\"\\] Alt text: Down arrow in the Create Configuration button.\n\n5.  Select **Assign Configuration**.\n6.  Select a bot process configuration record to associate it with a bot process.\n7.  Select **Submit**.\n8.  On the form, fill in the fields.\n\nFor a description of the field values, see [Bot Process form in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/select-botprocess.md).\n\n9.  Select **Save**.\n10. On the **Details** tab, in **Activity** and **Compose** fields, view the activity of the form, work notes, and additional comments.\n\n\n</td></tr><tr><td id=\"d625847e282\">\n\n**Perform this task in the classic environment**\n\n</td><td>\n\n1.  Switch to the classic environment.\n2.  Navigate to **All** &gt; **Robotic Process Automation** &gt; **Build** &gt; **Bot Process**.\n3.  In the form header, select **New**.\n4.  Select a bot process configuration record to associate it with a bot process.\n5.  Select **Submit**.\n6.  On the form, fill in the fields.\n\nFor a description of the field values, see [Bot Process form in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/select-botprocess.md).\n\n7.  Select **Save**.\n\n\n</td></tr></tbody>\n</table>\n## What to do next\n\nYou can add other details that pertain to the bot process, such as the business applications, credential groups, robots, process robot credential sets, schedules, process parameters, attended users, or groups. For more information, see [Adding details to your bot process in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/post-req-bot-process-rpa.md).\n\n**Parent Topic:**[Configuring a bot process record in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/create-botprocess.md)\n\n**Related topics**  \n\n\n[Create a bot process configuration record in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/create-botprocess-config.md)\n\n[Bot process configuration form in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/create-botprocess-config.md)\n\n[Edit a bot process in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/edit-botprocess.md)\n\n[Publish a bot process in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/publish-bot-process.md)\n\n[Retire a bot process in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/retire-bot-process.md)\n\n[View Audit History](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/c_HistorySets.md)\n\n## Bot Process form in RPA Hub\n\nUse the Bot Process form to associate it to the bot process configuration and populate the remaining fields required for a bot process.\n\n<table id=\"table_pyx_mhd_4qb\"><thead><tr><th>\n\nField\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td class=\"sub-head\" colspan=\"2\">\n\nBot Process\n\n</td></tr><tr><td>\n\nName\n\n</td><td>\n\nUnique name of the bot process.\n\n</td></tr><tr><td>\n\nProcess Type\n\n</td><td>\n\nType of the bot process:-   **Unattended**: Automations that don’t require any human intervention.\n-   **Attended**: Automations that require human intervention.\n\n</td></tr><tr><td>\n\nBot Process Configuration\n\n</td><td>\n\n\\[Auto-generated\\] Associated bot process configuration of the bot process.\n\n</td></tr><tr><td>\n\nOrder\n\n</td><td>\n\nPriority order of execution for the bot process. -   **1**: Highest priority\n-   **999999**: Least priority\n\nIf more than one unattended bot process is scheduled to start at the same time, the one with the highest priority runs, and the others are marked as **Skipped**.\n\nIf multiple bot processes have the same priority and schedule, one bot process is chosen at random to run.For more information, see [Execution priority of bot processes in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/bot-process-prioritization-order-rpa-hub.md).\n\nThe default value is set to `1`.\n\nRPA business user can view this field.\n\nThis field appears only when **Unattended** is selected from the **Process Type** field.\n\n</td></tr><tr><td>\n\nPackage\n\n</td><td>\n\nAssociated package of the bot process.For an unattended bot process, associate an unattended type package.\n\nFor an attended bot process, associate an attended type package.\n\nOnly published packages can be associated.\n\n</td></tr><tr><td>\n\nPackage Version\n\n</td><td>\n\nVersion of the active package in use. Only published package versions can be associated.\n\n</td></tr><tr><td>\n\nLife Cycle Stage Status\n\n</td><td>\n\n\\[Auto-generated\\] Life cycle stage status of bot process configuration.\n\n</td></tr><tr><td>\n\nRun Time Threshold \\(mins\\)\n\n</td><td>\n\nExpected duration for the bot process to run.The default value is 60 minutes.\n\nThis field appears only when **Unattended** is selected from the **Process Type** field.\n\nRPA business user can view this field.\n\nThis field is required.\n\n</td></tr><tr><td>\n\nJob Purging \\(days\\)\n\n</td><td>\n\nNumber of days after which the job data is deleted.\n\n</td></tr><tr><td>\n\nManaged by\n\n</td><td>\n\nIT owner of the business process.This field appears only for an existing record.\n\nRoles required to edit this field: RPA release manager and RPA admin.\n\n</td></tr><tr><td>\n\nOwned by\n\n</td><td>\n\nBusiness user who is part of the managed by a group and is responsible for the business process.This field appears only for an existing record.\n\nThis field depends on what you entered in the **Managed By Group** field.\n\nIf an entry in the **Managed By Group** field is populated, then only those users who are a part of the **Managed By Group** field and have an RPA business user role can be added to the **Owned By** field.\n\nIf the **Managed by Group** field is empty, then the **Owned By** field is read-only.\n\nRoles required to edit this field: RPA release manager and RPA admin.\n\n</td></tr><tr><td>\n\nEnable Embedded Task Automation\n\n</td><td>\n\nOption to trigger the attended bot process \\(automation\\) from the associated ServiceNow form that is mapped in the attended configuration record. For more information about the attended configuration record, see [Attended Configuration form in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/attended-config-form-rpa.md).On enabling the **Embedded Task Automation** check box, two additional tabs, **Process Field Parameters** and **Attended Configuration**, are displayed on the bot process form.\n\nFor more information about Embedded Task Automation, see [Embedded Task Automation \\(ETA\\) in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/embedded-task-auto-rpa.md).\n\n</td></tr><tr><td>\n\nDescription\n\n</td><td>\n\nDescription of the bot process.\n\n</td></tr><tr><td class=\"sub-head\" colspan=\"2\">\n\nSession Settings\n\n</td></tr><tr><td>\n\nKeep Monitor Active\n\n</td><td>\n\nOption to keep the monitor active of the machine where the robot is running the bot process.This field appears only when **Unattended** is selected from the **Process Type** field.\n\n</td></tr><tr><td>\n\nAuto Session Restore\n\n</td><td>\n\nOption to restore the state of the robot to the initial stage before the automation is executed.This field appears only when **Unattended** is selected from the **Process Type** field.\n\n</td></tr><tr><td>\n\nForce Start\n\n</td><td>\n\nOption to force start a bot process on a robot to override any other bot process already running on it.\n\n If the **Force Start** option is enabled for a bot process P1 and if bot process P2 is running on the same robot, P2 stops and P1 executes. Then, the process job of P2 moves to **Canceled** state.\n\n The **Force Start** option does not override the **Order** field. The **Force Start** option is applicable for the existing running bot processes and is not applicable for the bot processes that are yet to be launched.\n\n This field appears only when **Unattended** is selected from the **Process Type** field.\n\n</td></tr><tr><td>\n\nEnable Desktop In Desktop\n\n</td><td>\n\nOption to enable attended automation to run in Desktop In Desktop window. This option creates a new session on the same machine and the automation can be executed on this session without interrupting actual manual work on the main session.On enabling this option, the **End Desktop In Desktop on Complete** check box is also selected.\n\nThis field appears only when **Attended** is selected from the **Process Type** field.\n\n</td></tr><tr><td>\n\nEnd Desktop In Desktop on Complete\n\n</td><td>\n\nOption to close the Desktop In Desktop window after the bot process execution is completed.\n\n This option is automatically selected when you select **Enable Desktop In Desktop**. To leave the Desktop In Desktop window open after the bot process completes, clear the check box.\n\n This field appears only when **Attended** is selected from the **Process Type** field.\n\n</td></tr><tr><td>\n\nScreen Resolution\n\n</td><td>\n\nScreen resolution for the Desktop In Desktop window.This field appears only when **Attended** is selected from the **Process Type** field.\n\n</td></tr><tr><td class=\"sub-head\" colspan=\"2\">\n\nLog Settings\n\n</td></tr><tr><td>\n\nTrack Execution Logs\n\n</td><td>\n\nOption to enable the tracking of process execution logs.After you enable this check box, the logs are captured when an automation is executed by either an attended or an unattended robot. These logs help in understanding the errors and the end-to-end logging of automation execution.\n\nIf process jobs are purged, then the corresponding execution logs are purged.\n\nBy using the Attach feature in RPA Desktop Design Studio, these execution logs can be used to replay the automation to understand where the automation has failed. For example, at which component the automation has failed or details of the inputs passed to that component.\n\n**Note:** The **Attach** feature doesn't support Flat file output type.\n\n</td></tr><tr><td>\n\nSynchronize Execution Logs \\(seconds\\)\n\n</td><td>\n\nFrequency, in seconds, for execution logs to synchronize.This field appears only when the **Track Execution Logs** option is selected.\n\nIf you select **Robot Machine** in the **Storage** field, then this field is hidden.\n\n</td></tr><tr><td>\n\nStorage\n\n</td><td>\n\n**Note:** This field appears only when the **Track Execution Logs** option is selected.\n\n Storage location options for the execution logs:\n\n-   **Instance**: Only error information is logged in the execution log, on the instance.\n\nIf you select **Instance**, then the value for the **Log Level** field is set to Error and it can't be edited.\n\n-   **Robot Machine**: The log files are stored in the robot machine where the automation is executed.\n\nIf you select **Robot Machine**, then you can view two options to select from the **Log Level** field - **Error** or **Verbose**.\n\nTo view the end-to-end execution logs of all the components, select **Robot Machine** from the **Storage** field and then select **Verbose** from the **Log Level** field.\n\nFor optimum utilization of disk space in the robot machine, the existing logs are purged, based on the **sn\\_rpa\\_fdn.purge\\_client\\_logs** system property setting.\n\n\n If you select **Robot Machine**, then\n\n-   **Synchronize Execution Logs** field is hidden.\n-   The execution logs are stored in the machine on which the attended or unattended robot is installed.\n\n</td></tr><tr><td>\n\nOutput Type\n\n</td><td>\n\nOutput type of the execution log file. This log file is generated during the robot execution on the machine. There are two types of output:-   **DB File**: Default value. It's a lite database file that stores the process job metadata and the process automation execution details. After the process job completion, you can attach the DB file using the **Attach** option in the RPA Desktop Design Studio project to replay the automation on the design surface.\n-   **Flat File**: It's a file format that stores the process job metadata and the process automation execution details in plain text. It stores the execution data in a JSON format.\n\nThis **Output Type** field appears when the **Track Execution Logs** option is selected and when the **Robot Machine** is selected from the **Storage** field.\n\nIf a bot process, with Flat File as the Output Type, is triggered, then the execution log file is added to the process job folder in .txt format in the given locations. Similarly, for DB output type you will view .db format in the given locations.\n\nThe location of both the flat files and the DB files is in the machine on which the attended or unattended robot is installed.\n\n-   During execution: `Users\\<Userprofile>\\ServiceNow RPA Logs\\.executionlogs\\{InstanceName}\\{ProcessJob number}`.\n\nFor example, `Users\\john.smith\\ServiceNow RPA Logs\\.executionlogs\\{InstanceName}\\PJB0001165`.\n\n-   After execution is complete: `Users\\<Userprofile>\\ServiceNow RPA Logs\\.executionlogs\\{InstanceName}\\.archive\\{ProcessJob number}`.\n\nFor example: `Users\\john.smith\\ServiceNow RPA Logs\\.executionlogs\\{InstanceName}\\.archive\\PJB0001165`.\n\n\nThe content in the flat files is in JSON format. The following image gives the content structure.\n\nWhen you choose the **Flat File** option to store the execution logs, two flat files are generated and stored in the locations given.\n\n-   `ExecutionJobMetadata.txt`: Contains information on the process job such as the Process ID, Robot ID, and the log level. The image shows the structure of the content in the file.\n\n\\[Omitted image \"execution-metadata.png\"\\] Alt text: Execution metadata.\n\n-   File name in the format `ddMMMyyyy HHmmss.txt` \\(For example, `28Dec2023 125036.txt`\\): Contains the execution log entries. For example, the file gives the name of the Activity, component execution start and end time, duration, and the result in boolean, if applicable.\n\nThe flat files follow the rules on data purging set in the **sn\\_rpa\\_fdn.purge\\_client\\_logs** system property. For more information about the system property, see [Configure RPA Hub properties](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/rpahub-sys-properties.md).\n\n**Important:** In RPA Desktop Design Studio, if you mark one or more input or output ports of one or more components or methods in an automation as **Mark Data as Sensitive**, the flat file does not log the execution data of its corresponding process job. Instead, in the JSON file the data corresponding to the port appears as **SENSITIVE**. The following image gives an example.\n\n\\[Omitted image \"flat-file-sensitive.png\"\\] Alt text: Port indicated as sensitive.\n\nFor more information about marking an input or output port as **Mark Data as Sensitive**, see [Configure port properties](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/configure-input-port-properties.md)\n\nSince the actual data for the execution logs contain abundant data, the required data is only preserved. The content in text file is JSON type.​\n\nTo modify the value of this field for an existing bot process, ensure that the associated bot process is **In Maintenance** state.\n\n</td></tr><tr><td>\n\nLog Level\n\n</td><td>\n\nSelect a log level to capture:-   **Error**-\n\nOnly error information is stored during automation execution.\n\n-   **Verbose**-\n\nError information and end-to-end component execution logs, such as inputs and outputs and execution steps with timestamps are stored during automation execution. When you select **Verbose**, the flat files record details of the execution of all components in the automation. If the size of the flat file exceeds 10 MB while the process job executes, the flat file continues to split into multiple flat files with the log sequence appended in the file-naming convention until it executes the complete automation. The naming conventions of such files are `<timestamp>_<LogSequence>`.\n\nThis option appears only when Robot machine is selected as storage type.\n\n\nThis field appears only when the **Track Execution Logs** option is selected.\n\n</td></tr><tr><td>\n\nTrack Automation Logs\n\n</td><td>\n\nTrack automation logs that are generated by the robot. The robot logs the automation execution in automation logs. The logs help the RPA users to track the automation progress.For more information about viewing the automation logs, see [View automation logs in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/view-automation-logs-rpa.md).\n\nTo view automation logs of a bot process, in RPA Desktop Design Studio, use the Log component in the associated automation and populate the required details.\n\nFor more information about the Log component, see [Use the Log component](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/use-general-log.md).\n\n</td></tr><tr><td class=\"sub-head\" colspan=\"2\">\n\nAccess\n\n</td></tr><tr><td>\n\nManaged by Group\n\n</td><td>\n\nGroup that can access the bot process.\n\n</td></tr><tr><td class=\"sub-head\" colspan=\"2\">\n\nRobot PoolRoles required to edit this field: RPA release manager and RPA admin.\n\nIf an RPA developer and RPA support user are a part of the Managed by Group, then they can view and edit these fields.\n\nRPA business user can view these fields.\n\n</td></tr><tr><td>\n\nEnable Robot Pool\n\n</td><td>\n\nOption to enable the robot pool for the bot process.On enabling this option, the **Assign Robots** tab on the bot process is hidden.\n\nFor more information about robot pool, see [Robot pool in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/robot-pool-rpa.md).\n\n</td></tr><tr><td>\n\nRobot Pool\n\n</td><td>\n\nRobots that you can allocate dynamically from a selected robot pool.Select a robot pool from a list of existing robot pool names.\n\nThis field appears only when the **Enable Robot Pool** option is selected.\n\n</td></tr><tr><td>\n\nAllocation Type\n\n</td><td>\n\nRobots that you can allocate based on the Service Level Agreement \\(SLA\\) of the work items or the percentage of efficiency gain. Select the allocation type:\n\n-   **SLA Based**: Allocation of robots from the pool based on the SLA of the work item. The work items are sorted and prioritized based on the SLA.\n\nIf you select the allocation type as SLA Based, ensure that the work items must contain a Service Level Agreement \\(SLA\\).\n\n-   **Percentage Reduction**: Allocation of robots from the pool based on the efficiency percentage.\n\nThe default value is SLA Based.\n\nThis field appears only when **Enable Robot Pool** option is selected.\n\n</td></tr><tr><td>\n\nPercentage Reduction\n\n</td><td>\n\nThis field appears only when **Percentage Reduction** is selected from the **Allocation Type** field.Reduce the total execution time of a bot process by allocating more robots by a selected percentage.\n\nFor example, if there are 100 work items assigned to a bot process. It might take 100 minutes to execute the bot process. If you want to reduce that time to 75 minutes, you define a value 25 in this field.\n\nAfter you provide a value in this field, multiple robots are allocated to distribute the work load. Thus, the automation performs faster by that percentage.\n\nThe default value is 25.\n\nRobots are allocated to distribute the workload, based on the percentage you select:\n\n-   If you select a value from 5 to 50, 2 robots are allocated.\n-   If you select 55, 60, or 65, 3 robots are allocated.\n-   If you select 70 or 75, 4 robots are allocated.\n-   If you select 80, 6 robots are allocated.\n-   If you select 85, 7 robots are allocated.\n\n</td></tr><tr><td class=\"sub-head\" colspan=\"2\">\n\nCompose\n\n</td></tr><tr><td>\n\nWork notes \\(Private\\)\n\n</td><td>\n\nWork notes for the bot process.View the changes executed on the associated package, package version, process parameter, shared parameter, queue, and schedule.\n\n</td></tr><tr><td>\n\nAdditional Comments\n\n</td><td>\n\nAdditional comments that are related to the bot process.\n\n</td></tr></tbody>\n</table>**Related topics**  \n\n\n[Create a bot process configuration record in RPA Hub]()\n\n[Configuring a bot process record in RPA Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/create-botprocess.md)\n\n"}}