DocuWare

With the DocuWare modules in Make, you can:

  • store a document in the store

  • list, retrieve, search, and download files and documents

  • convert, delete, transfer, update, append, delete, and replace files, and documents.

To get started with DocuWare, create an account at docuware.com.

Note

To be able to use DocuWare with Make, it is necessary to have a DocuWare Cloud System running.

Note

The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!

Connect DocuWare with Make

To connect the Docuware app with the Make:

  1. Log in to your Make and add a module from the DocuWare into a Make scenario.

  2. Click Add next to the Connection field.

    Docuware_1.gif
  3. In the Connection name field, enter a name for the connection.

  4. In the DocuWare Server URL field, enter the DocuWare Cloud System URL. For example, organization.docuware.cloud.

  5. In the DocuWare Username  and DocuWare Passwords fields, enter your DocuWare account credentials respectively.

  6. Click Save.

You have successfully connected the DocuWare app with the Make and can now build scenarios.

Store to DocuWare

You can store documents using the following module.

Store a document in a file cabinet or document tray.

Connection

Establish a connection to your DocuWare account.

Select or Map

Choose between a guided select mode or the straight map mode.

File Cabinet/Document Tray ID

Select or map the ID from a File Cabinet or a Document Tray. For example in the Platform, under the File Cabinet endpoint and Document Trays, the IDs are recognizable by @IsBasket = “true".

https://{organization}.docuware.cloud/DocuWare/Platform/FileCabinets

Store Dialog ID

Select or map the ID of the store dialog you want to use. The dialog must have a relation to the File Cabinet or Document Tray.

In the case of a Document Tray, the relation is coming from the assigned File Cabinet and can be found in the parameter @AssignedCabinetId.

Finding the right dialog is possible via the following platform endpoint,  https://{organization}.docuware.cloud/DocuWare/Platform/FileCabinets/{FileCabinetID}/Dialogs?dialogType=Store.

Index Fields

Enter (map) the index field and its value. You can multiple fields.

File

Enter (map) the file details:

File Name

Enter (map) the file name, including the extension, For example, invoice.xml.

Data

Enter (map) a binary or text data that should be uploaded.

Get from DocuWare

You can list file cabinets, retrieve document information, and search and download files and documents using the following modules.

Lists all file cabinets from an organization.

Connection

Establish a connection to your DocuWare account.

Limit

Set the maximum number of Cabinets Make will return during one execution cycle. The default value is 100.

Gets a document complete with all keyword fields and table fields.

Connection

Establish a connection to your DocuWare account.

File Cabinet/Document Tray ID

Select or map a File Cabinet or Document Tray ID whose document details you want to retrieve.

Document ID

Enter (map) a Document ID whose details you want to retrieve.

Searches for one or more documents in a file cabinet or document tray.

Connection

Establish a connection to your DocuWare account.

Select or Map

Choose between a guided select mode or the straight map mode

File Cabinet/Document Tray ID

Enter (map) the File Cabinet ID or Document Tray ID whose documents you want to search.

Note

In case you have selected the select mode, you can select a File Cabinet ID.

Search Dialog ID

Enter (map) the Search Dialog ID of the document you want to search.

Note

The dialog must have a relation to the File Cabinet or Document Tray.

Search Fields

Enter (map) the fields to search:

Field Name

Enter (map) a field value.

From

Enter (map) the date to search the document created on or after the specified date. See the list of supported date and time formats.

To

Enter (map) the date to search the document created on or before the specified date. See the list of supported date and time formats.

Limit

Set the maximum number of documents Make will return during one execution cycle.

Downloads a file from a document.

Connection

Establish a connection to your DocuWare account.

File Cabinet/Document Tray ID

Select or map a File Cabinet ID or Document Tray ID whose file you want to download.

Document ID

Select or map a Document ID whose file you want to download.

File Position

Enter (map) the position of the file in the document. By default, the position starts with 1.

Downloads a document (e.g., original, PDF with annotations, or PDF without annotations).

Connection

Establish a connection to your DocuWare account.

File Cabinet/Document Tray ID

Select or map a File Cabinet ID or Document Tray ID whose document you want to download.

Document ID

Select or map a Document ID you want to download.

Download Format

Select or map the download format:

  • Original

  • as PDF with all annotations

  • as PDF without annotations

Altering Documents

You can replace, delete and transfer the documents, and files using the following modules.

Converts the index fields of a document or a list of documents to a flat list.

