New Site Collection activity

An activity that creates a SharePoint site collection.


New Site Collection activity

Configure the New Site Collection activity

To configure the New Site Collection 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 New Site Collection activity onto your process.

    Drag New Site Collection activity

General Configuration

Specifies the basic settings for the New Site Collection 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

New Site Collection Configuration

Specifies the details for your SharePoint site collection.

Figure: New Site Collection Configuration screen

New Site Collection Configuration screen

Fields

Field Name Definition

Central Administration URL

Function:
Specifies the URL of the SharePoint central administration site. Using this site, you can control and manage all SharePoint sites.
Accepted Values:
A valid SharePoint central administration site URL.
Default Value:
None
Accepts Process Data Variables:
No

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:

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:
Limitations:
  • OAuth 2.0 authentication is not supported for this activity.

Locale

Function:
Specifies the locale for the new SharePoint site.

A locale identifies the language used in a particular region or country .

Accepted Values:
A list of locales.
Default Value:
English (United States)
Accepts Process Data Variables:
No

Site Collection Template

Function:
Specifies the name of the SharePoint site template that is used to create the new SharePoint site or site collection.
Accepted Values:
The name of a SharePoint site template.
Default Value:
Team Site
Accepts Process Data Variables:
No

Relative Site URL

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

Site Title

Function:
Specifies the title for the new SharePoint site or site collection.
Accepted Values:
One line of text with no spaces.
Default Value:
None
Accepts Process Data Variables:
Yes

Overwrite Site

Function:
Specifies if the activity overwrites the site if it already exists at the location where the new site is to be created.
Accepted Values:
  • Deselected - The activity does not overwrite an existing SharePoint site.
    Note: If you specify False when a site or site collection already exists, then SharePoint does not change. The process stops the activity and updates the process variables specified in the SaveErrorMessageTo and SaveStatusTo properties.
  • Selected - The activity overwrites an existing SharePoint site.
Default Value:
Deselected

Store Site Collection URL in Process Attribute

Function:
Specifies the process data variable that stores the site collection URL.
Accepted Values:
A process data variable that accepts a URL.
Default Value:
None
Accepts Process Data Variables:
Yes

New Site Collection Owner Information Configuration

Specifies the owner details for your SharePoint site collection.

Figure: New Site Collection Owner Information Configuration screen

New Site Collection Owner Information Configuration screen

Fields

Field Name Definition

Owner Login ID

Function:
Specifies the user name of the owner of the SharePoint site collection.
Accepted Values:
A user name, with the domain name, in this format:

[domain]\[user name]

Default Value:
None
Accepts Process Data Variables:
Yes
Example:
MyDomain\Administrator

Owner Email ID

Function:
Specifies the e-mail address of the owner of the SharePoint site collection.
Accepted Values:
A text string in email address format.
Default Value:
None
Accepts Process Data Variables:
Yes

Owner Display Name

Function:
Specifies the name to show for the owner of the SharePoint site collection.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
Yes