Invoice Approval
| Date and Time | User | Processstep |
|---|
| Name | Web App Service Name (example: webapp-cpro-archive). |
| Publish | Code. |
| Runtime Stack | .Net 8 (LTS). |
| Operating System | Windows. |
| Region | Same region as the Azure Resource Group (example above: West Europe). |
| Pricing Plan | Same region as the Azure Resource Group (example above: West Europe). |
| Resource Group | The resource group that was created |
| Database Name | Any name based on your preference |
| Server | Follow the server that has been configured for the rest of the Azure Resources |
``` curl -X 'PUT' \ 'https://
| System Fields | /pages/tEOXuVaKB3OiemgBFMJF |
| Workflow Index Fields | /pages/66fe8a09baf3f85d4daca021b6fda626dcde3825 |
* Assign Document to User for Web Validation. *** ### \_errorMessage The variable \_errorMessage is used to store details about errors that arise in different modules, such as the Service Task. For instance, it records issues when the extraction module fails to process documents that haven't undergone OCR. Additionally, this variable can be set in a Script Task to indicate any problems encountered, for example: ```javascript _errorMessage = 'Web Service did not return expected result'; onwards = false; // keep the document in this workflow step ``` *** ### \_status A system variable set by a previous workflow step, commonly during web validation. Function: * Captures the button pressed by the user when closing a document. Values: * No value: * Indicates that the document was completed normally. * invalid: * Assigned when the user presses the 'Complete Ignoring Validation' button, despite one or more invalid field values. Purpose: * Determines the routing of the document to appropriate process steps based on the user's action selected during web validation. The \_status variable will be assigned one of the following values by Web Validation: * No value if the document is Completed normally without validation errors. * 'invalid' if the document is completed with validation errors (also if a Custom Button is used to complete the document). * 'reject' if the Reject button is used. * 'return' if the Return button is used. * 'rework' if the Rework button is used. * 'rescan' if the Rescan button is used. #### Using \_status in Script The \_status value can be assigned and read in a ScriptTask. Here is a sample script assigning (setting) the \_status value: ```javascript status = 'reject'; ``` In this case, the field status gets the value 'reject' assigned. Here is a sample script reading the currently assigned value in \_status: ```javascript var status; status = _status; ``` {% hint style="info" %} The \_status value is a string. {% endhint %} *** ### \_moveToStep In the workflow designer, up to 3 custom buttons can be configured:
| Label | Description |
|---|---|
| Page (starts at 0) | Used in Web Validation indicating which page the field applies to and hence web validation opens that page when the document is active. Does not apply to My Home. |
| Name |
|
| Display Name | The name is used for displaying in Process Monitor, My Home Task and Web Validation. It can contain spaces and special characters. |
| Tab name in My Home |
|
| Column in My Home (1,2,3) | Index fields can be arranged in up to 3 columns in My Home. If the value is left empty, the index value is by default in column 1. |
| Datatype | YizclLKriu5p |
| Type | Description |
| string | Allows to store up to 20,000 characters. If data with more than 20,000 characters needs to be stored, that should be added as a file in additional data. |
| amount | An amount field which includes thousand separator and always has two decimal places |
| date |
|
| datetime |
|
| lookup |
|
| number | A numeric field without decimal places. |
| Default Value |
|
| Is Required | If set, the My Home/Web Validation requires a value to be set. In case the value is empty, an error message is displayed to the user and the user cannot complete the document with the Complete Button. |
| Hide |
|
| Hide in Workflow Monitor |
|
| Read Only | When enabled, the field can only be read by the user but not modified. |
| Min Value | The minimum value that can be entered. For example, if 'Min Value' is set to 50, the user cannot enter 49. |
| Max Value | The maximum value that can be entered. For example, if 'Max Value' is set to 50, the user cannot enter 51. |
| Min Length | If set, the user needs to enter a value with minimum that length. It is ideal to check fixed length fields such as IBAN, Account Numbers, Tax Numbers. |
| Max Length | If set, the user needs to enter a value not exceeding that length. It is ideal to check fixed length fields such as IBAN, Account Numbers, Tax Numbers. |
| Lookup Values | See 'Datatype Lookup' above. |
- A date field. Will display with a data picker in My Home and Web Validation.
- Dates are displayed in the local formatting according to the browser’s regional settings.
- In order to store a date via script correctly, it needs to be in the format YYYY-MM-DD.
- This field includes a date and time picker in 'My Home' and 'Web Validation'.
- Dates and times are displayed according to the browser's regional settings.
- Time is shown with hours and minutes and is adjusted for the UTC time difference.
- For correct script storage, datetime must be formatted as YYYY-MM-DDTHH:mm:ss+00:00, such as "2017-12-31T23:59:59+02:00" to represent December 31, 2017, at 11:59:59 PM with a 2-hour UTC adjustment.
- Appears as a dropdown list in 'My Home' and 'Web Validation', allowing users to select a value.
Configurable as a key/value pair:
- The 'key' is used for data storage and scripting, while the 'value' is displayed to users.
- Includes an auto-complete feature that allows users to type ahead to filter the dropdown list, which can be configured to look up data from a database.
- Provided by CumulusPro after the initial Setup.
- Please contact CumulusPro for the initial setup.
- This field can be used to group similar values together.
- For instance, in a product catalog, it can group all items labeled as 'Tools' under one title and all 'Electrical' items under another.
- This option filters the database based on the value from 'WF Field Name Value'.
- Using this filter makes 'WF Field Name Value' a mandatory field.
- By default, only the top 25 entries are displayed, requiring users to start typing to find specific entries. This is suitable for long lists, like Supplier Databases with thousands of entries.
- If set to 'On', all entries that match the filter criteria are displayed, making it easier for users to select items, particularly with shorter lists.
| Straatos API V2 | |
| Straatos Interact API | /pages/1c6a6574f2b6f24b04f42686572cfb20315e3c50 |
| Straatos Adapter Service | /pages/129d726f984715355240f4234a6243705ffa2078 |
| Straatos Script Service API | /pages/590179f634d9db593c71af3af64bda7edad8db13 |
| Straatos XML API | /pages/92e8cd5139cf99a54a399d3fbc6e52f29d577293 |
| Name | Where to look | Description |
|---|---|---|
| createTask | Line 1 | New web service is defined. Web service calls are checked if it is for web service.createTask. |
| Line 4 | New task in Straatos created for the process ‘Test QA Workflow’ and Start Event ‘Start’. | |
| Line 6 | Response provided to calling web service. |
| Region | URL |
|---|---|
| Europe | https://effektifconnector.cumuluspro.net/ConnectorService.svc/json/Interact/ |
| Switzerland | https://effektifconnector-ch.cumuluspro.net/ConnectorService.svc/json/Interact/ |
| Asia | https://effektifconnector-asia.cumuluspro.net/ConnectorService.svc/json/Interact/ |
| Name | Type | Description |
|---|---|---|
| pathSegments | string | Path segments. for example: |
| URL | pathSegments | |
| https://domain.net/Connector.svc/json/Interact/A3B23-GUID-E76B/P2/P3 | ['A3B23-GUID-E76B', 'P2', 'P3'] | |
| queryParameters | For example: URL: https://domain.net/Connector.svc/json/Interact/A3B23-GUID-E76B/P2/P3?id=123&type=b | |
| headers | ? | Request headers as passed into the Interact call, for example, { 'Accept': 'application/json', 'X-Header': '123' } |
| contentType | string | Request content type as passed into the Interact call, for example, application/json |
| body | Request body as passed into the Interact call as byte [] or string using UTF-8 encoding. Not available for multipart requests (Content-Type starts with 'multipart/'). | |
| multipart | MultiPartRequest | Parsed parts of the multipart, only available if the request is a multipart request (Content-Type starts with 'multipart/') |
| Name | Type | Description |
|---|---|---|
| status | number | HTTP status code to return to the client, 200 by default |
| headers | Response headers that are returned to the client. For example: { 'Accept': 'application/json', 'X-Header': '123' } | |
| body | Response body as byte[] or MultiPart. To convert a string to byte[], you can use straatos.getBytes(stringVariable). A MultiPart object can be created using straatos.newFormData() |
| Name | Attribute | Description |
|---|---|---|
| findDocuments | fn(workflowName: string, activityName: string, variables: ?) -> [number] | Find documents in the specified workflow step that match the variables (for example, { 'InvoiceNumber': 'IN12345' }). Returns an array with document ids. |
| messageWorkflow | fn(workflowName: string, activityName: string, documentIds: [number], variables: ?) | Send a message to the specified documents (usually acquired through straatos.findDocuments()) in the specified workflow step. The specified (workflow) variables (for example, { 'Status': 'Verified' }) will be updated. |
| addDocument | fn(workflowName: string, startEventName: string) -> number | Create a document, required for startWorkflow. Returns the document id. |
| addComment | fn(documentId: number, comment: string, commentDateTimeIso8601: string) | Adds a document comment. commentDateTimeIso8601 should be in ISO datetime format (YYYYMMDDThhmmss ie 2021-04-10T16:56:02Z) |
| startWorkflow | fn(documentId: number, variables: ?) | Start the workflow / start event for the specified document (created with addDocument). The specified (workflow) variables (for example, { 'Status': 'Verified' }) will be assigned. |
| getVariables | fn(documentId: number) -> ? | Get the workflow field values for the specified document (for example, { 'Name': 'John', 'InvoiceNumber': 'IN12345' }) |
| setDocumentContent | fn(documentId: number, files: [?], filetype: string, createPagePreviews: bool, createPDFPreviews: bool) | Add content to the document. The filetype parameters must be 'tif', 'pdf' or 'jpg' Each entry in the files parameter array should be a binary (byte[]), either a single (multi page) TIF, a single (multi page) PDF or one or more JPG files. |
| ajax | fn(parameters: AjaxParameters) -> jqXHR | Perform a synchronous HTTP (Ajax) request. |
| getString | fn(data: ?) -> string | Convert byte[] to string using UTF-9 encoding |
| getBytes | fn(data: string) -> ? | Convert string to byte[] using UTF-8 encoding |
| decodeBase64 | fn(data: string) -> ? | Decode base64 string to byte[] |
| encodeBase64 | fn(data: ?) -> string | Encode base64 byte[] to string |
| newFormData | fn() -> MultiPart | Create a new MultiPart object |
| newXMLDocument | fn(documentElementName: string, documentElementNamespace: string) -> JsXmlDocument | Create a new XML document. The documentElementName can contain a namespace prefix (for example, 'ns:company') if a documentElementNamespace is provided. The documentElementNamespace is optional, for elements without namespace this parameter should not be specified. |
| parseXML | fn(data: ?) -> JsXmlDocument | Parses the data parameter (either a byte[] or string containing the XML and returns the XML document |
| transformXSL | fn(xslDocument: JsXmlDocument, inputDocument: JsXmlDocument) -> JsXmlDocument | Transforms the inputDocument using the xslDocument XSL. Returns the result as XML document |
| Name | Attribute | Description |
|---|---|---|
| documentElement | JsXmlElement | The root element of the XML document |
| xml | string | Pretty printed XML string |
| xmlBytes | fn(encoding: string) -> ? | Returns a byte[] of the pretty printed XML, using the specified encoding. If no encoding is specified, UTF-8 is used. |
| Name | Attribute | Description |
|---|---|---|
| text | string | Text value of the element, for example, CumulusPro would return 'CumulusPro'. Can also be updated, e.g. element.text = 'new value'; |
| nodeName | string | Name of the element, for example, CumulusPro would return 'company' |
| namespacePrefix | string | If the element has a namespace, returns the prefix used for example, ns:companyCumulusPro</ns:company> would return 'ns' |
| namespace | string | If the element has a namespace returns the namespace URI, for example, <ns:company xmlns:ns="urn:my-urn">CumulusPro</ns:company> would return 'urn:my-urn' |
| attributes | ? | Returns an object containing properties representing the attributes of the element, e.g. <ns:company ns:attr1="1" attr2="2">CumulusPro</ns:company> would return { 'ns:attr1': '1', '{urn:my-urn}:attr1': '1', 'attr2': '2' } |
| xml | string | Pretty printed XML string |
| addAttribute | fn(name: string, value: string, namespaceURI: string) | Adds a new attribute to the element. If namespaceURI is specified, name can contain a prefix, e.g. 'ns:attr1'. For attributes without a namespace, no namespaceURI should be specified. |
| removeAttribute | fn(name: string) | Removes the attribute by name. |
| addElement | fn(name: string, namespaceURI: string) -> JsXmlElement | Adds a child element to the current element. If namespaceURI is specified, name can contain a prefix, for example, 'ns:company'. For elements without a namespace, no namespaceURI should be specified. |
| remove | fn() | Remove the element from the document |
| selectElements | fn(xPath: string, namespaces: ?) -> [JsXmlElement] | Select elements using the given xPath expression, relative to the current element. Optionally, namespaces can be specified for example, { 'ns': 'urn:my-urn', 'ns2': 'urn:my-urn-2' } |
| selectSingleElement | fn(xPath: string, namespaces: ?) -> JsXmlElement | Select the first element matching the given xPath expression, relative to the current element. Optionally, namespaces can be specified for example, { 'ns': 'urn:my-urn', 'ns2': 'urn:my-urn-2' } |
| stringValue | fn(xPath: string, namespaces: ?) -> string | Evaluates the xPath expression relative to the current element. Optionally, namespaces can be specified for example, { 'ns': 'urn:my-urn', 'ns2': 'urn:my-urn-2' } |
| Name | Description |
|---|---|
| jqXHR | done: fn(callback: fn(data: ?, response: ?)) -> jqXHR fail: fn(callback: fn(response: ?, error: string)) -> jqXHR |
| AjaxParameters | GG4HPafC3gA7 |
| MultiPart | nvqmhbnJhIlx |
| MultiPartFile | F7EoVe62tTIc |
| MultiPartRequest | FB2k6jQOgjbD |
| Name | Where to look | Description |
|---|---|---|
| createTask | Line 1 | We must check for which webservice the call is. In this case, we expect the webservice to have a /createTask at the end. This allows us to create multiple webservices. |
| straatos.addDocument | Line 4 | The straatos.addDocument creates the task. The parameters specified are the workflow name (Test QA Workflow) and the Start Event Name (Start). The function returns the Straatos DocumentID. |
| response.body | Line 9 | We return the webservice response with a message and the DocumentID. The default Status is always 200 (unless set differently). The default Content-Type is text/plain. This can be overruled by e.g. response.headers['Content-Type'] = 'application/json'; |
| Name | Where to look | Description |
|---|---|---|
| forward | Line 1 | We created a new webservice called 'forward' as this is a completely different action to the create task. |
| Test QA Workflow | Line 2 | We want to find a specific document in the workflow 'Test QA Workflow' in the process step 'Wait'. |
| InvoiceNumber | Line 2 | We want to find a (all) documents where the invoice Number is the same as submitted in the header. |
| PaymentStatus | Line 6 | Here we update the document in the workflow. The ' PaymentStatus' is an index field in the workflow that gets updated and the document gets routed to the next stage. |
What are the usual challenges when two applications try to interact via web services?
Each application has its own set of web services with its own parameters, headers, body requirements. The challenge is to make them talk to each other. There are three ways to make that happen: * 3rd party application makes changes to their push web service API calls. * Straatos makes changes to its API definitions. * Use of a 3rd party web service (or Platform) that makes the two web service calls to talk to each other (example: Zapier, Mulesoft).What are the challenges of traditional approaches?
* Knowledge & skills to change the API: * Changes affect other users of the web service. * 3rd party product which can not be changed or requires the vendor to make changes. * Effort and cost to make the changes. * Changes affecting other users: * Duration, cost, and effort to develop a customer-specific web service (days to weeks). * Agility to change Webservices. * No customer self-service to change the Webservices. * 3rd Party Platform (such as Zapier/Mulesoft). * Different geolocation: * Not the feature set required. * Additional subscription/cost. * Additional service/company. * Dedicated web service. * Effort & cost to build an entire/independent web service. * Hosting & monitoring of the web service * Code maintenance * Extensive testing.What incoming web service calls are supported?
* The Straatos Interact API supports POST and GET calls. * All parameters, header, and body information are passed to the Interact Script and can be used in the script to determine what to do with the incoming call.Can more than one web service call be defined?
Yes, there is no limit on the number of different web service calls that can be defined in a single Straatos Interact Script. Example for 3 web service calls: * CreateTask. * ForwardTask. * RetrieveTaskInfo.Security: how does a web service call get authorised?
The security can be built into the Straatos Interact Script. Options: * No authentication: open web service. * Web service Key/API Key: check the key in the script. * OAuth2: * Use ajax to obtain tokens and validate outside Straatos. Authentication can be as secure and restrictive as needed.Is data between web service calls encrypted?
Yes, all communication uses SSL encryption.Can payload encryption be used?
Yes. The Interact Script can decrypt incoming encrypted payloads (if needed) or pass encrypted data through the workflow. Decryption and handling depend on processing needs.What is Organisation ID?
The Organisation ID is a unique identifier that defines your organization and is used as part of the request URL when consuming the API. How to find your Organisation ID: 1. Log in to the CumulusPro Admin Panel with your credentials. The CumulusPro Admin dashboard will appear. 2. In the dashboard, click Create Organisation. {% hint style="info" %} If the organisation is already available, please proceed to step 4. {% endhint %} 3. Select the desired template. and click Next. 1. The new organisation will appear on the dashboard. 4. From the dashboard, click the newly created organisation. A new dashboard will appear. 5. Click the organisation settings to view the organisation details. The organisation Settings page contains the Unique ID and all relevant information about the organization.| Method | Description |
|---|---|
| Get Document Info | Retrieves the information about the document or task. |
| Magick | This method incorporates an ImageMagick wrapper into the straatos data architecture. ImageMagick allows you to generate, edit, compose and convert digital photos. To learn more about the services that ImageMagick can provide, refer to https://imagemagick.org/. |
| Add Document Comment | Use this method to add a comment to the specific document identified by the documentId. DocumentId is the unique identifier for a document. The current Document ID is used as the default value. |
| Image Detect | Determine the presence of the Swiss flag and human faces on images/identity cards. |
| Add Additional Data | Add additional files to an existing document. |
| Add Additional Data With URL | Add additional files to an existing document from a specified path. |
| Remove Additional Data | Remove additional data from a document. |
| Detect Barcodes | Detect barcodes on specific document page identified by the documentId. |
| Detect Barcodes V2 | Detect barcodes in a document, using a newer and faster engine (optionally specified by documentId) |
| Get Account | Retrieves account information for specific account id. |
| List Accounts For Organisation | Retrieves all account information in an organisation. |
| List Accounts For Manager | Retrieves information about all accounts managed by a specific manager. |
| Face Detection | Determines whether an image contains a face, which can be useful when processing passports or identification cards. |
| Split Document | Divide a single document into two separate documents. |
| Merge Document | Combine two documents into a single document. |
| Delete Document Page | Deletes a page from a document permanently. Once deleted, there is no method to recover a document! |
| Html To Pdf | Converts an HTML input to a PDF file. It is possible to generate an Audit Report and attach it to a document. |
| Zip | It generates a zip archive. |
| Unzip | Unzips a zipped document associated with a task and adds the zip file's contents as additional data. |
| Pdf To Image | Convert a PDF document to a multipage TIFF or a collection of JPG images and add as additional data. This function returns a URL that points to the first image. |
| Create Searchable Pdf | Create a searchable pdf file containing the results of a JSON file. This provided URL is:
|
| Create Merge PDF | Create a PDF document from a collection of PDF files and/or images. Provides a URL to the generated PDF. |
| Set Error | Configure a Straatos Error. Once configured, the Straatos Task generates an Error Event and displays the Error Message in the Monitor. |
| Set Document Restriction | Access to a document stored within Straatos is granted using one of two methods:
|
| Create Account | Create a new user account. |
| Get Account | Retrieve information about an existing account. |
| Update Account | Update a user's account information. |
| Delete Account | Delete a user account. |
| Start Workflow | Start a new task in a workflow. |
| Get File As String - Get File As Base64 - Get File As ByteArray | Retrieves a file either as a string or as a Base64 file based on a provided URL to the file. |
| List Roles For Organisation | List all of the roles and functions of the current organisation. |
| Name | Description |
|---|---|
| id | The unique identifier to obtain information about a document. |
| region | The S3 region is used for storage. |
| originalURL | When available, the original URL of the uploaded document will be displayed. |
| documentPages | A list of documentPages. This list contains the following fields: |
| lastModifiedDateTime | DateTime when the document was last updated. |
| Comments | A list of comments. This list contains the following fields: |
| timestamp | When the comment was entered. |
| comment | The actual comment. |
| additionalData | A list of all the additional data. This list contains the following fields: |
| width | The width of the original document. Set the value of GetDimensions to true. |
| height | The height of the original document. Set the value of GetDimensions to true. |
| Name | Description |
|---|---|
| DocumentId | documentId is the unique identifier for a document. This is an optional parameter. (default: _documentId) |
| Command | The imageMagick command to execute; by default, convert is used. |
| InputAdditionalDataKey | If not null then the input file will be the additional file identified by the data key to use. If empty, then use the original URL (or if empty, preview URL) on a page level. |
| OutputAdditionalDataKey | Do not return the output URL but store the output as additional data. If this additional data key already exists, the new version will overwrite it. |
| OutputFormat | If the information is true, the result will contain the redirected output of the command rather than the URL of the output image. Another possible value is JSON, which results in the return of a JSON document containing all processed parameters. |
| ReturnOutput | if true and OutputFormat is not info, then '-' is appended. |
| OutputExtension | |
| PageIndex | Indicates the page number to be used (zero-based). |
| Parameters | Parameters to pass to the imageMagick call. |
| Name | Description |
|---|---|
| DocumentId | DocumentId is the unique identifier for a document. This is an optional parameter. (default: _documentId) |
| Comment | The text of the comment. |
| CommentTimestamp | The (optional) timestamp should be stored with the comment. If the date/time field is left blank, the current date/time will be used. |
| AuthAccountId | The id of the CumulusPro account. |
| LoginName | This information will be stored in the Comment table, with the LoginName displayed during Web validation. |
| Name | This information will be stored in the Comment table, with the row name displayed during Web validation. |
| Name | Description |
|---|---|
| DocumentId | DocumentId is the unique identifier for a document. This is an optional parameter. (default: _documentId) |
| InputAdditionalDataKey | When set, use an additionalData file as input, otherwise use OriginalUrl (or, if empty, the preview URL on page level) |
| PageIndex | 0-based pageIndex of the page to use. |
| EnableFaceDetection | When returning the execution result, this parameter specifies whether or not face detection should be considered |
| EnableLandmarkDetection | Specifies whether face landmark detection should be performed to determine whether the face is forward/upright and to validate the result of the face detection. |
| MinimumMatchingScore | This value specifies the minimum matching score that should be used when identifying the flag pattern. |
| Value | Description |
|---|---|
| -1 | If there is an error while parsing command line arguments or any file fails to load/save |
| 0 | If there is a global negative match |
| 1 | If there is a global positive match |
| Name | Description |
|---|---|
| FaceDetectionEnabled | Indicates whether face detection was enabled. |
| LandmarkDetectionEnabled | Indicates whether landmark detection was enabled. |
| FaceFound | Indicates whether a face was discovered in the document's image. |
| FlagFound | Indicates whether or not the flag pattern was correctly identified. |
| FlagScore | The resulting score for identifying flag patterns. |
| Doc... | - 4 point coordinate for the document boundaries on the input image. |
| Face... | - 4 point coordinate for the face boundaries on the input image. |
| Flag... | - 4 point coordinate for the flag pattern boundaries on the input image. |
| Name | Description |
|---|---|
| DocumentId | DocumentId is the unique identifier for a document. This is an optional parameter. (default: _documentId) |
| FormData | The actual content of the data file. |
| Extension | The extension (=filetype) of the file to store. |
| Key | AdditionalData is stored under this key. |
| Name | Description |
|---|---|
| DocumentId | DocumentId is the unique identifier for a document. This is an optional parameter. (default: _documentId) |
| Faster | When enabled, an algorithm makes additional attempts to locate a disable barcode. This is an optional value. |
| Formats | [Optional] The barcode format to look for. Possible values are: 2D Barcodes:
|
| PdfMatchPattern | [Optional] Regular expression to match. Only works if the original document is a PDF. This is an optional value. |
| PageIndexes | The 0-based pageIndex(es) of the pdf document to which barcodes should be detected. To specify multiple pages, use a comma to separate indexes (,). This is an optional value. |
| Name | Description |
|---|---|
| DocumentId | DocumentId is the unique identifier for a document. This is an optional parameter. (default: _documentId) |
| PageIndexes | An array of the page(s) that should be scanned. The pages should be defined as 0-based index numbers. |
| Formats | An array of barcode format(s) to look for. Possible values are:
GdPicture options:
|
| Name | Description |
|---|---|
| id | The id of the account (AuthAccount) |
| Name | Description |
|---|---|
| Id | The id of the account |
| ManagerAuthAccountId | The (optional) id of the user's manager as configured in Admin Panel |
| LoginName | The login name (email address) |
| Name | The (optional) name as configured in Admin Panel |
| UserIdentifier | The (optional) user identifier as configured in Admin Panel |
| Roles | A array of roles, each with its own Id, Name, and Functions (array of functions containing Id, Name) |
| Name | Description |
|---|---|
| managerId | The id of the manager's account |
| Name | Description |
|---|---|
| DocumentId | DocumentId is the unique identifier for a document. This is an optional parameter. (default: _documentId) |
| InputAdditionalDataKey | When set, an additionalData file is used as input; otherwise, OriginalUrl is used (or, if empty, the preview URL on page level) |
| CroppingMargin | Specifies the margin which is to be left for cropping |
| Threshold | Threshold value |
| EdgeRatio | Ratio of the edges |
| NoiseRatio | Noise Ratio |
| Name | Description |
|---|---|
| WorkflowInstanceId | The effective workflowInstanceId belonging to the documentId |
| PageIndex | 0-based index on where to split the document. All pages >= PageIndex will be part of the new documentId |
| CopyFieldValues | When true, the new document will have variable values of the original document. |
| WorkflowInstanceId | The effective workflowInstanceId belongs to the new document. |
|---|---|
| DocumentId | The DocumentId belonging to the newly created document. |
| Name | Description |
|---|---|
| DocumentId1 | The documentId of the first document |
| DocumentId2 | The documentId of the second document |
| WorkflowInstanceId2 | The WorkflowInstanceId was known by the straatos engine of the second documentId |
| Name | Description |
|---|---|
| DocumentId | DocumentId is the unique identifier for a document. This is an optional parameter. (default: _documentId) |
| PageIndex | 0-based index of the page to delete. |
| Name | Description |
|---|---|
| DocumentId | The unique identifier of the document for which the PDF should be created. |
| PageSize | The PDF page size (for example A4). |
| OutputAdditionalDataKey | The Additional Data Key in which the document can be found. For example 'pdf-audit'. |
| PrependPDFUrl | You can specify either PrependPDFUrl or PrependPDFAdditionalData (key). This field must point to an existing PDF file. The PDF will be prepended with the new HTML-generated PDF. Intended for use in creating cover pages for pre-existing documents. |
| PrependPDFAdditionalData | You can specify either PrependPDFUrl or PrependPDFAdditionalData (key). This field must point to an existing PDF file. The PDF will be prepended with the new HTML-generated PDF. Intended for use in creating cover pages for pre-existing documents. |
| AppendPDFUrl | You can specify either AppendPDFUrl or AppendPDFAdditionalData (key). This field must point to an existing PDF file. The PDF will be appended to the new HTML-based PDF. Ideal for creating audit trails and exporting documents that are attached to an existing document. |
| AppendPDFAdditionalData | You can specify either AppendPDFUrl or AppendPDFAdditionalData (key). This field must point to an existing PDF file. The PDF will be appended to the new HTML-based PDF. Ideal for creating audit trails and exporting documents that are attached to an existing document. |
| AppendPDFAdditionalData | You can specify either AppendPDFUrl or AppendPDFAdditionalData (key). This field must point to an existing PDF file. The PDF will be appended to the new HTML-based PDF. Ideal for creating audit trails and exporting documents that are attached to an existing document. |
| Landscape | Boolean, If the value is not set or is false, the value is Portrait. |
| HTML | The HTML code of the file. |
| Margin | If empty, the default value is 36. |
Audit Trail
| Name | Description |
|---|---|
| Url | The URL to the document to grant access to. |
| MinutesFromNow | The duration of access to the document in minutes. The number of minutes that have passed since the script was run (not from the creation of the task). |
| AccessCount | You can specify either PrependPDFUrl or PrependPDFAdditionalData (key). This field must point to an existing PDF file. The PDF file will be prepended with the new HTML-based PDF. Intended for use in creating cover pages for pre-existing documents. |
| Name | Description |
|---|---|
| AdditionalDataKey | The additionalData is placed under this key (not the URL) |
| Files | A File array. Each object in the array should be a JSON object containing 2 (out of possible 3) keys:
|
| DocumentId | Optional, if not specified the current document will be used. |
| TimeOutMs | Optional timeout in Milliseconds, If no timeout value is specified, the default value of 90 seconds is used. |
| Name | Description |
|---|---|
| AdditionalDataPrefix | Prefix for each additional data entry created from the zip file |
| AdditionalDataKey | The Key of the additionalData where the ZIP file is stored |
| DocumentId | Optional, if not specified the current document will be used. |
| IgnoreDirectoryInfo | Ignore the directory information in the ZIP file as an option. If it is true, all entries in the additional data key will be extracted without path information. The default value is false. |
| IncludeHiddenFiles | Optional option to include files that have a name string with '.'. The default value is false. |
| TimeoutMs | Optional timeout in Milliseconds, if no timeout value is specified, the default value of 90 seconds is used. |
| Name | Description |
|---|---|
| EndpageNumber | End (1 based) page number. The default value is 0, which includes all pages. This is an optional parameter. |
| JPGQuality | An optional value between 0-100. Default is 40. |
| DocumentId | If not specified, the current document will be used. This is an optional parameter. |
| OutputAdditionalDataKeyPrefix | Optional prefix for the generated additional data keys (default is 'page' and will be suffixed by e.g. '-0001.jpg') |
| OutputTiff | If true, a multipage TIFF file will be generated, default is false (JPG). |
| PDFURL | URL pointing to the PDF file. |
| ResolutionDPI | Optional value in DPI, default is 150. |
| StartPageNumber | Optional, start (1 based) page number. The default value is 0, which includes all pages. |
| TimeoutMs | Optional timeout in Milliseconds, if no timeout value is specified, the default value of 90 seconds is used. |
| UserPassword | Optional, password to access password-protected PDF files. |
| Name | Description |
|---|---|
| CompressionLevel | Optional, compression level, default is 'normal'. Available options are:
|
| Orientation | Optional page orientation. Available options are:
|
| DocumentId | Optional, if not specified the current document will be used. |
| OutputAdditionalDataKey | Optional additional data key, default is 'merge.pdf'. |
| PageSize | Optional page size. Available options are:
|
| Files | An array of file descriptions, one entry for each PDF file or image to append. Each entry is formatted as follows: {RL:'https://...', StartIndex: 0, Length: 99, Password: '...'}. Only the URL is required and point to a PDF or image file. |
| TimeoutMs | Optional timeout in Milliseconds, if no timeout value is specified, the default value of 90 seconds is used. |
| Password | Optional, password to access password-protected PDF files. |
| Name | Description |
|---|---|
| LoginName | Login credentials. |
| Email Address | Login email address. |
| Name | Name of the person/account. |
| UserIdentifier | Similar to Login Name. |
| Password | Optional, password to create new user. |
| Roles | Defining the roles to be added to the account. |
| Name | Description |
|---|---|
| Id | Account ID is associated with account for which information is required. |
| Name | Description |
|---|---|
| LoginName | Login credentials. |
| Email Address | Login email address. |
| Name | Name of the person/account. |
| UserIdentifier | Similar to Login Name. |
| Password | Optional, password to update user. |
| Roles | Defining the access to the roles for the account. |
| Name | Description |
|---|---|
| ID | ID of account that needs to be deleted. |
| Name | Description |
|---|---|
| workflowid | Workflow ID of workflow where new task should be started. If it is the same workflow, can be passed with straatos.workflowId. |
| startActivityId | Start activity ID of start event which should start the workflow. |
| Data | indexfielddata to be passed. |
| workflowconfiguration | Numeric (short) workflow ID which is also visible in Admin Panel. Alternative to specify workflowid. |
| webservice Key | (Optional, not needed to start a workflow in your own organisation). If you want to start a workflow in another organisation, enter that workflows webServiceKey here. |
| filetype | If original document is provided, provide filetype (pdf, tif, jpg). |
| documenturls | URL(s) to documents that need to be added as original document. |
| Name | Description |
|---|---|
| DocumentId | Straatos documentId of task from where to get file content. Required from interact API or when it is from different task. |
| FileUrl | URL to document to retrieve content from. |
| WebServiceKey | Only required if file is retrieve from workflow outside current workflow or if called from interact API. |
| Name | Description |
|---|---|
| credentials | Login credentials |
| ID | ID of account holder |
| Functions | Function/role of account holder. |
| Name | Description |
|---|---|
| workflowId | ID of workflow this workflowInstance is in. WorkflowId changes every time workflow is (re-)published. |
| workflowName | Name of workflow |
| workflowInstanceId | Unique ID of every workflowInstance. This will not change as long as the instance is in the workflow. |
| activityId | Uniquely identifies activity within current workflow. |
| activityName | Name of Script activity |
| activityInstanceId | Increasing sequence number representing logId of activity |
| activityInstanceDate | Date that activity execution started |
| workflowInstanceDate | Date the workflowInstance arrived in the workflow |
| console | Object with method log(String). Output will appear in efektif log. |
| Name | Description |
|---|---|
| nextSequenceNumber() | Retrieves the next sequence number for the specified identifier |
| clearSequenceNumber() | Clears the sequence (ie it will start at 1 again) |
| Name | Description |
|---|---|
| variablesByWorkflowInstanceId('') | Gets variables of workflowInstance defined by |
| variablesByDocumentId() | Gets variables of workflowInstance defined by (every workflowInstance also has unique documentId attached) |
| Name | Description |
|---|---|
| activityIdForName() | Returns activityId for the given activityName (only works for the current workflow, ie workflow the workflowInstance is in) |
| getActivityIdsByDocumentId() | Returns list of activityIds where workflowInstance defined by DocumentId is in (there is a 1:1 relation between documentId and workflowInstanceId). |
| getWorkflowInstanceIdByDocumentId() | Get workflowInstanceId (a string) for specified documentId |
| documentIdsForFilter() | Perform search on all documents on given variables |
| Name | Description |
|---|---|
| variablesByDocumentId() | Gets JSON string containing all variables by documentId |
| variablesByWorkflowInstanceId() | Gets JSON string containing all variables by workflowInstanceId |
| Name | Description |
|---|---|
| getBytes(inputString) | Converts inputString to byte array, using UTF-8 encoding. |
| getString(byte[]) | Converts byte array to a string, using utf-8 character set. |
| getString(<byte[]>, ) | Convert byte array to a string, using specified character set. |
| Name | Description |
|---|---|
| decodeBase64() | Returns (possibly binary) byteArray of base64 encoded string. |
| encodeBase64() | Returns base64 encoded string representation of (binary-) byteArray. |
| Name | Description |
|---|---|
| setWorkflowData(, ) | Sets workflow data. |
| getWorkflowData() | Gets workflow data for specified key |
| removeWorkflowData() | Removes workflow data for specified key |
| clearAllWorkflowData() | Removes all workflow data for current workflow |
| Name | Description |
|---|---|
| sendWorkflowMessage({}) | Sends a message to workflowInstance. Message should contain workflowId, activityId and an array of workflowInstances to message. Optionally variables per workflowInstance. See example below. |
| Name | Description |
|---|---|
| ajax() | Performs the call. See table below for the request options |
| Name | Description |
|---|---|
| url | Required: Complete url to call. Calls to urls containing localhost are not allowed. |
| data | Data you want to pass, or the multipart object from straatos.newFormData call |
| method | Possible values are GET, POST, PUT, DELETE and OPTIONS. When not specified, it defaults to GET |
| contentType | Optional contentType of data to be sent, default is 'application/json' |
| dataType | Optional contentType of expected data for example: 'binary' or 'text/html' |
| headers | Optional array with headers that will be passed to the call |
| timeout | Optional timeout in milliseconds. The default is 60 seconds. This one parameter specifies connectTimout, requestTimeout and socketTimeout. |
| Name | Description |
|---|---|
| append() | Adds a string, this string will be utf-8 encoded |
| append(, ) | Adds a string with a custom character set. Values used can be ‘utf-8’, or any of the character sets from the table below. |
| append(<byte []>) | Appends a byte array to multipart object |
| Name | Description |
|---|---|
| getByteArray() | Returns byte array (byte[]) representing multipart data |
| toString() | Returns utf-8 decoded string of multipart data |
| Name | Description |
|---|---|
| string ElementName | Name of root element |
| string Namespace | [Optional] Namespace of element |
| Name | Description |
|---|---|
| string Xml | XML string |
| Name | Description |
|---|---|
| string ElementName | Name of element |
| string Namespace | [Optional] Namespace of element |
| Name | Description |
|---|---|
| string Xpath | Xpath of element |
| Namespace | [Optional] Namespace prefix: namespace of element |
| Name | Description |
|---|---|
| string Xpath | Xpath of element |
| Namespace | [Optional] Namespace prefix: Namespace of element |
| Name | Description |
|---|---|
| string AttributeName | Attribute Name |
| string AttributeValue | Attribute value |
| string NameSpace | [Optional] Namespace of element |
| Name | Description |
|---|---|
| string AttributeName | Attribute name |
| Namespace | [Optional] Namespace prefix: Namespace of element |
| Name | Description |
|---|---|
| string AttributeFilter | Attribute filter. |
| Namespace | [Optional] Namespace prefix: Namespace of element. |
| Script Collection for Straatos | /pages/5ad687ad69e20fe4cfbf50e653be2d46d60a5606 |
| Javascript Coding Standards and Best Practices | /pages/79370a66b4d0b164e1131958c403c9934bb99042 |
| JSON Coding Standards and Best Practices | /pages/69de93f557f430b193c5c4a123814fccce31a00a |
Dear Sir/Madam,
An invoice that we have received from you needs your attention. Please click on the link below to review the invoice and the respective comments/questions.
{RejectURL}
Regards,
The CumulusPro Team