User Tools

Site Tools


replicator_snc_bulk_share

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
replicator_snc_bulk_share [2018/06/14 14:42]
robert.fan [Sharing Child vs Parent]
replicator_snc_bulk_share [2019/01/15 10:41] (current)
timothy.pike [Sharing Related Records]
Line 1: Line 1:
 ====== ServiceNow Bulk Share ====== ====== ServiceNow Bulk Share ======
 +===== Overview =====
 The Bulk Share allows a ServiceNow instance to share a pre-filtered range of data all at once. The consumer of this data can be another instance of ServiceNow, Replicator Agent, or any number of the other applications that Perspectium can integrate with. The Bulk Share allows a ServiceNow instance to share a pre-filtered range of data all at once. The consumer of this data can be another instance of ServiceNow, Replicator Agent, or any number of the other applications that Perspectium can integrate with.
  
 This job can share multiple tables through the table hierarchy, run through advanced filters and scripts, share out related/​auxiliary records, and more.  ​ This job can share multiple tables through the table hierarchy, run through advanced filters and scripts, share out related/​auxiliary records, and more.  ​
  
-This page documents each of the core components of the bulk share and the following features related to it:+This page documents each of the core components of the Bulk Share and the following features related to it:
   * Creating a Basic Bulk Share   * Creating a Basic Bulk Share
   * Additional Settings   * Additional Settings
Line 15: Line 16:
  
 ===== Creating a Bulk Share ===== ===== Creating a Bulk Share =====
-To start configuring a bulk share, go to the //​Replicator > Bulk Share// module under the Perspectium app.+To start configuring a Bulk Share, go to the //​Replicator > Bulk Share// module under the Perspectium app.
  
 {{:​bulksharemodule.png?​nolink&​300|}} {{:​bulksharemodule.png?​nolink&​300|}}
  
-By selecting the above module, you will be presented with a list of currently defined ​bulk shares.  If this is your first time, there will not be any existing entries. ​ Go ahead and click the {{::​new_button.png?​nolink&​40}} button at the top of the list. You will now be presented with a form to define a bulk share.+By selecting the above module, you will be presented with a list of currently defined ​Bulk Shares.  If this is your first time, there will not be any existing entries. ​ Go ahead and click the {{::​new_button.png?​nolink&​40}} button at the top of the list. You will now be presented with a form to define a Bulk Share.
  
 ==== Initial Setup ==== ==== Initial Setup ====
Line 41: Line 42:
   * Audit Log   * Audit Log
   * History Set   * History Set
 +  * Referenced Fields <wrap info>​[[dubnium_release|Dubnium]]</​wrap> ​
 Of the main record. By default this will share __all__ the related records per table. The attachment option will share out the sys_attachment (metadata) as well as the sys_attachment_doc (data) records for the attachments. Of the main record. By default this will share __all__ the related records per table. The attachment option will share out the sys_attachment (metadata) as well as the sys_attachment_doc (data) records for the attachments.
  
Line 63: Line 65:
  
 You can read more about the handling for the [[:​replicator_servicenow_hierarchy|ServiceNow Hierarchy here]]. You can read more about the handling for the [[:​replicator_servicenow_hierarchy|ServiceNow Hierarchy here]].
 +
 +====Include Referenced Field Records==== ​
 +<wrap info>​[[updateset_releases|D Release]]</​wrap>​
 +
 +A checkbox to indicate if referenced field records related to this table should also be shared. ​
 +
 +{{:​include_reference_field_records.png|}}
 +
 +You can read more about this feature [[include_referenced_field_records|Include Referenced Field Records here]].
  
 ==== Insert Only ==== ==== Insert Only ====
Line 87: Line 98:
  
 ==== Run Schedule ==== ==== Run Schedule ====
-You can schedule ​bulk shares ​to run automatically in the background. Regular ​bulk shares ​can also be assigned a run schedule based of a current scheduled ​bulk share. Essentially,​ this feature allows you to change ​ a normal ​bulk share into a scheduled ​bulk share.+You can schedule ​Bulk Shares ​to run automatically in the background. Regular ​Bulk Shares ​can also be assigned a run schedule based of a current scheduled ​Bulk Share. Essentially,​ this feature allows you to change ​ a normal ​Bulk Share into a scheduled ​Bulk Share.
  
 ==== Cipher ==== ==== Cipher ====
