| 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. |