Tag Synchronization for Department in AWS

Connector Applicability

Applies to Source Connectors

AWS

Applies to Destination Connectors

All

Assumptions

These instructions assume you have already setup a source connection in CI Sync for AWS using the CI Sync instructions here: Add AWS to SaaS Agent

Pre-Read

Syncfish recommend customers read the following documentation before changing the Connection Setting/s described below.

  1. Understanding the use of CI Sync Connection Settings

  2. Rule 10 - AWS Tag Synchronization

  3. FAQ - Overview of Cloud Tag and Label Synchronization Capabilities of CI Sync

Locating and Amending the Connection Setting in the CI Sync UI

  1. Navigate to the Settings page

  2. Under the Source Connections heading (list), locate your AWS connection.

  3. Click the Update link on the right hand side of the AWS connection.

  4. Scroll down and locate the Section Heading and view the Individual Settings.

azure department 2.jpg

The screen shot is provided only as sample to assist when reading this page. The state of your own CI Sync UI will depend on whether you are starting from the CI Sync default position or if you have already amended one/more of the settings.

  1. Tick the Override default box/boxes and then use the sliders related to the individual settings. The following table elaborates any further information about these particular settings.

Setting

Type

Additional Notes

Enable for Department

Slider

If enabled, the defined Tags will be synchronized to the discrete department field against each CI in the CMDB.

When enabled, the Department Tag RegEx field will be exposed (see below).

Department Tag RegEx

RegEx

Enter a Regular Expression that matches one or more Tag names in AWS (i.e. one or more Tags that represent the Department associated with the AWS resource).

Example RegEx

/^Department$|^Department Unit$|^DepartmentLabel$/

RegEx Explained

This RegEx will identify Tags named “Department”, “Department Unit” or “DepartmentLabel” (i.e. three variations) and sync’d the associated values into ServiceNow.

Sync Behaviour and ServiceNow Data Explained

  1. If there are multiple Tags that match the defined regEx for a field, the value within each Tag will be searched against the ServiceNow cmn_department table with the first matching value returned.

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

  3. Once a match is returned, CI Sync will store the sys_id of the cmn_department record against the department field on the CI. If no match is found, the department 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 Tag data (i.e. an entry will be created in cmdb_key_value for each Label or Tag and it’s raw value).

Syncfish recommend customers read the following FAQ for more information about the behaviour of Tag (or Label) synchronization into ServiceNow.

FAQ - Overview of Cloud Tag and Label Synchronization Capabilities of CI Sync

Department Value Replacements

RegEx

This setting allows customers to define a search and replace RegEx express that acts on the values read from a given 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

[['/_/', ' ']]

RegEx Explained

This RegEx will replace “_” characters with space characters. For example: “123_456” will be transformed to “123 456” (without the quotes.. they are just for reference in this documentation)

  1. After modifying the settings, scroll to the bottom of the page, tick the “I consent…” checkbox and finally click the Save connection button.

  2. You can now run a sync job and the amended settings will be applied causing the CI Sync Data Sync rules to be modified accordingly.

Importantly

Make sure you consciously override the setting against either your TEST or PROD environment (i.e. your TEST vs PROD sync jobs).

For more information on how to use TEST vs PROD Connection Settings please read Understanding the use of CI Sync Connection Settings.

Syncfish strongly recommend making changes for TEST environment/sync jobs first. Only modify PROD related settings after thoroughly validating the intended results in TEST.