Label and Tag Synchronization for Managed By in GCP

GCP

All

Setting

Type

Additional Notes

For Label Synchronization

Enable Label Synchronizatiion

Slider

If enabled, CI Sync will use the subsequent Connection Settings (in the rows below) to read the relevant Label from GCP and persist the value into ServiceNow as follows:

1. The value will be persisted to a discrete attribute on each CI.

2. The value (and it’s associated Label Name) will be persisted into the cmdb_key_value table (i.e. an entry will be created in cmdb_key_value for each Label and it’s raw value).

Customers need to enable and configure one or more of the subsequent Connections (described in the rows below) after enabling this setting,

For Tag Synchronization

Enable Tag Synchronizatiion

Slider

If enabled, CI Sync will use the subsequent Connection Settings (in the rows below) to read the relevant Tag from GCP and persist the value into ServiceNow as follows:

1. The value will be persisted to a discrete attribute on each CI.

2. The value (and it’s associated Tag Name) will be persisted into the cmdb_key_value table (i.e. an entry will be created in cmdb_key_value for each Tag and it’s raw value).

Customers need to enable and configure one or more of the subsequent Connections (described in the rows below) after enabling this setting,

The following settings can then be used for either/both Label and Tag Synchronization

Prioritize Tags vs Labels

Choicelist

Select one of the available choicelist items to control the behaviour when both Tags and Labels are being used for the same destination attribute in ServiceNow (e.g. an “Managed By” Tag and an “Managed By” Label both exists and CI Sync will be persisting both into the cmdb_ci.managed_by attribute).

See below for the available choices.

1. Prefer Label over Tag

   1. CI Sync will use values from Labels in preference to values from Tags.

2. Prefer Tag over Label

   1. CI Sync will use values from Tags in preference to values from Lables.

Enable for Managed By

Slider

If enabled, defined Labels or Tags will be synchronized to the managed_by field against CIs in the CMDB.

When enabled, the Managed By Label RegEx field will be exposed (see below).

Managed By [Label | Tag] RegEx

RegEx

Enter a Regular Expression that matches one or more Label or Tag names in GCP (i.e. one or more Labels or Tags that represent the Owned By associated with the GCP resource).

Example RegEx

/^ManagedBy$|^ManagedByTag$|^ManagedBy 1$|^ManagedBy 2$|^ManagedBy1$|^ManagedBy$/

RegEx Explained

This RegEx will identify Labels (or Tags) named “ManagedBy”, “ManagedByTag”, “ManagedBy 1”, “ManagedBy 2”, “ManagedBy1” or “ManagedBy2” (i.e. six variations) and sync’d the associated values into ServiceNow.

Sync Behaviour and ServiceNow Data Explained

1. If there are multiple Labels or Tags that match the defined regEx for a field, the value within each Label or Tag will be searched against the ServiceNow sys_user table. The CI Sync lookup ranks the results to return active users first.

2. If there are multiple values within a Label or Tag (including multiple Labels or Tags), either comma or semi-colon separated, the individual values will be extracted and searched individually against the ServiceNow sys_user table with the first matching value returned.

3. Once a match is returned, CI Sync will store the matching sys_user value against the managed_by field on the CI. If not match is found, the managed_by attribute on the CI will be blank.

4. Regardless of whether a match is found (or not), CI Sync will also populate the ServiceNow cmdb_key_value table with the raw label (tag) data (i.e. an entry will be created in cmdb_key_value for each Label or Tag and it’s raw value).

Managed by Value Replacements

Choicelist

For context in GCP: GCP is restrictive as to the values allowed in Labels, therefore CI Sync provides support for transforming GCP Tags or Labels into valid user names. For user names: as GCP does not allow for the entry of space characters in Label values, CI Sync provides for the substitution of either “-” or “_” with a space character when searching the sys_user.name field.

This setting allows customers to define a search and replace RegEx express that acts on the values read from a given Label or Tag.

Enter a Regular Expression that defines the search string and the replacement value string.

The RegEx format consists of a two element array. The first element is the search RegEx and the second element is the replacement text.

Example RegEx

[['/dot/', '.'],['/at/', '@']]

RegEx Explained

This RegEx will replace the literal text “dot” with a “.” (period) character, and will replace the literal text “at” with the “@” symbol. For example “AndrewdotKentatsyncfishdotcomdotau” will be transformed to “Andrew.Kent@syncfish.com.au” (without the quotes.. they are just for reference in this documentation)

Managed By Lookups

Choicelist

Select one of the available choicelist items which control sys_user attribute/s CI Sync searches using the value/s in the tag.

See below for the available choices.

In this example if you select ‘e-mail [email] & Name [name]' you will see a message as per below explaining that you must select the corresponding options in the ServiceNow destination connection 'User Synchronization’ section. Please refer to the document linked below.

Define a User oriented attribute when using User Synchronization from a Source System in ServiceNow

If the corresponding selection in ServiceNow is not made the sync job will error.