Output Action SharepointAction

This Output Action stores the generated document to a Microsoft SharePoint document library.

Parameters

Note

The parameter names of the Output Actions are not case-sensitive. All parameter names may contain data fields (exceptions are described in the relevant parameters).

Example: FileName = "Application_<%Citizen.Name%>.pdf"

Parameter	Requirement	Description
`Site`	mandatory	Specifies the name of the SharePoint site. Example: `http://mysite.com`
`Library`	mandatory	Specifies the root folder name of the SharePoint document library.
`FileName`	mandatory	Defines the document’s file name. Example: `C:\Documents\SalesReport.pdf` The extension will define the file format (.docx, .xlsx, .pptx, .pdf, .html, …).
`Folder`	optional	Specifies the folder name to which the output will be saved.
`Rootfolder`	optional	Defines the internal name of your SharePoint library.
`SpecialFormat`	optional	Specifies a special format (dox42 Server for Documents only): When generating a PDF: `PDFA1b` `PDFForm`(Form fields are preserved in the PDF). When generating HTML: `HTMLCode`: this will cause the text of the generated document to be interpreted in HTML code.
`Sign`	optional	The format PDF may bear a digital signature (dox42 Server For Documents only). Certificate and corresponding password have to be defined in the web.config file. Value: `true`
`Field1.Name` `Field1.Value`	optional	Fields allow you to write values to columns in the SharePoint document library. You can create multiple Fields: `Field1`, `Field2`, … Use the SharePoint internal field name to identify the field. Note You can find the internal field name by opening the list in the dox42 SharePoint data source and check Use Internal Field Names.
`ContentType`	optional	Set the content type for the item.
`DocumentDataField`	optional	If this field is assigned, the generated document will not be saved in the document library, but the document in the stated dox42 Datafield will be loaded) and saved in the SharePoint document library. Can contain a path, an URL or a binary document. Example: `Data.MyDocument`
`CheckInMessage`	optional	If this field is assigned, the server will check in the document after saving with the stated message. If a document of the same title is already existing, this document will be checked out automatically.
`Username`	optional	If not provided, the service account of the dox42 Server will be used for SharePoint authentication.
`Password`	optional	Include your password here.
`SharePoint_online`	optional	Set this flag for Microsoft SharePoint Online. Alternative to parameter `Azure_AD` . Values: `true` or `false`
`SharePoint_FBA`	optional	Set this flag for SharePoint sites with forms based authentication. Values: `true` or `false`
`Azure_AD`	optional	The Request must include an Authorization Header containing Azure Active Directory Token - alternative to parameter `SharePoint_online`. Values: `true` or `false`
`retry_count`	optional	Defines that the SharePointAction should retry to save the document in case of error (e.g. timeout) and specifies the number of retries. Value: `number >= 0` Default = `0` (no retry).
`Condition`	optional	If value false, the Output Action will not be performed.

Set special SharePoint and Managed Metadata Fields

Metadata field type	Description
Choice field	Set the value.
Multi value choice field use	Use `;#` to separate the values. Example: `red;#green;#yellow`
Lookup/Person/Group-field	Set the ID.
Set a multi value Lookup/Person/Group-field.	Set the ID and the value like `ID;#Value`. Example: `3;#Hawaii;#9;#Vienna;#13;Melbourne` Only the IDs are used to set the field, the values are ignored (but may not be omitted).