Implementation

The implementation of any common attachment format is symmetrical, meaning that the output, when consumed, should produce the same or similar records at the target. The implementation should also exhibit idempotent behavior, meaning when a document is consumed and processed repeatedly, the same result either appears or is ignored, because the results already exist.

↑ Go to top of page

Dynamic Shares

For the correct outputs to be produced, you must create 2 Dynamic Shares - one to capture the comments and work_notes field values in a before context, and the other as async mode to capture the related records in a delayed step.

In the before Dynamic Share, use the following code snippet to prevent unwanted outbound messages to be queued when comments or work_notes are not updated. Please note this is only necessary if it applies to your use case.

if (current.comments.nil() && current.work_notes.nil()) {
	ignore = true;
}

Embedded Records

Embedded records are fields in the Common Change document that cannot be mapped by singular values. Instead, they are entirely different records embedded inside the Common Change document to be created on the subscribing system.

 NOTE: Deactivate each of the transform scripts in PSP Common Change to Change if you choose not to parse these embedded objects into records. If you need to extend or add additional capabilities, instead of modifying the existing scripts, add new ones so that upgrades are possible.

The following are examples of the embedded records in Common Change: 

Configuration Item's Affected Embedded Record

The CI affected field in the Common Change is an embedded record that, when populated, will create a new CI affected on the system receiving the Common Change.

Approver Embedded Record

The approver field in the Common Change is an embedded record that, when populated, will create a new approver on the system receiving the Common Change.

Attachment Embedded Record

The attachment field in the Common Change is an embedded record that, when populated, will create a new attachment on the system receiving the Common Change.

Change Task Embedded Record

The change task field in the Common Change is an embedded record that, when populated, will create a new change task on the system receiving the Common Change.

Impacted Service Embedded Record

The impacted service field in the Common Change is an embedded record that, when populated, will create a new impacted service on the system receiving the Common Change.

Incident Embedded Record

The incidents_caused and incidents_fixed fields in the Common Change is an embedded record that, when populated, will create a new incident on the system receiving the Common Change.

Problems Embedded Record

The problems field in the Common Change is an embedded record that, when populated, will create a new problem on the system receiving the Common Change.

Table Maps

The Perspectium Common Change Helium update set will contain the following:

Outbound Table Maps

Inbound Table Map

Import Set

Sample Output

A sample Common Change looks like this:

<common_change>
   <affected_cis>
      <affected_ci>
         <ci_class />
         <ci_name />
         <ci_id />
      </affected_ci>
   </affected_cis>
   <approval />
   <approvers>
      <approver>
         <created />
         <approver_name />
         <assignment_group_name/>
         <approver />
         <state />
         <comments/>
         <approver_email />
         <assignment_group/>
      </approver>
   </approvers>
   <assigned_to />
   <assignment_group />
   <attachments>
      <attachment>
         <data />
         <size_bytes />
         <file_name />
         <sys_id />
         <content_type />
      </attachment>
   </attachments>
   <backout_plan />
   <category />
   <change_tasks>
      <change_task>
         <assignment_group />
         <short_description />
         <correlation_id />
         <number />
         <work_notes />
         <comments />
         <correlation_display />
         <change_task_type />
         <assigned_to />
         <state />
         <description />
         <cmdb_ci />
      </change_task>
   </change_tasks>
   <close_code />
   <close_notes />
   <cmdb_ci />
   <comments />
   <correlation_display />
   <correlation_id />
   <description />
   <end_date />
   <impact />
   <impacted_services>
      <impacted_service>
         <operational_status />
         <type />
         <location_name />
         <id />
         <manually_added />
         <name />
      </impacted_service>
   </impacted_services>
   <implementation_plan />
   <incidents_caused>
      <incident>
         <number />
         <opened_at />
         <category />
         <caller_id_name />
         <assigned_to_name />
         <short_description />
         <priority />
         <id />
         <state />
         <assignment_group_name />
      </incident>
   </incidents_caused>
   <incidents_fixed>
      <incident>
         <number />
         <opened_at />
         <category />
         <caller_id_name />
         <assigned_to_name />
         <short_description />
         <priority />
         <id />
         <state />
         <assignment_group_name />
      </incident>
   </incidents_fixed>
   <justification />
   <number />
   <priority />
   <problems>
      <problem>
         <short_description />
         <assignment_group_name />
         <id />
         <assigned_to_name />
         <state />
         <number />
      </problem>
   </problems>
   <provider />
   <psp_action />
   <requested_by />
   <requested_by_date />
   <risk />
   <short_description />
   <start_date />
   <state />
   <test_plan />
   <type />
   <work_notes />
</common_change>

The following Perspectium Inbound/Outbound Message unloads can be un-gzipped and uploaded into your instance of ServiceNow to view and used for testing.

Common Change Sample - Inbound.xml.gz

Common Change Sample - Outbound.xml.gz