SharePoint Online - Create a document set

Use the SharePoint Online - Create a document set action A tool for building the processes, logic, and direction within workflows. to create a new document set in a document library of a SharePoint Online site.

For more information about the SharePoint Online connector, go to SharePoint Online.

Before you begin: 

Jump to:

Configure the SharePoint Online - Create a document set action

Important: Before inserting variables in the action configuration, you must manually type or select the values and populate other dependent fields in order to retrieve the output data. Once configured, you can insert variables to the required fields.

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add, rename, and copy actions.

  1. Select a Connection. If you do not have a connection, see Add a connection.
    2. Note: 

    Only the connections created with the List and libraries authentication method are available in the drop-down list.

    For more information about authentication methods for SharePoint Online connections, see Authentication methods for SharePoint Online connections.

  1. Type a SharePoint site URL and click Retrieve libraries.

    2. Example: https://domain.sharepoint.com/sites/hr

    All the libraries in the specified site are displayed in the Document library field drop-down list.

  1. Select the Document library to create the document set. The Add field button is enabled to enter values for the columns/fields of the created item document set. If the selected list has mandatory columns they are displayed by default to enter a value.
  2. Select the Content type of the document set.
  3. Specify values for the mandatory fields/columns that are displayed.

SharePoint Online - Create document set action fields and settings

Important: Before inserting variables in the action configuration, you must manually type or select the values and populate other dependent fields in order to retrieve the output data. Once configured, you can insert variables to the required fields.

Section Field Description Variable types
(unlabeled)

Connection Credentials and other settings required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.

SharePoint Online connection to connect to the SharePoint Online site.

To refresh the available connections, click Refresh.

 (n/a)
New document set

SharePoint site URL

The URL of the SharePoint Online site containing the document library you want to use.

To retrieve the libraries for the SharePoint site URL, type the SharePoint site URL and click Retrieve libraries.

Example: https://domain.sharepoint.com/sites/hr

 Text, Decimal, Integer, Boolean, DateTime, Collection
  Document library

The document library to create the document set.

When you specify the SharePoint Online site URL, all the document libraries in the selected site will be available to select from in the Document library drop-down list.

The Add fields button is displayed when the Document library is selected.

 Text, Decimal, Integer, Boolean, DateTime, Collection
  Folder path

Destination folder or folder path to create the new document set. If the folder does not exist in the specified path, a new folder is created.

Examples: FolderA/SubFolderA

 Boolean, Collection, DateTime, Decimal, Integer, Text
  Content type The SharePoint content type to apply to the document set. Boolean, Collection, DateTime, Decimal, Integer, Text
  Add field

(Displayed only when the Document library is selected.)

Displays selections to select and add columns (fields) that you want to populate for the new document set.

If you want to enter values for fields of the new document set: 

  1. Click Add fields to view fields for the selected list.
  2. Select each field you want and then click Add.

    3. or

    Click Select all to add all the fields.

  1. For each added field, specify the value you want.

See Valid values for added fields, by column type

The selected columns of the document set will be updated with these values.

The values you enter must meet SharePoint Online formatting requirements for the related column type. See, Valid values for added fields, by column type.

Selection

Description

Filter options ()

Type in text to filter the list of fields.

Select all

Selects all fields.

Cancel

Discards field selections and hides the fields available for selection.

Add

Adds the selected fields.

The fields you add are displayed for you to enter the value. The document is created in the document library with these values populated.

 (n/a)
Output Result

Stores the result of the action in an object with the following variables:

  • Document set ID: Integer variable to store the ID of the created document set.
  • Document set URL: Text variable to store the URL of the created document set.
 Object

The values you enter for the added fields must meet the following formatting requirements:

Column type (SharePoint Online) Value entry guidance (Nintex Automation Cloud)

Choice

<choice 1>

Example: Blue

Supported variable A placeholder that stores changes each time the workflow runs, such as the information entered in a form, or the name of a file. You can also create variables to store information you use in the workflow, such as an email address. types: Text

Note: Multiple-selection columns cannot be updated using the action Update an item. That is, Choice type SharePoint columns configured with the "Checkboxes (allow multiple selections)" option for "Display choices using" setting, cannot be updated.

Single value only. New columns are configured with the "Display choices using" option of "Drop-down Menu."

Currency

<decimal value>

Example: 25.50

Supported variable types: Decimal

Date and Time

<date or date/time>

Example: 20170602

Supported variable types: DateTime

For updates to date-only columns, removes time.
Hyperlink or Picture

<URL>,<description>

Example: https://www.nintex.com,Nintex

Supported variable types: Text

Lookup

<ID of list item in selected list>

Example: 1

Supported variable types: Integer
Managed Metadata

<unique identifier of the term in the term store>

Example: 883f304208f84f78bbe6d48d7e34c494

Supported variable types: Text

Multiple lines of text

<text and/or HTML>

Example: <b>ACME</b> invoice

OR

ACME invoice

(HTML is supported when "Enhanced rich text" is enabled for the SharePoint column.)

Supported variable types: Text

Number

<integer>

Example: 1

Supported variable types: Integer

Person or Group

<person or group ID>; <person or group ID>

Example: 1;2

Supported variable types: Integer

Single line of text

<text>

Example: ACME Invoice

Supported variable types: Text

Task Outcome

<choice 1>

Example: Approved

Supported variable types: Text

Single value only. Typically used to update task lists.

Yes/No

<true/false>

Example: True

Supported variable types: Boolean

For more information about column types, see List and library column types (Microsoft article).