SharePoint - Describe List
Declaration
<AMSHAREPOINT ACTIVITY="describe_list" SESSION="text" LIST="text" RESULTDATASET="text" />
Description: Retrieves list information and populates a dataset with results.
Practical Usage
Generally used get list information.
Connection Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Connection |
--- |
--- |
--- |
--- |
Indicates where this activity's SharePoint credentials should originate from. This is a design-time parameter used only during task construction, 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 this activity with. This parameter is active only if the Connection parameter is set to Session. The default value is SharePointSession1. NOTE: Use the End Session activity to end an active SharePoint session. |
Version |
Text (options) |
Yes if Connection set to Host |
SharePoint 2010 |
|
The SharePoint version to associate with this session. The available options are:
NOTE: Some SharePoint activities are only supported in SharePoint 2010 or newer. |
Site |
Text |
Yes |
(Empty) |
SITE="http://myServer/tech" |
An existing SharePoint site to associate with this session. 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. Active only if the Version parameter is set to SharePoint Online or SharePoint 2010 and newer. |
Authentication type |
Text (options) |
No |
Basic |
|
The method of authentication to use. Certain parameters become active depending on which authentication method is selected. Authentication types vary depending on the SharePoint version. 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. 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 username (specified in the Username parameter) 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, otherwise a time out error is generated. The default value is 600 seconds. |
Proxy type |
Text (options) |
No |
Default |
|
The proxy type to use. 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 |
8080 |
PROXYPORT="8080" |
The port that should be used to connect to the proxy server. The default port is 8080. This parameter is available only if the Proxy type parameter is set to HTTP. |
List Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
List title |
Text |
Yes |
(Empty) |
SITE="text" |
The title of the list to retrieve. Click the folder icon to use the SharePoint Browser, a user-friendly interface that enables you to connect to a SharePoint site to view or select specific contents. |
Create and populate dataset with SharePoint list description |
Text |
Yes |
(Empty) |
CHECKINTYPE= "OverwriteCheckIn" |
The name of the dataset to create and populate with information about the retrieved list. For more details, see Datasets below. |
Datasets
A dataset is a multiple column, multiple row container object where every column represents a particular variable, and each row corresponds to a given member of the dataset in question. This activity creates and populates a dataset containing specific fields (rows) in addition to the standard dataset fields. The table below describes these fields (assuming the dataset name assigned was theDataset).
Name |
Type |
Return Value |
---|---|---|
theDataset.Required |
True/False |
A Boolean value that determines whether users must enter a value for the field on New and Edit forms. |
theDataset.Type |
Text |
The list type. |
theDataset.ColumnName |
Text |
The display name for the current list (e.g., Content Type ID) |
theDataset.InternalName |
Text |
The internal name for the current list (e.g., ContentTypeID) |
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: This sample task demonstrates usage of the Describe list activity.
<AMSHAREPOINT ACTIVITY="create_session" SITE="https://netauto.sharepoint.com/sites/temp" VERSION="sharepointonline" USERNAME="rogerthat@networkautomation.com" PASSWORD="AM4xncbw+8bogP3o69vRo2Sc+GRLX0I+ZtAaME" SESSION="SharePointSession1" /> <AMSHAREPOINT ACTIVITY="describe_list" SESSION="SharePointSession1" LIST="%listName%" RESULTDATASET="theDataset" /> <AMSHAREPOINT ACTIVITY="end_session" SESSION="SharePointSession1" />