Versions Compared

Key

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

Below are the different modules that fall under the category of Control and Configuration, which allows you to make general customizations to your Perspectium application. All of the modules below can be found at Perspectium > Control and Configuration. Explore the following modules to learn more: 




UI Expand
titleProperties


Divbox
stylebackground: white

The Propertities module defines the options, settings, and preferences applied to your Perspectium application. 

To configure Perspectiujm's properties, go to Perspectium > Control and Configuration > Properties

In the following sections you can find instructions for customizing your General Settings and DataSync Settings, as well as an overview table of Perspectium properties.


UI Expand
titleGeneral Settings


Divbox
stylebackground: white

From the Properties page, click General Settings (Perspectium > Control and Configuration Properties > General Settings)

On the General Settings page, you can:

  • Change/view your Perspectium Integration Mesh username, password, and/or URL
  • Allow the sharing of incidents to Perspectium Support
  • Delete error messages older than one day in the Outbound Messages table (via datacleaners)
  • Generate debug logging
  • Limit bytes/records for Outbound Message jobs
  • Limit the maximum number of messages in the Outbound Messages queue

Tip

The application installs a role called perspectium that has access to the Perspectium application's tables. This role can be used to limit ServiceNow users to only have access to the Perspectium application and can be given to a user used with theDataSync Agent to access ServiceNow table schemas in order to replicate accurately and dynamically to external databases.



UI Expand
titleDataSync Settings


Divbox
stylebackground: white

From the Properties page, click DataSync Settings (Perspectium > Control and Configuration Properties > DataSync Settings)

Your DataSync Settings contain the default encryption and decryption keys that are used for shared and subscribed data, as well as various configuration options for your bulk shares and inbound messages.

On the DataSync Settings page, you can:

  • Share display values
  • User a percentage of workers to run concurrent scheduled bulk shares
  • Save Perspectium properties in the sys_properties table
  • Disable inbound messages
  • Enable multiple jobs to process messages in the inbound table
  • Skip updating the sys_domain_path field when subscribing to records
  • Alert before bulk sharing a large number of records
  • Generate unique names for business rules associated with dynamic shares



UI Expand
titlePespectium Properties Overview


Divbox
stylebackground: white

Listed are a few of the Perspectium properties needed for the application:


Property nameDescriptionTypeDefault value
com.perspectium.outbound.default_disabled

Used to send messages to Perspectium Integration Mesh to monitor status of the Perspectium for ServiceNow application. 

(info) NOTE: If the Perspectium application cannot connect to the Default Mesh, this values will toggle to true

true/falsefalse
com.perspectium.scheduled_job.node

Specify node to run Perspectium Scheduled Jobs (Warning: Changing from default may affect performance)

(info) NOTE:

  • The value "Default" allows your ServiceNow instance choose which node to run scheduled jobs on
  • This feature is only available on ServiceNow production instances as developer instances only have one node
dropdownDefault

com.perspectium.enable_receipts

Generate receipts from messages received to view details about the data you are sharing to/subscribingtrue/falsefalse

com.perspectium.outbound.delete_immediately 
(DataSync)

com.perspectium.observer.outbound.delete_immediately 
(Observer)

Deletes messages as soon as they are posted to the Integration Mesh, rather than updating them to sent and letting a different process delete the message. 

(info) NOTE: This can be used under systems with high volume to limit the different processes going to the Outbound Message tables. 

true/falsefalse

com.perspectium.replicator.track_shared_records

Enable shared record tracking for dynamic shares.

true/false

true







UI Expand
titleStop/Start all jobs


Divbox
stylebackground: white

DataSync for ServiceNow runs several scheduled jobs in the background of your instance. 

However, if Perspectium scheduled jobs start to affect your instance's performance, you may want to stop your Perspectium scheduled jobs and then start them again. Here's how:

Go to Perspectium > Control and Configuration > Start / Stop All Jobs. Then, click Stop All Jobs or Start All Jobs

On the resulting page, make sure to read through what will and won't be done. If it all looks good, click Confirm


Tip

To use this feature, you will need the Admin role. See ServiceNow Roles on how to assign roles. 





UI Expand
titleView all scheduled jobs


Divbox
stylebackground: white

To view all scheduled jobs associated with your DataSync for ServiceNow instance, navigate to Perspectium Control and Configuration All Scheduled Jobs.

Any MultiOutput jobs you create will also appear here.

For more information on Perspectium multiple MultiOutput jobs, see create MultipOutput Jobs

Tip

To use this feature, you will need the Admin role. See ServiceNow Roles on how to assign roles. 





UI Expand
titleServiceNow table maps


Divbox
stylebackground: white

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:


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


Divbox
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.

Instructions

Prerequisites:

Procedure

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



UI Expand
titleCustomize your target database schema using table maps


Divbox
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

Instructions

Prerequisites:

Procedure

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) WARNINGIf 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.

    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.



UI Expand
titleAdd Create a ServiceNow table map to your ServiceNow dynamic share/bulk share


Divbox
stylebackground: white

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.



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


Divbox
stylebackground: white




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


Divbox
stylebackground: white




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


Divbox
stylebackground: white







UI Expand
titleTroubleshooting


Divbox
stylebackground: white





UI Expand
titleProperties


Divbox
stylebackground: white





UI Expand
titleProperties


Divbox
stylebackground: white