Configure RPA Hub properties

reference brazil Updated Sep 10, 2026 14 min read rpahub-sys-properties.md
Raw file servicenow.com

You can access system properties for RPA Hub by navigating to All > Robotic Process Automation > Administration > Properties.

Property

Description

Role required (to edit)

Enable auto assignment of Attended Robot.sn_rpa_fdn.allow_rda_robot_auto_assignment

Auto assigns robot licenses to users from the bot process, on a first come first serve basis.- Type: Yes | No

  • Default value: No

For more information, see Run an automation using Attended Robot.

admin, sn_rpa_fdn.rpa_admin

Sets the instance and robot machine authentication mechanism.sn_rpa_fdn.instance_authentication

Select an authentication type:- mTLS: Mutual Transport Layer Security. As a prerequisite, install the user certificate.

For more information about installing a user certificate, if you have the admin role, see Install the user-generated certificates.

  • Basic: Authentication happens based on user name and password.

admin, sn_rpa_fdn.rpa_admin

Enable auto session restore.sn_rpa_fdn.process.auto_session_restore

Restores auto session.- Type: Yes | No

  • Default value: No

If it is set to Yes, then the Auto Session Restore check box on a new bot process form is selected by default. There is no impact to the existing bot processes, when this system property value is changed.

For more information about the bot process form, see Bot Process form in RPA Hub.

If enabled, when the unattended robots log in or unlock the machine to start the automation, then the machine session is restored to the original state (log off or locked) after the automation is completed.

sn_rpa_fdn.rpa_admin

Enable the code quality check at the instance level.sn_rpa_fdn.enable_code_quality_check

Enables the code quality check at the instance level.- Type: Yes | No

  • Default value: Yes

If it is set to Yes, then the configure the sn_rpa_fdn.restrict_package_by_severity and sn_rpa_fdn.code_quality_check_timeout system properties appropriately.

sn_rpa_fdn.rpa_admin

Sets restriction on publishing package from RPA Desktop Design Studio and publishing bot process in RPA Hub, if the package contains any of the defined selection. This property is effective only when code quality check feature is enabled.sn_rpa_fdn.restrict_package_by_severity

Sets a restriction on publishing package from RPA Desktop Design Studio and publishing bot process in RPA Hub. This property is effective only when code quality check feature is enabled.Select a restriction type:

  • No restriction - Enables packages to publish from RPA Desktop Design Studio regardless of the code quality result. The packages with error or warning can also be published from the RPA Desktop Design Studio. Enables the publishing of bot processes regardless of the code quality result of the associated package version.
  • Error - Restricts packages with Code Quality Result as 'Error' to publish from RPA Desktop Design Studio. Restricts publishing of bot process if it is using the package versions whose code quality check is marked as error.
  • Error or Warning - Restricts packages with Code Quality Result as 'Error' or 'Warning' to publish from RPA Desktop Design Studio. Restricts publishing of bot process if it is using the package versions whose code quality check is marked as 'Error' or 'Warning'.

Default value: No restriction

sn_rpa_fdn.rpa_admin

Maximum duration, in minutes, for the completion of the code quality check. Ensure to enter a positive integer value. This property is effective only when code quality check feature is enabled.sn_rpa_fdn.code_quality_check_timeout

Limit the processing time for code quality check. Enter a maximum duration, in minutes, for the completion of the code quality check. Ensure to enter a positive integer value. This property is effective only when code quality check feature is enabled.- Type: integer

  • Default value: 5

sn_rpa_fdn.rpa_admin

Enable this to ensure the security of the published packages via code signing, where the package is digitally verified.sn_rpa_fdn.code_signing_required

Ensures the security of the packages that are published from the RPA Desktop Design Studio.

  • Type: Yes | No
  • Default value: No

It is validated by the Unattended Robot and Attended Robot.

admin

Mark this as true in order to enable manual upload of automation package.sn_rpa_fdn.allow_manual_upload_of_automation_package

Enables RPA release managers to manually upload the automation package (zip file).- Type: Yes | No

  • Default value: No

This property helps in controlling direct upload of attachments in the existing package version record.

admin

Enable this to ignore certificate expiry while publishing digitally signed package/package version created with RPA Desktop Design Studio.

sn_rpa_fdn.ignore_certificate_expiry_date

Ensures that the package is published to the instance from RPA Desktop Design Studio even after the code signing certificate is expired.

  • Type: Yes | No
  • Default value: No

admin

Enable to reference unattended robot's machine name from CMDB tables.

sn_rpa_fdn.enable_unattended _robot_machine_name_lookup

Enables you to select one of the available machines in the CMDB table.- Type: Yes | No

  • Default value: No

If you enable this property as Yes, then configure the sn_rpa_fdn.machine_name_reference_fields system property appropriately.

