Check Out File activity

An activity that checks a file out from SharePoint.

Configure the Check Out File activity

To configure the Check Out File activity, do the procedure in this topic.

Examples

(Example) Create a SharePoint Access Token

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, and open the SharePoint tab.
On the SharePoint tab, drag the Check Out File activity onto your process.

General Configuration

Specifies the basic settings for the Check Out File activity.

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

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:

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

Check Out File Configuration

Specifies how to configure the activity to check out files from SharePoint.

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: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List (External) Form Based Apps – SharePoint Data Source (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
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: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
Library	Function: Specifies the name of the SharePoint library. Accepted Values: A valid SharePoint library name. Default Value: None Accepts Process Data Variables: Yes
Folder	Function: Specifies the name of your SharePoint folder. Accepted Values: The name of your SharePoint folder If the folder does not exist within the specified SharePoint list, the AgilePoint system creates it. Default Value: None Accepts Process Data Variables: Yes
File Name	Function: The name of your file. Accepted Values: A valid file name. Default Value: ${DocName} Accepts Process Data Variables: Yes
If File Is Already Checked Out	Function: Specifies what to do if the file is already checked out. Accepted Values: Complete Activity - Completes the Check Out activity and continues the process. Suspend Process - Suspends (stops) the process. Default Value: None Accepts Process Data Variables: No
Check Out To Local	Function: Specifies if a file can be checked out from a SharePoint document library to your computer. Accepted Values: Deselected - A draft copy of the file is stored on the server. This specifies that you can access the SharePoint file over the Internet. Selected - A copy of the file is checked out on your computer's hard drive. Thus, you can work on the file on your computer. Default Value: Deselected