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. Open Process Builder.

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


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

    Open SharePoint tab
  3. On the SharePoint tab, drag the New Site activity onto your process.

    Drag New Site activity

General Configuration

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

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts 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

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts 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 NameDefinition

SharePoint

Description:
Specifies the access token that connects to your SharePoint site.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts 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:

Relative Site URL

Description:
Specifies the URL for your SharePoint site.
Allowed Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Variables:
Yes
Example:

Site Title

Description:
Specifies the title for the new SharePoint site or site collection.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Accepts Variables:
Yes

Locale

Description:
Specifies the locale for the new SharePoint site.

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

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

Site Template

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

Convert If There

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

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

Overwrite the Site

Description:
Specifies if the activity overwrites the site if it already exists at the location where the new site is to be created.
Allowed 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

Description:
Specifies the process data variable that stores the full site URL which includes the sub site.
Allowed Values:
A variable.

Format:

  • String

Accepted:

  • URL
Default Value:
None
Accepts 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?