System properties

Name	Value	Type	Description
x_1e_connect.1E_device_filter	{"Operator": "or","Operands":[{"Attribute":"DeviceType","Operator":"LIKE","Value":"Desktop"},{"Attribute":"DeviceType","Operator":"LIKE","Value":"Laptop"},{"Attribute":"DeviceType","Operator":"LIKE","Value":"Server"}]}	string	This property is to be used when fqdn is not available in your instance and when the property 'x_1e_connect.new_custom_connector_support' is set to true. It specifies the filter that will be used to retrieve devices from 1E. This property is not in use from ITSM version 5.2.16.
x_1e_connect.access_token_expiry_time	100	integer	Access token expiry time (in seconds).
x_1e_connect.api_timer_multiplier	5	string	This property is used for response polling. The value specified in this property is multiplied with the response counter to calculate the time for the next poll.
x_1e_connect.approval_password		password	1E Platform Approver User Password.
x_1e_connect.approval_username		string	1E Platform Approver User Name.
x_1e_connect.attachment_prefix	1E_Instruction_Results_	string	File name prefix for attached response.
x_1e_connect.authentication_password		password	Password of account to authorize 1E API calls (If Basic Authentication is in use).
x_1e_connect.authentication_username		string	User name of account to authorize 1E API calls (If Basic Authentication is in use).
x_1e_connect.DeviceInfoSyncTime	sys_updated_on>=javascript:gs.minutesAgo(5)	string	Contains encoded query that will be used to filter device info data from 'x_1e_connect_device_info' table. If query returns a record then it will not fetch data from 1E and the saved data will be shown on UI. Default value is 5 minutes.
x_1e_connect.devices_api	/Consumer/Devices	string	API to get devices from 1E Platform
x_1e_connect.device_field_for_identification	name	string	This property is to be used when fqdn is not available in your instance and when the property 'x_1e_connect.new_custom_connector_support' is set to true. Select one of the unique field from the choices and the default value is name.
x_1e_connect.device_fqdn_field	cmdb_ci.fqdn	string
x_1e_connect.device_info	/consumer/Devices/FQDN/	string	API to gather device attributes.
x_1e_connect.device_info_ci_criteria	sys_class_name=cmdb_ci_pc_hardware^ORsys_class_name=cmdb_ci_computer	string	Criteria for CI filter.
x_1e_connect.device_lookup_without_save_incident_form	false	true \| false	Allow device look-up without needing to save the incident
x_1e_connect.device_view_button_visibility	false	true \| false	Added 1E DeviceView tab inside show_details UI macro
x_1e_connect.does_cmdb_ci_table_contains_fqdn	true	true \| false	This property should be set to true if the fqdn is present in cmdb ci computer table. By default, this system property's value is true. If this property is set to false, then change the following system properties- Set "x_1e_connect.new_custom_connector_support" property to true Set "x_1e_connect.device_field_for_identification" property to either name or serial_number or mac_address Set "x_1e_connect.device_fqdn_field" property to either cmdb.name or cmdb.serial_number or cmdb.mac_address based on value of "x_1e_connect.device_field_for_identification" property
x_1e_connect.download_teamviewer_client_from	Web	choice list	This property determines the source from which the TeamViewer client will be downloaded if it is not already installed on the device. The options are: Web: The client will be downloaded from the TeamViewer Website. 1E Platform: The client will be downloaded from the 1E Platform.
x_1e_connect.enable_approval	false	true \| false	Enable approval. (ServiceNow will not ask for any approval if the checkbox is unchecked.)
x_1e_connect.enable_checkEntitlement	true	true \| false	This property enables Check Entitlement button on App Configuration and Multi-Tenant Configuration page. By default this property is true.
x_1e_connect.enable_itsm_category_subcategory	{ "hardware": ["monitor", "cpu"], "software": ["email"] }	string	This system property enables all 1E ITSM Connect features exclusively for the specified categories and subcategories. This property is case-sensitive, which means the values must match exactly as choice values. Any categories or subcategories not explicitly listed will remain disabled. By default, this system property's value is set to false. Expected format- Copy `{ "<category1>": ["<subcategory1>", "<subcategory2>"], "<category2>": ["<subcategory1>"] }`
x_1e_connect.execute_instruction_for_CI_field_only	false	true \| false	In Service Operations Workspace, if you want to execute an instruction to display experience score and run quick fixes for the CI present in that field, set this property to true. Otherwise, if you want to utilize the default functionality, set this property to false.
x_1e_connect.experienceScore_old	/Experience/MetricsHistory/Cube	string	API to gather experience score
x_1e_connect.experience_score	/Experience/DeviceMetrics/Search/	string	API to gather experience score for 1E Platform version 23.5 or higher
x_1e_connect.first_range	0;0	string	First range while fetching tabular data from 1E Platform(0;0)
x_1e_connect.fulfiller_role	ITIL	string
x_1e_connect.gsw_content_information_multitenant	380c98991bd0c11061115395604bcbfb	string	Guided setup pages for multi-tenant
x_1e_connect.gsw_content_information_singletenant	a0c1b1811b98811061115395604bcb5b,7559f1491b98811061115395604bcbdf	string	Guided setup pages for single-tenant
x_1e_connect.gsw_content_modern_auth	1f2ca2b51bd61d5061115395604bcbd9	string
x_1e_connect.instructionTTL	60	string	1E Platform will gather data for these many minutes for an instruction. Value must be between 10 and 10080.
x_1e_connect.instruction_for_teamviewer_client_check	1E-Exchange-TeamViewer-CheckClient	string	This property checks whether TeamViewer client is installed on the device.
x_1e_connect.instruction_sets	1E A,1E ConfigMgrConsoleExtensions,1E Event,1E Exchange Adidas ChangeCompanyNameandLogo (1),1E Exchange DeleteFileByName,1E Experience,1E Explorer TachyonAgent,1E Explorer TachyonCore,1E for Device Refresh (v23.11),1E Inventory,1E Nomad,1E PatchInsights,1E Related,1E ServiceNow,1E Solutions,1E Tachyon Platform,Bitlocker,Browser Management,DomainAccountManagement,End user interaction,End-user Experience,End-User Self-Service,IT Management,MECM Instructions ,Microsoft Onedrive,Microsoft Teams,Network Drive,Nomad Client Health,Performance,serco,Smart Device Refresh,Software Inventory,Solutions_Intune,User Account Management,User Login Tracking,VDX Health,Windows 11 Migration,Windows AppLocker,Windows Client Health,Windows Operations,ZZTest	string	Stores 1E Instruction sets
x_1e_connect.jwt_provider	0e1643ad1b9d52102611eb12604bcb48	choice list	Sys ID of JWT provider (iDP)
x_1e_connect.key_id	4e1575eb-51c5-411a-b359-e8e2712d8566	string	App ID
x_1e_connect.logging.destination	db	choice list
x_1e_connect.logging.verbosity		choice list
_1e_connect.max_status_br_poll_minutes	5	integer	The 'ITSM Status Poll' BR will run for maximum these many minutes. This is to avoid any infinite polling. If value is set to 0, then it will interrupt the polling.
x_1e_connect.metadata	/Experience/metrics	string	API to gather meta-data for 1E platform version 23.5 or higher.
x_1e_connect.metadata_old	/Experience/metrics/metadata	string	API to gather meta-data
x_1e_connect.newExperienceAPISupport	true	true \| false	This system property is related to Experience score. Set this value to true for 1E Platform version 23.5 or higher. By default this value is true.
x_1e_connect.new_custom_connector_support	false	true \| false	This property enables the support for new custom connector, when cmdb does not contain FQDN. The default value of this property is false, which means the functionality is disabled by default.
x_1e_connect.nlumodel	781e889d1b216850430355352a4bcb3a	string
x_1e_connect.oauth_access_token		password2
x_1e_connect.policy_response_history_api	/consumer/policy/responses/history/	string	This API fetches history of a policy response. Used in Device View.
x_1e_connect.policy_rule_compliance_api	/consumer/policy/view/policyrulestatus/tachyonguid/	string	This API fetches policies rule compliance for a device from 1E Platform. Used in Device View.
x_1e_connect.responseTTL	120	string	1E Instructions keep answers minutes. Response will persist for these many minutes in 1E Platform. Value must be between 10 and 10080.
x_1e_connect.response_batch	100	string	Response batch size. Number of records to be fetched from 1E Platform in one iteration.
x_1e_connect.response_page_size	10	choice list	Page size. Default page size of 1E Instruction response table.
x_1e_connect.retain_instruction_response	5	integer	Instruction response keep days. Instruction responses will persist for these many days.
x_1e_connect.retain_roles	false	true \| false	Used to retain roles in instruction set while retrieving the instruction.
x_1e_connect.retain_triggered_instruction	3	integer	Instruction history keep months. 1E instruction history will persist for these many months.
x_1e_connect.retryMessage	Please wait, the instruction is still running. After the device provides results, they will time out in {timeout} minutes. {clickHere} to see if the instruction has finished and returned results.	string	This message is displayed when the instruction is taking longer to process and needs to be re-executed again after a while. This message is configurable and can be set to required value. The {timeout} value comes from the instruction TTL, present in instruction definition table which comes from Platform. Keep the format of the {timeout} and {click Here} as it is. This format fetches the dynamic values in the UI.
x_1e_connect.show_team_viewer_tab	false	true \| false	By default, this property is set to false. Once enabled, the TeamViewer Session Connect tab will become visible in the Service Operations Workspace (SOW).
x_1e_connect.softwaremetrics_history	/Experience/SoftwareMetrics/Search	string	API to gather software metric history for 1E platform version 23.5 or higher
x_1e_connect.statistics_api	/consumer/InstructionStatistics/Summary/	string	API to get Instruction statistics from 1E Platform.
x_1e_connect.sugesstions_count	5	string	Stores the count of maximum suggested instruction to show in Agent Workspace.
x_1e_connect.synchronous_instructions	/Consumer/Devices/tachyonguid/	string	API to execute 1E instruction synchronously.
x_1e_connect.SystemStatistics	/consumer/SystemStatistics/ProjectedInstructionStatistics	string	API to generate instruction details like Average Execution time
x_1e_connect.tachyon_tab_name	1e_itsmconnect	string
x_1e_connect.target_device_field_task	u_ci_computer	string	This field name is used to get the targeted device name by calling 1E APIs.
x_1e_connect.task_extended_tables_to_be_used	incident	string	This property defines which Task extended tables should use 1E Platform tab. Please provide the name of tables separated by comma.
x_1e_connect.task_sectionname	1e_experience	string
x_1e_connect.teamViewerCheckAuthenticationStatus	/Consumer/TeamViewerIntegration/CheckAuthenticationStatus?state=	string	This API checks the current status of the authentication request for signed in user.
x_1e_connect.teamViewerEnsureAuthenticated	/consumer/TeamViewerIntegration/EnsureAuthenticated	string	This API checks whether token is available in 1E Platform for the signed in user authentication.
x_1e_connect.teamViewerPollingInterval	5000	integer	Polling interval for checking user authentication status in Team Viewer Session connect (in SOW). Its default value is set to 5 seconds (5000 milliseconds).
x_1e_connect.teamViewerPollingTimeoutMinutes	180000	integer	TeamViewer polling timeout minutes for checking the user authentication status in TeamViewer Session Connect (in SOW). Its default value is 3 minutes (18000 milli seconds)
x_1e_connect.teamviewer_create_session	/Consumer/TeamViewerIntegration/CreateSession	string	This API creates a TeamViewer session on the device.
x_1e_connect.teamviewer_initiate_session	/Consumer/TeamViewerIntegration/InitiateSessionOnDevice	string	This API initiates the TeamViewer session on the device.
x_1e_connect.teamviewer_integration_enabled	/Consumer/TeamViewerIntegration/Enabled	string	This API checks whether the TeamViewer integration is enabled on 1E Platform.
x_1e_connect.validateExperienceLicense	/Consumer/License/IsLicensed/Experience/DeviceRawMetrics	string	API to validate experience license for 1E Platform 23.5 and higher.
x_1e_connect.validateExperienceLicense_old	/consumer/SystemInformation/IsConsumerLicensed/Name/Experience	string	API to validate experience license.
x_1e_connect.wait_time_seconds	3	string	Time interval in seconds between subsequent Check Status API calls.
x_1e_connect.x509_pem_certificate	81b347e91b9d52102611eb12604bcb39	choice list	SysID of X509 PEM Certificate