Note: If you enable this system property and if there are any existing robot records, to use them, retire the robot and create a new record.

admin

Provide names of CI tables to reference unattended robot's machine name.

sn_rpa_fdn.machine_name_reference_fields

CI table names to reference the machine name of an unattended robot.- Type: Comma separated list

  • Default value: cmdb_ci_hardware

admin

Frequency, in seconds, to sync the execution logs.sn_rpa_fdn.process.sync_execution_logs

Defines the frequency, in seconds, for execution logs to synchronize.- Type: integer

  • Default value: 60

When a new bot process is created, the default value you define in this system property appears in the Synchronize Execution Logs (seconds) field. There is no impact to the existing bot processes, when this system property value is changed.

This system property is only applicable only for those bot processes where the Track Execution Logs check box is enabled. The logs are saved locally and are synced based on the interval set in this property.

For more information about the bot process form, see Bot Process form in RPA Hub.

sn_rpa_fdn.rpa_admin

Maximum limit for frequency, in seconds, to sync the execution logs.sn_rpa_fdn.process.sync_execution_logs_max_value

Defines the maximum limit for frequency, in seconds, for execution logs to synchronize.

  • Type: integer
  • Default value: 300

This system property is only applicable only for those bot processes where the Track Execution Logs check box is enabled and the value for the Storage field is Instance.

For more information about the bot process form, see Bot Process form in RPA Hub.

sn_rpa_fdn.rpa_admin

Enable tracking of execution logs.sn_rpa_fdn.process.track_execution_log

Tracks the execution logs.- Type: Yes | No

  • Default value: No

If it is set to Yes, then the Track Execution Logs check box on a new bot process form is selected by default. There is no impact to the existing bot processes, when this system property value is changed.

After you enable the Track Execution Logs check box on a bot process form, 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.

For more information about execution logs, see Bot Process form in RPA Hub.

sn_rpa_fdn.rpa_admin

Maximum days to retain process job.sn_rpa_fdn.max_purge_days_process_job

Defines the maximum days to retain a process job.- Type: integer

  • Default value: 90

In a bot process record, process jobs are purged based on this system property.

Based on this system property, the maximum value for the Job Purging (days) field in a bot process is defined.

For more information about the bot process form, see Bot Process form in RPA Hub.

sn_rpa_fdn.rpa_admin

Default value for the number of days to retain process job logs.sn_rpa_fdn.process.job_purge_days

Defines the number of days to retain job logs.- Type: integer

  • Default value: 30

In a bot process record, process jobs are purged based on this system property.

When a new bot process is created, the default value you define in this system property appears in the Job Purging (days) field.

For more information about the bot process form, see Bot Process form in RPA Hub.

ServiceNow employee

Enable attended automation to run in desktop-in-desktop.sn_rpa_fdn.process.rda_run_in_desktop_in_desktop

Ensures the attended automations to run in a Desktop In Desktop window.- Type: Yes | No

  • Default value: No

If it is set to Yes, then the Enable Desktop In Desktop check box on a new bot process form is selected by default.

If it is set to No, then the Enable Desktop In Desktop check box on a new bot process form is not selected by default.

For more information about the bot process form, see Bot Process form in RPA Hub.

sn_rpa_fdn.rpa_admin

Enable the robot to force start.sn_rpa_fdn.process.force_start

Forces the robot to start. - Type: Yes | No

  • Default value: No

If it is set to Yes, then the Force Start check box on a new bot process form is selected by default.

For more information about the bot process form, see Bot Process form in RPA Hub.

For example, a robot R1 is assigned to multiple bot processes BP1 and BP2, and R1 is currently executing BP1. Then, if BP2, whose sn_rpa_fdn.process.force_start system property is set to Yes, is triggered forcefully and BP1 is terminated.

sn_rpa_fdn.rpa_admin

Keep bot monitor active.sn_rpa_fdn.process.keep_monitor_active

Ensures that the bot monitor is active. - Type: Yes | No

  • Default value: Yes

This system property is set at the instance level. This property is not set at the automation level.

If it is set to Yes, then the Keep Monitor Active check box on a new bot process form is selected by default. Also the system is unlocked even after locking it.

If it is set to No, then the robot machine is locked (based on idle time settings as per the organization), when the automation doesn't have any foreground actions such as SendKeys or Mouse click.

For more information about the bot process form, see Bot Process form in RPA Hub.

sn_rpa_fdn.rpa_admin

List of screen resolutions in desktop-in-desktop.sn_rpa_fdn.process.rda_screen_resolution

Lists the screen resolutions in a Desktop In Desktop window.- Type: string

  • Default value: 1920x1080

sn_rpa_fdn.rpa_admin

Expected duration for the bot process to run.sn_rpa_fdn.process.runtime_threshold

Defines the expected duration for the bot process to run.- Type: integer

  • Default value: 60

