Sharepoint

Contents

Info

This connector supports also OAuth, if used this authentication requires creation and use of OAuth users.

Warning

If an existing Office 365 authentication configuration is switched (standard vs OAuth) the connector needs to be reconfigured because returned item values are different according the used authentication method.

Front

Sharepoint site address
Enter the name of the Sharepoint site address you want to upload to. If you need to connect to an Office 365 website select the checkbox on the right.

Info

Sharepoint site address is the site URL root. Do do not specify a URL to a direct library, folder or page because it will generate connection errors because not able to locate Sharepoint API / Web Services.

Office 365
Switch on to perform connection to Office 365 Sharepoint online servers. If OFF it is assuming a connection to a on premise Sharepoint server. The option is exclusive with Federation option.

When connecting to Office 365 both standard and OAuth authentication can be used according if the OAuth fields below are used.

Federation
Use Federated authentication for on premise Sharepoint servers, when required. The option is exclusive with Office 365 option.

Username, Password and Domain
Enter the username, password and domain of a user who has access to the Sharepoint site.

Info

When using Office 365 Domain is not required and the username needs to be in the from username@contoso.com. Specifying a domain authentication will fail returning connection errors.

Info

If OAuth is used the username is the one used when creating the OAuth user and not the OneDrive for Business username.

Use admin consent
If enabled uses the OAuth administrator consent given via a preconfigured SSO profile on the same tenant domain of the user.

By using this option PIN is not required because tenant administrator will access the specified user storage. For more info refer to the SSO profiles.

PIN
Enter your OneDrive for business PIN here, or click on the Variables button on the right, to select a variable which will contain the PIN. (PIN will be created in OAuth User settings).

Warning

If either the Admin consent or the PIN is enabled / filled OAuth authentication will be used rather than the standard authentication. In this case only the Username is required.

Use proxy
If your administrator has set up a proxy for your internet connections, you should check this option and provide proxy details by selecting the Proxy Settings button below. Ask your administrator for help in order to provide correct proxy settings.

Return Type
Select the type of list to display. This can either be:

  • Sites
  • List / Library
  • Folder
  • List items

Default return format is ID;#Value or an internal item ID when using OAuth authentication on Office 365.

List / Library
If a connection can be made with Sharepoint, using the settings you provided in the previous entries, then you can select this button, which will give you a list of available Lists/Libraries, from which you can select one to retrieve the items from.

Folder (only available with return type Folders)
Enter the folder from where query sub folders from Sharepoint, select a folder by pressing the browse folders button or click on the Variables button on the right, to select a variable which will contain the folder.

Parent Folder (only available with return type List items)
Enter the Parent folder to find the List items in Sharepoint here, or click on the Variables button on the right, to select a variable which will contain the parent folder. This field only needs to be filled if the List items have a folder structure, so you will be able to pick up sub-folders.

Return column (only available with return type List items)
Enter the return column in Sharepoint here, or click on the Variables button on the right, to select a variable which will contain the return column. This field only needs to be filled if the return column is different then the default one, e.g. a different column is intended to be returned rather than default ID. When left empty, the default return column is used for the selected List item.

Filter (available with return type Folders or List items)
Enter a filter for the folders or list items in Sharepoint here, or click on the Variables button on the right, to select a variable which will contain the filter. The filter behaves differently according if returning Folders or List Items.

Folders

Enter the text which the folder name contains.

Special filter formats are available:

  • CONTAINS=XXX, where the folder name contains XXX
  • BEGINSWITH=XXX, where the folder name starts with XXX
  • EQUALS=XXX, where the folder name is equal to XXX
  • NOTEQUALS=XXX, where the folder name is not equal to XXX

(replace XXX with your current Variable / Value)

List items

The filter requires the following format:

COLUMNNAME=XXX

Which returns only the list items where the value inside the COLUMNAME is equal to XXX.

Note

This connector is supporting Selected (with tree) recursive item lists. Check how to crate a New Item List.

Store

Sharepoint site address
Enter the name of the Sharepoint site address you want to upload to. If you need to connect to an Office 365 website select the checkbox on the right.

Info

Sharepoint site address is the site URL root. Do do not specify a URL to a direct library, folder or page because it will generate connection errors because not able to locate Sharepoint API / Web Services.

Office 365
Switch on to perform connection to Office 365 Sharepoint online servers. If OFF it is assuming a connection to a on premise Sharepoint server. The option is exclusive with Federation option.

When connecting to Office 365 both standard and OAuth authentication can be used according if the OAuth fields below are used.

Federation
Use Federated authentication for on premise Sharepoint servers, when required. The option is exclusive with Office 365 option.

Username, Password and Domain
Enter the username, password and domain of a user who has access to the Sharepoint site.

Info

When using Office 365 Domain is not required and the username needs to be in the from username@contoso.com. Specifying a domain authentication will fail returning connection errors.

Info

If OAuth is used the username is the one used when creating the OAuth user and not the OneDrive for Business username.

Use admin consent
If enabled uses the OAuth administrator consent given via a preconfigured SSO profile on the same tenant domain of the user.

By using this option PIN is not required because tenant administrator will access the specified user storage. For more info refer to the SSO profiles.

PIN
Enter your OneDrive for business PIN here, or click on the Variables button on the right, to select a variable which will contain the PIN. (PIN will be created in OAuth User settings).

Warning

If either the Admin consent or the PIN is enabled / filled OAuth authentication will be used rather than the standard authentication. In this case only the Username is required.

Use proxy
If your administrator has set up a proxy for your internet connections, you should check this option and provide proxy details by selecting the Proxy Settings button below. Ask your administrator for help in order to provide correct proxy settings.

List / Library
If a connection can be made with Sharepoint, using the settings you provided in the previous entries, then you can select this button, which will give you a list of available Lists/Libraries, from which you can select one to upload the document to.

List / Library Properties
The properties menu will prompt a screen, allowing you to add values to different column fields defined in the selected list/Library within Sharepoint. The available columns will automatically be filled if the connection to your Sharepoint site is made correctly.

Make sure to enter the Properties value according their type otherwise they may appear empty on the uploaded document, in this case a warning message might be logged in the process logs.

If the your property is a date Sharepoint field from the Scanshare must respect the format required by SharePoint.

Info

The date field format must be as follows: YYYY-DD-MM or with hour YYYY-DD-MMThh:mm:ssZ (T= AM/PM designator and Z=Hours offset from UTC, with a leading zero for a single-digit value ).

Folder
Enter the folder from where upload the document to Sharepoint, select a folder by pressing the browse folders button or click on the Variables button on the right, to select a variable which will contain the folder.

The Folder can be a single direct folder or a full path composed by subfolders separated by / (forward slash). Each folder, either a single folder or part of the path, can be an ID returned by the front connector return items folders or a named folder. If a folder doesn’t exist it will be created, at any level of the path. Also the full path can be created if not existing.

Set properties on folder
if you need to set the properties of the folders, you should check this option and the same properties of the last uploaded document will be set.

Filename
Enter the filename for the document to upload to SharePoint, or click on the Variables button on the right, to select a variable which will contain the filename.

Document upload test
By clicking this button, a window will open where you can select a document to upload to Sharepoint. It is also possible to drag and drop a file into this box which will be uploaded to Sharepoint as well. A sample upload will be performed into the target List / Library / Folder.

Info

The sample upload is actually uploading the sample document into the target Sharepoint server. Make sure to remove the document afterwards if not needed.

Previous Article

ShareFile

Next Article

Synergy Enterprise