- 1. Overview
- 2. Process Functions
- 3. Task Functions
- 4. Dynaform and Field Functions
- 5. Case Functions
- 6. Case Routing Functions
- 7. Case Notes Functions
- 8. User Functions
- 9. Group Functions
- 10. Email Functions
- 11. Document Functions
- 12. Unique ID Functions
- 13. Date Functions
- 14. String Functions
- 15. Database Functions
- 16. Grid Functions
- string RegEx: (Optional) A regular expression used to search for groups by their name. If this parameter is not included, all the groups are returned.
An array of groups, with the following structure:
If no group is found, an empty array is returned.
- string guid: The unique ID of a group.
- string name: The name of a group.
$array = PMFGroupList();Returns all the groups in the current workspace.
$array = PMFGroupList('(Ad)+')Returns all groups starting with "Ad".
$array = PMFGroupList('', 3, 4);Returns all groups from the third register and the following 4 items.
$array = PMFGroupList('(Ad)+', 2, 5);Returns all groups starting with Ad, but this time from the second register and the following 5 items.
PMFGetGroupUID() retrieves the unique ID of a group using the group name.
- string groupName: The name of the group.
- string: The function returns the unique ID of the group.
The returned value stored in
@@groupUID will be
PMFGetGroupName() retrieves the name of a group using the unique ID of the group and given language.
- string groupUID: The unique ID of the group, which can be found in the following ways:
- string Language: Optional parameter. The language in which the group name will be retrieved. If not specified then the default system language is used.
Note: Please take into account that returned values directly depend on the current data stored in the wf_<WORKSPACE>.CONTENT table, and more specifically records related to group titles
(CON_CATEGORY = GRP_TITLE).
- string: The function returns the name of the group.
The returned value stored in
@@groupName will be
PMFGetGroupUsers() retrieves the users who are part in a Group.
- string groupUID: The unique ID of a group, which can be found in the following ways:
An array of associative arrays; each one of these arrays contains information about each user included in the group. The array has the following structure:
@@UsersList will obtain all the information about the users of the group. The return value will show:
PMFAssignUserToGroup() assigns a user to a group. Note that the logged-in user must have the PM_USERS permission in his/her role to be able to assign a user to a group.
- string userUID: The unique ID of the user.
- string groupUID: The unique ID of the group.
Returns 1 if the user was successfully assigned to the group; otherwise, returns 0 if an error occurred.
$var = PMFAssignUserToGroup(@@USER_LOGGED, $GroupUID);
if($var == 0)
@@text = "It was not assigned";
@@text = "It was assigned";
$GroupUID: The ID of the employee group.
@@USER_LOGGED: This is the ID of the user logged in.
$var: This function returns 1 if the user was successfully assigned and 0 if not, and will store the return value to confirm the assignation.
PMFRemoveUsersFromGroup() removes users from a group. Take into consideration that only roles with the PM_USERS permission will be able to use this function.
- string groupUID: The unique ID of the group from which the users will be removed. This parameter can be found in the following ways:
- array usersUID: An array of the unique IDs of the users who are going to be removed from the group.
Returns 1 if the user/group was assigned successfully; otherwise, returns 0 if an error occurred.