Add Role

API Type

Web Services

Description

Creates a role in AgilePoint NX, and specifies the access right for the users assigned to the role.

Syntax

public virtual WFRole AddRole(String RoleName, String Description, int[] Rights, bool Enabled)

Parameters

Name	Description
RoleName	Function: The name of a role. Type string Accepted Values: A valid role name.
Description	Function: A description of an entity. Type string Accepted Values: A string that can contain spaces and special characters.
Rights	Function: Specifies the rights that are assigned to the Role. Type WFAccessRights Accepted Values: An array of index values. See the table for appropriate indexes. WFAccessRights provides the enums for rights. See the sample code for more information.
Enabled	Function: Enables or disables an entity. Type bool Accepted Values: True - Enables the entity. False - Disables the entity.

Access Rights

Index	Rights
0	Register and modify the user information
1	Unregister a user
2	Add and modify role information
3	Remove a role
4	Add and modify group information
5	Remove a group
6	Modify and view system information
7	Add a process definition
8	Check in and check out a process definition
9	Delete or disable a process definition
10	Release a process definition
11	Initiate a process
12	Suspend and resume a process
13	Resend and cancel an email notification
14	Cancel a process
15	Rollback a process
16	Reassign a task
17	Cancel a task
18	Create a task
19	Add, remove and modify delegation
20	Add, remove and modify report configuration
21	Achieve and restore processes
22	Add, remove and modify shared custom attributes
23	View process details

Output

WFRole object for the role that is added.

Example

IWFAdminService svc = GetAdminService();
string RoleName = ...// for example, "Process Manager";
string Description = ...;
/*integer array specifying the access rights for this role.
* 11 - Initiate a process
* 14 - Cancel a process
* 23 - view process details
*/
int[] Rights = 
    {
    WFAccessRights.InitiateProcessInstance,
    WFAccessRights.CancelProcessInstance,
    WFAccessRights.ViewProcessDetails
	};

try
	{
    WFRole role = svc.AddRole(RoleName, Description, Rights, True);
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.