Standard SmartObjects: Workflow Task Allocation

You can use the Workflow Task Allocation SmartObjects to perform recipient assignment operations in a user task. For example, you can use the Round Robin SmartObject (RoundRobinSO) to allocate tasks for a defined set of users, so that a task is assigned to one user in the group, the next task is assigned to the next user in the group, and so on.

The tables below display the methods and properties returned byof workflow task allocation SmartObjects. Note that not all properties are returned for all methods.

Task Allocation SmartObjects

RoundRobinSO

This SmartObject is used internally by the Get Round Robin method of the TaskAllocationRoleMethods SmartObject.

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
Create
  • RoleName (Text)
  • LastDateTime (DateTime)
  • LastUserName (Text)
  • None
 Adds an entry to the RoundRobin table.
Delete
  • RoleName (Text)
  • None
  • None
 Removes an entry to the RoundRobin table.
Get List
  • None
  • LastDateTime (DateTime)
  • LastUserName (Text)
  • RoleName (Text)
  • LastDateTime
  • LastUserName
  • RoleName
 Retrieves a list of items from the Round Robin table.
Load
  • RoleName (Text)
  • None
  • LastDateTime
  • LastUserName
  • RoleName
 Reads a specific item from the Round Robin table.
Save
  • RoleName (Text)
  • LastDateTime (DateTime)
  • LastUserName (Text)
  • None
 Updates or creates an item in the round robin table.

Properties

Name Type Example Notes
LastDateTime Text 2020-01-02T00:00:00 Returns the value from the SmartObject record queried in a date and time format. If there is no value in the SmartObject record, this property is empty.
LastUserName Text Smith, Roberts Returns the value from the SmartObject record queried. If there is no value in the SmartObject record, this property is empty.
RoleName Text Finance, Documentation Returns the value from the SmartObject record queried. This is also the required input property.

TaskAllocationADMethods

Use this SmartObject to determine Managers or Direct Reports for a user.

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
Get Direct Reports
  • User Name (Text)
  • None
  • User Name
 Returns the users who report directly to this person.
Get Manager
  • User Name (Text)
  • None
  • Manager Name
 Returns the direct manager of this person.

Properties

Name Type Example Notes
ManagerName Text John Smith Manager's display name.
UserName Text K2:Denallix\Administrator User's account name.

TaskAllocationRoleMethods

Use this SmartObject to return user names for use when allocating tasks in different ways, such as round-robin, least work, most work, fastest user, and slowest User.

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
Get Fastest User
  • Maximum Time (Number)
  • Minimum Time (Number)
  • Role Name (Text)
  • None
  • User Name
 Returns the user who completes their work the fastest.
Get Least Work
  • Role Name (Text)
  • None
  • User Name
 Returns the user with the least amount of tasks.
Get Most Work
  • Role Name (Text)
  • None
  • User Name
 Returns the user with the most tasks.
Get Role Peers
  • Role Name (Text)
  • User Name (Text)
  • None
  • User Name
 Returns the peers of the current user for the specified role.
Get Round Robin
  • Role Name (Text)
  • None
  • User Name
 Returns the next user in a round-robin task allocation scenario.
Get Slowest User
  • Maximum Time (Number)
  • Minimum Time (Number)
  • Role Name (Text)
  • None
  • User Name
 Returns the user who completes their work the slowest.

Properties

Name Type Example Notes
MaxTime Number 1, 2, 3  
MinTime Number 1, 2, 3  
RoleName Text Finance, Everyone Existing role name.
UserName Text K2:Denallix\Administrator User's account name.

Users and Groups

Use this SmartObject to retrieve details about specific groups or users.

Methods

Method Required Input Properties Optional Input Properties Returned Properties Notes
Get Email For Group
  • Group Fully Qualified Name (Text)
  • None
  • Description
  • Display Name
  • E-Mail
  • Name
 Returns details for a specific group.
Get Email For Group Users
  • Group Fully Qualified Name (Text)
  • User Provider Label (Text)
  • Description (Text)
  • E-mail (Text)
  • Manager (Text)
  • Name (Text)
  • Description
  • Display Name
  • E-Mail
  • Fully Qualified Name
  • Manager
  • Name
  • SIP Account
  • User Name
 Returns details for users in a group.
Get Email For Role Users
  • Role Name (Text)
  • None
  • Description
  • Display Name
  • E-Mail
  • Fully Qualified Name
  • Manager
  • Name
  • SIP Account
  • User Name
 Returns details for users in a role.
Get Email For User
  • User Fully Qualified Name (Text)
  • None
  • Description
  • Display Name
  • E-Mail
  • Manager
  • Name
  • SIP Account
  • User Name
 Returns details for a specific user.

Properties

Name Type Example Notes
Description Text Finance group for approving travel requests.  
Display Name Text Denallix\Finance or Denallix Administrator Group account name or display name, depending on the method executed.
E-mail Text Finance@denallix.com Group email address.
Fully Qualified Name Text K2:Denallix\Administrator User's account name including provider label.
Manager Text Denallix\Administrator Manager's account name.
Name Text Denallix\Finance Group account name.
SIP Account Text    
User Name Text Denallix\Administrator User's account name.