SharePoint - End Session

 

Declaration

<AMSHAREPOINT ACTIVITY="end_session" SESSION="text" />

See Also

SharePoint - Get Attachments | SharePoint - Get Files | SharePoint - Get Folder(s) | SharePoint - Get Groups | SharePoint - Get List Items | SharePoint - Get Lists | SharePoint - Get Roles | SharePoint - Get Sites | SharePoint - Get Users | SharePoint - Move File | SharePoint - Remove from Role | SharePoint - Remove List Item | SharePoint - Remove User from Group | SharePoint - Rename Folder | SharePoint - Update List | SharePoint - Update List Item | SharePoint - Update Role | SharePoint - Update Site | SharePoint - Upload File

Description

Ends a session previously created using the Create Session activity.

IMPORTANT: The SharePoint activities are performed using SharePoint Client Object Model/Web Services. Therefore, you must have SharePoint Server 2003/2007/2010 installed in order for these activities to work. Additionally, certain activities or parameters are only supported in SharePoint Server 2010. Support details are highlighted in the properties of relevant activities.

Practical Usage

SharePoint operations must be linked to a specific session. This activity is often used at the end of a task to end a specific session after all operations have been completed.

Parameters

Server Properties

Property

Type

Required

Default

Markup

Description

Session

Text

Yes

SharePointSession1

SESSION="mySession1"

The session name end. Multiple sessions can exist within a single task allowing several SharePoint operations to be automated simultaneously.

NOTE: Use the Create Session activity to create a new session.

 

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties allows you to instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables and Functions

All text fields allow the use of expressions such as variables, functions or AutoMate extended functions, which can be entered by surrounding the expression in percentage signs (example: %FileDateTime(myVar)% or %myVar%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on function

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: End sharepoint session "mySharePointSession".

 

<AMSHAREPOINT ACTIVITY="end_session" SESSION="mySharePointSession" />

 

↑ Top of Page