Journal field framework
Summarize
Summary of Journal field framework
The Journal Field Framework (JFF) in ServiceNow Zurich release enables real-time synchronization of journal-type fields, such as comments and work notes, between provider and consumer instances. This framework enhances operational transparency, maintains historical context, and ensures journal updates are attributed to actual users rather than generic company names. Synchronization is facilitated through a Remote Task Definition (RTD) configured with compatibility version 2.2.x or later.
Show less
Key Features
- Journal Field Mapping: Map and synchronize any journal-type fields between provider and consumer instances based on inbound and outbound field configurations in an RTD. For example, you can map comments to work notes or vice versa. By default, a comment-to-comment mapping is created when creating an RTD from Service Exchange version 2.2.x.
- Mapping Rules: Supported mappings include journal field to journal field and journal field to non-journal field. However, non-journal field to journal field mappings are not supported. Additionally, the same journal source field cannot be used twice for different mappings within the same RTD.
- User Identity Attribution: Journal entries are written using individual user identities (e.g., "David (xyz company)"), ensuring clarity about who made updates.
- Historical Journal Synchronization: When the "Sync pre-existing entries" option is enabled during RTD setup and activation, all past journal entries on a task are synchronized between instances upon remote task connection.
Considerations
- Journal synchronization will not work if a remote task is deleted and a new remote task is created later for the same parent task and RTD.
- Synchronization of historical journal entries stops and does not resume if a remote task is disconnected and then reconnected, even if the sync option is enabled.
Next Steps
- Create a Remote Task Definition in Service Exchange for Providers to configure journal field mappings.
- Activate the Remote Task Definition record in Service Exchange to enable synchronization features.
The Journal Field Framework (JFF) enables real-time synchronization of journal type fields, such as comments and work notes, between provider and consumer.
JFF also enhances operational transparency, preserves historical context, and verifies that updates are attributed to actual users for greater transparency.
The synchronization of journal type fields between consumer and provider instances is enabled through a Remote Task Definition (RTD) configured with compatibility version 2.2.x or later.
With JFF, you can do the following.
- Journal field mapping
- Map and synchronize any journal type fields between provider and consumer instances based on the Inbound and Outbound field configurations in a remote task definition.For example, while creating an RTD, you can create mappings such as:
- Comments to work notes
- Work notes to comments
A comment-to-comment mapping is created by default in both the Inbound and the Outbound field configurations while creating a remote task definition from Service Exchange version 2.2.x. For more information, see Create a remote task definition in Service Exchange for Providers.
- Write journal entries as an actual user
- Write journal entries using user identities rather than a generic company name. For example, all comments for user David would appear as David (xyz company).
- Synchronize historical journal entries
- Synchronize all historical journal entries between consumer and provider instances for a remote task.
If the Sync pre-existing entries option is configured during Remote Task Definition (RTD) setup and while activating the RTD, all journal comments made in a task are synchronized between the consumer and provider instances when a remote task is connected.
Considerations
Journal synchronization or synchronize of historical journals might not work for the following scenarios:
- Synchronization of Journal fields won’t work if a remote task is deleted and a new remote task is later created for the same parent task and RTD.
- Synchronization of historical journal entries stops and doesn’t resume if a remote task is disconnected and later reconnected, even if the Sync pre-existing entries option is enabled in the connected RTD.