x_1e_connect.1E_device_filter

{"Operator": "or","Operands":[{"Attribute":"DeviceType","Operator":"LIKE","Value":"Desktop"},{"Attribute":"DeviceType","Operator":"LIKE","Value":"Laptop"},{"Attribute":"DeviceType","Operator":"LIKE","Value":"Server"}]}

string

This property is to be used when fqdn is not available in your instance and when the property 'x_1e_connect.new_custom_connector_support' is set to true. It specifies the filter that will be used to retrieve devices from 1E.

This property is not in use from ITSM version 5.2.16.

x_1e_connect.access_token_expiry_time

100

integer

Access token expiry time (in seconds).

x_1e_connect.api_timer_multiplier

5

string

This property is used for response polling. The value specified in this property is multiplied with the response counter to calculate the time for the next poll.

x_1e_connect.approval_password

password

1E Platform Approver User Password.

x_1e_connect.approval_username

string

1E Platform Approver User Name.

x_1e_connect.attachment_prefix

1E_Instruction_Results_

string

File name prefix for attached response.

x_1e_connect.authentication_password

password

Password of account to authorize 1E API calls (If Basic Authentication is in use).

x_1e_connect.authentication_username

string

User name of account to authorize 1E API calls (If Basic Authentication is in use).

x_1e_connect.DeviceInfoSyncTime

