Skip to main content

Write to SharePoint

Toni Gonzales
  • Updated

The Write to SharePoint workflow action writes output files from the Typefi Job folder to your organisation's SharePoint Online Shared library. To write output files to SharePoint, you must first use the Copy from SharePoint action.

 

WritetoSharePoint_empty.png

Field

Description

Properties

Manage your file-handling preferences by defining your properties in an external .txt file. For example, you can choose what file types you want to write to SharePoint. To create a .txt file, refer to the Define SharePoint properties section for a list of properties and functions.

Click the Choose Files or Folder icon 02-folder-icon.png to choose your .txt file.

Shared library

A dropdown menu will display a list of available Shared libraries to signed-in users connected to SharePoint. If you are not connected to SharePoint, the Shared library field shows ---. To connect, please see the help article, Connect SharePoint to Typefi Server.

The Shared library works with the writeToPath="" property to determine the output location.

Define SharePoint properties

The Write to SharePoint action uses a properties .txt file to specify the desired file type and the target location to save files within your Shared library.

To define these properties, create a customised .txt file with your file-handling preferences. Create a new line for each file type you want to write to SharePoint. For an example, see the attached sharepoint-properties.txt.

Example

The line in the .txt file moves the latest output.cxml to a new folder in a Shared library and overwrites an existing file.

<filetype="cxml" writeToPath="${root-sharepoint-path}" createFolder="yes" conflictBehavior="replace" copyLast="yes">

Property

Description

filetype=””

(Required)

Specifies the type of file to be saved from the Typefi job folder to your selected Shared library (required for accurate file handling).

To specify a file type in your .txt file, include one of the following values: CXML, INDD, PDF, XML, or EPUB (for example, filetype= “cxml”). To specify multiple file types, set preferences for each file type on separate lines.

See the attached sharepoint-properties.txt file for an example.

writeToPath=””

(Required)

Specifies the root SharePoint path where you want to save your files in the Shared library.

In your .txt file, use ${root-sharepoint-path} to match the Destination stored by the Copy from SharePoint action; for example,writeToPath=${root-sharepoint-path}. For more information, please see the Copy from SharePoint.

createFolder=””

(Required)

Creates a folder when one does not already exist in your selected Shared library. In your .txt file, set the createFolder=”” property to "yes".

If no folder exists and you remove this property or set it to “no”, you’ll get an error.

conflictBehavior=””

Configure how to handle existing files at the specified location indicated by writeToPath=””:

  • Set conflictBehavior= “rename” to rename a file by adding a counter (for example,output-2.cxml) to prevent overwriting the existing file.

  • Set conflictBehavior= “replace” to overwrite the existing file with a new one.

  • Set conflictBehavior= “fail” to prevent overwriting existing files by failing the job.

copyLast=””
  • Use copyLast= “yes”to save only the last generated file of a specific type.
  • Use copyLast= “no” or remove this property to copy all specified file types.

Feedback

The Write to SharePoint workflow action was created in response to a customer request for their XML-based workflow. It is not yet compatible with Typefi Writer-based workflows and may not fit all XML-based workflows.

We value your input and welcome your feedback and suggestions regarding how we can customise the SharePoint integration to align with your organisation's needs. Please reach out; we're happy to help!

See also

Related articles

Comments

0 comments

Please sign in to leave a comment.