ServiceNow table maps

ServiceNow table maps are typically used in Perspectium Service Gateway integrations to handle the mapping of fields in certain ServiceNow tables as data is shared out of your instance. You can include a table map as part of your ServiceNow dynamic share or bulk share to help with field mappings and data transformation.

 NOTE: When using a table map with a dynamic share, the dynamic share will trigger based on trigger conditions (i.e. create, update or filter conditions). So this may result in a dynamic share being triggered when a particular field is updated that is not in the table map. As a result, the table mapped record shared out may not have any updated content since all the fields mapped have not changed. To avoid this scenario, use the Share or ignore on specified field updates option.

 NOTE: If a table map is set, records with an attachment or message size greater than 5 MB will not be shared out due to ServiceNow platform limitations with how large one particular record can be.

Prerequisites:

• First, you will need to commit a Perspectium update set containing table maps to your ServiceNow instance.
• You will also need to create a ServiceNow dynamic share or bulk share.

Instructions:

1. In your sharing ServiceNow instance, go to Perspectium > Perspectium Core > Shares > Dynamic Share or Perspectium > Perspectium Core > Shares > Bulk Share.
   
   
2. Click View Dynamic Shares or View Bulk Shares.
   
   
3. From the available shares, click on the one that you want to add a table map for.
   
   
4. In the Data Enrichment tab, click the search icon next to Table map.
   
   
   
   
5. From the resulting list, select the table map you want to add
   
   
6. Click Update (top right corner) to save your changes

By default, data replicated from existing tables will automatically create the same schema at the replicated database. The targeted database schema of replication needs to be flexible and customized in certain situations, such as: 

• An existing schema that the replicated data need to fit in
• A need to rename the field names or transform the field values using script at the source
• The resulting field types need to be modified to a specific type or field length

Customizing target database schema is done by using table maps in your dynamic share or bulk share. 

Prerequisites:

• Set up and configure DataSync for ServiceNow

Instructions:

1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Table Maps
   
   
2. Select the table map you want to use, review the information in the fields, and check the Generate schema box
   
    WARNING: If there are multiple table maps with the same Target table name, the agent will return the first record when querying against ServiceNow for the schema.
   
   For the purposes of these instructions, we'll use the table Incident to Common Incident.
   
   NOTES:
    
   
   • Checking the Generate schema box is required in the initial sharing of your records.
   • Specifying Field Type and Field Length is optional except for designating at least one field as Sys ID (GUID). This is required for the target database table to be created and queried for updates and deletes. 
   • The value specified in the Target table name field will be used as the name of the table in the database.
     
     
     
     

3. To share the table map output, you need to crate a dynamic share or bulk share and select the table map from step #1 in the table map field. The generated payload can be subscribed by an agent and the scheme created dynamically.
   
   In this example, the common incident table map will result in the following table schema, if consumed by a database agent for MySQL.
   
   

   mysql> describe common_incident;
   +---------------------+--------------+------+-----+---------+-------+
   | Field               | Type         | Null | Key | Default | Extra |
   +---------------------+--------------+------+-----+---------+-------+
   | state               | mediumtext   | YES  |     | NULL    |       |
   | short_description   | varchar(160) | YES  |     | NULL    |       |
   | description         | mediumtext   | YES  |     | NULL    |       |
   | priority            | mediumtext   | YES  |     | NULL    |       |
   | attachments         | mediumtext   | YES  |     | NULL    |       |
   | category            | mediumtext   | YES  |     | NULL    |       |
   | correlation_id      | varchar(100) | YES  |     | NULL    |       |
   | number              | varchar(40)  | YES  |     | NULL    |       |
   | correlation_display | varchar(100) | YES  |     | NULL    |       |
   | caller_id           | mediumtext   | YES  |     | NULL    |       |
   | caller_email        | varchar(100) | YES  |     | NULL    |       |
   | caller_full_name    | mediumtext   | YES  |     | NULL    |       |
   | comments            | mediumtext   | YES  |     | NULL    |       |
   | sys_id              | varchar(224) | NO   | PRI |         |       |
   | work_notes          | mediumtext   | YES  |     | NULL    |       |
   +---------------------+--------------+------+-----+---------+-------+
   15 rows in set (0.00 sec)

    NOTE: Even though we specified the number field as the required Sys ID (GUID) field in the table map, the number field does not become the GUID. Instead, the sys_id field is created as GUID (PRI key) and contains number values to be used for lookup during updates/deletes. This is consistent with replicating database views.

Here's how:

1. In your ServiceNow instance, go to Perspectium > Control and Configuration > Table Maps
   
   
2. Click New. 
   
   
3. Select the table map direction (Outbound or Inbound) from the Direction dropdown. The fields available will change depending on whether you choose Outbound or Inbound.
   
   Refer to ServiceNow table maps for more information on the difference between Outbound and Inbound table maps. 
   
   
4. Complete the required fields:
   
   • Enter a Name
   • (For Outbound table maps only) Select the table you want to create  table map for from the Source table dropdown
   • (For Outbound table maps only) Enter the name of the target table in the Target Table Name field (e.g. incident)
   • (For Inbound table maps only) Select the target table from the Target Table dropdown
     
     
5. Click Submit.

Existing table maps, as well as transform maps and all other related mappings, can be duplicated or copied. If you plan to modify any of the Common Table Maps, e.g. Incident to Common Incident, we recommend that you modify a new copied table map. 

