Set Permission activity

An activity that sets the permissions for a SharePoint site, site collection, lists, or library.


Set Permission activity

Configure the Set Permission activity

To configure the Set Permission activity, do the procedure in this topic.

Examples

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In the Process Builder, in the Activity Library, and open the SharePoint tab.

    Open SharePoint tab
  3. On the SharePoint tab, drag the Set Permission activity onto your process.

    Drag Set Permission activity

General Configuration

Specifies the basic settings for the Set Permission activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Set Permission

Specifies how to configure the activity to set permissions in SharePoint.

Figure: Set Permission screen

Set Permission screen

Fields

Field Name Definition

SharePoint

Function:
Specifies the access token that connects to your SharePoint site.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Token for SharePoint
Function of this Screen:
Configure an access token to connect to SharePoint.
Example:
Refer to:

Set Permission for

Function:
Specifies the item for which to set the permissions.
Accepted Values:
  • Site Collection
  • Site
  • List/Library
  • List Item
Default Value:
Site Collection
Accepts Process Data Variables:
No

Site

Function:
Specifies the URL for your SharePoint site.
Accepted Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:

List

Function:
Specifies the name of the SharePoint library or list.
To Open this Field:
  1. Select List/Library or List Item.
Accepted Values:
A valid SharePoint library name or list name.
Default Value:
None
Accepts Process Data Variables:
Yes

List Item ID

Function:
Specifies the ID of a SharePoint list item.
To Open this Field:
  1. Select List Item.
Accepted Values:
The ID of your SharePoint list item.
Default Value:
${ListItemID}
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

User / Group Configuration

Specifies the users and groups to set the permissions.

Figure: User / Group Configuration screen

User or Group Configuration screen

Fields

Field Name Definition

Permission Type list

Function:
Specifies a category of participants to add the permission.
Accepted Values:
  • Site Collection Groups - Shows your SharePoint site collection groups.

    To create a group, refer to Create a Group.

  • Site Collection Users - Shows your SharePoint site collection users.

    To add a new user, refer to Add a New User.

  • Site Groups - Shows your SharePoint site groups.

    To create a group, refer to Create a Group.

  • Site Users - Shows your SharePoint site users.

    To add a new user, refer to Add a New User.

Default Value:
Site Collection Groups
Accepts Process Data Variables:
No

Search

Function:
Does a search based on the specified criteria.

Details

Function:
Specifies the users or groups for whom to set permissions.
Accepted Values:
A list of users or groups.
Default Value:
None
Accepts Process Data Variables:
Yes

Permission Levels

Specifies the permissions to set for the selected users and groups.

Figure: Permission Levels screen

Permission Levels screen

Fields

Field Name Definition

Permission Level

Function:
Specifies the permission level for the SharePoint resource.
Accepted Values:
One or more permissions from the list.

When you select the access token from the SharePoint field on the Set Permission screen, this field shows the permissions associated with the access token.

Default Value:
None
Accepts Process Data Variables:
No

Description

Function:
Specifies the description for the permission levels.
Accepted Values:
A list of descriptions for the permission levels
Default Value:
Read only.
Accepts Process Data Variables:
No