-Perspectium Bulk Shares hav several cipher options for securing your data. Currently we offer TripleDES, ​AES128, Base64 Encode ​only, and Unencrypted options. Make sure that the option you select is supported at the endpoint. ​+Perspectium Bulk Shares hav several cipher options for securing your data. Currently we offer TripleDES, ​AES-128, AES-256, Base64 Encode, and Unencrypted options. Make sure that the option you select is supported at the endpoint. ​
  
-{{::​bulkshare_cipher.png|}} 
 ---- ----
  
Line 112: Line 122:
  
 ==== Share only Sys IDs Listed ==== ==== Share only Sys IDs Listed ====
-Much like the Share only selected fields box the “Share only Sys IDs listed” option will allow you to share only the sys ids specified in the bulk share. This way, instead of having to specify conditions to find certain sys ids, you can list the actual sys ids here and then the bulk share will only share those records.+Much like the Share only selected fields box the “Share only Sys IDs listed” option will allow you to share only the sys ids specified in the Bulk Share. This way, instead of having to specify conditions to find certain sys ids, you can list the actual sys ids here and then the Bulk Share will only share those records.
  
 You can enter in (sys_id - is one of - .....) into your filter condition to easily set up the sys_id sharing as well but this option is intended to be a more automatic way to do so. You can enter in (sys_id - is one of - .....) into your filter condition to easily set up the sys_id sharing as well but this option is intended to be a more automatic way to do so.
  
-A “Sys IDs” related list is provided in the Related Links section where you can enter the sys ids you want to bulk share (“Record Sys ID” is the record'​s sys id in the table).+A “Sys IDs” related list is provided in the Related Links section where you can enter the sys ids you want to Bulk Share (“Record Sys ID” is the record'​s sys id in the table).
  
 You can read more about this feature [[:​share_only_sys_ids_listed|Sharing sys_ids listed here]]. You can read more about this feature [[:​share_only_sys_ids_listed|Sharing sys_ids listed here]].
  
 ==== Condition Builder ==== ==== Condition Builder ====
-You can also add filter conditions to the bulk share in order to specify which records from the tables get shared. ​+You can also add filter conditions to the Bulk Share in order to specify which records from the tables get shared. ​
  
 {{::​bulkshare_conditionbuilder.png|}} {{::​bulkshare_conditionbuilder.png|}}
Line 127: Line 137:
 You can add multiple Filter Conditions, as well as "​OR"​ clauses in case you want two sets of conditions that allow for replication. ​ You can add multiple Filter Conditions, as well as "​OR"​ clauses in case you want two sets of conditions that allow for replication. ​
 ==== Share Scripts ====  ==== Share Scripts ==== 
-There are three share script options available when configuring your bulk share, Before Share Scripts, Before Bulk Share Scripts, and After Bulk Share Scripts.+There are three share script options available when configuring your Bulk Share, Before Share Scripts, Before Bulk Share Scripts, and After Bulk Share Scripts.
  
 == Before Share Scripts == == Before Share Scripts ==
Line 135: Line 145:
 == Before / After Bulk Share Scripts == == Before / After Bulk Share Scripts ==
  
-The "​Before ​bulk share script"​ and "​After ​bulk share script"​ sections allow you to specify a script that will run before the bulk share starts sharing out records and after the bulk share has completed sharing records. ​ This can be useful for when you want to run a script using the [[:​updateset_perspectium_api|Perspectium API]] to populate the bulk share with the sys ids of the records to be shared and/or create PSP outbound messages to send before the bulk share runs or after it is completed.+The "​Before ​Bulk Share script"​ and "​After ​Bulk Share script"​ sections allow you to specify a script that will run before the Bulk Share starts sharing out records and after the Bulk Share has completed sharing records. ​ This can be useful for when you want to run a script using the [[:​updateset_perspectium_api|Perspectium API]] to populate the Bulk Share with the sys ids of the records to be shared and/or create PSP outbound messages to send before the Bulk Share runs or after it is completed.
  