Here's how:

1. In your ServiceNow instance, go to Perspectium > Control and Configuration > Table Maps
   
   
2. Select the table map that you want to copy
   
   
3. Under the Related Links section at the bottom, click Copy table map
   
   
   

Table maps can be configured to use scripts to serialize the record yourself. Within the script, you can set the variable answer to be the value you want the record to be serialized and returned as. 

This is an advance configuration. Contact Perspectium Support for more information. 

The following variables are available to use:

Instructions:

1. In your ServiceNow instance, go to Perspectium > Control and Configuration > Table Maps
   
   
2. Select the table map that you want to add a script to or create a new table map
   
   
3. Under the Mapping Script section, check the Use Script box
   
   
4. Fill the Script field with the appropriate script. See below for an example script.
   
   
5. Click Update.
   
   

/*
 * Custom Table Map
 */
 
//Serialize 'current' record into an XMLDocument
var recordSerializer = (typeof GlideRecordXMLSerializer != 'undefined') ? new GlideRecordXMLSerializer() : new Packages.com.glide.script.GlideRecordXMLSerializer(); 
var xmlstr = recordSerializer.serialize(current);
var xmlDoc = new XMLDocument(xmlstr);
 
//Process Display Values As Necessary
var pspUtil = new PerspectiumUtil();
var addDisplayValues = pspUtil.getPspPropertyValue("com.perspectium.replicator.add_display_values", "true");
var currentFieldsOnly = pspUtil.getPspPropertyValue("com.perspectium.replicator.share_current_fields", "false");
if (currentFieldsOnly == "true" || addDisplayValues == "true") {
    addDVFields();
}
 
/*
 * Any extra mapping, to add
 */
 
// Send the XMLDoc string to our answer
answer = xmlDoc.toString();
 
// Helper Functions
 
//Standard DV Field Processing
function addDVFields(){
    var fl = (typeof GlideFieldList != 'undefined') ? new GlideFieldList() : new Packages.com.glide.processors.FieldList();
    var tableName = current.getTableName();
    var fieldNames = fl.get(current.getTableName(),"");
    var arrFields = current.getFields();
 
    for (var i = 0; i < arrFields.size(); i++) {
        var glideElement = arrFields.get(i);
        var ed = glideElement.getED();
        var elName = glideElement.getName();
 
        if (!fieldNames.contains(elName) || (currentFieldsOnly == "true" && tableName != ed.getTableName())) {
            removeElement(elName);
        }
 
        // Create dv fields for reference, choice, or lists
        if (ed.isReference() || ed.isChoiceTable() || ed.getInternalType() == "glide_list") {
            addElement("dv_" + elName, glideElement.getDisplayValue());
        }
 
        if (!glideElement.hasValue()) {
            continue;
        }
    }
}
 
//Remove an element from xmlDoc
function removeElement(elName){
    var nn = xmlDoc.getElementByTagName(elName);
    if(nn && nn.parentNode) {
        nn.parentNode.removeChild(nn);
    }
}
//Add an element from xmlDoc
function addElement(elName, elValue){
    xmlDoc.createElement(elName, elValue);
}

ServiceNow table maps abide by the share only updated fields property that is set in the dynamic share record. However, if you want to override this setting, you can do so in the table field map record.  This can be useful if you have a field that is designated as the record's unique ID field (such as the sys_id field) that you always want to share out, regardless of whether it's updated or not.

Prerequisites:

• First, you will need to commit a Perspectium update set containing table maps to your ServiceNow instance.
• You will also need to create a ServiceNow dynamic share or bulk share.
• Lastly, you will need to add a table map to your dynamic share

Instructions:

1. In your sharing ServiceNow instance, go to Perspectium > Control and Configuration > Table Maps.
   
   
2. Find and click the name of the table map that you want to modify.
   
   
3. In the PSP Table Field Maps section, select the field that you want to always hare out regardless of the field being updated or not.
   
   
4. Check the Always Share Field box.
   
   
5. Click Update.

ServiceNow table maps will often generate common documents with empty elements, depending on the script that is used or the source field being mapped. This may not be the desired result and hiding these empty elements may be more favorable. This can be done using the hide empty fields feature that is built into table maps.

Prerequisites:

• First, you will need to commit a Perspectium update set containing table maps to your ServiceNow instance.
• You will also need to create a ServiceNow dynamic share or bulk share.
• Lastly, you will need to add a table map to your dynamic share

Instructions

1. In your ServiceNow instance, go to Perspectium > Control and Configuration > Table Maps.
   
   
2. Find and click the name of the table map that you want to modify.
   
   
3. Check the Hide Empty Fields box.
   
   
4. Click Update.

This feature allows you to map fields in the outbound record based on values from the ServiceNow record to be shared.

Prerequisites:

• Create a ServiceNow table map

Instructions

1. In your ServiceNow instance, go to Perspectium > Control and Configuration > Table Maps.
   
   
2. In the PSP Table Field Maps section, click New.
   
   Alternatively, you can click Add all source table fields. This allows you to quickly add all fields of the specified source table as field maps. This can be useful for cases where you want all fields to be in the outbound table map and only want to modify a few fields to have different values.
   
   
   
   
3. Set the following required fields:
   
   
   • Set the Source Field with the name of the field in the source table
   • Set the Target Field with the name of the field in the target table
     
     
4. Click Submit.