We're updating some of our product names. K2 Five is now Nintex Automation. You may see both product names in our help pages while we make this change.
Sync Service SmartObjects
Use the Sync Service SmartObjects to interact with the identity synchronization (sync) service in K2. K2 recommends that you do not modify these SmartObjects in any way as these are system SmartObjects and may be updated in a future release.
Use the methods of the Run History SmartObject to see sync histories by either date range or status
Properties
Name
Type
Example
Notes
RunHistoryEntryId
Number
Unique number auto-assigned to each entry
ProviderInstanceID
Number
1
Unique number auto-assigned to each instance
ProviderInstanceName
Text
Denallix
The domain in an Active Directory environments
ProviderName
Text
K2
Providers are identified by the security label, for example "K2" is Active Directory
RunStatus
Text
1, 2, or 3
Shows the outcome of the sync that ran (synchronizing, complete, failed)
SyncStart
DateTime
2018-10-01T11:00:01
The date and time when the sync started. YYYY-MM-DD HH:MM:SS
SyncEnd
DateTime
2018-10-01T11:00:01
The date and time when the sync ended. YYYY-MM-DD HH:MM:SS
IdentityCount
Number
15000
Membership count
LinkCount
Number
15000
Links are relationships between identities. Group membership is considered a link as well as manager-direct report relationships. This count represents the number of group membership and manager-direct report relationships which are included in this sync instance. This number provides some insight into the complexity of your environment.
PropertyCount
Number
The number of user and group properties changes (for example, a change in user or group name) included in this sync run.
Methods
Method
Description
Properties
Get Run History Entries By Date Range
Retrieve a list of syncs in a date range
Provider Name
Provider Instance Name
Sync Start
Sync End
Get Run History Entries By Status
Retrieve a list of syncs based on the status: Synchronizing, Complete, Failed