sys_updated_on>=javascript:gs.minutesAgo(5)

string

Contains encoded query that will be used to filter device info data from 'x_1e_connect_device_info' table. If query returns a record then it will not fetch data from 1E and the saved data will be shown on UI. Default value is 5 minutes.

x_1e_connect.devices_api

/Consumer/Devices

string

API to get devices from 1E Platform

x_1e_connect.device_field_for_identification

name

string

This property is to be used when fqdn is not available in your instance and when the property 'x_1e_connect.new_custom_connector_support' is set to true. Select one of the unique field from the choices and the default value is name.

x_1e_connect.device_fqdn_field

cmdb_ci.fqdn

string

x_1e_connect.device_info

/consumer/Devices/FQDN/

string

API to gather device attributes.

x_1e_connect.device_info_ci_criteria

sys_class_name=cmdb_ci_pc_hardware^ORsys_class_name=cmdb_ci_computer

string

Criteria for CI filter.

x_1e_connect.device_lookup_without_save_incident_form

false

true | false

Allow device look-up without needing to save the incident

x_1e_connect.device_view_button_visibility

false

true | false

Added 1E DeviceView tab inside show_details UI macro

x_1e_connect.does_cmdb_ci_table_contains_fqdn

true

true | false

This property should be set to true if the fqdn is present in cmdb ci computer table. By default, this system property's value is true. If this property is set to false, then change the following system properties-