If a value is defined here, then the same value appears in the Run Time Threshold (mins) field on a new bot process form.

For more information about the bot process form, see Bot Process form in RPA Hub.

The value in the Runtime Threshold (Mins) field on the bot process form and the configuration in this system property are used for plotting the event duration in the robot calendar.

For more information about the robot calendar, see Using the robot calendar for RPA Hub.

sn_rpa_fdn.rpa_admin

Enable work item name to be unique.sn_rpa_fdn.queue.is_queue_item_name_unique

Ensures that the work item name is unique.- Type: Yes | No

  • Default value: Yes

If it is set to Yes, then the Is Work Item Name Unique check box on a new queue form is selected by default. There is no impact to the existing queue records.

For more information about the queue form, see Queue form in RPA Hub.

sn_rpa_fdn.rpa_admin

Maximum value of max attempts field on work queues.sn_rpa_fdn.queue.maximum_attempts_max_value

Defines the maximum value of the Maximum Attempts field in the Queue form.- Type: integer

  • Default value: 99
  • Maximum value: 99

admin, sn_rpa_fdn.rpa_release_manager, or sn_rpa_fdn.rpa_admin

Sets the default number of days to retain work items.sn_rpa_fdn.queue.purge_days

Defines the default value of the Purge After (days) fields in the Queue form.- Type: integer

  • Default value: 30

ServiceNow employee

Maximum number of days to retain work items.sn_rpa_fdn.max_purge_days_work_queue_item

Defines the maximum value of the Purge After (days) fields in the Queue form.- Type: integer

  • Default value: 90

sn_rpa_fdn.rpa_admin

Maximum duration after the last heart beat for robot to turn unresponsive. The value must be between 5 and 30 minutes.sn_rpa_fdn.robot.unresponsive

Defines the maximum duration after the last heartbeat for the robot to turn unresponsive. The value must be between 5 and 30 minutes.- Type: integer

  • Default value: 5

If a robot is unresponsive, then the scheduled automations will not execute on that machine.

sn_rpa_fdn.rpa_admin

Sets the default value of the order field in the bot process. 1 being the highest and 999999 the lowest.sn_rpa_fdn.process.order

Defines the default value of the Order field in the bot process.1 is the highest and 999999 is the lowest default value.

  • Type: integer
  • Default value: 1

sn_rpa_fdn.rpa_admin

Maximum days to retain alert triggers. The value must be between 1 and 30.sn_rpa_fdn.alert.trigger_purge_days

Defines the maximum days to retain alert triggers. The value must be from 1 through 30.- Type: integer

  • Default value: 10

ServiceNow employee

Maximum days to retain alert notifications. The value must be between 1 and 60.sn_rpa_fdn.alert.purge_days

Defines the maximum days to retain alert notifications. The value must be from 1 through 60.- Type: integer

  • Default value: 30

ServiceNow employee

Maximum number of days to retain client logs. The value must be between 1 and 90.sn_rpa_fdn.purge_client_logs

Defines the limit for maximum days to retain client logs (product and execution logs). Based on this values, clients delete the files in robot machine. The value must be from 1 through 90.- Type: integer

  • Default value: 7

After 7 days, in this scenario, the logs are automatically purged from your local folder.

admin, sn_rpa_fdn.rpa_admin

Set to fetch the robots in the Assign bot process section of the RPA Desktop Design Studio, whose machine name matches the one on which the Studio is running.sn_rpa_fdn.restrict_robots_in_assign_bot_process_by_machine_name

Restrict robots in Assign bot process section by machine name.- Type: Yes | No

  • Default value: No

If this value is set to Yes, then you can impersonate as robot from the RPA Desktop Design Studio on that specific robot machine, along with the users added in the Assigned Studio Users tab in the Robot form, if any.

If this value is set to No, then the users added in the Assigned Studio Users tab in the Robot form can impersonate as robot from the RPA Desktop Design Studio. For more information about adding the assigned studio users, see Add assigned studio users to an unattended robot.

For more information about assign bot process to an automation project, see Assign bot process to an automation project.

sn_rpa_fdn.rpa_admin

Set the default value of the Screen Resolution field on the Robot form for high density robots.sn_rpa_fdn.robot_screen_resolution

Defines the default value of the Screen Resolution field on the Robot form for high density robots.- Type: string

  • Default value: 1920x1080

sn_rpa_fdn.rpa_admin

Bypass Legal Noticesn_rpa_fdn.bypass_legal_notice

Enables the unattended robot to clear the legal notice message set by the system-level policy. This ensures that a legal notice is not displayed during the robot's login process.- Type: Yes | No

  • Default value: No

sn_rpa_fdn.rpa_release_manager, or sn_rpa_fdn.rpa_admin
Search documentation
Search document titles and file paths on the brazil branch