SharePoint

Introduction

The purpose of this manual is to detail how to configure and integrate Qflow with SharePoint to allow interaction between both platforms, thus enabling operations on files in sites and document libraries.

SharePoint has the following actions:

• Upload file

• Get file

• Create folder

• Edit folder

• Edit document

• Delete file

• Delete folder

See Actions for the description and content of each one.

Prerequisites

You must have a Microsoft account with access to SharePoint Online or OneDrive for Business. This can be configured from the Microsoft site aquí.

Application parameter

To establish the connection it is necessary to have at least one application parameter (see Application parameters) that allows communication between Qflow and SharePoint. This parameter can be created from the service task configuration in Qflow. (see Connector configuration from a Service Task)

The following steps detailed below are required to create a SharePoint application parameter.

Application parameter using OAuth

This type of application parameter requires signing in to the SharePoint account from Qflow. This is done in the connector configuration by following the OAuth flow steps.

Once the above steps are completed, it will be possible to interact with SharePoint from Qflow.

Actions

The following actions can be performed with SharePoint:

Upload file

This action allows uploading a file to a SharePoint site. The file to be uploaded and the site URL must be provided. Optionally, you can specify the document library (if omitted, the site’s default is used), the destination folder within the library (using Path and/or Folder ID or name), a file name, and whether to overwrite an existing file with the same name. If overwrite is not enabled and a file with that name already exists, a new one will be created with a suffix (1), (2), etc. Paths are normalized (slashes and spaces). It is also possible to send file properties to update library columns during the upload.

Table 88 Inputs

Input	Description
File	Required. The file to upload. The maximum allowed size is 50 MB.
Site URL	Required. Absolute URL of the SharePoint site.
Document library	Name of the document library; if omitted, the site default is used.
Path	Folder within the library where the file will be stored, for example “Invoices/2025”. It is combined with what is entered in Folder ID or name when that field is a name or a location; it is not used when that field indicates a unique identifier. The path is corrected automatically: leading or trailing slashes, duplicate slashes, and unnecessary spaces are removed.
Folder ID or name	Destination folder within the library. You can specify its name (for example, Invoices), its location within the library (for example, Invoices/2025), or its unique identifier. If omitted, the file is uploaded directly to the folder indicated in Path (or to the root of the library).
File name	Name to save the file with; if not specified, the original name is used.
Overwrite	If enabled, an existing file with the same name is overwritten. If disabled and that name already exists, a new file is created with suffix (1), (2), etc.
File properties	Key/value structure to update file properties in the library. The key must match the column name in SharePoint, and the value corresponds to the data to be stored. Supported types are: Text, Number, Boolean, Date, and Date/Time.

Table 89 Outputs

Output	Description
Document link	View link for the uploaded file.
Document ID	Identifier of the document in SharePoint.

Get file

This action allows retrieving a file from a SharePoint site. The site URL and the file to retrieve must be provided, identifying it by name, location, or unique identifier. Optionally, you can specify the document library and the path where the file is located. If no library is specified, the site’s default is used. In addition to the file content, it is possible to map file properties to internal process data.

Table 90 Inputs

Input	Description
Site URL	Required. Absolute URL of the SharePoint site.
Document library	Name of the document library; if omitted, the site default is used.
Path	Folder within the library where the file is located. It is combined with what is entered in File ID or name when that field is a name or a location; it is not used when that field indicates a unique identifier.
File ID or name	Required. File to retrieve. You can specify its name (for example, invoice.pdf), its location within the library including the name (for example, Invoices/invoice.pdf), or its unique identifier.

Table 91 Outputs

Output	Description
Properties	Key/value structure that maps document library column names to internal process data. The values read from those columns in SharePoint are written directly to the mapped data when the file is retrieved.
File	File retrieved from SharePoint.

Create folder

This action allows creating a folder in a SharePoint document library. The site URL and the name of the folder to create must be provided. Optionally, you can specify the document library, the path where the folder will be created, and properties to assign to it. If a folder with the specified name already exists at the indicated path, the existing folder is used instead of creating a duplicate.

Table 92 Inputs