Set "x_1e_connect.new_custom_connector_support" property to true

Set "x_1e_connect.device_field_for_identification" property to either name or serial_number or mac_address

Set "x_1e_connect.device_fqdn_field" property to either cmdb.name or cmdb.serial_number or cmdb.mac_address based on value of "x_1e_connect.device_field_for_identification" property

x_1e_connect.download_teamviewer_client_from

Web

choice list

This property determines the source from which the TeamViewer client will be downloaded if it is not already installed on the device.

The options are:

Web: The client will be downloaded from the TeamViewer Website.

1E Platform: The client will be downloaded from the 1E Platform.

x_1e_connect.enable_approval

false

true | false

Enable approval. (ServiceNow will not ask for any approval if the checkbox is unchecked.)

x_1e_connect.enable_checkEntitlement

true

true | false

This property enables Check Entitlement button on App Configuration and Multi-Tenant Configuration page. By default this property is true.

x_1e_connect.enable_itsm_category_subcategory

{

"hardware": ["monitor", "cpu"],

"software": ["email"]

}

string

This system property enables all 1E ITSM Connect features exclusively for the specified categories and subcategories. This property is case-sensitive, which means the values must match exactly as choice values. Any categories or subcategories not explicitly listed will remain disabled. By default, this system property's value is set to false.

Expected format-

Copy

{

  "<category1>": ["<subcategory1>", "<subcategory2>"],

  "<category2>": ["<subcategory1>"]

}

