SharePoint Adapter Actions
Add a member to a SharePoint Group
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the SharePoint connection definition |
groupName* | text, expression, variable | the name of the Group |
userLoginName* | text, expression, variable | the login name of the User to add to the Group |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
memberAdded = addSharePointGroupMember(session,
"testGroup", "Test\\\\testuser")Define a connection to SharePoint.
Property | Value | Description |
|---|---|---|
siteUrl* | text, expression, variable | URL of the SharePoint site |
username | text, expression, variable | username for authentication to SharePoint |
password | password, string, expression, variable | password for authentication to SharePoint |
options | expression, variable | A record or JavaScript object with a field for each additional option. Currently defined fields are connectTimeout and socketTime which require a numeric value from 1 to 2147483647 (0x7FFFFFFF) that represents the number of milliseconds for the timeout, and 0 representing no timeout. |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
Global.spHost = "sharepoint.test.local"
Global.spUser = "Test\\\\Administrator"
Global.spPwd = <Password>
session = defineSharePointConnection("http://" + Global.spHost,
Global.spUser,<Password>)Delete a SharePoint Group record.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the SharePoint connection definition |
groupName* | text, expression, variable | the name of the SharePoint Group to delete |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
deleted = deleteSharePointGroup(session, "testGroup")
Delete a member from a SharePoint Group.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the SharePoint connection definition |
groupName* | text, expression, variable | the id of the group |
userLoginName* | text, expression, variable | the id of the object to delete from the Group |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
memberDeleted = deleteSharePointGroupMember(session, "testGroup",
"Test\\\\testuser")Get a SharePoint Group record.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the SharePoint connection definition |
groupName* | text, expression, variable | the name of the SharePoint Group to get |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
group = getSharePointGroup(session, "testGroup")
Get SharePoint Group records.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the SharePoint connection definition |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
groups = getSharePointGroups(session)
Get a SharePoint User record.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the SharePoint connection definition |
loginName* | text, expression, variable | the loginName of the SharePoint User to get |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
user = getSharePointUser(session, "Test\\\\testuser")
Get SharePoint User records.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the SharePoint connection definition |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
users = getSharePointUsers(session)
Rename a SharePoint Group record.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the SharePoint connection definition |
groupName* | text, expression, variable | the name of the SharePoint Group to rename |
newName* | text, expression, variable | the new name |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
renamed = renameSharePointGroup(session, "testGroup", "testGroup1")
Create/Update a SharePoint Group record.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the SharePoint connection definition |
record* | expression, variable | the record to save |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
groupTemplate = createRecord() setRecordField(groupTemplate, "Name", "testGroup") created = saveSharePointGroup(session, groupTemplate)
Create/Update a SharePoint User record.
Property | Value | Description |
|---|---|---|
connection* | expression, variable | the SharePoint connection definition |
record* | expression, variable | the record to save |
returnVariable | expression, variable | name of the variable to be assigned to the return value |
Example
userTemplate = createRecord() setRecordField(userTemplate, "LoginName", "Test\\\\testUser") setRecordField(userTemplate, "Name", "testUser") created = saveSharePointUser(session, userTemplate)
Field | Read-Only | Description |
|---|---|---|
LoginName (required) | Y | User login name (from the Authentication Provider, usually AD - must exist in the provider before can be created in SharePoint) |
Name | N | Display Name |
N | User e-mail address | |
Notes | N | Descriptive notes about User |
Groups | Y | List of Groups that the User is a member of |
ID | Y | Internal SharePoint ID |
IsDomainGroup | Y | Domain group flag |
IsSiteAdmin | Y | Site administrator flag |
SID | Y | Security ID |
Field | Read-Only | Description |
|---|---|---|
Name (required) | Y | Name of Group |
Description | N | Description of Group |
OwnerIdentifier | N | Name of Group or LoginName of User that owns this group |
OwnerType | N | The type of the OwnerIdentitifier: “user” or “group” |
Users | Y | List of Users that are members of Group |
ID | Y | Internal SharePoint ID |
OwnerID | Y | Internal SharePoint ID of Owner |
OwnerIsUser | Y | Owner type flag flag |