Check Out File activity

An activity that checks a file out from SharePoint.


Check Out File activity

Configure the Check Out File activity

To configure the Check Out File 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 Check Out File Check Out File icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Check Out File 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

Check Out File Configuration

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

Figure: Check Out File Configuration screen

Check Out File 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:

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:

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