-Both sections expect [[http://​wiki.servicenow.com/​index.php?​title=Scripting_in_Business_Rules|server side javascript]],​ and is preconfigured with a globally available variable called //​bulkshare_gr//​ that is the [[http://​wiki.servicenow.com/?​title=GlideRecord|GlideRecord]] object corresponding to the bulk share configuration itself (i.e. you can use bulkshare_gr.u_name to access the name of the bulk share).+Both sections expect [[http://​wiki.servicenow.com/​index.php?​title=Scripting_in_Business_Rules|server side javascript]],​ and is preconfigured with a globally available variable called //​bulkshare_gr//​ that is the [[http://​wiki.servicenow.com/?​title=GlideRecord|GlideRecord]] object corresponding to the Bulk Share configuration itself (i.e. you can use bulkshare_gr.u_name to access the name of the Bulk Share).
  
 ==== Share Updates Since Then ==== ==== Share Updates Since Then ====
-Users can select the option "Share updates since then" to only share records that have been inserted or updated since the last bulk share ran which is shown in the "Last share time" field. This option will also be applied on: Scheduled Bulk Shares, [[:​run_another_bulk_share_like_this|Run another ​bulk share like this]] and Execute now.+Users can select the option "Share updates since then" to only share records that have been inserted or updated since the last Bulk Share ran which is shown in the "Last share time" field. This option will also be applied on: Scheduled Bulk Shares, [[:​run_another_bulk_share_like_this|Run another ​Bulk Share like this]] and Execute now.
  
 {{::​checkpointshow.png?​}} {{::​checkpointshow.png?​}}
Line 146: Line 156:
 ==== Limit Number of Records Shared ==== ==== Limit Number of Records Shared ====
  
-Users can limit the number of records that get shared in a bulk share using the "Limit number of records shared"​ field. The bulk share will stop sharing records once it reaches the limit that the user input. Bulk shares will evaluate the condition first before applying the "Limit number of records shared"​.+Users can limit the number of records that get shared in a Bulk Share using the "Limit number of records shared"​ field. The Bulk Share will stop sharing records once it reaches the limit that the user input. Bulk shares will evaluate the condition first before applying the "Limit number of records shared"​.
  
 For example, the configuration below will only share 50 //​incident//​ records. For example, the configuration below will only share 50 //​incident//​ records.
Line 159: Line 169:
 ==== Run As ==== ==== Run As ====
  
-Bulk shares automatically run as Admin users, and thus have access to all records in a table. if you only want certain records to be shared, or avoid sending records that you don't have access to, you can choose to run the bulk share as another user.+Bulk shares automatically run as Admin users, and thus have access to all records in a table. if you only want certain records to be shared, or avoid sending records that you don't have access to, you can choose to run the Bulk Share as another user.
  
 {{::​bulkshare_runas.png|}} {{::​bulkshare_runas.png|}}
Line 170: Line 180:
  
 ==== Team ==== ==== Team ====
-The Team field will be available on the dynamic share, ​bulk share, scheduled ​bulk shares, subscribed queues, and subscribe form views. You can select a team that was created on the Multi Team Administration module. ​ This is really just for cosmetic / organizational purposes.+The Team field will be available on the dynamic share, ​Bulk Share, scheduled ​Bulk Shares, subscribed queues, and subscribe form views. You can select a team that was created on the Multi Team Administration module. ​ This is really just for cosmetic / organizational purposes.
  
 You can read more about [[:​snc_multiteam_administration|Multi Team Administration here]]. You can read more about [[:​snc_multiteam_administration|Multi Team Administration here]].
Line 186: Line 196:
  
 {{:​snc_bulk_share_distribute_workload.jpg|}}\\ {{:​snc_bulk_share_distribute_workload.jpg|}}\\
-When selected, the "​Distribute Bulk Share Workload"​ option will schedule a bulk share job to run on a different node of your instance than the one the last bulk share ran on.  This will help to optimize performance so all your bulk shares ​are not run on the same node of your instance.\\+When selected, the "​Distribute Bulk Share Workload"​ option will schedule a Bulk Share job to run on a different node of your instance than the one the last Bulk Share ran on.  This will help to optimize performance so all your Bulk Shares ​are not run on the same node of your instance.\\
 \\ \\
 ==== Scheduled Job Priority ==== ==== Scheduled Job Priority ====
-You can specify the priority of the scheduled job that executes the bulk share under the advanced tab in the bulk share form.+You can specify the priority of the scheduled job that executes the Bulk Share under the advanced tab in the Bulk Share form.
  
-By default, scheduled jobs are created with a priority of 100 and specifying a value here allows you to override this with a different value. If the Advanced section is selected and no value is specified, the bulk share will run with the default value of 100.+By default, scheduled jobs are created with a priority of 100 and specifying a value here allows you to override this with a different value. If the Advanced section is selected and no value is specified, the Bulk Share will run with the default value of 100.
  
 {{::​bulkshare_advanced.png|}} {{::​bulkshare_advanced.png|}}
Line 198: Line 208:
 <wrap info>​[[updateset_releases|C Release]]</​wrap>​ <wrap info>​[[updateset_releases|C Release]]</​wrap>​
  
-This option allows you specify what node you want your bulk share to run on.  Once selected the Bulk Share will only process on this specified node.  You may want to use this option to distribute the Perspectium processing across several nodes. ​+This option allows you specify what node you want your Bulk Share to run on.  Once selected the Bulk Share will only process on this specified node.  You may want to use this option to distribute the Perspectium processing across several nodes. ​
  
 You can select the node that you would like this Bulk Share to run on via a reference. ​ This is a reference to the table "​sys_cluster_state"​ on the ServiceNow instance. You will need "​admin"​ access (or a custom ACL rule) in order to see and set this value. You can select the node that you would like this Bulk Share to run on via a reference. ​ This is a reference to the table "​sys_cluster_state"​ on the ServiceNow instance. You will need "​admin"​ access (or a custom ACL rule) in order to see and set this value.
Line 208: Line 218:
 {{page>​enable_share_debug_logging&​noheader&​nofooter}} {{page>​enable_share_debug_logging&​noheader&​nofooter}}
  
 +----
 +====== Actions & Related Lists ======
 ---- ----
 ===== UI Actions ===== ===== UI Actions =====
 ==== Create/Run Another Bulk Share like this ==== ==== Create/Run Another Bulk Share like this ====
-At the bottom of the bulk share form there are options to "​Create a new bulk share like this one" and "Run another ​bulk share like this one"+At the bottom of the Bulk Share form there are options to "​Create a new Bulk Share like this one" and "Run another ​Bulk Share like this one"
  
 {{::​bulkshare_anotherbulkshare.png|}} {{::​bulkshare_anotherbulkshare.png|}}
  
-The Create a new bulk share option creates but does NOT execute another ​bulk share with the same configuration.+The Create a new Bulk Share option creates but does NOT execute another ​Bulk Share with the same configuration.
  
-The Run another ​bulk share creates and executes another ​bulk share with the same configuration. ​+The Run another ​Bulk Share creates and executes another ​Bulk Share with the same configuration. ​
 ==== Preview ==== ==== Preview ====
-**On a bulk share that has yet to be executed**, you will see the "​Preview"​ related link option:\\+**On a Bulk Share that has yet to be executed**, you will see the "​Preview"​ related link option:\\
 \\ \\
 {{:​bulk_share_preview_related_link.png|}}\\ {{:​bulk_share_preview_related_link.png|}}\\
 \\ \\
-When selected, this option will take you to the Bulk Share Preview page to give you a preview of the bulk share before it is executed:  ​+When selected, this option will take you to the Bulk Share Preview page to give you a preview of the Bulk Share before it is executed:  ​
 {{::​bulk_share_preview_page.png|}} {{::​bulk_share_preview_page.png|}}
  
Line 242: Line 254:
  
 ==== Outbound Messages ==== ==== Outbound Messages ====
-On each dynamic and bulk share, a related list will display all messages in the Outbound queue for the share:+On each dynamic and Bulk Share, a related list will display all messages in the Outbound queue for the share:
 \\ \\
 \\ \\
Line 254: Line 266:
  
 ==== Records Processed ==== ==== Records Processed ====
-The "​Records Processed"​ entry reflects the complete total number of records processed and bulk shared ​out, including the number of auxiliary records shared if options such as "​Include attachments",​ "​Include journal field" are selected. ​ To see a breakdown of records per table (i.e. how many sys_attachment,​ sys_journal_field,​ etc. records), the "​Records Processed"​ related list at the bottom of the form is provided to show these details:\\+The "​Records Processed"​ entry reflects the complete total number of records processed and Bulk Shared ​out, including the number of auxiliary records shared if options such as "​Include attachments",​ "​Include journal field" are selected. ​ To see a breakdown of records per table (i.e. how many sys_attachment,​ sys_journal_field,​ etc. records), the "​Records Processed"​ related list at the bottom of the form is provided to show these details:\\
 \\ \\
 {{:​snc_bulk_share_total_records_processed.png|}} {{:​snc_bulk_share_total_records_processed.png|}}
  
-<wrap info>​[[updateset_releases|D Release]]</​wrap>​: +<wrap info>​[[updateset_releases|Dubnium]]</​wrap>​ 
- +\\ 
- +These entries ​will be updated periodically every 1000 records, rather than just at the conclusion ​of the Bulk Share.
-The entry will update as the bulk share runs to display progress. Its value will include current total number ​of records processed including auxiliary records from attachments,​ journal fields, etc.+
replicator_snc_bulk_share.1529012534.txt.gz · Last modified: 2018/06/14 14:42 by robert.fan