x_1e_connect.execute_instruction_for_CI_field_only

false

true | false

In Service Operations Workspace, if you want to execute an instruction to display experience score and run quick fixes for the CI present in that field, set this property to true. Otherwise, if you want to utilize the default functionality, set this property to false.

x_1e_connect.experienceScore_old

/Experience/MetricsHistory/Cube

string

API to gather experience score

x_1e_connect.experience_score

/Experience/DeviceMetrics/Search/

string

API to gather experience score for 1E Platform version 23.5 or higher

x_1e_connect.first_range

0;0

string

First range while fetching tabular data from 1E Platform(0;0)

x_1e_connect.fulfiller_role

ITIL

string

x_1e_connect.gsw_content_information_multitenant

380c98991bd0c11061115395604bcbfb

string

Guided setup pages for multi-tenant

x_1e_connect.gsw_content_information_singletenant

a0c1b1811b98811061115395604bcb5b,7559f1491b98811061115395604bcbdf

string

Guided setup pages for single-tenant

x_1e_connect.gsw_content_modern_auth

1f2ca2b51bd61d5061115395604bcbd9

string

x_1e_connect.instructionTTL

60

string

1E Platform will gather data for these many minutes for an instruction. Value must be between 10 and 10080.

x_1e_connect.instruction_for_teamviewer_client_check

1E-Exchange-TeamViewer-CheckClient

string

This property checks whether TeamViewer client is installed on the device.

x_1e_connect.instruction_sets

1E A,1E ConfigMgrConsoleExtensions,1E Event,1E Exchange Adidas ChangeCompanyNameandLogo (1),1E Exchange DeleteFileByName,1E Experience,1E Explorer TachyonAgent,1E Explorer TachyonCore,1E for Device Refresh (v23.11),1E Inventory,1E Nomad,1E PatchInsights,1E Related,1E ServiceNow,1E Solutions,1E Tachyon Platform,Bitlocker,Browser Management,DomainAccountManagement,End user interaction,End-user Experience,End-User Self-Service,IT Management,MECM Instructions ,Microsoft Onedrive,Microsoft Teams,Network Drive,Nomad Client Health,Performance,serco,Smart Device Refresh,Software Inventory,Solutions_Intune,User Account Management,User Login Tracking,VDX Health,Windows 11 Migration,Windows AppLocker,Windows Client Health,Windows Operations,ZZTest

string

Stores 1E Instruction sets

x_1e_connect.jwt_provider

0e1643ad1b9d52102611eb12604bcb48

choice list

Sys ID of JWT provider (iDP)

x_1e_connect.key_id

4e1575eb-51c5-411a-b359-e8e2712d8566

string

App ID

x_1e_connect.logging.destination

db

choice list

x_1e_connect.logging.verbosity

choice list

_1e_connect.max_status_br_poll_minutes

5

integer

The 'ITSM Status Poll' BR will run for maximum these many minutes. This is to avoid any infinite polling. If value is set to 0, then it will interrupt the polling.

x_1e_connect.metadata

/Experience/metrics

string

API to gather meta-data for 1E platform version 23.5 or higher.

x_1e_connect.metadata_old

/Experience/metrics/metadata

string

API to gather meta-data

x_1e_connect.newExperienceAPISupport

true

true | false

This system property is related to Experience score. Set this value to true for 1E Platform version 23.5 or higher. By default this value is true.

x_1e_connect.new_custom_connector_support

false

true | false

This property enables the support for new custom connector, when cmdb does not contain FQDN. The default value of this property is false, which means the functionality is disabled by default.

x_1e_connect.nlumodel

781e889d1b216850430355352a4bcb3a

string

x_1e_connect.oauth_access_token

password2

x_1e_connect.policy_response_history_api

/consumer/policy/responses/history/

string

This API fetches history of a policy response. Used in Device View.

x_1e_connect.policy_rule_compliance_api

/consumer/policy/view/policyrulestatus/tachyonguid/

string

This API fetches policies rule compliance for a device from 1E Platform. Used in Device View.

x_1e_connect.responseTTL

120

string

1E Instructions keep answers minutes. Response will persist for these many minutes in 1E Platform. Value must be between 10 and 10080.

x_1e_connect.response_batch

100

string

