How to sync User Fields in Xurrent

This article describes how to synchronize member, requested for and requested by information between Xurrent and other systems.

We can consider member as an Assignee in Xurrent and Requested by as a Reporter. Member/Assignee belongs to the team so if you want to set the member field of Request you also need to set team field of Request.

Outgoing sync (Xurrent → Remote system)

To send assignee, reporter and requested for information from Xurrent to the remote system:

replica.assignee = entity.assignee
replica.reporter = entity.reporter
replica.requested_for = entity.requested_for

Note: If Xurrent proxy user token has limited scopes and permissions, these 3 properties will provide only name and id of person. In case if you want to send the email id of the person you need to provide Person — Read permission/scope to the token.

Read here more about required permissions or scopes: Xurrent Personal Access Required Token Permissions or Scopes

Incoming sync (Remote system → Xurrent)

There are 2 ways to set the user fields in Xurrent:

1. By providing person id directly: Provide internal id of the person, ask your admin to provide that.

2. By searching email of the person: Provide email to nodeHelper's getUserByEmail method.

Note: To use getUserByEmail, the proxy user Personal Access Token should have Person — Read permission/scope.

// OPTION 1: By providing direct person id
entity.memberId = 12345
entity.requestedById =  5027436
entity.requestedForId =  5027436

// OPTION 2: By searching person's email and set 
entity.assignee = nodeHelper.getUserByEmail("abc@demo.com")
entity.reporter = nodeHelper.getUserByEmail("abc@demo.com")
entity.requested_for = nodeHelper.getUserByEmail("abc@demo.com")

Important: To set assignee, it is mandatory to set team as well. Exalate will check if provided member is part of the provided team or not, and if not the exception/error will be thrown.

Read here more about how to set team field : How to sync Team Field in Xurrent

More information

Have more questions? Ask the community

Outgoing sync (Xurrent → Remote system)

Incoming sync (Remote system → Xurrent)

More information

Related Articles