General tab

Use this tab to set general connection parameters to log in to SharePoint Server.

You can use RRT in all text boxes on this tab except for the Password field.
Option Description
Activate Use this combo box to activate the component according to a condition. See more information about conditions in Conditional Activation.

If the activation is OFF, the component won't perform any actions during files processing.

This combo box is present only in the eConnector component.

Server and Site collection Enter the URL of site collection on the SharePoint server. The URL should represent a string of the following format:

prefix://server_address:port/site_collection

Where:

  • prefix: a protocol prefix; http:// or https://. The prefix is not mandatory: http:// is used by default, when prefix is not specified. To provide a SSL secured connection (SMTPS) to the server, specify the https:// prefix.
  • server_address: a server address specified as:
    • A name of physical machine, where SharePoint server is running; for example, myserver.
    • A full domain name of the machine, where SharePoint server is running; for example, myserver.ourcompany.com.
    • An IP address of the machine with the SharePoint server; for example, 192.168.0.1.
    • A host header of the machine with the SharePoint server; for example, hostheader.ourcompany.com.

    The server address is mandatory.

  • port: a port number used for connection to the SharePoint server; for example, 1000. Port is not mandatory.
  • site_collection: a path to the desired site collection on the SharePoint server; for example, sites/airelle, sites/brefs, sites/cendres.

    Site collection is not mandatory, when you use the AutoStore Add-on Services connection method. When you don't specify the site collection in this case, the root site collection is used by default.

    When you use Native services connection method, you should enter the complete URL of site collection.
    It is highly recommended to check the URL in the browser on the machine where your workflow server is installed.

The following examples present some useful references of how to specify Server and Site collection:

  • http://myserver:1000
  • https://myserver.ourcompany.com/sites/airelle
  • http://hostheader.ourcompany.com/sites/brefs
  • 192.168.0.1
  • http://192.168.0.1/sites/cendres
  • https://192.168.0.1:1000/sites/airelle

SharePoint connection method Select the connection method which will be used for accessing the server. There are four available connection methods:
  • AutoStore Add-on Services: select this method to access to the SharePoint server that uses AutoStore web service. This is the default connection method.
  • Native Services: select this method to access to the SharePoint server that does not use AutoStore web service or to access the SharePoint Online Service. This method has some restrictions indicated in the Restrictions and limitations topic.
  • Office 365/SharePoint Online: select this method to connect to SharePoint Online using Modern Authentication / OAuth2.
  • Security Token Services: select this method to access the SharePoint using a custom identity provider. When you select this method, you should specify the path to the custom assembly in the Cookie provider text box. This method means that during configuring and processing the component loads a custom assembly that implements the special interface to get an authentication cookie.
    The Forms authentication credentials type is set by default, when you select this connection method.
Credentials type Select the authentication type for connecting to the server in this combo box. The component supports two possible authentication types:
  • Windows authentication: select this option to access to the server using the integrated Windows authentication method. This is the default option.
  • Forms authentication: select this option to access to the server using the Forms-based authentication method.
Cookie provider Enter the path to a custom assembly that will be used for defining an authentication cookie. You can enter the path manually or click the browse button (...) and browse to it through the folder tree.

This field is enabled only for Security Token Services connection method.

For more information on the custom cookie provider assembly, see Cookie provider assembly.

User name Enter the user name which will be used to log in to the server in one of the following forms:
  • User
  • Domain\User
  • User@domain.com

This field is not enabled for the Office 365/SharePoint Online connection method.

Local user account

In this text box, specify a domain user account that will be used by the workflow.

The accepted format is UPN (User Principal Name) – testuser@test.domain.corp

Make sure that the account specified in this text box has completed the authorization and consent process through Token Vault. Otherwise, the component will fail to process files through this account.

You may use RRTs in this text box. When you use an RRT, make sure that it is replaced with a domain user account in UPN format; otherwise, the component will fail to process files and they will be rejected.

This field is enabled for the Office 365/SharePoint Online connection method only.

Obtain password via RRT

Select this check box to use an RRT as a password. Enter the RRT into the Password RRT text box.

This field is not enabled for the Office 365/SharePoint Online connection method.

Password Enter the user password that will be used to log in to the server. This password will be saved in the encrypted form.

This field is not enabled for the Office 365/SharePoint Online connection method. In case of other methods, this text box is disabled if the Obtain password via RRT check box is selected.

Password RRT Enter the RRT that will be used as a password. In this case the password is not encrypted.

This field is not enabled for the Office 365/SharePoint Online connection method. In case of other methods, this text box is enabled only if the Obtain password via RRT check box is selected.

This field supports and returns values for encrypted by restricted RRTs. For more information, see Encrypted Field RRTs.

Impersonate This field is not enabled for the Office 365/SharePoint Online connection method. In case of other methods, select this option to change the author of the sent document or list item on the server. If this check box is not selected, the author will be the user specified in the User name text box.

  • For SharePoint 2013, and later versions, this option is available only for Native Services/Office365.

If you use the Impersonate option, the user specified in the User name text box should be a site collection administrator of the SharePoint site where you want to store documents or list items. The impersonator should have the 'Write' permissions for the selected directory.

If you use the Impersonate option, both the User name and the impersonator name should be entered in one of the following forms: Domain\User or User@domain.com.

The impersonation is applied at the configuration stage and at run time. At the configuration stage, getting lists of data from the SharePoint server is performed using the impersonator account permissions. As an exception, the list of sites is displayed using the permissions of the user specified in the User name text box. At run time the impersonator permissions are used for saving documents and list items.

Token Vault URL

Enter the fully qualified Token Vault URL with port number.

Provider ID

Enter the ID of that Authorization Provider, which was set up in Token Vault to work with this AutoStore component.

Site Enter the name of the SharePoint site where you want to store the documents or list items.

You can click the browse button (...) to open the Select Site dialog box in which you can select a site from the displayed site tree.

You can specify a subsite of the site entering its name after the parent site name followed by the slash character '/'; for example, SubSite1/SubSite1_1. If a site is not specified, the component will store documents or list items in the base SharePoint directory.

Server log file Enter full path to the file on the server side which is used by the web service for logging. This log file can be used for debugging/support purposes. If this path is not specified, the web service will not create the log file.

This option is available only when AutoStore Add-on Services connection mode is selected; otherwise, it is disabled.

For correct logging, ensure that the WSS_ADMIN_WPG Windows group on the web service computer has 'Full Control', and the WSS_WPG Windows group has 'Read & Execute', 'List Folder Contents', and 'Read' permissions or higher on the folder containing the trace log. To perform this procedure, you must be a member of the Administrators group on the server host machine. For more details, see Event ID 5400 (http://technet.microsoft.com/en-us/library/cc561020.aspx).
Web protocol timeout (seconds) Specify the timeout in seconds for uploading documents or list items to the SharePoint Server.

While uploading, the component waits for this time, and when the timeout expires, the component aborts uploading and rejects the job. That may happen, for example, because of uploading problems or of a very big size of files being uploaded. It is recommended to increase timeout value when sending big documents or when sending documents into the document library which already contains a large number of documents.

Pass through Select this check box to make the documents available to the rest of the components in your process.

This check box is present only in the process component configuration window.