Response batch size. Number of records to be fetched from 1E Platform in one iteration.

x_1e_connect.response_page_size

10

choice list

Page size. Default page size of 1E Instruction response table.

x_1e_connect.retain_instruction_response

5

integer

Instruction response keep days. Instruction responses will persist for these many days.

x_1e_connect.retain_roles

false

true | false

Used to retain roles in instruction set while retrieving the instruction.

x_1e_connect.retain_triggered_instruction

3

integer

Instruction history keep months. 1E instruction history will persist for these many months.

x_1e_connect.retryMessage

Please wait, the instruction is still running. After the device provides results, they will time out in {timeout} minutes. {clickHere} to see if the instruction has finished and returned results.

string

This message is displayed when the instruction is taking longer to process and needs to be re-executed again after a while. This message is configurable and can be set to required value. The {timeout} value comes from the instruction TTL, present in instruction definition table which comes from Platform.

Keep the format of the {timeout} and {click Here} as it is. This format fetches the dynamic values in the UI.

x_1e_connect.show_team_viewer_tab

false

true | false

By default, this property is set to false. Once enabled, the TeamViewer Session Connect tab will become visible in the Service Operations Workspace (SOW).

x_1e_connect.softwaremetrics_history

/Experience/SoftwareMetrics/Search

string

API to gather software metric history for 1E platform version 23.5 or higher

x_1e_connect.statistics_api

/consumer/InstructionStatistics/Summary/

string

API to get Instruction statistics from 1E Platform.

x_1e_connect.sugesstions_count

5

string

Stores the count of maximum suggested instruction to show in Agent Workspace.

x_1e_connect.synchronous_instructions

/Consumer/Devices/tachyonguid/

string

API to execute 1E instruction synchronously.

x_1e_connect.SystemStatistics

/consumer/SystemStatistics/ProjectedInstructionStatistics

string

API to generate instruction details like Average Execution time

x_1e_connect.tachyon_tab_name

1e_itsmconnect

string

x_1e_connect.target_device_field_task

u_ci_computer

string

This field name is used to get the targeted device name by calling 1E APIs.

x_1e_connect.task_extended_tables_to_be_used

incident

string

This property defines which Task extended tables should use 1E Platform tab. Please provide the name of tables separated by comma.

x_1e_connect.task_sectionname

1e_experience

string

x_1e_connect.teamViewerCheckAuthenticationStatus

/Consumer/TeamViewerIntegration/CheckAuthenticationStatus?state=

string

This API checks the current status of the authentication request for signed in user.

x_1e_connect.teamViewerEnsureAuthenticated

/consumer/TeamViewerIntegration/EnsureAuthenticated

string

This API checks whether token is available in 1E Platform for the signed in user authentication.

x_1e_connect.teamViewerPollingInterval

5000

integer

Polling interval for checking user authentication status in Team Viewer Session connect (in SOW). Its default value is set to 5 seconds (5000 milliseconds).

x_1e_connect.teamViewerPollingTimeoutMinutes

180000

integer

TeamViewer polling timeout minutes for checking the user authentication status in TeamViewer Session Connect (in SOW). Its default value is 3 minutes (18000 milli seconds)

x_1e_connect.teamviewer_create_session

/Consumer/TeamViewerIntegration/CreateSession

string

This API creates a TeamViewer session on the device.

x_1e_connect.teamviewer_initiate_session

/Consumer/TeamViewerIntegration/InitiateSessionOnDevice

string

This API initiates the TeamViewer session on the device.

x_1e_connect.teamviewer_integration_enabled

/Consumer/TeamViewerIntegration/Enabled

string

This API checks whether the TeamViewer integration is enabled on 1E Platform.

x_1e_connect.validateExperienceLicense

/Consumer/License/IsLicensed/Experience/DeviceRawMetrics

string

API to validate experience license for 1E Platform 23.5 and higher.

x_1e_connect.validateExperienceLicense_old

/consumer/SystemInformation/IsConsumerLicensed/Name/Experience

string

API to validate experience license.

x_1e_connect.wait_time_seconds

3

string

Time interval in seconds between subsequent Check Status API calls.

x_1e_connect.x509_pem_certificate

81b347e91b9d52102611eb12604bcb39

choice list

SysID of X509 PEM Certificate