How to Sync Rich Text and HTML Between Xurrent and Other Systems

Xurrent uses its own rich text format for comments and custom fields. When syncing with other systems like Jira, ServiceNow, or Zendesk, you need to convert between formats.

This guide explains how to use the NodeHelper methods to convert rich text in your sync rules.

Available NodeHelper Methods

Limitations

Jira Wiki → Xurrent (convertWikiToXurrent)

The following Jira Wiki elements are NOT supported and will not be converted:

Xurrent → Jira Wiki (convertXurrentToWiki)

The following Xurrent elements are NOT supported and will not be converted:

Note: Basic formatting (bold, italic, headers, lists, links, images, quotes, code blocks) is fully supported in both directions.

Syncing Comments

Outgoing Sync (Xurrent → Other System)

To Jira (Wiki format)

// Data Filter - Outgoing to Jira
// Convert Xurrent comments to Jira Wiki format and exclude internal comments

replica.comments = entity.comments.findAll { !it.internal }.each {
    it.body = nodeHelper.convertXurrentToWiki(it.body)
}

To ADO (HTML format)

// Data Filter - Outgoing to Zendesk or ServiceNow
// Convert Xurrent comments to HTML format and exclude internal comments

replica.comments = entity.comments.findAll { !it.internal }.each {
    it.body = nodeHelper.convertXurrentToHtml(it.body)
}

To Plain Text (strip all formatting)

// Data Filter - Outgoing as plain text
// Strip all formatting from comments

replica.comments = entity.comments.findAll { !it.internal }.each {
    it.body = nodeHelper.stripHtml(nodeHelper.convertXurrentToHtml(it.body))
}

Incoming Sync (Other System → Xurrent)

From Jira (Wiki format)

// Incoming Processor - From Jira
// Convert Jira Wiki comments to Xurrent format

replica.comments.each {
    it.body = nodeHelper.convertWikiToXurrent(it.body)
}
entity.comments = commentHelper.mergeComments(issue, replica)

From ADO (HTML format)

// Incoming Processor - From Zendesk or ServiceNow
// Convert HTML comments to Xurrent format

replica.comments.each {
    it.body = nodeHelper.convertHtmlToXurrent(it.body)
}
entity.comments = commentHelper.mergeComments(issue, replica)

Syncing Rich Text Custom Fields

// Data Filter - Outgoing
// Convert a rich text custom field to Wiki format
def richText = entity.customFields."My Rich Text Field"?.value
if (richText) {
    replica.customKeys."rich_text_converted" = nodeHelper.convertXurrentToWiki(richText)
}

// Data Filter - Outgoing
def richText = entity.customFields."My Rich Text Field"?.value
if (richText) {
    replica.customKeys."rich_text_converted" = nodeHelper.convertXurrentToHtml(richText)
}

// Incoming Processor
// Convert the Jira description (Wiki format) into a Xurrent rich text custom field
entity.customFields."Custom Rich Text"?.value = nodeHelper.convertWikiToXurrent(replica.description)

// Incoming Processor
entity.customFields."Custom Rich Text"?.value = nodeHelper.convertHtmlToXurrent(replica.description)