Connection

Establish a connection to your DocuWare account.

Input Documents

Enter (map) the index fields:

System Field

Select whether this is a system field.

Field Name

Enter (map) a field name.

Field Label

Enter (map) the field label.

Is Null

Select whether this is a null field.

Read Only

Select whether this is read-only.

Value

Enter (map) a value

Value Type

Enter (map) the value type.

List Items

Enter (map) the data record fields to be displayed in the list.

Note

Separate the values with a comma (e.g., first, second). Their order will be reflected in the result list.

Deletes a document in a file cabinet.

Connection

Establish a connection to your DocuWare account.

File Cabinet/Document Tray ID

Select or map a File Cabinet or Document Tray ID whose documents you want to delete.

Document ID

Enter (map) a Document ID you want to delete.

Transfers a document from one to another file cabinet.

Connection

Establish a connection to your DocuWare account.

Source File Cabinet/Document Tray ID

Select or map a Source File Cabinet or Document Tray ID whose document you want to transfer.

Select or Map

Choose between a guided select mode or the straight map mode.

Target File Cabinet/Document Tray ID

Enter (map) a File Cabinet or Document Tray ID to transfer the document. In selection mode, each field is loaded from the selected dialog.

Index Dialog ID

Enter (map) the Index Dialog ID. The dialog must have a relation to the File Cabinet or Document Tray.

Document IDs

Enter (map) the Document IDs:

Transfer Document ID

Enter (map) the Document IDs to transfer.

Index Fields

Enter (map) the index fields:

Note

In selection mode, each field is loaded from the selected dialog. The label has the format INDEXFIELDLABEL (field type). Every Input element will represent the field type.

Field Name

Enter (map) a field name.

Value

Enter (map) a value for the field.

Keep Source Document

Select whether to retain the document at the source file cabinet or document after transferring.

Use Intelligent Indexing Data for Empty Index Field

Select whether to use intelligent indexing data for every empty index field.

Updates the index fields of a document.

Connection

Establish a connection to your DocuWare account.

Select or Map

Choose between a guided select mode or the straight map mode.

File Cabinet/Document Tray ID

Select or map a File Cabinet or Document Tray ID whose document index fields you want to update. In selection mode, each field is loaded from the selected dialog.

Document ID

Enter (map) a Document ID to update the index fields.

Index Fields

Enter (map) the index fields:

Field Name

Enter (map) a field name.

Value

Enter (map) a field value.

Field Type

Select the field type:

  • Text

  • Numeric

  • Decimal

  • Date

Adds a file to a document.

Connection

Establish a connection to your DocuWare account.

File Cabinet/Document Tray ID

Select or map a File Cabinet or Document Tray ID whose file you want to append.

Document ID

Enter (map) a Document ID of a document to append the file.

File

Enter (map) the file details:

File Name

Enter (map) the name of the file to append, including the extension, for example, invoice.xml.

File Data

Enter (map) the binary or text data to be uploaded.

Deletes a file in a document.

Connection

Establish a connection to your DocuWare account.

File Cabinet/Document Tray ID

Select or map a File Cabinet or Document Tray ID whose file you want to delete.

Document ID

Enter (map) a Document ID of a document to delete the file.

File Position

Enter (map) the position of a file, starting with 1.

Replaces a file in a document.

Connection

Establish a connection to your DocuWare account.

File Cabinet/Document Tray ID

Select or map a File Cabinet or Document Tray ID whose file you want to replace.

Document ID

Enter (map) a Document ID of a document to replace the file.

File Position

Enter (map) the position of a file, starting with 1.

File

Enter (map) the file details:

File Name

Enter (map) the name of the file to append, including the extension, for example, invoice.xml.

File Data

Enter (map) the binary or text data to be uploaded.

Places a stamp on a file page in a document.

Connection

Establish a connection to your DocuWare account.

Select or Map

Choose between a guided select mode or the straight map mode.

File cabinet/Document Tray ID

Select or map a File Cabinet or Document Tray ID whose file place you want to stamp.

Document ID

Enter (map) a Document ID to which you want to stamp the file.

File Position

Enter (map) the position of a file, starting with 1.

Page Number

Enter (map) the page number to place the stamp on. For example, 2 would place a stamp on the file's second page.

Stamp ID

Enter (map) a Stamp ID of a stamp to place on file.

Stamp Form Fields

Enter (map) the field name and its value. You can add multiple fields.