The SharePoint activities are performed using SharePoint Client Object Model/Web Services. Therefore, you must have SharePoint Server 2003/2007/2010 installed for these activities to work.
Microsoft SharePoint collaboration software is emerging as one of the more powerful tools for companies that need to design and implement enterprise-scale solutions to meet business-critical needs such as managing content, administering business processes and streamlining how people find and share information across the network. The SharePoint system is composed of a full range of applications and tools that allow document management, workflow design and collaboration, which helps teams stay connected and productive by providing easy access to the people, documents, and information that can help in decision making and getting work done. With the use of AWE's SharePoint activities, organizations have the power to automate the creation, management, and implementation of SharePoint sites that are discoverable throughout the organization. By further streamlining and automating SharePoint processes, a company's resources can be allocated to other areas, which can lead to reduced costs and greater operational efficiency.
See Also: Twitter, Services, Exchange, FTP, HTTP, MSMQ
|
|
The SharePoint activities are performed using SharePoint Client Object Model/Web Services. Therefore, you must have SharePoint Server 2003/2007/2010 installed for these activities to work. |
In the Activity to perform box, select an activity, then configure the properties for that activity. The available properties depend on the activity selected.
To set properties
In the Available Actions pane, open the Network folder and double-click the SharePoint action or drag it into the Steps pane.
On the Properties tab, select an Activity to perform.
Specify the properties that appear, depending on the activity selected.
To set the Description tab properties, refer to Description Tab Options.
To set the Error Causes and On Error tab properties, refer to Step Error Handling.
When finished, click OK to save settings and close the properties dialog box.
Available Activities
The following table briefly describes the available activities for this action as specified in the Activity to perform box.
|
Activity |
Description |
Declaration |
Examples |
|
Add Attachment |
Adds an attachment to the specified SharePoint list. |
<AMSHAREPOINT ACTIVITY="add_attachment" TITLE="text" ID="text" ATTACHMENT="text" OVERWRITE="yes/no" PROVIDER="text (options)" /> |
Add Sharepoint attachment "C:\Temp\attachment_file.txt" to item id "item_id" in list "the_List". Session is "SharePointSession1".
<AMSHAREPOINT ACTIVITY="add_attachment" TITLE="the_List" ID="item_id" ATTACHMENT="C:\Temp\attachment_file.txt" OVERWRITE="yes" PROVIDER="session_based" /> |
|
Add List Item |
Adds an item to an existing list on a SharePoint Services site. Lists usually appear in a multi-column/multi-row table of information which are basic buildings blocks of Web pages on a Windows SharePoint Services site. The columns represent lists and the rows represent items in those lists. If the specified list (column) does not exist, it will be created during runtime along with its associated value. If the column already exists, the specified value will be added to the next available row in that column. A Microsoft Windows SharePoint Services site can include a variety of lists — from contacts and calendars to announcements and issue-tracking lists. This activity is commonly used to add items to such lists. To create a new list, use the Create List activity. |
<AMSHAREPOINT ACTIVITY="add_listitem" LIST="text (options)" SITE="text" AUTHTYPE="text (options)" USERNAME="text" PASSWORD="text (encrypted)" DOMAIN="text" IGNOREINVALIDCERTIFICATE="yes/no" CERTIFICATE="text" TIMEOUT="number" PROXYTYPE="text (options)" PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" PROXYPASSWORD="text (encrypted)"><SharePointCellData Name="text" Value="text" /><SharePointCellData /></AMSHAREPOINT> |
Add an item to Sharepoint list "myList". Session is "SharePointSession1".
<AMSHAREPOINT ACTIVITY="add_listitem" LIST="myList" PROVIDER="session_based"><SharePointCellData Name="Contacts" Value="David" /></AMSHAREPOINT>
|
|
Add to Role (Permission Level) |
Adds the user to the specified role definition. This activity is only supported in SharePoint Server 2010. |
<AMSHAREPOINT ACTIVITY="add_to_role" NAME="text" ID="text" SITE="text" IGNOREINVALIDCERTIFICATE="yes/no" CERTIFICATE="text" TIMEOUT="number" /> |
Example 1 - Adding a group to a role assignment. <AMSHAREPOINT ACTIVITY="add_to_role" NAME="Developer Role" ID="14" PROVIDER="session_based" SESSION="mySession" /> Example 2 - Adding a user to a role assignment. <AMSHAREPOINT ACTIVITY="add_to_role" NAME="User Role" LOGIN="WINSERV0082D\the_User_Name" PROVIDER="session_based" /> |
|
Add User to Group |
Adds a user to the specified group. |
<AMSHAREPOINT ACTIVITY="add_user" ID="text" TITLE="text" LOGIN="text" EMAIL="text" PROVIDER="session_based" /> |
Add user "Senior Tech" to group with id "15". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="add_user" ID="15" TITLE="Senior Tech" LOGIN="PeterParker" EMAIL="peterparker@dailybugle.com" PROVIDER="session_based" /> |
|
Check In |
Checks in a document. Checking documents in and out allows users to obtain exclusive write access to a document, eliminating the need to merge changes from multiple authors. When a user checks a document out, that user is the only user who can save changes to the document. Other users can read the document, but they cannot make changes. The user who has the document checked out can update the document, and see the latest version of the document, but other users will not see the updates until the document has been checked back in. |
<AMSHAREPOINT ACTIVITY="checkin" SOURCE="text" URL="text" COMMENT="text" CHECKINTYPE="OverwriteCheckIn" PROVIDER="text (options)" /> |
|
|
Check Out |
Checks out a document. Checking documents in and out allows users to obtain exclusive write access to a document, eliminating the need to merge changes from multiple authors. When a user checks a document out, that user is the only user who can save changes to the document. Other users can read the document, but they cannot make changes. The user who has the document checked out can update the document, and see the latest version of the document, but other users will not see the updates until the document has been checked back in. If you want to make changes to a file that resides in a SharePoint library, the safest way to do it is to check the file out. |
<AMSHAREPOINT ACTIVITY="checkout" URL="text" PROVIDER="text (options)" /> |
Check out file "/my/Shared Documents/install.log". Session is "SharePointSession1".
<AMSHAREPOINT ACTIVITY="checkout" URL="/my/Shared Documents/install.log" PROVIDER="session_based" />
|
|
Copy File (Document) |
Copies a file from the source URL to the destination URL. Used to copy a file from one SharePoint location to another. |
<AMSHAREPOINT ACTIVITY="copy_file" URL="text" DESTINATION="text" OVERWRITE="yes/no" PROVIDER="text (options)" /> |
Copy file "/my/Shared Documents/install.log" to "/my/SharedDocuments/wow/install.log". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="copy_file" URL="/my/Shared Documents/install.log" DESTINATION="/my/Shared Documents/wow/install.log" OVERWRITE="yes" PROVIDER="session_based" /> |
|
Create Folder |
Creates a folder in an existing document library. |
<AMSHAREPOINT ACTIVITY="create_folder" LIBRARY="text" FOLDER="text" URL="text" PROVIDER="text (options)" /> |
Create folder "folder_name" in library "library_name". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="create_folder" LIBRARY="library_name" FOLDER="folder_name" URL="http://myServer/folder-name" PROVIDER="session_based" /> |
|
Create Group |
Creates a new group. |
<AMSHAREPOINT ACTIVITY="create_group" TITLE="text" DESC="text" ROLETYPE="text" PROVIDER="session_based" /> |
|
|
Create List |
Creates a new list. A SharePoint list is a collection of similar items. A list contains columns or fields that define the item data or metadata schema. Each item stored in a list shares the same schema. Technically lists also include libraries, but libraries are often seen as separate from lists or at least specialized forms of lists. In lists items are defined by metadata or the columns of a list with documents being attached to that metadata. In a library a document is the item with library metadata supporting the document. Lists in SharePoint resemble database tables in structure and behavior. Lists support various field or data types, and can have triggers that react to list events such as creating, updating or deleting items. In addition lists can be configured to filter, sort or group items based on item data or properties. |
<AMSHAREPOINT ACTIVITY="create_list" LIST="text" DESC="text" QUICKLAUNCH="text (options)" ENABLEATTACHMENTS="yes/no" ENABLEFOLDER="yes/no" ENABLEVERSIONING="yes/no" PROVIDER="text (options)"><ColumnConstruct SchemaXml="text" AddToDefaultView="True/False" /></AMSHAREPOINT> |
Create Sharepoint list "List_Title" of type "Meetings". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="create_list" LIST="List_Title" DESC="Meetings" TEMPLATETYPE="Meetings" QUICKLAUNCH="On" ENABLEATTACHMENTS="yes" ENABLEFOLDER="yes" ENABLEVERSIONING="yes" PROVIDER="session_based"><ColumnConstruct SchemaXml="column1" AddToDefaultView="True" /><ColumnConstruct SchemaXml="column2" AddToDefaultView="False" /></AMSHAREPOINT> |
|
Create Role (Permission Level) |
Creates a new role assignment in which to add items to. This activity is only supported in SharePoint Server 2010. |
<AMSHAREPOINT ACTIVITY="get_roles" RESULTDATASET="text" PROVIDER="text (options)" SESSION="text" /> |
Get Sharepoint role(s) and store information in dataset "myRoleAssignments". Session is "mySharePointSession". <AMSHAREPOINT ACTIVITY="get_roles" RESULTDATASET="myRoleAssignments" PROVIDER="session_based" SESSION="mySharePointSession" /> |
|
Create Session |
Creates a new SharePoint session in which to attach subsequent SharePoint related activities to. This allows multiple sessions to exist within the same task. To end a session, use the End Session activity. |
<AMSHAREPOINT ACTIVITY="create_session" SITE="text" AUTHTYPE="text (options)" USERNAME="text" PASSWORD="text (encrypted)" DOMAIN="text" IGNOREINVALIDCERTIFICATE="yes/no" CERTIFICATE="text" TIMEOUT="number" SESSION="text" /> |
Create Sharepoint session "mySession". Site url is "http://winserv08r2/my/personal/qa". <AMSHAREPOINT ACTIVITY="create_session" SITE="http://winserv08r2/my/personal/qa" SESSION="mySession" /> |
|
Create Site |
Creates a new SharePoint site. SharePoint sites are, functionally, ASP.NET 2.0 web applications that are served using IIS and a SQL Server database as a data storage back end. All site content data, such as items in document libraries and lists, are stored within an SQL database named by default as "WSS_Content_[ID]". |
<AMSHAREPOINT ACTIVITY="create_site" TITLE="text" URL="text" DESC="text" TEMPLATETYPE="text" LANGUAGE="number" USESITEPERMISSION="yes/no" RESULTDATASET="text" PROVIDER="session_based" /> |
Create Sharepoint site "temp" of type "Blog : BLOG#0". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="create_site" TITLE="temp" URL="punam" DESC="it works" TEMPLATETYPE="Blog : BLOG#0" USESITEPERMISSION="yes" RESULTDATASET="test" PROVIDER="session_based" /> |
|
Delete Attachment |
Deletes an existing attachment from the specified SharePoint list. |
<AMSHAREPOINT ACTIVITY="delete_attachment" TITLE="text" ID="text" ATTACHMENT="text" PROVIDER="session_based" /> |
Delete Sharepoint attachment "Attachment_Name" from item id "the list item identifier. " in list "temp". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="delete_attachment" TITLE="temp" ID="the list item identifier. " ATTACHMENT="Attachment_Name" PROVIDER="session_based" /> |
|
Delete File (Document) |
Deletes an existing file or document in a SharePoint library. |
<AMSHAREPOINT ACTIVITY="delete_file" URL="text" PROVIDER="text (options)" /> |
Delete file "SourceURL". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="delete_file" URL="SourceURL" PROVIDER="session_based" /> |
|
Delete Folder |
Deletes a folder in an existing document library. |
<AMSHAREPOINT ACTIVITY="delete_folder" FOLDER="text" PROVIDER="session_based" /> |
Delete folder "myFolder.URL". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="delete_folder" FOLDER="myFolder.URL" PROVIDER="session_based" /> |
|
Delete Group |
Deletes an existing group. |
<AMSHAREPOINT ACTIVITY="delete_group" ID="text" PROVIDER="text (options)" /> |
Delete Sharepoint group whose id is "alphanumeric_value". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="delete_group" ID="alphanumeric_value" PROVIDER="session_based" /> |
|
Delete List |
Deletes an existing list. |
<AMSHAREPOINT ACTIVITY="delete_list" LIST="text" PROVIDER="text (options)" /> |
Delete Sharepoint list "myList". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="delete_list" LIST="myList" PROVIDER="session_based" /> |
|
Delete Role (Permission Level) |
Deletes an existing role. This activity is only supported in SharePoint Server 2010. |
<AMSHAREPOINT ACTIVITY="delete_role" NAME="text" PROVIDER="text (options)" /> |
Delete Sharepoint role "myRole". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="delete_role" NAME="myRole" PROVIDER="session_based" /> |
|
Delete Site |
Deletes an existing SharePoint site. |
<AMSHAREPOINT ACTIVITY="delete_site" URL="text" PROVIDER="text (options)" /> |
Delete Sharepoint site "site.URL". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="delete_site" URL="site.URL" PROVIDER="session_based" /> |
|
Discard Check Out |
Discards an existing check out. If you check out a file and make no changes to it, you can discard the checkout, rather than saving it. If your organization tracks versions, a new version is created each time you check a file back into the library. By discarding the checkout, you can avoid making new versions when you have not made any changes to the file. In some cases, you might make changes that you do not want to keep. Rather than saving the file, you can discard the checkout and thereby lose the changes. |
<AMSHAREPOINT ACTIVITY="discard_checkout" URL="text" PROVIDER="text.(options)" /> |
Discard check out of file "site.URL". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="discard_checkout" URL="site.URL" PROVIDER="session_based" /> |
|
Download attachment |
Downloads an attachment from a list item in a Microsoft Windows SharePoint Service. |
<AMSHAREPOINT ACTIVITY="download_attachment" TITLE="text" ID="text" ATTACHMENT="text" DESTINATION="text" OVERWRITE="yes/no" PROVIDER="text (options)" /> |
Download Sharepoint attachment "myFile.txt" into "C:\Temp\myFile.txt" from item id "item_ID" in list "myList". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="download_attachment" TITLE="myList" ID="item_ID" ATTACHMENT="myFile.txt" DESTINATION="C:\Temp\myFile.txt" OVERWRITE="yes" PROVIDER="session_based" /> |
|
Download File (Document) |
Downloads a file from a SharePoint library. |
<AMSHAREPOINT URL="text" DESTINATION="text" OVERWRITE="yes/no" PROVIDER="text (options)" /> |
Download file "/my/personal/myFile.txt" to "C:\Temp\myFile.txt". Session is "SharePointSession1". <AMSHAREPOINT URL="/my/personal/myFile.txt" DESTINATION="C:\Temp\myFile.txt" OVERWRITE="yes" PROVIDER="session_based" /> |
|
End Session |
Ends a SharePoint session initially created with the use of the Create Session activity. |
<AMSHAREPOINT ACTIVITY="end_session" SESSION="text" /> |
End Sharepoint session "mySharePointSession". <AMSHAREPOINT ACTIVITY="end_session" SESSION="mySharePointSession" /> |
|
Get attachments |
Retrieves attachments from the specified list item and populates a dataset with the results. |
<AMSHAREPOINT ACTIVITY="get_attachments" TITLE="text" ID="text" RESULTDATASET="text" PROVIDER="text (options)" /> |
Get Sharepoint attachments from item id "Item_ID" in list "List_Title" and store information in dataset "dataset_name". Session is "SharePointSession1".. <AMSHAREPOINT ACTIVITY="get_attachments" TITLE="List_Title" ID="Item_ID" RESULTDATASET="dataset_name" PROVIDER="session_based" /> |
|
Get Files (Documents) |
Retrieves files from a SharePoint library. |
<AMSHAREPOINT ACTIVITY="get_files" LIBRARY="text" RESULTDATASET="text" PROVIDER="session_based">text</AMSHAREPOINT> |
Get Sharepoint library "Shared Documents" file(s) and store information in dataset "test". Site url is "http://winserv201/my/personal/files". <AMSHAREPOINT ACTIVITY="get_files" LIBRARY="Shared Documents" RESULTDATASET="test" SITE="http://winserv201/my/personal/files" AUTHTYPE="Basic" USERNAME="administrator" PASSWORD="AM2RzswreJs0SU=aME" DOMAIN="winserv08r2"><Where><Eq><FieldRef Name='Country' /><Value Type='Lookup'>Belgium</Value></Eq></Where></AMSHAREPOINT> |
|
Get Folder(s) |
Retrieves folders from a SharePoint library. |
<AMSHAREPOINT ACTIVITY="get_folders" LIBRARY="text" RESULTDATASET="text" PROVIDER="text (options)" /> |
Get Sharepoint library "myLibrary" folders and store information in dataset "myDataset". Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="get_folders" LIBRARY="myLibrary" RESULTDATASET="myDataset" PROVIDER="session_based" /> |
|
Get Groups |
Retrieves information regarding one or more SharePoint groups and populates a dataset with the results. This activity is only supported in SharePoint Server 2010. |
<AMSHAREPOINT ACTIVITY="get_groups" RESULTDATASET="text" PROVIDER="text (options)" SESSION="text" /> |
Get Sharepoint groups(s) and store information in dataset "mygroups". Session is "SharePointSession3". <AMSHAREPOINT ACTIVITY="get_groups" RESULTDATASET="mygroups" PROVIDER="session_based" SESSION="SharePointSession3" /> |
|
Get List Items |
Retrieves list items and populates a dataset with the results. |
<AMSHAREPOINT ACTIVITY="get_listitems" LIST="text" RESULTDATASET="text" PROVIDER="text (options)" SESSION="text" /> |
Get Sharepoint list "Calendar" items(s) and store information in dataset "myListItems". Session is "SharePointSession3". <AMSHAREPOINT ACTIVITY="get_listitems" LIST="Calendar" RESULTDATASET="myListItems" PROVIDER="session_based" SESSION="SharePointSession3" /> |
|
Get Lists |
Retrieves available lists and populates a dataset with the results. |
<AMSHAREPOINT ACTIVITY="get_lists" RESULTDATASET="text" PROVIDER="text (options)" SESSION="text" /> |
Get Sharepoint list(s) and store information in dataset "myListItems". Session is "SharePointSession3". <AMSHAREPOINT ACTIVITY="get_lists" RESULTDATASET="myListItems" PROVIDER="session_based" SESSION="SharePointSession3" /> |
|
Get Roles (Permission Levels) |
Retrieves available roles and populates a dataset with the results. This activity is only supported in SharePoint Server 2010. |
<AMSHAREPOINT ACTIVITY="create_role" NAME="text" PERMISSIONS="text (options)" DESC="text" ORDER="Number" PROVIDER="session_based" /> |
Create Sharepoint role "Role_Name" with "CreateGroups" permissions. Session is "SharePointSession1". <AMSHAREPOINT ACTIVITY="create_role" NAME="Role_Name" PERMISSIONS="CreateGroups" DESC="Meetings" ORDER="2" PROVIDER="session_based" /> |
|
Get Sites |
Retrieves available sites and populates a dataset with the results. |
<AMSHAREPOINT ACTIVITY="get_sites" RESULTDATASET="text" PROVIDER="text (options)" SESSION="text" /> |
Get Sharepoint site(s) and store information in dataset "myListItems". Session is "SharePointSession3". <AMSHAREPOINT ACTIVITY="get_sites" RESULTDATASET="mysites" PROVIDER="session_based" SESSION="mySharePointSession" /> |
|
Get Users |
Retrieves available users from the specified group and populates a dataset with the results. |
<AMSHAREPOINT ACTIVITY="get_users" ID="text" RESULTDATASET="text" PROVIDER="text (options)" SESSION="text" /> |
Get Sharepoint user(s) from group with id "ID" and store information in dataset "myusers". Session is "mySharePointSession". <AMSHAREPOINT ACTIVITY="get_users" ID="ID" RESULTDATASET="myusers" PROVIDER="session_based" SESSION="mySharePointSession" /> |
|
Move File (Document) |
Moves a file from the source URL to the destination URL. |
<AMSHAREPOINT URL="text" DESTINATION="text" OVERWRITE="yes/no" PROVIDER="text (options)" /> |
Download file "/my/personal/myFile.txt" to "C:\Temp\myFile.txt". Session is "SharePointSession1". <AMSHAREPOINT URL="/my/personal/myFile.txt" DESTINATION="C:\Temp\myFile.txt" OVERWRITE="yes" PROVIDER="session_based" /> |
|
Remove from Role (Permission Level) |
Removes the specified user from the specified role definition. This activity is only supported in SharePoint Server 2010. |
|
|
|
Remove List Item |
Removes an item from the specified list. |
|
|
|
Remove User from Group |
Removes the specified user from the specified group. |
|
|
|
Rename Folder |
Renames a folder from the specified SharePoint library. |
|
|
|
Update Group |
Updates information for the specified group. |
|
|
|
Update List |
Updates a list based on the specified field definitions and list properties. |
|
|
|
Update List Item |
Updates an item from the specified list. |
|
|
|
Update Role (Permission Level) |
Updates information for the specified role definition. This activity is only supported in SharePoint Server 2010. |
|
|
|
Update Site |
Updates information for the specified site. |
|
|
|
Upload File (Document) |
Uploads a file to the specified site. |
|
|
Attachment Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Attachment name |
Text |
No |
(Empty) |
ATTACHMENT="C:\Temp\file.txt" |
The path and file name of the attachment to add. |
|
Create and populate dataset with SharePoint Attachments(s) |
Text |
Yes |
(Empty) |
RESULTDATASET="dataset_name" |
The name of the dataset to create and populate with information regarding the data retrieved. |
|
Destination |
|||||
|
Group ID |
Text |
Yes |
(Empty) |
TITLE="relative.URL" |
Specifies the member identifier for the group to delete. |
|
List title |
Text |
Yes |
(Empty) |
TITLE="listtle" |
The title of the role to create. |
|
List item ID |
Text |
Yes |
(Empty) |
ID="the_item_ID" |
The list item identifier of the list that contains the attachment to delete. |
|
Overwrite |
Yes/No |
No |
No |
OVERWRITE="yes" |
If set to YES, existing attachments with the same name will be overwritten with the newly added attachment. NOTE: This option is only supported in SharePoint 2010.
|
|
Source (Server relative URL) |
Text |
Yes |
(Empty) |
TITLE="relative.URL" |
The relative URL of the file based on the URL for the server. |
File Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
CAML Query |
Text |
Yes |
(Empty) |
LIBRARY="text" |
The CAML Query to run. NOTE: This option is only supported in SharePoint 2010. |
|
Comment |
Text |
No |
(Empty) |
COMMENT="text" |
A user defined comment regarding the checkin. |
|
Checkin type |
Text (options) |
No |
(Empty) |
CHECKINTYPE="OverwriteCheckIn" |
The type of checkin. This parameter is only supported in Sharepoint 2010 Server. The available options are:
|
|
Create and populate dataset with SharePoint file(s) information. |
Text |
Yes |
(Empty) |
RESULTDATASET="dataset_name" |
The name of the dataset to create and populate with information about the files that were queried. |
|
Destination |
Text |
Yes |
(Empty) |
DESTINATION="C:\Temp\File.txt" |
The destination folder and file name that the file should be downloaded to. This requires an absolute path/file name. |
|
Destination (server relative URL) |
Text |
Yes |
(Empty) |
URL="text" |
The destination URL. |
|
Document library title |
Text |
Yes |
(Empty) |
TITLE="library_title" |
The title of the document library from which to retrieve file information. Click GO to populate this field with available libraries. |
|
Overwrite |
Yes/No |
No |
No |
OVERWRITE="yes" |
If set to YES, files with the same name as the copied file will be overwritten. If set to NO, this step fails with an error if files with the same name are found. This parameter is set to NO by default. |
|
Source |
Text |
Yes |
(Empty) |
SOURCE="text" |
The source location. |
|
Source (server relative URL) |
Text |
No |
(Empty) |
URL="/my/Shared Documents/install.log" URL="install.log" |
The source URL of the file to check out. |
Folder Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Create and populate dataset with SharePoint Folder information |
Text |
Yes |
(Empty) |
RESULTDATASET="dataset_name" |
The name of the dataset to create and populate with information regarding the role assignments that are retrieved. |
|
Document Library Title |
Text |
Yes |
(Empty) |
LIBRARY="Shared Documents" |
The title of the document library in which to create a folder. |
|
Folder Name |
Text |
Yes |
(Empty) |
FOLDER="folder_name" |
The name of the folder. |
|
Parent Folder URL (optional) |
Text |
No |
No |
URL="http://myServer/folder_name" |
The URL of the parent folder in which to create a subfolder. This is required only if you want to create a subfolder within an existing folder. If left blank, a subfolder will be created from the root directory. |
Group Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Create and populate dataset with SharePoint Folder information |
Text |
Yes |
(Empty) |
RESULTDATASET="dataset_name" |
The name of the dataset to create and populate with information regarding the role assignments that are retrieved. |
|
Description |
Text |
Yes |
(Empty) |
DESC="group_description" |
A user defined description of the group to create. |
|
|
Text |
No |
(Empty) |
EMAIL="user@company.com" |
The email address associated with the user to add to the group. |
|
Group ID |
Text |
Yes |
(Empty) |
ID="theGroupID" |
The group ID in which to add the existing user. |
|
Login name |
Text |
Yes |
(Empty) |
LOGIN="LoginName" |
The login name of the user to add to the group. |
|
Role Type |
Text |
No |
(Empty) |
ROLETYPE="read" |
The group's role definition. Use the Get Roles activity to retrieve a list of role definitions. |
|
Title |
Text |
Yes |
(Empty) |
TITLE="group_title" |
The title of the group to create. |
List Item Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Add column |
Text |
No |
(Empty) |
You can add columns to sites and lists, and reference them in content types. A column represents an attribute, or piece of metadata, that the user wants to manage for the items in the list or content type to which they added the column. To add a column, click the Click here to add a new item link and enter values. |
|
|
Add list item |
Text |
Yes |
(Empty) |
|
To add a new item, click the Click here to add a new item link and enter a value for the Column and Value fields. |
|
Column |
Text |
Yes |
(Empty) |
Name="columnName" |
The column name in which to add a value to. |
|
Create and populate dataset with SharePoint Folder information |
Text |
Yes |
(Empty) |
RESULTDATASET="dataset_name" |
The name of the dataset to create and populate with information regarding the role assignments that are retrieved. |
|
Description |
Text |
No |
(Empty) |
DESC="group_description" |
A user defined description of the group to create. |
|
Default view |
Yes/No |
No |
No |
AddToDefaultView="False" |
Specifies whether the column should be set as the default view. The default value is FALSE. |
|
Enable attachments |
Text |
Yes |
(Empty) |
ENABLEATTACHMENTS="yes" |
Specify whether to enable attachments |
|
Enable versioning |
Text |
No |
(Empty) |
ENABLEVERSIONING="yes" |
Specify whether to enable versioning |
|
Enable folder creation |
Text |
Yes |
(Empty) |
ENABLEFOLDER="yes" |
Specify whether to enable folder creation |
|
List title |
Text |
Yes |
(Empty) |
TITLE="group_title" |
The displayed title for the list. Click Go to populate this field with all available list titles. Thereafter, select the desired list title from the drop-down. |
|
Schema XML |
Text |
No |
(Empty) |
SchemaXml="column2" |
The name of the column to add. |
|
Template type |
Text (options) |
No |
GenericList |
TEMPLATETYPE="DiscussionBoard" |
Numerous SharePoint templates available in a drop-down list |
|
Quick launch |
Text (options) |
No |
DefaultValue |
QUICKLAUNCH="on" |
On, Off, or DefaultValue, Doesn't matter |
|
Value |
Text |
Yes |
(Empty) |
Value="theValue" |
The value to add under the specified list (column). |
Proxy Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Proxy Password |
Text |
No |
(Empty) |
PROXYPASSWORD="encrypted" |
The proxy password to authenticate with. This parameter is available only if the Use Authentication parameter is enabled. |
|
Proxy Port |
Number |
No |
8080 |
PROXYPORT="8080" |
The port that should be used to connect to the proxy server. The default port is 808. This parameter is available only if the Proxy Type parameter is set to HTTP. |
|
Proxy Server |
Text |
No |
(Empty) |
PROXYSERVER="proxy.host.com" |
The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This parameter is available only if the Proxy Type parameter is set to HTTP. |
|
Proxy Type |
Text (options) |
No |
Default |
PROXYTYPE="http" |
The proxy type to use. The available options are:
|
|
Proxy Username |
Text |
No |
(Empty) |
PROXYUSERNAME=username |
The proxy username to authenticate with. This parameter is available only if the Use Authentication parameter is enabled. |
|
Use Authentication |
If enabled, specifies that proxy authentication is required, enabling authentication-based parameters. This parameter is disabled by default and only available if the Proxy Type parameter is set to HTTP. NOTE: This is a design time parameter and therefore does not contain any markup. |
||||
Role Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Create and populate dataset with SharePoint Folder information |
Text |
Yes |
(Empty) |
RESULTDATASET="dataset_name" |
The name of the dataset to create and populate with information regarding the role assignments that are retrieved. |
|
Description |
Text |
Yes |
(Empty) |
DESC="role_description" |
A user defined description assigned for the role. |
|
Group ID |
Text |
No |
(Empty) |
ID="theGroupID" |
If this option is enabled, specifies the group ID of the group in which to add to the role assignment. If this option is selected, the User Logon parameter is ignored. |
|
Order |
Number |
No |
(Empty) |
ROLETYPE="read" |
Specifies the order in which roles are displayed. |
|
Permissions |
Text (options) |
No |
(Empty) |
PERMISSIONS="Open" |
The permissions set for the role. Click the drop-down list to display a list |
|
Role name |
Text |
Yes |
(Empty) |
TITLE="group_role" |
The name of the role to create/edit/delete. |
|
User Logon |
Text |
No |
(Empty) |
LOGIN="theLoginName" |
If this option is enabled, specifies the user login name of the user in which to add to the role assignment. If this option is selected, the Group ID parameter is ignored. |
Server Properties
These properties allow you to create a custom session for this activity or link this activity to an existing session.
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Authentication Type |
Text (options) |
No |
Default |
AUTHTYPE="Form" |
The method of authentication to use. Certain parameters become active depending on which authentication method is selected. The available options are:
This parameter is active only if the Provide Settings parameter is set to Custom. |
|
Certificate |
Text |
No |
(Empty) |
CERTIFICATE="C:\Temp\file.cer" |
The (DER encoded) certificate to use for SharePoint authentication. This parameter is active only if the Provide Settings parameter is set to Custom and the Authentication Type parameter is set to Basic or Form. |
|
Domain |
Text |
Yes if Auth Type is set to Basic or Form |
(Empty) |
DOMAIN="myServer" |
The domain that the username/password belongs to. This parameter is active only if the Provide Settings parameter is set to Custom and the Authentication Type parameter is set to Basic or Form. |
|
Ignore invalid certificate |
Yes/No |
No |
No |
IGNOREINVALIDCERTIFICATE="yes" |
If set to YES, specifies that invalid certificates will be automatically ignored. Set to NO by default. This parameter is active only if the Certificate parameter is set to YES. |
|
Password |
Text |
Yes if Auth Type is set to Basic or Form |
(Empty) |
PASSWORD="encryptedText" |
The SharePoint password. This parameter is active only if the Provide Settings parameter is set to Custom and the Authentication Type parameter is set to Basic or Form. |
|
Provide Settings |
Text (options) |
Yes |
Custom |
PROVIDER="session_based" |
Indicates where this activity's credentials should originate from. Different properties apply depending on the option selected. The available options are:
|
|
Session |
Text |
No |
SharePointSession1 |
SESSION="mySession1" |
The session name to be created. This allows several SharePoint activities to be linked to this session, eliminating redundancy. Numerous sessions can be used within a single task. The default value is SharePointSession1. This parameter is active only if Provide Settings parameter is set to Session Based. NOTE: Use the End Session activity to end an active SharePoint session. |
|
Site |
Text |
Yes |
(Empty) |
SITE="http://myServer/tech" |
An existing SharePoint site. SharePoint sites are, functionally, ASP.NET 2.0 web applications that are served using IIS and a SQL Server database as a data storage back end. This parameter is active only if the Provide Settings parameter is set to Custom. |
|
Timeout (seconds) |
Number |
No |
600 |
TIMEOUT="500" |
The total number of seconds that this activity is allowed to complete, otherwise a time out error is generated. The default value is 600 seconds. This parameter is active only if Provide Settings parameter is set to Custom. |
|
Username |
Text |
Yes if Auth Type is set to Basic or Form |
(Empty) |
USERNAME="theUserName" |
The SharePoint username. This parameter is active only if the Provide Settings parameter is set to Custom and the Authentication Type parameter is set to Basic or Form. |
|
Version |
Text (options) |
Yes |
SharePoint 2010 |
VERSION="SharePoint2010" |
The SharePoint version. This parameter is active only if Provide Settings parameter is set to Custom. |
Site Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Create and populate dataset with Sharepoint site(s) information |
Text |
No |
(Empty) |
RESULTDATASET="datasetName" |
The name of the dataset to create and populate with information about SharePoint sites. |
|
Description |
Text |
Yes |
(Empty) |
DESC="text_description" |
A user defined description of the new site. |
|
Language |
Number |
Yes |
1033 |
LANGUAGE="1033" |
The locale ID that specifies the language of the new site. The default value is 1033. |
|
Template Type |
Text (options) |
No |
Blank Site : STS#1 |
TEMPLATETYPE="STS#1" |
The name of the site template to be used for creating the new site. Click Go to populate the list with available templates. The default value is Blank Site : STS#1. |
|
Title |
Text |
Yes |
(Empty) |
TITLE="site_title" |
The title of the site. |
|
URL |
Text |
Yes |
|
URL="http://server_name/sites" |
The URL leaf name of the new site. |
|
Use same permissions as parent site |
Yes/No |
No |
No |
USESITEPERMISSION="yes" |
If set to YES, the new site will use the same permissions set for the parent site. |
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
The Error Causes tab properties allow 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
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
All text fields allow the use of expressions such as variables, functions or AWE 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 percent sign (%) or by pressing F2.