Try OpenEdge Now
skip to main content
Managed Adapters Guide
SharePoint Managed Adapter : Working with SharePoint Adapter : Configuring the SharePoint Adapter
 

Configuring the SharePoint Adapter

You can configure the SharePoint adapter workstep in your BPM process by performing the following procedures.
To configure the SharePoint Adapter:
1. On the Diagram tab, click the Assign Participants link in the Tasks pane. Expand the Adapters > Managed > SharePointAdapters folder and drag the default GenericSharePointAdapter (or a previously configured SharePoint adapter instance) to your Content pane, creating a SharePoint adapter workstep.
2. Double-click the workstep to open its Properties view, and click the Configuration tab. This tab includes the Configure button, the Change mapping button, and the Advanced Properties button for defining the adapter configuration, adapter mapping, and advanced properties respectively.
3. Click Configure to open the configurator box of the SharePoint Adapter Configurator.
Note: The SharePoint Adapter configurator box has two tabs- Authentication and Settings.
4. Select the radio button for Auto Configuration or Manual Configuration.
5. Enter the details in the SharePoint Adapter Configurator window as per the following table.
Field Name
Description
Auto Configuration
Server Alias
Enter the SharePoint server alias. This field is auto-populated with a default server alias that you can click and modify.
Note: Refer to the server-config.xml file for server alias information. If you do not have access to server-config.xml file, contact your Server Administrator.
Manual Configuration
Mode
From the drop-down list, select the mode of authentication. Select None for no security, NTLM for SharePoint server secure authentication, and Basic for authentication without secure authentication. NTLM is selected by default.
Site URL
Enter the SharePoint Site URL.
Username
Enter the User name (If User authentication is enabled for SharePoint Server).
Password
Enter the Password (If User authentication is enabled for SharePoint Server).
Note: The "Always use BPM Performer's SharePoint access credentials" checkbox is for use while invoking SharePoint Adapter as an Adaplet. If this checkbox is selected, SharePoint access credentials that are set in the BPM User Profile page should be used while invoking SharePoint Adapter as an Adaplet.
6. Click the Settings tab.
7. From the Action drop-down list, select the action that you want to perform.
8. The steps to perform after you select a particular action are detailed in the following table.
Action for Document
Steps to perform
Create
a. Select List Item.
b. In the List Name field, enter a name for the List Item.
c. In the List Item Path field, enter the path of the location where you want to store the List Item.
d. Select ALL or Selective for Metadata. If you selected Selective for Metadata, click Add and edit the items in the Properties pane. Map and Temptable are supported when you select All.
e. Click OK.
Note: The entries in the Properties pane are editable. To edit a Property, click in the white space and enter a name for the property.
Upload
a. Select Document or Attachment.
b. If you selected Document, provide the Library Name and Location URL(including the file) where you want to upload the document and click OK.
c. If you selected Attachment, enter the List Name and the List Item ID where you want to upload the Attachment and enter the File Name of the attachment that you want to upload and click OK.
Note: Provide the file name in the File Name field. Do not include File Name in the Location URL while uploading multiple documents.
Download
a. Select Document or Attachment.
b. If you selected Document, provide the Library Name and Location URL(including the file name) from where you want to download the document and click OK.
c. If you selected Attachment, enter the List Name and the List Item ID from where you want to download the Attachment and enter the File Name of the attachment that you want to Download.
d. Click OK.
Delete
a. Select one of the three
*Document
*Attachment
*List Item
a. If you selected Document, enter the Location URL of the document, including the document name that you want to delete.
b. If you selected Attachment, enter the List Name, the List Item ID from where you want to delete the Attachment and enter the File Name of the attachment that you want to delete.
c. If you selected List Item, enter the name of the List Name and the List Item ID which you want to delete.
b. Click OK.
Get Metadata
a. Select Document or List Item.
b. Provide the Location URL of the document for which you want to Get Metadata.
c. If you selected Document:
a. Enter the Location URL of the document.
b. Select ALL or Selective for Metadata. If you selected Selective for Metadata, click Add and edit the items in the Properties pane.
d. If you selected List Item:
a. Enter the List Name for which you want to get metadata.
b. Enter the corresponding List Item ID.
c. Select ALL or Selective for Metadata. If you selected Selective for Metadata, click Add and edit the items in the Properties pane.
e. Click OK.
Note: The Location URL field can be left blank and selected later during Dataslot mapping. The entries in the Properties pane are editable. To edit a Property, click in the white space and enter a name for the property.
Set Metadata
a. Select Document or List Item.
b. Provide the Location URL of the document for which you want to Set Metadata.
c. If you selected Document:
a. Enter the Location URL of the document.
b. Select ALL or Selective for Metadata. If you selected Selective for Metadata, click Add and edit the items in the Properties pane.
d. If you selected List Item:
a. Enter the List Name for which you want to set metadata.
b. Enter the corresponding List Item ID.
c. Select ALL or Selective for Metadata. If you selected Selective for Metadata, click Add and edit the items in the Properties pane.
e. Click OK.
Note: The Location URL field can be left blank and selected later during Dataslot mapping. The entries in the Properties pane are editable. To edit a Property, click in the white space and enter a name for the property.
The dataslot Mapping Window opens. Dataslot Mapping is explained in Defining the Dataslot Mapping section.
Note: Please note that ServerAlias, UserName and Password are constant parameters and cannot be mapped to dataslots. The following table provides information about parameters and their corresponding dataslot mapping information.
Table 21. Parameter Values
Type
Actions
Parameters that can be mapped to a DataSlot
Document
Upload, Download, Delete, Set Metadata, and Get Metadata
Site URL(Authentication tab), Location URL, and Library Name
Attachment
Upload, Download, and Delete
Site URL(Authentication tab), List Item ID, List Name, and File Name (Regular expressions are supported for FileName)
List Item
Create, Delete, Set Metadata, and Get Metadata
Site URL(Authentication tab), List Item ID, and List Name