SharePoint - Get Users
Declaration
<AMSHAREPOINT ACTIVITY="get_users" SITE="text" VERSION="text (options)" AUTHTYPE="text (options)" USERNAME="text" PASSWORD="text (encrypted)" DOMAIN="text" IGNOREINVALIDCERTIFICATE="YES/NO" CERTIFICATE="text" PROXYTYPE="text (options)" PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" PROXYPASSWORD="text (encrypted)" TIMEOUT="number" RESULTDATASET="text" />
Description: Retrieves lists from a SharePoint server and populates a dataset with the results.
Practical Usage
Used to get information regarding SharePoint lists.
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 become 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 |
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 808. |
User Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Group ID |
Text |
Yes |
(Empty) |
ID="theGroupID" |
The group ID in which to retrieve user data from. |
Create and populate dataset with SharePoint user information. |
Text |
Yes |
(Empty) |
RESULTDATASET="dataset_name" |
The name of the dataset to create and populate with information regarding the users that are retrieved. 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.Email |
Text |
The user's e-mail address. |
theDataset.LoginName |
Number |
The user's login name. |
theDataset.Title |
Text |
A value that specifies the name of the user. |
theDataset.ID |
Number |
A value that specifies the member identifier for the user. |
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: 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" />