OneDrive Connector

8 minute read Last updated on November 09, 2022

OneDrive Connector Icon

Use the OneDrive Connector Node to distribute documents to Microsoft OneDrive, a file hosting service that allows users to upload and sync files to cloud storage. The connector allows you to send documents to OneDrive via an automated workflow, or you can access OneDrive directly at the MFP panel.

Notes:

  • To use the OneDrive Connector, you must have a OneDrive account.
  • The maximum file size for uploading documents to OneDrive is 100 MB.

To open the OneDrive Connector Node properties window, add an output node for OneDrive to your workflow and double-click on it.

OneDrive Connector

  • Enabled - To enable this node in the current workflow, check the box at this field. If you leave the box blank, the workflow ignores the node and documents pass through as if the node was not present. Note that a disabled node does not check for logic or error conditions.

  • Node Name - The node name defaults into this field. This name appears in the workflow below the node icon. Use this field to specify a meaningful name for the node that indicates its use in the workflow.

  • Node Description - Enter an optional description for this node. A description can help you remember the purpose of the node in the workflow or distinguish nodes from each other. If the description is long, you can hover the mouse over the field to read its entire contents.

Buttons

  • Metadata - To access the Metadata Browser window, click this button.
  • Help - To access Dispatcher Phoenix Online Help, click this button.
  • Save - To preserve your node definition and exit the window, click this button.
  • Cancel - To exit the window without saving any changes, click this button.

Configuring the OneDrive Connector

To configure the OneDrive Connector, you must first log into your OneDrive account via Dispatcher Phoenix Web’s Authentication Manager. Once this initial set up is complete, logging into OneDrive within the node or at the MFP panel is no longer necessary, providing an optimized single-sign-on experience.

Note: If your organization has configured Microsoft Azure to require Admin permission for application registration at the machine, your administrator can override this restriction and allow users to register without an Admin present when creating accounts for OneDrive Connector. If you choose to configure OneDrive Connector in this way, we recommend the Admin log in first and grant consent before other users attempt to create their accounts. Otherwise, any account created for OneDrive Connector via Dispatcher Phoenix Web’s Authentication Manager will require Admin credentials and the Admin will be the user registered.

To override the Admin permission requirement when creating a OneDrive Connector account, follow the steps in the Set Up section below. In Step 4, log in using Admin credentials. If this is the first time the Admin logged in, the “Consent on behalf of your organization” checkbox will appear. Check the box at this field, then proceed to the next step in the Set Up procedure.

Important! The “Consent on behalf of your organization” option appears only the first time the Admin logs in. To regain this option, Dispatcher Phoenix must be removed from the Enterprise Applications list in Azure. The next time the Admin logs in, the option will appear.

Set Up

To begin, you must first log into OneDrive via the Dispatcher Phoenix Web’s Authentication Manager. Do the following:

  1. Log into Dispatcher Phoenix Web.

  2. Select the Accounts tool on the Home page.

  3. On the Accounts page, select the + button and choose the OneDrive option. See the following illustration:

    OneDrive Connector

  4. Log into OneDrive using your account credentials (email address/OneDrive account username and password).

  5. Select Yes if asked for permission to let the application access your info.

  6. The OneDrive account will now be listed on the Accounts page. See the following illustration for an example:

    OneDrive Connector

  7. If you need to delete the account, select the vertical ellipsis button and choose Delete Account, as in the following illustration:

    OneDrive Connector

  8. If you add multiple accounts, the first account you added will be marked as the Primary Account with a star icon. The benefit of a primary account is that when you sign into the MFP, you will have immediate access to this account. You can switch to a different account at the MFP by selecting the check icon, then selecting the back arrow icon on the next screen. You can also switch your primary account by selecting the vertical ellipsis button and selecting Enable Primary Account. You can also Disable Primary Account to always be prompted with the account screen at the MFP.

Customizing the OneDrive Connector Node

Once connected, the right hand side of the OneDrive node properties window displays a tree-view of your folders, sub-folders, and files in OneDrive. You can use this area to browse through your OneDrive folder structure and choose a folder to store your documents in.

See the following illustration for an example:

Select A Folder

To choose another OneDrive account, choose the account from the Account drop-down list.

To modify the default Connection Timeout (the seconds allotted for the time without communication, after initial connection to the server, before a timeout occurs), enter a value in the Connection Timeout field.

Sending Documents to a New Folder

To create a new folder in OneDrive to scan to, select the New folder option from the Options drop-down menu or press Ctrl + Shift + N.

In the Create New Folder window that appears, enter the name for the new folder in the Name field; then select the Create button. The newly created folder will now appear in the Folder view.

File Name Restrictions

The following restrictions apply to file names:

  • File names cannot start with a space or end with a space.

  • You cannot start a file name with two period characters (..).

  • Non-printable characters cannot be included in a file name (tabs, newlines, etc.)

  • Do not use < >  :  "  /  \  |  ?  *

View Options

You can adjust the default view of your OneDrive folders in the node properties window by using the Options button on the top right hand side of the window. Choose the following items from the Options pull-down menu:

  • To turn off the default view, uncheck the Show tree view option or press Ctrl + T.

  • To hide the files stored in OneDrive folders, uncheck the Show files option or press Ctrl + E.

  • To refresh the current view with the most up-to-date folders/files, select the Refresh option or press F5.

Creating a OneDrive Connector Index Form

You can create an index form that allows you to log into OneDrive automatically at the MFP. Do the following:

  1. Make sure that you have logged into OneDrive from Dispatcher Phoenix Web’s Account Manager.

  2. Make sure that your workflow includes a MFP Panel node and OneDrive Connector node.

  3. Open up the Index Form Builder from the MFP Panel node. You should see a OneDrive Connector button under the Workflow Index Fields area.

  4. Drag and drop the OneDrive Connector button to the Index Form work area. A Scan to OneDrive index form will automatically appear, as in the following illustration:

    OneDrive Index Form

  5. Save and close the Index Form Builder.

  6. The OneDrive Connector node properties window will be automatically populated with the variable names of the fields on the Index Form. Although you cannot edit the fields on this window, you can click on the wrench tool button to go to that section or field in the Index Form Builder. See the following illustration:

    OneDrive Index Form

OneDrive Index Form on MFP

At the MFP, the OneDrive Index Form will appear as follows:

OneDrive at MFP

Database Browsing - OneDrive Configuration

You can also manually configure a query to retrieve data (e.g., list of folders, validation, etc.) from OneDrive.

Using the Index Form Builder, do the following:

  1. Add a new field, such as a drop-down list.

  2. Define an On Load event for the field; then add a Query.

  3. Choose OneDrive Data Source from the Query drop-down list.

  4. The OneDrive Data Source Configuration window appears, which allows you to perform specific actions in order to retrieve data from OneDrive.

    OneDrive Data Source Configuration Window

    Do the following:

    • In the Friendly Name field, enter an identifying name for the OneDrive data source configuration.

    • In the Action area, you can choose what kind of action to perform on the OneDrive data source. Options include:

      • Get Primary OneDrive Account – This option returns the primary OneDrive account for the user.

      • Get OneDrive Accounts - This option returns all the OneDrive accounts for the user.

      • Get OneDrive Folders - Use this action to display a list of folders within a specific OneDrive Folder Path. When you select the Get OneDrive Folders item, new fields will appear for configuration, as in the following illustration:

        Get OneDrive Folders

    • Folder Path – Enter the folder ID of the OneDrive root folder that you want displayed at the MFP panel.

      • Show new folder option – Check this option to allow the user to create a new OneDrive folder at the MFP.

      • Show files - Check this option to display files in OneDrive folders at the MFP.