SharePoint - Add View
Declaration
<AMSHAREPOINT ACTIVITY="add_view" SESSION="text" LIST="text" VIEW="text" COLUMNS="number" QUERY="text" ROWLIMIT="number" ISDEFAULT="YES/NO" />
Description: Creates a view with the specified name, view fields, query, row limit, and denotes whether or not it is the default view.
Practical Usage
Use views to see the items in a list or library that are most important to you or that best fit a purpose. For example, you can use this activity to create views of the files that were created most recently, of the list items that apply to a specific department, or of the files created by an individual. After you create a view, it is always available when you look at a list or library.
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:
|
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 |
|
The SharePoint version to associate with this activity. The available options are:
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 |
|
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.
|
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 |
|
The type of proxy required for SharePoint connections that pass through a proxy server. The available options are:
|
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 |
808 |
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 808. |
View Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
List title |
Text |
Yes |
(Empty) |
LIST="myList" |
The title of the list in which to create a view. |
View |
Text |
Yes |
(Empty) |
VIEW="myView" |
The unique name of the view to create. |
Column(s) |
Text |
Yes |
(Empty) |
COLUMNS="Created,Modified" |
The column names (or headers) to include in the view. To delimit each column, use a comma with no spaces (e.g., Name,Address,Phone#). This parameter is case sensitive. |
Row limit |
Text |
Yes |
(Empty) |
ROWLIMIT="500" |
The maximum number of rows (items) to return in the view. NOTE: The maximum number of rows in a view that SharePoint allows is 5000. |
Is default |
Yes/No |
No |
(Empty) |
ISDEFAULT="YES" |
If set to YES, specifies that this view will become the default view. If set to NO (default) this view will not be the default view. NOTE: You can change the default view to any public view for the list or library; you cannot use a personal view. |
Query |
Text |
No |
(Empty) |
QUERY="<FieldRef Name='Title'/>" |
A Collaborative Application Markup Language (CAML) string that contains the Where clause for the query. |
Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.
Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)
On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: This simple task creates a SharePoint view with the following columns: Title, Created, Modified
<AMSHAREPOINT ACTIVITY="create_session" SITE="https://netauto.sharepoint.com/sites/text" VERSION="sharepointonline" USERNAME="king.taco@networkautomation.com" PASSWORD="AM48swl5oDSFYhKASv/xC8SyB1QuzwD97yoaME" SESSION="SharePointSession1" /> <AMSHAREPOINT ACTIVITY="add_view" SESSION="SharePointSession1" LIST="myList" VIEW="myView" COLUMNS="Title,Created,Modified" ISDEFAULT="YES" /> <AMSHAREPOINT ACTIVITY="end_session" SESSION="SharePointSession1" />