Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ServiceNow tables maps are used to map and/or transform outbound ServiceNow field data for the record being dynamic shared or bulk shared. If the field names of the record being shared out from ServiceNow need to be modified, or if the value of one or more fields needs to be transformed, you can create an outbound table map to modify the fields for your integration.

Go to Perspectium > Control and Configuration > Table Maps to access.

Table maps are typically used in Perspectium Service Gateway integrations. For more information about how to use a ServiceNow table map to transform data being shared out of your ServiceNow instance, see Service Gateway.

Outbound Table Maps

Outbound table maps are used to map and/or transform the outbound ServiceNow field data for the replicated records. You should use Outbound table maps if the field names of the replicated record from ServiceNow need to be modified, or if the value of one or more fields needs to be transformed. Once the Outbound table map is configured, it can be assigned to a dynamic share or bulk share by selecting it in the Table Map field on corresponding forms. See Add a table map to your ServiceNow dynamic share/bulk share.

Outbound table maps are utilized and packaged per integration. See ServiceBond for all the different Perspectium supported applications that uses Outbound table maps.  

Inbound Table Maps

Inbound table maps direct messages to an Import Set Table where a ServiceNow Transform Map will do the processing. These configurations are used to map inbound replication messages to a ServiceNow table based on the Topic and Type specified in the message. For example, a record coming in with the “topic=siam” and the “type=common_incident” will be mapped to the “u_psp_common_incident” Import Set Table. The corresponding Transform Map will then process the message appropriately.

Explore these features:

...

titleAdd a table map to your ServiceNow dynamic share/bulk share

...

stylebackground: white

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.

(info) 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.

(info) 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:

Instructions:

...

titleCustomize your target database schema using table maps

...

stylebackground: white

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:

Instructions:

...

Code Block
languagesql
themeEclipse
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)

(info) 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.

...

titleCreate a ServiceNow table map

...

stylebackground: white

Here's how:

...

titleCopy a ServiceNow table map

...

stylebackground: white

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:

...

Image Removed

...

titleUse scripts to serialize records

...

stylebackground: white

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:

...

titleClick for example of a table map script

...

stylebackground: white
Code Block
languagejs
/*
 * 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);
}

Image Removed

...

titleAlways share field

...

stylebackground: white

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:

Instructions:

...

Image Removed

...

titleHide empty fields

...

stylebackground: white

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:

Instructions

...

Image Removed

...

titleField mappings in table maps

...

stylebackground: white

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

...

Image Removed

...

titleUse script in field mappings

...

stylebackground: white

Using scripts, you an enhance or create new columns of data in your table map's field mapping.

Here's how:

Prerequisites:

  • Create a new field mapping

Instructions

...

Image Removed

Examples

...

titleSet mapping field value

To set an overall value for your field mapping, use the following: 

Code Block
languagejs
answer = ""; 

...

titleConversion to a new format

To script the transformation of an entire record to a new format (ex: convert to a custom JSON format), use the current variable to reference values in the source record and set the answer variable to be the new value returned.

The following example builds a JSON string from the value of correlation_id and short_description in the current record:

Code Block
var attributes = {"type":"Case"};
var o = {};
o.attributes = attributes;
o.Id = current.correlation_id;
o.Subject = current.short_description.toString();

var j = new JSON();
j = j.encode(o);

answer = j.toString();

...

titleIgnore mapping fields

To ignore mapping fields for cases such as specified conditions not being met, use the script: 

Code Block
languagejs
ignore = true; 

In the following example, the mapping field will be ignored if the the work_notes field is empty:

Code Block
languagejs
if (current.work_notes == "")
   ignore = true;
else
   answer = current.work_notes;

...

Next, find instructions on how to create and configure ServiceNow table maps to fit your needs.