API integration
You can integrate your system with the WorkZone for Office add-in, access the existing files, and create new documents via the API. To do this, you must use the wzfo.integration.js
javascript module. The module includes asynchronous methods that return jQuery
promises. Use the promises to track the status of asynchronous operations.
When you install the WorkZone for Office Server, the installer adds the wzfo.integration.js
file to the WorkZone Server.
Method | Description |
---|---|
initialize
|
Optional method. Determines language settings of the integration module. It receives the |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Opens a requested email. This method requires WorkZone record Id.
|
|
Creates a new Microsoft Word document that is linked to an existing document. This method requires a document ID of the existing document.
|
|
Creates a new email with the following parameters:
|
|
Creates a new email with an attachment. This method requires the following parameters:
Example: {ids:[<id>,<id>],asPdf:false}
Note: If there is no PDF file of the requested document on the server, neither the PDF nor the original file will be attached.
|
|
Creates a new folder in Microsoft Outlook. This folder is located in Process Views -> My Views. This method requires the following parameters:
|