New Site activity

An activity that creates a SharePoint site.


New Site activity

Configure the New Site activity

To configure the New Site activity, do the procedure in this topic.

Examples

Good to Know

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, go to the Activity Library, and open the SharePoint SharePoint icon tab.
      2. On the SharePoint SharePoint icon tab, drag the New Site New Site icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the New Site activity.

Figure: General Configuration screen

General Configuration screen

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

SharePoint New Site Configuration

Specifies how to create a new SharePoint site.

Figure: SharePoint New Site Configuration screen

SharePoint New Site Configuration 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:

Add Token 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:

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

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 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

Convert If There

Function:
Specifies if the activity converts an existing site of the same name to a new SharePoint site.
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

Inherit Permissions from the Parent Site

Function:
Specifies if the sub site can inherit permissions from the parent site.
Accepted Values:
  • Selected - The site inherits permissions from the parent site.
  • Deselected - The site uses unique permissions.
Default Value:
Deselected

Overwrite the 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 URL in Process Attribute

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

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?