Input	Description
Site URL	Required. Absolute URL of the SharePoint site.
Document library	Name of the document library; if omitted, the site default is used.
Path	Folder within the document library where the new folder will be created, for example “Invoices/2025”. Leave it empty to create the folder directly in the library. The folder indicated here must already exist.
Folder name	Required. Name of the folder to create. If a folder with that name already exists at the indicated path, the existing folder is used and no duplicate is created.
Properties	Key/value structure with the values assigned to the new folder. The key must match the column name in the document library, and the value corresponds to the data to be stored. If any of the specified names does not exist in the library, the operation fails.

Table 93 Outputs

Output	Description
Folder ID	Identifier of the created (or existing) folder in SharePoint.
Folder URL	Web URL of the folder in SharePoint.

Edit folder

This action allows updating custom properties and/or granting access to an existing folder in a SharePoint document library. The site URL and the folder to edit must be provided, identifying it by name, location, or unique identifier. Optionally, folder properties can be updated and edit or read-only permissions can be granted to email addresses, with the option to notify them by email.

Table 94 Inputs

Input	Description
Site URL	Required. Absolute URL of the SharePoint site.
Document library	Name of the document library; if omitted, the site default is used.
Path	Indicates where the folder to edit is located, for example “Invoices/2025”. Leave it empty if the folder is at the root of the library.
Folder ID or name	Required. Folder to edit. You can specify its name, its full location within the library, or its SharePoint identifier.
Properties	List of properties to update on the folder. Enter the document library column name on the left and the new value on the right. If the specified column does not exist in the library, the operation fails.
Emails granted edit permission	Email addresses that will be able to edit the folder. One or more addresses can be entered.
Emails granted read-only permission	Email addresses that will be able to view the folder but not edit it. One or more addresses can be entered.
Send invitation email	If enabled, SharePoint sends an invitation email to each of the people listed above. If not enabled, access is granted without notifying them.

Edit document

This action allows updating custom properties and/or granting access to an existing document in a SharePoint document library. The file’s content is not altered. The site URL and the document to edit must be provided, identifying it by name, location, or unique identifier. Optionally, document properties can be updated and edit or read-only permissions can be granted to email addresses, with the option to notify them by email.

Table 95 Inputs

Input	Description
Site URL	Required. Absolute URL of the SharePoint site.
Document library	Name of the document library; if omitted, the site default is used.
Path	Indicates where the document to edit is located, for example “Invoices/2025”. Leave it empty if the document is at the root of the library.
File ID or name	Required. Document to edit. You can specify its name, including the extension (for example, invoice.pdf), or its SharePoint identifier.
Properties	Lista de propiedades que se actualizarán en el documento. Se debe indicar el nombre de la columna de la biblioteca de documentos a la izquierda y el nuevo valor a la derecha. Si la columna indicada no existe en la biblioteca, la operación falla.
Emails granted edit permission	Email addresses that will be able to edit the document. One or more addresses can be entered.
Emails granted read-only permission	Email addresses that will be able to view the document but not edit it. One or more addresses can be entered.
Send invitation email	If enabled, SharePoint sends an invitation email to each of the people listed above. If not enabled, access is granted without notifying them.

Delete file

This action allows deleting a document from a SharePoint document library. The site URL and the file to delete must be provided, identifying it by name, location, or unique identifier. Optionally, you can specify the document library and the path where the file is located. The deleted file is moved to the site’s recycle bin.

Table 96 Inputs

Input	Description
Site URL	Required. Absolute URL of the SharePoint site.
Document library	Name of the document library; if omitted, the site default is used.
Path	Folder within the library where the file to delete is located.
File ID or name	Required. File to delete. You can specify its name (including the extension), its location within the library, or its unique identifier.

Delete folder

This action allows deleting a folder from a SharePoint document library, including its content. The site URL and the folder to delete must be provided, identifying it by name, location, or unique identifier. Optionally, you can specify the document library and the path where the folder is located. The deleted folder is moved to the site’s recycle bin.

Table 97 Inputs

Input	Description
Site URL	Required. Absolute URL of the SharePoint site.
Document library	Name of the document library; if omitted, the site default is used.
Path	Folder within the library where the folder to delete is located.
Folder ID or name	Required. Folder to delete. You can specify its name, its location within the library, or its unique identifier.

Note

Integrations with external platforms depend on the policies, conditions and technical characteristics defined by their respective providers. Any changes to such services (including APIs, integration mechanisms, functionality and costs) are beyond Qflow’s control.