Document Services Framework for Microsoft OneDrive
Integrate the Document Services Framework with Microsoft OneDrive.
Request apps on the Store
Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Integration Hub subscription
This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.
Spoke version
Microsoft OneDrive spoke for Document Services Framework spoke v 1.2.2 is the latest version.
Supported versions
This spoke was built for Microsoft OneDrive Spoke for Document Services Framework V1.1, but might be compatible with later versions.
Key features
Microsoft OneDrive Spoke for Document Services Framework enables a flow designer to do the following:
- Upload documents to Microsoft OneDrive
- Collaborate
- Manage versions
- Download documents
Spoke dependencies
If you’re having trouble installing the app, ensure that these dependent plugins are installed:
- Complex Object (com.glide.cobject)
- IHUB Spoke Util Pack (com.snc.ihub_spoke_util_pack)
- Multi Provider Document Services Framework (com.snc.multiprovider_documents)
- Remote Directory Sync (com.snc.remote_directory_sync)
- ServiceNow Flow Designer - Dynamic Inputs (com.glide.hub.dynamic_inputs)
- ServiceNow IntegrationHub Action Step - REST (com.glide.hub.action_step.rest)
- ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime)
Note: Some of these plugins are licensable features and require appropriate licenses if used outside the spoke implementation.
Spoke subflows
The Microsoft OneDrive Spoke for Document Services Framework provides sample subflows to demonstrate the automation of Document Services tasks. To customize a sample subflow, copy it to a new application scope. The following tables list the available sample subflows for V1 and V2.
Note: Only V2 subflows support the Microsoft SharePoint site.
| Subflow | Description |
|---|---|
| Add Collaborator To Group | Adds the supplied CollaboratorID as the Member or Owner specified by Type. |
| Collaborate Document | Associates a document with a group or a user on Microsoft OneDrive. |
| Collaborate Document With Recipient Type | Associates a document with a specified Recipient Type |
| Connect Document From OneDrive Using Path | Connects the Microsoft OneDrive document. |
| Copy OneDrive Document Version | Copies the document with the specified version from Microsoft OneDrive to an attachment in the ServiceNow instance. |
| Create Document | Copies the document to Microsoft OneDrive, creates a record in the Multi Provider Document \[mp\_document\] table, and adds a version in the Multi Provider Document Version \[mp\_document\_version\] table. |
| Create Group | Creates a group as specified in Microsoft OneDrive and updates the Multi Provider Permission Configuration \[mp\_permission\_configuration\] table. |
| Delete Document | Deletes the document in Microsoft OneDrive and removes its corresponding records in the Multi Provider Document Version \[mp\_document\_version\] tables. |
| Delete Document Version | Deletes the specified version of the document in Microsoft OneDrive and the ServiceNow instance and deletes a record in the Multi Provider Document Version \[mp\_document\_version\] table. |
| Get All Document Version | Retrieves all document versions from Microsoft OneDrive and creates and updates records in the Multi Provider Document Version \[mp\_document\_version\] table. |
| Get Document from OneDrive | Copies the document from Microsoft OneDrive to the specified document name. It also creates a record in the Multi Provider Document \[mp\_document\] table and in all document versions in the Multi Provider Document Version \[mp\_document\_version\] table. |
| Restore Document Version | Restore the document to the version in Microsoft OneDrive. |
| Sync Collaborators | Syncs all Microsoft Azure users into the Multi Provider Collaborators [mp_collaborators] table.If the user is deleted or updated, the user's record in the Multi Provider Collaborators [mp_collaborators] table is checked, if it’s present then the record is deleted or updated. If the user is newly added, then it creates an entry in the Multi Provider Collaborators [mp_collaborators] table under Multi Provider Documents. Note: The scheduled job with the name Sync Collaborators triggers the subflow for Sync Collaborators. You can choose from the available run a script option. The default option is On Demand. The job is run based on the set schedule and collaborators are synchronized accordingly. For more information, see Automatically run a script of your choosing. |
| Delete Collaborator Record | Deletes the specified collaborator record from the Multi Provider Collaborators \[mp\_collaborators\] table. |
| Update Document Content | Updates the specified document with the provided attachment in Microsoft OneDrive that corresponds to the document ID. The attachment name should match the name of the document in Microsoft OneDrive. |
| Upload Large File | Uploads an attachment to Microsoft OneDrive. The maximum size of the file can’t exceed 60 MB. |
| Get Latest URL | Gets the latest URL to a document in the Microsoft OneDrive. |
| Reconnect Document from Microsoft OneDrive | Reconnects to a document in Microsoft OneDrive. Note: Before using the subflow, ensure that the corresponding Microsoft OneDrive connection and credential are created and the Microsoft OneDrive authorization token is available. |
| Subflow | Description |
|---|---|
| Get Document Latest URL V2 | Gets the latest URL from Microsoft OneDrive for the referred document ID. |
| Update Document Content V2 | Updates the specified document with the provided attachment content in Microsoft OneDrive corresponding to the document ID from table Multi Provider Document sys\_id. The attachment name should match with the name of the document in Microsoft OneDrive. |
| Collaborate Document V2 | Associates a document with a specified recipient type. |
| Connect Document From OneDrive Using Path V2 | Connects the Microsoft OneDrive document that can also be tracked under Multi Provider Documents. |
| Copy OneDrive Document Version V2 | Copies the document with the specified version from Microsoft OneDrive to an attachment in the ServiceNow instance. |
| Create Document V2 | Copies the document to Microsoft OneDrive and creates a record in the Multi Provider Document \[mp\_document\] table and the Multi Provider Document Version \[mp\_document\_version\] table for Multi Provider Documents. |
| Delete Document V2 | Deletes the document in Microsoft OneDrive and removes its corresponding records in the Multi Provider Document \[mp\_document\] table and the Multi Provider Document Version \[mp\_document\_version\] tables. |
| Delete Document Version V2 | Deletes the particular version of the document in bothMicrosoft OneDrive and deletes a record in the Multi Provider Document Version \[mp\_document\_version\] table under Multi Provider Documents. |
| Get All Document Versions V2 | Retrieves all the document versions from Microsoft OneDrive and creates or updates records in the Multi Provider Document Version \[mp\_document\_version\] table under Multi Provider Documents. This subflow supports documents from different sources supported by Microsoft OneDrive. |
| Get Document from OneDrive V2 | Copies the document from Microsoft OneDrive to the specified document name. It also creates a record in the Multi Provider Document \[mp\_document\] table and all its versions in the Multi Provider Document Version \[mp\_document\_version\] table under Multi Provider Documents. |
| Reconnect Document from Microsoft OneDrive V2 | Reconnects to a document in the Microsoft OneDrive.Note: Before using the subflow, ensure that the corresponding Microsoft OneDrive connection and credential are created and the Microsoft OneDrive authorization token is available. |
| Restore Document Version V2 | Restores the document to the version provided in the Microsoft OneDrive. |
| Sync Collaborators V2 | Syncs all Microsoft Azure users into the Collaborators \[mp\_collaborators\] table under Multi Provider Documents. |
| Upload Large File V2 | Uploads an attachment to Microsoft OneDrive. The maximum size of the file can't exceed 60 MB. |
| Remove Document Collaboration | Removes collaboration on a Microsoft OneDrive document. |
| Update Document Collaboration | Updates collaboration on a Microsoft OneDrive document. |
Note: The V2 subflows work only for documents attached to the platform using the Create Document V2 or Connect Document V2 subflows.
.
Spoke Actions
The Microsoft OneDrive Spoke for Document Services Framework provides sample actions to automate Document Services tasks when events occur in ServiceNow. The following table lists the available sample actions.
| Action | Description |
|---|---|
| Delete Collaborator Record | Deletes the specified collaborator record from the Multi Provider Collaborators \[mp\_collaborators\] table. |
| Delete document | Deletes the document record from the Multi Provider Document \[mp\_document\] table. |
| Delete document and versions | Deletes the specified document and all of its versions from the Multi Provider Document Version \[mp\_document\_version\] table. |
| Delete document version | Deletes specified versions of a document from the Multi Provider Document Version \[mp\_document\_version\] table. |
| Delete versions of document | Deletes all versions of a specified document. |
| Look up Target Record Existence | Checks for the existence of a target record in the specified target table. |
| Look Up Incremental Files and Folders |
Note: Search results may vary due to Microsoft OneDrive 's indexing behavior. |
| Look up Sites Based On Query String Stream | Lists all the sites satisfying the specified query string. |
| Update Delta Token | Updates the system property deltaToken with the specified delta token. |
Connection and credential alias requirements
Integration Hub uses aliases to manage connection and credential information. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection. For more information, see Connections and Credentials.
For information about setting up the spoke, see Set up Microsoft OneDrive spoke.
Parent Topic:Microsoft OneDrive integration with Document Services