SharePoint - Update List

Declaration

<AMSHAREPOINT ACTIVITY="update_list" LIST="text" DESC="text" 
NEWTITLE="text" QUICKLAUNCH="text (options)" 
ENABLEATTACHMENTS="Yes/No" ENABLEFOLDER="Yes/No" 
ENABLEVERSIONING="Yes/No" PROVIDER="text (options)" />

Description: Updates an existing SharePoint list based on the specified field definitions and list properties.

Practical Usage

Used to automate the management of SharePoint lists, which are a key, underlying feature of your SharePoint site. They enable teams to gather, track, and share information by using a Web browser.

Connection Parameters

Property

Type

Required

Default

Markup

Description

Connection

---

---

---

---

Indicates where this activity's SharePoint credentials should originate from. This is a visual parameter used only during design-time, thus, contains no properties or markups. The available options are:

  • Host - Specifies that a custom set of credentials will be entered for this activity. This option is normally selected if only a single SharePoint activity is required to complete the task.

  • Session - Specifies that credentials should derive from a session created in a previous Create session step. This allows several activities to be linked to a specific session, eliminating redundancy. Multiple sessions can exist within a single task, allowing several SharePoint operations to be automated simultaneously.

Session

Text

Yes if Connection set to Session

SharePoint

Session1

SESSION="mySession1"

The name of the session to associate with this activity. This parameter is active only if the Connection parameter above is set to Session. If the Connection parameter is set to Host, this parameter is ignored and the remainder of the parameters specified below becomes active.

Version

Text (options)

Yes if Connection set to Host

SharePoint 2010

  1. VERSION="sharepointonline"

  2. VERSION="sharepoint2010"

  3. VERSION="sharepoint2007"

The SharePoint version to associate with this activity. The available options are:

  • SharePoint Online - A cloud-based service, hosted by Microsoft as an alternative to installing and deploying SharePoint Server on premises.

  • SharePoint 2010 and newer (default) - SharePoint version 2010 or newer - includes SharePoint Foundation 2010/2013 and SharePoint Server 2010/2013.

  • SharePoint 2007 and older - SharePoint version 2007 or older - includes Windows SharePoint Services (WSS) v3 edition and Microsoft Office SharePoint Server 2007 (MOSS 2007) edition.

NOTE:  Some SharePoint activities are only supported in SharePoint 2010 or newer.

Site

Text

Yes if Connection set to Host

(Empty)

SITE="http://myServer/tech"

The SharePoint site to access. A SharePoint site is a collection of pages, site templates, lists, and libraries configured for the purpose of achieving an express goal.

Authentication type

Text (options)

No

Default

  1. AUTHTYPE="form"

  2. AUTHTYPE="anonymous"

  3. AUTHTYPE="basic"

  4. AUTHTYPE="digest"

  5. AUTHTYPE="ntlm"

The method of authentication to utilize. Authentication types vary depending on the SharePoint version. Different parameters become active depending on which authentication method is selected. Below lists available authentication methods and their compatibility.

  • Default (default) - Compatible withSharePoint 2010 or newer.

  • Basic - Compatible with  all SharePoint versions.

  • Form - Compatible withSharePoint 2010 or newer.

  • Anonymous - Compatible withSharePoint 2010 or newer.

  • Digest - Compatible with  SharePoint 2007 or older.

  • Proprietary - Compatible with  SharePoint 2007 or older.

  • None - Compatible with  SharePoint 2007 or older.

  • NTLM - Compatible with  SharePoint 2007 or older.

Username

Text

Yes

(Empty)

USERNAME="theUserName"

A valid SharePoint username. This parameter may or may not be active depending on which option is selected under the Authentication type parameter.

Password

Text

Yes

(Empty)

PASSWORD="encryptedText"

A valid SharePoint password to authenticate the username entered above. This parameter may or may not be active depending on which option is selected under the Authentication type parameter.

Domain

Text

Yes

(Empty)

DOMAIN="myServer"

The domain that the user belongs to. This parameter may or may not be active depending on which option is selected under the Authentication type parameter.

Certificate

Text

No

(Empty)

CERTIFICATE="C:\Temp\file.cer"

The (DER encoded) certificate to use for SharePoint authentication. This parameter may or may not be active depending on which option is selected under the Authentication type parameter.

Ignore invalid certificate

Yes/No

No

No

IGNOREINVALIDCERTIFICATE="yes"

If set to YES, specifies that invalid server certificates that are detected will be automatically ignored. Set to NO by default.

Timeout (seconds)

Number

No

600

TIMEOUT="500"

The total number of seconds allowed to connect to the SharePoint server before a timeout error is generated. The default value is 600 seconds.

Proxy type

Text (options)

No

Default

  1. PROXYTYPE="none"

  2. PROXYTYPE="http"

The type of proxy required for SharePoint connections that pass through a proxy server. The available options are:

  • System default (default) - Points to the default proxy used by the system.

  • None - No proxy authentication required.

  • HTTP - Proxytype is HTTP.

Use authentication

---

---

---

---

If enabled, specifies that proxy authentication is required, enabling authentication-based parameters (disabled by default). This is a design-time parameter, therefore, contains no properties or markups. It is active 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 username

Text

No

(Empty)

PROXYUSERNAME=username

The proxy username to authenticate with. This parameter is available only if the Use Authentication parameter is enabled.

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. This parameter is available only if the Proxy type parameter is set to HTTP. The default value is 8080.

List Parameters

Property

Type

Required

Default

Markup

Description

Description

Text

No

(Empty)

DESC="group_description"

A user defined description of the group to create.

New Title

Text

Yes

(Empty)

NEWTITLE="the_new_list_title"

The new title for the list.

Quick Launch

Text (options)

No

DefaultValue

QUICKLAUNCH="on"

Specifies whether the list should be a quick launch item. The available options are:

  • Doesn't matter

  • Off

  • On

  • DefaultValue

Add Column(s)

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 new item link.

Schema XML

Text

No

(Empty)

SCHEMAXML="column2"

The name of the column to update.

Remove Column(s)

Text

No

No

REMOVECOLUMNS="column-name"

Specifies the column(s) to remove.

Enable Attachments

Yes/No

No

Doesn't matter

ENABLEATTACHMENTS="yes"

Denotes whether attachments should be enabled. The available options are:

  • Doesn't matter

  • Yes

  • No

Enable Versioning

Yes/No

No

No

ENABLEVERSIONING="yes"

Denotes whether versioning should be enabled. The available options are:

  • Doesn't matter

  • Yes

  • No

Enable Folder Creation

Yes/No

No

No

ENABLEFOLDER="yes"

Denotes whether subfolder creation should be enabled. The available options are:

  • Doesn't matter

  • Yes

  • No

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: Update SharePoint list "Contacts". Session is "SharePointSession1".

<AMSHAREPOINT ACTIVITY="update_list" LIST="Contacts" 
DESC="contact list" NEWTITLE="Contact_List" 
QUICKLAUNCH="On" ENABLEATTACHMENTS="No" ENABLEFOLDER="Yes" 
ENABLEVERSIONING="Yes" PROVIDER="session_based"  />