How to create an Application Package

Here is a short explanation of how to create an application package.

Create new package by clicking right moutse button and select New - Package.

The package folder and package settings are created.
AppPkg1

Change the package metadata.
AppPkg1

Add connectors.
AppPkg1

Add roles.
AppPkg1

Add properties.
AppPkg1

Add portal tabs.
AppPkg1

AppPkg1

Create workflow in package.
AppPkg1

Only the connectors defined in package settings can be selected in the workflow.
AppPkg1

The package property can be used in the workflow.
AppPkg1

In the package menu it is possible add workflows that is not included in the package. If this is done, the user gets a warning message. External workflows are not included when exporting. Warning message:
AppPkg1

Add roles to the menu. Only package setting roles are available to be selected.
AppPkg1

Drag and drop workflow as workflow into the package. Connector mapping is requested.
AppPkg1

Export warning when menu contains workflow that is not in the package.
AppPkg1

Export when workflows not published.
AppPkg1

Import of existing package.
AppPkg1

Connector mapping when creating new package at import.
AppPkg1

Lock package.
AppPkg1

Enter and confirm password.
AppPkg1

Package locked.
AppPkg1

Unlock package
AppPkg1

AppPkg1

Inbox

There are two types of inboxes one can add to a menu, seed item and handover item.

Seed Item

How to configure a seed item in a workflow:

Connect a table or machine step with a data arrow to the start step.

A machine step is connected to the start step

A machine step is connected to the start step

Click on the start step and configure:

How to configure seed item in an inbox:

Click on "+" and choose Seed Item and then select your workflow in the server content.

Step to select a seed item to the inbox

Step to select a seed item to the inbox

Example how Seed Item is set up in the inbox

Example how Seed Item is set up in the inbox

How to configure inboxes:

Example how an inbox with seed items can look in Universal Windows Client

Example how an inbox with seed items can look in Universal Windows Client

Handover Item

How to configure handover item in an inbox:

Click on + and choose Handover Item and then select your workflow in the server content.

Step to select a handover item to the inbox

Step to select a handover item to the inbox

One or more menus needs to be configurated to make workflows available in the clients. A menu can have three different types of content Category, Workflow Item and Inbox.

Edit Roles to assign the menu to those roles that the menu should be availalbe to.

Menu example

Menu example

Generate link helps the user to construct a link to execute a workflow. This is supported for both User Workflows and Machine Workflows. Generate Link is located in the context menu in server content panel.

User Workflows

User workflow links points to the web client and provides a direct link to a workflow execution.

Configuration example

Configuration example

Configuration example

Configuration example

User workflow links points to the mobile client and provides a direct link to a workflow execution.

Machine Workflows

Machine workflows can be executed over http request. These request are made directly to the flow server. The workflow is executed by a machine user and authentication is made by basic authentication.

Configuration example

Configuration example

Manually select BarTender document

With this operation you can manually select a BarTender document from your local file system.

The file is stored in the machine step and is not in any way synchronized with the file in your local file system. Once the file has been selected you can export the file by clicking on Export file....

Note that if you select another operation in the machine step the document will be lost and has to be selected from the file system again.

The same input and outputs as 'Print' applies, see Print for more information.

Database Connector

TODO

IFS Applications Connector

TODO

M3 Connector

TODO

Infor M3 REST Connector

The M3 Rest Connector is used to execute transactions in M3 via the M3-API-REST bulk API.

Press Select operation to select which transaction to execute.

Input

The input will of course depend on the transaction to execute. There is one common parameter that always is available though, readtimeoutmillis. In this parameter you can specify the amount of time to wait for response from job.

Another common feature for all transactions is the possibility to use an iterator. If you select a iterator it means that the transaction will be executed once for each row in the table specified as iterator. Using a iterator will change the output of the cogwheel to a table with the same number of rows as the iterator table, each row in the table is corresponding result of transaction execution for row in iterator table. You can of course map columns in iterator to parameters of transaction. Simply select an iterator, and for a parameter select I Iterator in dropdown menu for parameter and then select the suitable column of iterator table.

Output

Record (or table of records if iterator is used).

Member Description
HttpStatusCode The status code returned from REST API. Typically 200 if request (not necessarily transaction) was successful. 401 if not authorized etc.
ReasonPhrase HTTP ReasonPhrase, if any
AllHeaders Simple variable containing all headers (with line feed between each header) returned by REST API.
OK A record containing result of transaction if it was successfully executed. Will be empty if transaction failed.
- Program - Simple variable containing the program executed
- Transaction - Simple variable containing the transaction executed
- Records - A table containing the records (if any) returned by transaction. The columns of the table will of course depend on the transaction, but you can always choose not the request particular columns by unchecking the Included checkbox. By doing that, it will not be requested from the REST API, which could boost performance. You can also specifiy a row limit on Records (default 100).
Error A record containing error information if transaction failed for some reason. Will be empty if transaction was successfully executed.

Note that if HttpStatusCode is 200, either OK or Error (never both) contains data. This can be used to take different paths in your workflow. Simply add a 'Decision Step' and add a script rule like transactionResults.Error != nil to check for errors.

Maximo Generic Connector

Maximo Generic connector communicates with Maximo Web Services.

Creating a Maximo Connector Machinestep

When connector is configured we can use it in machine steps. We have to do the following steps:

  1. Reload Maximo Web Services
Reload Web Services

Connector reads WSDL from Maximo Main Web Services from MaximoWebServiceAddress (configuration):

for example: http://{MaximoWebServiceAddress}/meaweb/wsdl/MXWSREGISTRY.wsdl

After that it creates the web service dotnet client object and call Maximo Main Web Services.

Response from Maximo Main Web Service contains list with all available Maximo Web Services.

  1. Choose specific Maximo Web Service
Pick Web Service

When specific web service is chosen the connector reads the WSDL for the SelectedWebService from MaximoWebServiceAddress (configuration):

for example: http://{MaximoWebServiceAddress}/meaweb/wsdl/{SelectedWebService}.wsdl

After that it creates web service dotnet client object and calls the selected Maximo Web Service.

Response from Selected Maximo Web Service contains list with all available methods and their parameters.

  1. Choose Method and fill method parameters
Fill parameters

When specific web service method is chosen, the connector reads all input parameters from the method definition and displays it:

Fill parameters

When all required parameters are set we can use connector (by running workflow or directly from Flow Studio to test it).

When Connector is executed it use web service dotnet client (created in point 2) and execute method and read response data.

Basic API

About the Novacura Flow Transporter Package
The Novacura Flow SAP connector will call a number of SAP BAPIs in order to retrieve the interface information. The following functions give the required information:

  1. ZNCFLOW_APPLICATION_COMPONENT: List BAPI application tree
  2. BAPI_MONITOR_GETLIST: Returns a list of all available BAPI's in the SAP system.
  3. BAPI_INTERFACE_GETDOCU: Returns the help text documentation for a BAPI on different levels.
  4. RFC_GET_FUNCTION_INTERFACE: Returns all parameters for a BAPI or function module in SAP.
  5. ZNCFLOW_DDIF_FIELDINFO_GET: Returns the data dictionary specification for parameter fields

BAPI: BAPI_INTERFACE_GETDOCU

With this BAPI you will get the documentation for the requested BAPI in the form of help text. This is useful for giving detailed descriptions of the BAPI on a general level or on the Method. If you give the Object you will get text on the object and if you give the object and the method you get details on the method. The fields in the input Is the same as the resulting table (BAPILIST) in the previous BAPI (BAPI_MONITOR_GETLIST).

Field Description Type Spec Example
OBJTYPE Object type I CHAR10 SFLIGHT
OBJNAME Object name I CHAR32
METHOD Method name of the object type I CHAR32 GetDetail
PARAMETER Name of parameter in method I CHAR32
FIELD Field name in the parameter for F4 values I CHAR30
LANGUAGE Language of the text to be displayed I LANG1
TEXTFORMAT Format of the text to be displayed I CHAR3
LINKPATTERN Convert SAPscript Hyperlinks to HTML I CHAR255
RETURN Return messages O BAPIRET2
TEXT Table for the text T BAPITGB

Table: BAPITGB

Field Description Spec Example
LINE Line in documentation text CHAR255

BAPI: BAPI_MONITOR_GETLIST

This BAPI returns information for BAPI's relating to the position in the BAPI application tree. Giving an * in the first input parameter will give a full list of all BAPI's.
The other parameters can be left blank thus letting the system using default values. It is possible to select BAPI's for a list of application nodes by sending in a table COMPONENTS2SELECT with rows of nodes in the field COMPONENT. This BAPI together with the first (ZNCFLOW_APPLICATION_COMPONENT) will give you enough information to draw the complete Application tree containing all BAPI's.

Field Description Type Spec Example
OBJECTTYPE Object type I CHAR10 * (will result in full list)
SHOW_RELEASE Release /Reference Release to Display I CHAR4 Use default
BAPIS_POTENTIAL Display Potential BAPIs I CHAR1 Use default
BAPIS_NEW Display New BAPIs in Release I CHAR1 Use default
BAPIS_OLD Display BAPIs from Previous Releases I CHAR1 Use default
RELEASED_BAPI Release Status of BAPIs I CHAR1 Use default
RELEASED_FUNC Release Status of Function Modules I CHAR1 Use default
RETURN Return messages O BAPIRET2
COMPONENTS2SELECT Application Components/Areas to Select T BAPIMONCOM
SYSTEMS2SELECT Original System of BAPIs to Select T BAPISRCSYS Use default
BAPILIST List of Selected BAPIs T BAPIMONSTR

Structure: BAPIRET2

Field Description Spec Example
TYPE Message type: S Success, E Error, W Warning, I Info, A Abort CHAR1
ID Message Class CHAR30
NUMBER Message Number NUMC3
MESSAGE Message text CHAR220
LOG_NO Application log: log number CHAR20
LOG_MSG_NO Application log: Internal message serial number NUMC6
MESSAGE_V1 Message Variable CHAR50
MESSAGE_V2 Message Variable CHAR50
MESSAGE_V3 Message Variable CHAR50
MESSAGE_V4 Message Variable CHAR50
PARAMETER Parameter Name CHAR32
ROW Lines in parameter INT4
FIELD Field in parameter CHAR30
SYSTEM Logical system from which message originates CHAR10

Table: COMPONENTS2SELECT

Field Description Spec Example
COMPONENT Application component ID CHAR24

Table: BAPILIST

Field Description Spec Example
OBJECTTYPE Object Type CHAR10 SFLIGHT
OBJECTNAME Object name CHAR32 Flight
BAPINAME Method name of BAPI CHAR32 GetDetail
ABAPNAME Function module name CHAR30 BAPI_FLIGHT_GETDETAIL
COMP Application component ID CHAR24 BC-DWB
CREA_REL Release at Creation CHAR4 610
CREATOR Author CHAR12 SAP
UDATE Changed On CHAR8 18.09.2001
CHANGER Last changed by CHAR12 SAP
SOURCESYS Name of the SAP system CHAR8 SAP
BAPI_AG Application area or BAPI work group responsible CHAR5 Basis
ISINTERFAC Interface object type CHAR1
BAPI_REL Release status of BAPI method CHAR1 X
FUNC_REL Release status of function module CHAR1 R
OBSOLETE Release in which the status was set to obsolete CHAR4
FM_DOCU Documentation on function module exist CHAR1
BO_DOCU Documentation for business object exist CHAR1
MESTYPE Message type CHAR30
VERB Object type component CHAR32 GETLIST
BO_TEXT Description CHAR80 Flight with connection data (SAP training)
BAPI_TEXT Description CHAR80 Find list of flights

BAPI: ZNCFLOW_DDIF_FIELDINFO_GET

This BAPI will return de definition of data dictionary objects. In this case the parameters for BAPI's or function modules returned from BAPI: RFC_GET_FUNCTION_INTERFACE.

Field Description Type Spec Example
TABNAME Name of the Table (of the Type) for which Information is Required I CHAR30
FIELDNAME Use Parameter LFIELDNAME Instead I CHAR30
LANGU Language of the Texts I LANG1
LFIELDNAME If Filled, only Field with this Long Name I CHAR132
ALL_TYPES Take all Types into Consideration I CHAR1
GROUP_NAMES Take Named Includes into Consideration I CHAR1
UCLEN Unicode length with which runtime object was generated I RAW1
DO_NOT_WRITE Write I CHAR1
X030L_WA Nametab Header of the Table (of the Type) E CHAR30
DDOBJTYPE Kind of Type E CHAR8
DFIES_WA Single Information if Necessary E CHAR30
LINES_DESCR Information about Other Referenced Types E DDTYPEDESC-TYPENAME (CHAR30)-TYPEKIND (CHAR4)-DFIES
DFIES_TAB Field List if Necessary T DFIES
FIXED_VALUES Description of Domain Fixed Values T DDFIXVALUES

Table/Structure: DFIES_TAB

Field Description Spec Example
TABNAME Table Name CHAR30
FIELDNAME Field Name CHAR30
LANGU Language Key LANG1
POSITION Position of the field in the table NUMC4
OFFSET Offset of a field NUMC6
DOMNAME Domain name CHAR30
ROLLNAME Data element (semantic domain) CHAR30
CHECKTABLE Table Name CHAR30
LENG Length (No. of Characters) NUMC6
INTLEN Internal Length in Bytes NUMC6
OUTPUTLEN Output Length NUMC6
DECIMALS Number of Decimal Places NUMC6
DATATYPE ABAP/4 Dictionary: Screen data type for Screen Painter CHAR4
INTTYPE ABAP data type (C,D,N,...) CHAR1
REFTABLE Table for reference field CHAR30
REFFIELD Reference field for currency and qty fields CHAR30
PRECFIELD Name of included table CHAR30
AUTHORID Authorization class CHAR3
MEMORYID Set/Get parameter ID CHAR20
LOGFLAG Indicator for writing change documents CHAR1
MASK Template (not used) CHAR20
MASKLEN Template length (not used) NUMC4
CONVEXIT Conversion Routine CHAR5
HEADLEN Maximum length of heading NUMC2
SCRLEN1 Max. length for short field label NUMC2
SCRLEN2 Max. length for medium field label NUMC2
SCRLEN3 Max. length for long field label NUMC2
FIELDTEXT Short Description of Repository Objects CHAR60
REPTEXT Heading CHAR55
SCRTEXT_S Short Field Label CHAR10
SCRTEXT_M Medium Field Label CHAR20
SCRTEXT_L Long Field Label CHAR40
KEYFLAG Identifies a key field of a table CHAR1
LOWERCASE Lowercase letters allowed/not allowed CHAR1
MAC Flag if search help is attached to the field CHAR1
GENKEY Flag (X or Blank) CHAR1
NOFORKEY Flag (X or Blank) CHAR1
VALEXI Existence of fixed values CHAR1
NOAUTHCH Flag (X or Blank) CHAR1
SIGN Flag for sign in numerical fields CHAR1
DYNPFLD Flag: field to be displayed on the screen CHAR1
F4AVAILABL Does the field have an input help CHAR1
COMPTYPE DD: Component Type CHAR1
LFIELDNAME Field name CHAR132
LTRFLDDIS Basic write direction has been defined LTR (left-to-right) CHAR1
BIDICTRLC DD: No Filtering of BIDI Formatting Characters CHAR1
OUTPUTSTYLE DD: Output Style (Output Style) for Decfloat Types NUMC2
NOHISTORY DD: Flag for Deactivating Input History in Screen Field CHAR1
AMPMFORMAT DD: Indicator whether AM/PM time format is required CHAR1

Table: FIXED_VALUES

Field Description Spec Example
LOW Values for Domains: Single Value / Upper Limit CHAR10
HIGH Values for domains: upper limit CHAR10
OPTION Option for domain fixed values CHAR2
DDLANGUAGE Language Key LANG1
DDTEXT Short Text for Fixed Values CHAR60

BAPI: RFC_GET_FUNCTION_INTERFACE

This BAPI will return all parameters and parameter attributes for a specific BAPI or function module. The function module name (FUNCNAME) is the same value that was returned for each BAPI in the call to BAPI_MONITOR_GETLIST (field ABAPNAME in table BAPILIST).

Field Description Type Spec Example
FUNCNAME Name of the function module I CHAR30 BAPI_FLIGHT_GETDETAIL
LANGUAGE Language of the parameter text I LANG1
NONE_UNICODE_LENGTH Length is also supplied in Unicode systems in non-Unicode format I CHAR1
REMOTE_BASXML_SUPPORTED BasXML Protokoll E CHAR1
REMOTE_CALL Function module can be called Remote-Function E CHAR1
UPDATE_TASK Function module is in the update E CHAR1
PARAMS Parameter of function module T RFC_FUNINT
RESUMABLE_EXCEPTIONS Resumable Exceptions T RSEXC

Table: PARAMS

Field Description Spec Example
PARAMCLASS Parameter type CHAR1 I
PARAMETER Parameter name CHAR30 AIRLINEID
TABNAME Table Name CHAR30 BAPISFLKEY
FIELDNAME Field Name CHAR30 AIRLINEID
EXID ABAP Data Type CHAR1 C
POSITION Position of field in structure (from 1) CHAR10 1
OFFSET Field offset from beginning of structure (from 0) INT10 0
INTLENGTH Internal length of field INT10 6
DECIMALS Number of decimal places INT10 0
DEFAULT Default value for import parameter CHAR21
PARAMTEXT Short text CHAR79 Airline Code
OPTIONAL Optional parameters CHAR1

BAPI: ZNCFLOW_APPLICATION_COMPONENT

This BAPI returns the BAPI application tree. The resulting table contains all nodes in the BAPI tree indicating what level the node is on and what the superior node is. The input parameter can list all nodes (giving only a *) or a specific component. Ending with an * can give all nodes starting with a specific name. For example AP-MD* will give all nodes starting with AP-MD. I.e all nodes below that node.

Field Description Type Spec Example
COMP Application Component I CHAR24 * (will result in full list)

Table: COMPONENTS

Field Description Spec Example
COMP Application component ID CHAR24 AP-MD-BF
NAME Short text CHAR60 Master data
LEVEL Numc3, internal use NUMC3 002
SUPERIOR Application component ID CHAR220 AP-MD

SAP BAPI Connector

Introduction

Novacura Flow is delivered with a API connector for SAP ECC (supporting version ECC 6 and newer), where Flow is communication with SAP through the SAP BAPIs.

In order to use the SAP connector in Flow, the connector needs a license for the current environment.

Getting started

There are a couple of things that needs to be done before you can start using the SAP connector.

In short, these four steps needs to be done prior to creating workflows with the SAP connector (assuming that you of course already have installed the Flow Server):

  1. Install the SAP GUI for Windows on the Flow server. This is necessary for Flow to be able to connect to SAP.
  2. Verify that the connection between the Flow Server and SAP works, using the SAP Logon Pad.
  3. Install the Novacura Flow Transporter package in the SAP environment you want to connect to. The Transporter package will install a couple of BAPIs that the connector need to generate an API tree in the Flow Studio. Download Transporter package here.
  4. Make sure you have a license for the SAP Connector, read more; here.
  5. Configure the SAP Connector in the Flow Studio, read more; here.

Steps 3 to 5 are described below.

Designing a SAP workflow

If you want an example of a SAP workflow, you can find a simple workflow here, using the ABAP workbench BAPIs for Flight Booking: http://community.novacuraflow.com/product/sap-flight-booking-example/

Make sure you have these BAPI in your SAP environment before you use this workflow.

When in the Flow Studio, adding a Machine Step to your workflow will let you create a connection to SAP. After selecting the SAP connector you have defined in Environment/Connectors, you will be able to configure a method call to SAP with the following steps.

Get the list of BAPIs: When selecting youe SAP connector in the list of available connectors, press the button with the three dots. This will connect to your SAP environment and generate the entire BAPI tree in the connector. So whatever BAPIs you have in your installatione of SAP will be accessible directly from Flow.


Select a BAPI: After the generation of the BAPI tree is done, you will see all BAPIs arranged in a folder structure. You can find the BAPI you need by either browse through the structure or by searching for the BAPI using the Filter option.


Configure the BAPI call (Input):

There are three tabs that can be used for configuration of the BAPI all:

First, define the input. You can either set fixed data by just typing the value you need or by using existing (single) variables in the workflow. Note that Input can be set both on the Import and Tables tabs.


Configure the BAPI call (Output): All data coming out from the called BAPI will end up in the Target Variable, so the Target Variable must be set (as in all Machine Steps returning data). There are two tabs for output; Export and Tables. Export are singe variables returned from the BAPI. Tables are table variables returned from the BAPI. Depending on the BAPI, Export and Tables will look and function differently.


Configuring Commit step

Selecting check box This step modifies data will ensure that a BAPI commit step is executed. Check this box for any BAPI that updates or inserts data in the ECC system. For a BAPI that only reads data it can be left unchecked.

When you have configure the BAPI call, you can test it using the Play button on the top right of the Application Window in the Studio.

Error handling

SAP returns errors as output from the BAPI. This means that you will need to handle errors from SAP in the workflow. Like this:


So, now you can create any app directly on top of your SAP environment!

Add attached file (from bytes)

Upload a file as an attachment to task item.

Parameters

Parameter Description
Custom List app name Name of Custom List app in SharePoint (not id)
Item ID ID of item
Remote filename Remote filename
Source bytes Table (consisting of bytes) to read from

Output

Record with information about whether operation failed or not.

Member Description
HasFailed Whether operation has failed or not
ErrorMessage A description of the failure, if any
ErrorCode An error code related to operation failure. Is 0 if no failure occured

Errors

Error code Description
1000 Unspecified error.
1000001 User is not authorized to perform operation.
1000004 Item with given id does not exist.

Add attached file (from file system)

Upload a file as an attachment to task item.

Parameters

Parameter Description
Custom List app name Name of Custom List app in SharePoint (not id)
Item ID ID of item
Remote filename Remote filename
Local filename Full path to file to upload. Note that the user the application pool running Flow Server must have access to the file.

Output

Record with information about whether operation failed or not.

Member Description
HasFailed Whether operation has failed or not
ErrorMessage A description of the failure, if any
ErrorCode An error code related to operation failure. Is 0 if no failure occured

Errors

Error code Description
1000 Unspecified error.
1000001 User is not authorized to perform operation.
1000004 Item with given id does not exist.

Add attached file (from stream)

Upload a file as an attachment to task item.

Parameters

Parameter Description
Custom List app name Name of Custom List app in SharePoint (not id)
Item ID ID of item
Filename Remote filename
Source stream Simple variable containg a stream

Output

Record with information about whether operation failed or not.

Member Description
HasFailed Whether operation has failed or not
ErrorMessage A description of the failure, if any
ErrorCode An error code related to operation failure. Is 0 if no failure occured

Errors

Error code Description
1000 Unspecified error.
1000001 User is not authorized to perform operation.
1000004 Item with given id does not exist.

Delete all attached files

Delete all attachments on provided task item.

Parameters

Parameter Description
Custom List app name Name of Custom List app in SharePoint (not id)
Item ID ID of item
Filename Remote filename

Output

Record with information about whether operation failed or not.

Member Description
HasFailed Whether operation has failed or not
ErrorMessage A description of the failure, if any
ErrorCode An error code related to operation failure. Is 0 if no failure occured

Errors

Error code Description
1000 Unspecified error.
1000001 User is not authorized to perform operation.
1000004 Item with given id does not exist.

Delete attached file

Delete an attachment on provided task item.

Parameters

Parameter Description
Custom List app name Name of Custom List app in SharePoint (not id)
Item ID ID of item
Filename Remote filename

Output

Record with information about whether operation failed or not.

Member Description
HasFailed Whether operation has failed or not
ErrorMessage A description of the failure, if any
ErrorCode An error code related to operation failure. Is 0 if no failure occured

Errors

Error code Description
1000 Unspecified error.
1000001 User is not authorized to perform operation.
1000004 Item with given id does not exist.
1000005 File not found.

List attached files

Lists all files attached to specified item.

Parameters

Parameter Description
Custom List app name Name of Custom List app in SharePoint (not id)
Item ID ID of item

Output

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

Member Description
HasFailed Whether operation has failed or not
ErrorMessage A description of the failure, if any
ErrorCode An error code related to operation failure. Is 0 if no failure occured
Results Table variable containing the results of operation

Structure of Results

Results
  • Filename
  • ServerRelativeUrl
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Delete item

    Deletes item with given ID.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item ID ID of item

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Get items by query

    Gets information about items by provided CAML Query

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    CAML Query The query to send to SharePoint

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Values
    • StaticName
    • Value
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List all items

    Lists all items in Custom List app.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Row limit Limit on how many items to list. A value of -1 indicates no limit

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Values
    • StaticName
    • Value
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List fields of items

    Lists the fields that are available for items in Custom List app.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • StaticName
  • Title
  • Description
  • DefaultValue
  • ReadOnly
  • Required
  • TypeAsString
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Create new item

    Creates a new item in a Custom List app. Returns the ID of created item in Results.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item name Title of new item
    Folder url Url to folder to create item in. Leave empty for root folder. Example if adding item to folder 'folder1' in Custom List 'clist' in subsite 'subsite1': '/subsite1/Lists/clist/folder1'

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Create new item, with field values

    Creates a new item in a Custom List app. Returns the ID of created item in Results.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item name Title of new item
    Field values Table consisting of field values. Note that StaticName of fields needs to be provided, not Title
    Folder url Url to folder to create item in. Leave empty for root folder. Example if adding item to folder 'folder1' in Custom List 'clist' in subsite 'subsite1': '/subsite1/Lists/clist/folder1'

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Update item field

    Updates a field of a given item.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item ID ID of item
    Field Name of field/column (StaticName, not Title)
    Value New value of property

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Check in file

    Checks in a file to SharePoint that the user has checked out

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
    Comment Comment, must not exceed 1023 characters
    Checkin type Specifies check in type

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000002 User has not checked out the file.

    Check out file

    Checks out a file to the SharePoint user the connector is running as.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000003 File already checked out.

    Discard check out

    Undo a check out of a file.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000002 User has not checked out the file.

    Copy file

    Copies a file from a Document Library to another (or the same) Document Library at the same SharePoint site.

    Parameters

    Parameter Description
    Source Document Library Name Name of source Document Library in SharePoint to copy file from
    Source filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt" to move
    Destination Document Library Name Name of target Document Library in SharePoint to copy file to
    Destination filename Name of file in destination Document Library
    Overwrite Specifies whether to overwrite destination file if it already exists

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Delete file

    Deletes a file in the Document Library. If the file does not exist, the operation is considered succesful.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt" to move

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Get file information

    Gets information about a file provided as a releative url, example: '/subsite1/Shared Documents/file.doc'

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Record variable containing the results of operation

    Structure of Results

    Results
  • Author
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckedOutByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • LockedByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • ModifiedBy
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckInComment
  • CheckOutType
  • ContentTag
  • CustomizedPageStatus
  • ETag
  • Exists
  • Length
  • Level
  • MajorVersion
  • MinorVersion
  • Name
  • ServerRelativeUrl
  • TimeCreated
  • TimeLastModified
  • Title
  • UIVersion
  • UIVersionLabel
  • Errors

    Error code Description
    1000 Unspecified error.

    List files

    Lists all files at the root of a Document Library

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Populate user members Specifies whether to populate members that relates to SharePoint users, e.g. Author.

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Author
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckedOutByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • LockedByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • ModifiedBy
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckInComment
  • CheckOutType
  • ContentTag
  • CustomizedPageStatus
  • ETag
  • Exists
  • Length
  • Level
  • MajorVersion
  • MinorVersion
  • Name
  • ServerRelativeUrl
  • TimeCreated
  • TimeLastModified
  • Title
  • UIVersion
  • UIVersionLabel
  • Errors

    Error code Description
    1000 Unspecified error.

    Move file

    Moves a file from a Document Library to another (or the same) Document Library at the same SharePoint site.

    Parameters

    Parameter Description
    Source Document Library Name Name of source Document Library in SharePoint to move file from
    Source filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt" to move
    Destination Document Library Name Name of target Document Library in SharePoint to move file to
    Destination filename Name of file in destination Document Library
    Move operations Specifies move options.

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Update file property

    Parameters

    Parameter Description
    Server relative url An url relative to server, e.g. "/subsite/doclib/folder/file.txt".
    Field name Name of field or column
    New value The new value to set on field

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Create subfolder

    Creates a new folder beneth specfied folder. If the folder already exists, the operations is considered succesful

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Parent folder Name of folder to create sub folders in. E.g. "folder1" or "folder1/subfolder2"
    Name of sub folder Name of folder to create

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Delete folder

    Deletes a folder by its relative url.

    Parameters

    Parameter Description
    Server relative url of folder An url relative to server, e.g. "/subsite/doclib/folder"

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List files in folder

    Lists all files in a specified folder.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Folder Remote folder in Document Library, can include sub folders if applicable. E.g. "subfolder1/subfolder2"
    Populate user properties Specifies whether to populate members that relates to SharePoint users, e.g. Author

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Author
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckedOutByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • LockedByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • ModifiedBy
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckInComment
  • CheckOutType
  • ContentTag
  • CustomizedPageStatus
  • ETag
  • Exists
  • Length
  • Level
  • MajorVersion
  • MinorVersion
  • Name
  • ServerRelativeUrl
  • TimeCreated
  • TimeLastModified
  • Title
  • UIVersion
  • UIVersionLabel
  • Errors

    Error code Description
    1000 Unspecified error.

    List files in folder by relative url

    Lists all files in a folder specified by relative url. Useful for instance if you got a Record containg folder information including its relative url and want to list those files.

    Parameters

    Parameter Description
    Server relative url An url relative to server, e.g. "/subsite/doclib/folder".
    Populate user properties Specifies whether to populate members that relates to SharePoint users, e.g. Author

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Author
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckedOutByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • LockedByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • ModifiedBy
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckInComment
  • CheckOutType
  • ContentTag
  • CustomizedPageStatus
  • ETag
  • Exists
  • Length
  • Level
  • MajorVersion
  • MinorVersion
  • Name
  • ServerRelativeUrl
  • TimeCreated
  • TimeLastModified
  • Title
  • UIVersion
  • UIVersionLabel
  • Errors

    Error code Description
    1000 Unspecified error.

    List folders in root of Document Library

    Lists all folders in the root of the Document Library.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ItemCount
  • Name
  • ServerRelativeUrl
  • WelcomePage
  • Errors

    Error code Description
    1000 Unspecified error.

    List subfolders of folder

    Lists all subfolders of specified folder.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Folder Name of folder to list sub folders of. E.g. "subfolder1/subfolder2"

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ItemCount
  • Name
  • ServerRelativeUrl
  • WelcomePage
  • Errors

    Error code Description
    1000 Unspecified error.

    Get subfolders by relative url

    Lists all subfolders of specified folder provided by relative url. Useful for instance if you got a Record containg folder information including its relative url and want to list the sub folders of that folder.

    Parameters

    Parameter Description
    Server relative url An url relative to server, e.g. "/subsite/doclib/folder"

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ItemCount
  • Name
  • ServerRelativeUrl
  • WelcomePage
  • Errors

    Error code Description
    1000 Unspecified error.

    Download file by url to file system

    Downloads a single file by server relative url to file system.

    Parameters

    Parameter Description
    Server relative url An url relative to server, e.g. "/subsite/doclib/folder/file.txt".
    Local filename Full path where to download file. Note that the user the application pool running Flow Server must have write access to the file. If the file already exists, it is overwritten.

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Download file by url to stream

    Downloads a single file by server relative url to a simple variable (stream).

    Parameters

    Parameter Description
    Server relative url An url relative to server, e.g. "/subsite/doclib/folder/file.txt".

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.

    Download file to file system

    Downloads a single file from Document Library by path to file system.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Remote filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
    Local filename Full path where to download file. Note that the user the application pool running Flow Server must have write access to the file. If the file already exists, it is overwritten.

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Download file to stream

    Downloads a single file to a simple variable (stream).

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.

    Upload file from bytes

    Uploads a single file from a Table of bytes to a SharePoint Document Library.

    Parameters

    Parameter Description
    Source bytes Table (consisting of bytes) to read from
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename to use in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
    Overwrite if exists Specifies whether to overwrite remote file if it already exists or abort

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Upload file from local file system

    Uploads a single file from file system to a SharePoint Document Library.

    Parameters

    Parameter Description
    Local filename Full path to file to upload. Note that the user the application pool running Flow Server must have access to the file.
    Document Library Name Name of Document Library in SharePoint (not id)
    Remote filename Remote filename to use in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
    Overwrite if exists Specifies whether to overwrite remote file if it already exists or abort

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Upload file from stream

    Uploads a single file from a stream to a SharePoint Document Library.

    Parameters

    Parameter Description
    Source stream Simple variable containg a stream
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename to use in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
    Overwrite if exists Specifies whether to overwrite remote file if it already exists or abort

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Set description

    Set a new description on a Document Library

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    New description New description to set on Document Library

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Set name

    Set a new title on a Document Library

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    New title The new title

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Add attached file (from bytes)

    Upload a file as an attachment to task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Remote filename Remote filename
    Source bytes Table (consisting of bytes) to read from

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Add attached file (from file system)

    Upload a file as an attachment to task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Remote filename Remote filename
    Local filename Full path to file to upload. Note that the user the application pool running Flow Server must have access to the file.

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Add attached file (from stream)

    Upload a file as an attachment to task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Filename Remote filename
    Source stream Simple variable containg a stream

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Delete all attached files

    Delete all attachments on provided task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Filename Remote filename

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Delete attached file

    Delete an attachment on provided task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Filename Remote filename

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.
    1000005 File not found.

    List attached files

    Lists all files attached to specified task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Filename
  • ServerRelativeUrl
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Get task information by ID

    Get information such as start date, due date etc about a task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Record variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Get task information by name

    Get information such as start date, due date etc about all tasks with given name.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task name Name of task

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Get task information by query

    Gets information about tasks by provided CAML Query. Example to get all tasks that are 50% or more completed:

    <View>
        <Query>
            <Where>
                <Geq>
                    <FieldRef Name='PercentComplete' />
                    <Value Type='Number'>0.50</Value>
                </Geq>
            </Where>
        </Query>
    </View>
    

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    CAML Query The query to send to SharePoint.

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Get task property value

    Gets the value of a field of a given task. This is an advanced operation that require deeper knowledge on how SharePoint works. The Property parameter is the identifier of a field, which might not be the same as is displayed in SharePoint. E.g use 'Body' as Property to update 'Description'.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Property Name of property

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    List tasks

    Lists all tasks.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Row limit Limit on how many tasks to list. A value of -1 indicates no limit

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List fields of tasks

    Lists the fields that are available for tasks in Task app.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Include read only fields Specifies whether to include fields that can only be read in the results of the operation

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • StaticName
  • Title
  • Description
  • DefaultValue
  • ReadOnly
  • Required
  • TypeAsString
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List tasks assigned to current user

    Lists all tasks assigned to current user. Optionally including finished tasks.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Include already finshed tasks Specifies whether to also include completed tasks

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List tasks assigned to specific user

    Lists all tasks assigned to specified user. Optionally including finished tasks.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    User ID ID of user
    Include already finshed tasks Specifies whether to also include completed tasks

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Add predecessor

    Adds an existing task as a predecessor to provided task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Predecessor task id ID of predecessor task

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Get predecessors

    Gets all predecessors of given task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • TaskID
  • Value
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Remove all predecessor

    Removes all predecessor of provided task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Remove predecessor

    Removes a predecessor of provided task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Predecessor task id ID of predecessor task

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Assign task to user (by username)

    Assign a task to given SharePoint user (by username).

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Username Username of user to assign task to
    Remove other assignees Specfies whether to remove other assignees. Default true

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Delete task

    Deletes task with given ID.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Set task as finished

    Sets the percent complete to 100%.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Update task progress

    Updates the progress of a given task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    New progress New progress in %

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Update task property

    Updates a field of a given task. This is an advanced operation that requires deeper knowledge on how SharePoint works. The Property parameter is the identifier of a field, which might not be the same as is displayed in SharePoint. E.g use 'Body' as Property to update 'Description'.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Property Name of property
    Value New value of property

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Create new subtask

    Creates a new subtask in a Task app.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Parent Task ID ID of parent task
    Task name Name of new subtask
    Start date When task is to be started
    Due date When task is to be finished
    Percent complete How much of task that is finished. Default 0
    Description Description of task
    Priority Priority of task
    Status Status of task
    Assigned to (user ID(s)) User ID to assign task to, if any

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Create new task

    Creates a new task in a Task app. Returns the ID of created task in Results.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task name Name of new task
    Start date When task is to be started
    Due date When task is to be finished
    Percent complete How much of task that is finished. Default 0
    Description Description of task
    Priority Priority of task
    Status Status of task
    Assigned to (user ID(s)) User ID to assign task to, if any

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Assign user to group

    Assigns a user to a group

    Parameters

    Parameter Description
    Group id Id of group
    Login name Login name of user, not id

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Detach user from group

    Detaches the user from the group

    Parameters

    Parameter Description
    Group id Id of group
    Login name Login name of user, not id

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    List site groups

    Gets and list all site groups

    Parameters

    Parameter Description

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • AllowMembersEditMembership
  • AllowRequestToJoinLeave
  • AutoAcceptRequestToJoinLeave
  • CanCurrentUserEditMembership
  • CanCurrentUserManageGroup
  • CanCurrentUserViewMembership
  • OnlyAllowMembersViewMembership
  • RequestToJoinLeaveEmailSetting
  • Id
  • LoginName
  • Title
  • Description
  • OwnerTitle
  • Errors

    Error code Description
    1000 Unspecified error.

    List users by group id

    List all users assigned to a group.

    Parameters

    Parameter Description
    Group id Id of group

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Id
  • LoginName
  • Email
  • Title
  • IsSiteAdmin
  • Errors

    Error code Description
    1000 Unspecified error.

    Get user by ID

    Get information about a SharePoint user.

    Parameters

    Parameter Description
    User ID ID of user

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Record variable containing the results of operation

    Structure of Results

    Results
  • Id
  • LoginName
  • Email
  • Title
  • IsSiteAdmin
  • Errors

    Error code Description
    1000 Unspecified error.

    Get user by Login name

    Get information about a SharePoint user.

    Parameters

    Parameter Description
    Login name Login name of user, not id

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Record variable containing the results of operation

    Structure of Results

    Results
  • Id
  • LoginName
  • Email
  • Title
  • IsSiteAdmin
  • Errors

    Error code Description
    1000 Unspecified error.

    List users

    Get list of all users at site.

    Parameters

    Parameter Description

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Id
  • LoginName
  • Email
  • Title
  • IsSiteAdmin
  • Errors

    Error code Description
    1000 Unspecified error.

    Microsoft SharePoint 2013

    The SharePoint 2013 connector can be used to integrate with various apps in SharePoint 2013.

    Business systems

    Email Connector

    User the email connector to send email in your workflow. It is possible to use Flow script in the email connector to make the email more informative.

    TODO

    Create directory

    Creates a directory at the FTP server. It is not possible to create several levels of directories in one step. If you want to create the directory "./dirA/dirB", the directory "./dirA" must exist. Otherwise you have to do it in two steps; first creates directory "./dirA" and the second one created "./dirA/dirB".

    Parameters

    Parameter Description
    Remote path Path to the directory to create.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Delete empty directory

    Deletes specified empty directory. Note if directory contain a file it will return an error.

    Parameters

    Parameter Description
    Remote path Path to directory to delete

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Check if directory exists

    Determains whether directory at specified path exists.

    Parameters

    Parameter Description
    Path The path to check.

    Output

    Simple value,'True' if directory exists. 'False' otherwise.

    Since

    6.3

    See also

    FTP Connector

    List directory

    Lists all files and directories in a specified path.

    Parameters

    Parameter Description
    Remote path Path to list.
    Mask Mask to use when filtering items in directory. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B"
    Case sensitive Specifies whether to ignore casing or not.
    Include files Specifies whether to include files in the listing.
    Include directories Specifies whether to include directories in the listing.
    Recursive Specifies whether to also search in subdirectories.

    Output

    A table consisting of records with the following structure:

    Member Description
    Name The name of the file or directory.
    Size The size, in bytes, of the item.

    Since

    6.3

    See also

    FTP Connector

    Download single file

    Downloads a file from the FTP server to the machine where Flow Server is running.

    Parameters

    Parameter Description
    Remote filename The name of the file to be downloaded
    Local filename Filename of where on Flow Server to store the downloaded file.
    File tranfer mode Specifies how to handle if file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Download multiple files

    Downloads multiple files from the FTP server to the machine where Flow Server is running.

    Parameters

    Parameter Description
    Remote path Path to downloaded files from.
    Remote mask Mask used to filter which files to download. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Local filename Filename of where on Flow Server to store the downloaded files.
    File tranfer mode Specifies how to handle if file already exists.
    File copy mode Specifies what to do with the file after download has been completed.
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to download files from sub directories recursivly.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Download stream

    Downloads a file from FTP server and store it as Flow variable.

    Parameters

    Parameter Description
    Remote filename The name of the file to be downloaded

    Output

    Simple value (binary stream).

    Since

    6.3

    See also

    FTP Connector

    Delete file

    Delete a remote file.

    Parameters

    Parameter Description
    Remote path Path to file to delete.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Delete files

    Delete multiple remote files based on mask.

    Parameters

    Parameter Description
    Remote path Path where to delete files.
    Mask Mask used to filter which files to download. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to delete files recursivly.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Check if file exists

    Checks if a remote file exists.

    Parameters

    Parameter Description
    Remote path Path to check.

    Output

    Simple value,'True' if file exists. 'False' otherwise.

    Since

    6.3

    See also

    FTP Connector

    Get file time

    Get a remote file time.

    Parameters

    Parameter Description
    Path File of interest.

    Output

    Simple value, Date.

    Since

    6.3

    See also

    FTP Connector

    Get list of files

    Get list of files in a directory.

    Parameters

    Parameter Description
    Remote path Path to list.

    Output

    A table consisting of records with the following structure:

    Member Description
    Name The name of the file.
    Size The size, in bytes, of the item.

    Since

    6.3

    See also

    FTP Connector

    Get size of file

    Gets the size, in bytes, of remote file.

    Parameters

    Parameter Description
    Remote path File of interest.

    Output

    Simple value, numeric.

    Since

    6.3

    See also

    FTP Connector

    Rename file

    Renames a remote file.

    Parameters

    Parameter Description
    Old path Current name of file.
    New path New name of file.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Set file time

    Changes a remote file time.

    Parameters

    Parameter Description
    Path File of interest.
    New time New time for the file.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Clear Command Channel

    Clears command channel encryption state, turning off SSL/TLS encryption.

    Parameters

    Parameter Description
    Graceful SSL Closure Send closure notification to the server.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Get Server System

    Get server system operating system.

    Parameters

    Parameter Description

    Output

    Single value, text.

    Since

    6.3

    See also

    FTP Connector

    Send Command

    Sends a command to the FTP Server.

    Parameters

    Parameter Description
    Send Command Command to send. Send NOOP for a dummy message.

    Output

    Single value, text. Returs a error code.

    Since

    6.3

    See also

    FTP Connector

    Upload single file

    Uploads a single file from the Flow Server to the FTP Server.

    Parameters

    Parameter Description
    Local filename File to upload.
    Remote filename Where to upload the file.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Upload multiple files

    Uploads multiple files from the Flow Server to the FTP Server.

    Parameters

    Parameter Description
    Local path Path where to upload files from.
    Mask Mask used to filter which files to upload. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Remote path Path where to upload the files.
    File transfer mode Specifies what to do if the file already exists.
    Case sensitive Specifies whether to ignore casing or not.
    Recursive Specifies whether to also upload from subdirectories.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Upload stream

    Uploads the content of a Flow variable that contains a binary stream. This can for instance be used to upload data from a camera input.

    Parameters

    Parameter Description
    Local stream Stream to read data from.
    Remote filename Where to upload the data.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    FTP

    The FTP Connector is used to upload and download files from an FTP server. It can also perform other operations such as creating remote directories and list files and directories on the FTP server.

    Configuration

    Operations

    Directory operations
    Check if directory exists
    Create directory
    Delete empty directory
    List directory
    Download operations
    Download multiple files
    Download single file
    Download stream
    File operations
    Check if file exists
    Delete file
    Delete files
    Get size of file
    Rename file
    Set file time
    Get time of file
    Get list of files
    Upload operations
    Upload multiple files
    Upload file
    Upload stream
    Server operations
    Send Command
    Clear Command Channel
    Get Server System

    Modbus

    All commands can be sent in synchronous or asynchronous mode. If a value is accessed in synchronous mode the program will stop and wait for slave to response. If the slave didn't answer within a specified time a timeout exception is called. The class uses multi threading for both synchronous and asynchronous access. For the communication two lines are created. This is necessary because the synchronous thread has to wait for a previous command to finish.

    Operations

    Read operations
    Read Coils Inputs
    Read Digital Inputs
    Read Holding Register
    Read Inputs Register
    Write operations
    Read Write Multiple Holding Register
    Write Multiple Coils
    Write Multiple Holding Register
    Write Single Coil
    Write Single Holding Register

    Read Coils

    Reads Coils

    Parameters

    Parameter Description
    First Address to be read Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    Returns a table with values, true or false.

    Since

    6.4

    See also

    Modbus Connector

    Read Digital Inputs

    Read Digital Inputs

    Parameters

    Parameter Description
    First Address to be read Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    Returns a table with values, true or false.

    Since

    6.4

    See also

    Modbus Connector

    Read Holding Register

    Read Holding Register

    Parameters

    Parameter Description
    First Address to be read Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    Returns a table with values.

    Since

    6.4

    See also

    Modbus Connector

    Read Input Register

    Read Input Register

    Parameters

    Parameter Description
    First Address to be read Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    Returns a table with values.

    Since

    6.4

    See also

    Modbus Connector

    Read Write Multiple Holding Register

    Read Write Multiple Holding Register

    Parameters

    Parameter Description
    First Address to be read Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.
    First address to be written Length of data.
    Holding register inputs to be written Contains the register information.

    Output

    Return table with values.

    Since

    6.4

    See also

    Modbus Connector

    Write Coil

    Write Coil

    Parameters

    Parameter Description
    First Address to be written Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    No return!

    Since

    6.4

    See also

    Modbus Connector

    Write Single Register

    Write Single Register

    Parameters

    Parameter Description
    First Address to be written Address from where the data written begins.
    Holding register input to be written. Value to write on the address.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    No return!

    Since

    6.4

    See also

    Modbus Connector

    Write Multiple Coils

    Write Multiple Coils

    Parameters

    Parameter Description
    First Address to be written Address from where the data written begins.
    Number of addresses to be set. Values to be set.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    No return!

    Since

    6.4

    See also

    Modbus Connector

    Write Multiple Registers

    Write Multiple Registers

    Parameters

    Parameter Description
    First Address to be written Address from where the data read begins.
    Number of addresses to be read Values to write.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    No return!

    Since

    6.4

    See also

    Modbus Connector

    External Oauth 2.0 provider

    There are no settings, only choose what variable you would like to output the token to. This variable can be used in conjuction the REST connector to access Oauth 2.0 authenticated resources, like azure graph api

    Create directory

    Creates a directory at the SFTP server. It is not possible to create several levels of directories in one step. If you want to create the directory "./dirA/dirB", the directory "./dirA" must exist. Otherwise you have to do it in two steps; first creates directory "./dirA" and the second one created "./dirA/dirB".

    Parameters

    Parameter Description
    Remote path Path to the directory to create.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Delete directory

    Deletes specified directory. Note that the directory must be empty unless Recursive is set to true.

    Parameters

    Parameter Description
    Remote path Path to directory to delete
    Recursive Specifies whether to also delete all files and subdirectories.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Check if directory exists

    Determains whether directory at specified path exists.

    Parameters

    Parameter Description
    Path The path to check.

    Output

    Simple value,'True' if directory exists. 'False' otherwise.

    Since

    6.3

    See also

    SFTP Connector

    List directory

    Lists all files and directories in a specified path.

    Parameters

    Parameter Description
    Remote path Path to list.
    Mask Mask to use when filtering items in directory. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B"
    Case sensitive Specifies whether to ignore casing or not.
    Include files Specifies whether to include files in the listing.
    Include directories Specifies whether to include directories in the listing.
    Recursive Specifies whether to also search in subdirectories.

    Output

    A table consisting of records with the following structure:

    Member Description
    Name The name of the file or directory.
    IsDirectory True if the item is a directory, false if it is a file.
    Size The size, in bytes, of the item.
    LastAccessTime Last time item was accessed.
    LastModifiedTime Last time the item was modified.
    CreationTime Time of item creation.

    Since

    6.3

    See also

    SFTP Connector

    Download single file

    Downloads a file from the SFTP server to the machine where Flow Server is running.

    Parameters

    Parameter Description
    Remote filename The name of the file to be downloaded
    Local filename Filename of where on Flow Server to store the downloaded file.
    File tranfer mode Specifies how to handle if file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Download multiple files

    Downloads multiple files from the SFTP server to the machine where Flow Server is running.

    Parameters

    Parameter Description
    Remote path Path to downloaded files from.
    Remote mask Mask used to filter which files to download. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    File tranfer mode Specifies how to handle if file already exists.
    File copy mode Specifies what to do with the file after download has been completed.
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to download files from sub directories recursivly.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Download stream

    Downloads a file from SFTP server and store it as Flow variable.

    Parameters

    Parameter Description
    Remote filename The name of the file to be downloaded

    Output

    Simple value (binary stream).

    Since

    6.3

    See also

    SFTP Connector

    Copy remote file

    Copies a remote file into the selected destination.

    Parameters

    Parameter Description
    Remote source path Path where to copy from.
    Remote destination path Path where to copy to.
    Overwrite if already exists True or false.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Delete file

    Delete a remote file.

    Parameters

    Parameter Description
    Remote path Path to file to delete.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Delete files

    Delete multiple remote files based on mask.

    Parameters

    Parameter Description
    Remote path Path where to delete files.
    Mask Mask used to filter which files to download. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to delete files recursivly.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Check if file exists

    Checks if a remote file exists.

    Parameters

    Parameter Description
    Remote path Path to check.

    Output

    Simple value,'True' if file exists. 'False' otherwise.

    Since

    6.3

    See also

    SFTP Connector

    Get size of file

    Gets the size, in bytes, of remote file.

    Parameters

    Parameter Description
    Remote path File of interest.

    Output

    Simple value, numeric.

    Since

    6.3

    See also

    SFTP Connector

    Rename file

    Renames a remote file.

    Parameters

    Parameter Description
    Old path Current name of file.
    New path New name of file.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Upload single file

    Uploads a single file from the Flow Server to the SFTP Server.

    Parameters

    Parameter Description
    Local filename File to upload.
    Remote filename Where to upload the file.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Upload multiple files

    Uploads multiple files from the Flow Server to the SFTP Server.

    Parameters

    Parameter Description
    Local path Path where to upload files from.
    Local mask Mask used to filter which files to upload. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Remote path Path where to upload the files.
    File transfer mode Specifies what to do if the file already exists.
    Case sensitive Specifies whether to ignore casing or not.
    Recursive Specifies whether to also upload from subdirectories.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Upload stream

    Uploads the content of a Flow variable that contains a binary stream. This can for instance be used to upload data from a camera input.

    Parameters

    Parameter Description
    Local stream Stream to read data from.
    Remote filename Where to upload the data.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    SFTP

    The SFTP Connector is used to upload and download files from an SFTP server. It can also perform other operations such as creating remote directories and list files and directories on the SFTP server.

    Operations

    Directory operations
    Check if directory exists
    Create directory
    Delete directory
    List directory
    Download operations
    Download multiple files
    Download single file
    Download stream
    File operations
    Check if file exists
    Copy remote file
    Delete file
    Delete files
    Get size of file
    Rename file
    Upload operations
    Upload multiple files
    Upload file
    Upload stream

    Siox

    Before using the Siox connector you need the Siox driver from the Siox website. You can also find the documentation for all the operation if you download the Siox SDK.

    Communication

    BarTender 2016

    The BarTender 2016 connector can be used to integrate with BarTender, typically to print BarTender documents.

    32-bit version of BarTender 2016 R8 Automation Edition or Enterprise Automation Edition needs to be installed on the same machine as Flow Server.

    List printers

    Lists all printers available.

    Output

    Record with information about whether operation failed or not.

    Member Description
    Results Contains a table with information about printers
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Structure of Results

    Results
  • PrinterName
  • DriverName
  • PortName
  • Location
  • IsDefault
  • Errors

    Error code Description
    1000 Unspecified error.

    Prints a BarTender document to specified printer or to an image (printing to image requires Enterprise Automation Edition).

    Parameters

    Parameter Description
    Printer Printer to print to, leave empty to use default printer
    Print job name Name of print job, can be omitted
    Document password If applicable, the password to use in order to print the document
    Number of identical copies to print If supported, specifies how many identical copies to print
    Embedded data Values to embedded data can be provided here. The members of this record parameter depends on the BarTender document. See this for example of usage
    Text file database If the document reads data from a text file, this section can be used to configure it. More information about this parameter below.
    Database connection If the document reads data from a database, this section can be used to configure it. More information about this parameter below.
    Print to image preview This section can be used to configure that the document should be printed to an image instead of a printer. Requires Enterprise Automation Edition of BarTender

    Text file database

    Parameter Description
    File name File to use as input. Relative to Flow Server or, if not a complete path, relative to where the BarTender document is located.
    Delimitation Specifies how fields are separated in text file
    Field delimiter Specifies what character is used to delimit fields if Delimitation is Custom
    Number of fields The number of fields to consider when reading text file (if file contains more data than needed)
    Use field names from first record Specifies whether the first row of the file contains the field names.
    Flow table If specified, overrides File name and data is read from the provided table. See this for example of usage

    Database connection

    Parameter Description
    Name Name of database
    User ID Database user to login to the database with, if applicable
    Password Password for given database user, if applicable
    SQL Statement Specifies the SQL to execute.
    File name Specifies path to file, if applicable, for instance if Microsoft Access or Microsoft Excel is used.
    Server The database server to connect to, if applicable

    Output

    Record with information about whether operation failed or not.

    Member Description
    Results Contains a message from BarTender, typically information about the printing
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occurred

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 Failed to print.
    1000002 Failed due to timeout.

    Sends a BTXML Script to BarTender.

    Parameters

    Parameter Description
    Filename Full path to file containing BTXML Script

    Output

    Record with information about whether operation failed or not.

    Member Description
    Results Contains a record with the xml response from BarTender and a table with messages from BarTender
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Structure of Results

    Results
  • XmlResponse
  • Messages
    • Text
    • ID
    • Severity
    • Category
  • Errors

    Error code Description
    1000 Unspecified error.

    Sends a BTXML Script to BarTender.

    Parameters

    Parameter Description
    Script value String containing the BTXML Script

    Output

    Record with information about whether operation failed or not.

    Member Description
    Results Contains a record with the xml response from BarTender and a table with messages from BarTender
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Structure of Results

    Results
  • XmlResponse
  • Messages
    • Text
    • ID
    • Severity
    • Category
  • Errors

    Error code Description
    1000 Unspecified error.

    Html to PDF Connector

    Use the PDF connector to create PDF files in your workflow. The connector uses Hypertext Markup Language (HTML) to define the layout of your PDF pages and fully supports using FlowScript.

    PDF Connector Settings Window

    Connector Output

    The output from the connector is a standard file record: [filename:the_file_name, data:binary_pdf_data].

    General Tips & Tricks

    In most use cases, you want to take control over the page breaks in your document. In order to achieve this, you need to specify a maximum length for all dynamic data in your workflow and specify the height of the elements which contains the dynamic data using the HTML DOM Style height property. If you do not to this, the document will grow with its content and you might get undesirable page breaks.

    Tip: Create a simple workflow with a PDF connector and a user step. In the user step, add a file gallery with the generated PDF document(s)
    and use the workflow for designing and debugging your page layouts.
    Another good practice is to use one machine step per page and then supply the previous PDF document (file record) as input parameter for the next PDF task (see Append a new page to an existing PDF below).

    Settings

    This chapter describes the available settings in the PDF connector.

    File Name

    This string defines the filename-key value of the target file record (see Connector Output).

    PDF Settings File Name

    Append new page to an existing PDF

    The connector optionally takes a file record containing a PDF file as an input variable. If suppied, the new page(s) created in the current machine step will be appended to the existing PDF file. The target variable will contain the merged PDF file as a standard file record.

    PDF Settings File Name

    To keep the file name from the previous PDF step, just re-use the filename value from the previous PDF file record:

    PDF Settings File Name

    Margins

    The margin size in points (one inch = 72 points).

    PDF Settings Margins

    Page Size

    <td valign="top">The default setting for page size is A4 format. <br/>
        The page size selector lets you choose from <br/>
        the most common page sizes.</td>
    <td><div style="left: 18px;">![PDF Settings Page Size](pdf_connectorSettingsPageSize.png){ width=100px }</div></td>

    Page Orientation

    Choose between Portrait and Landscape orientation. The default orientation is Portrait.

    PDF Settings Page Orientation

    Images / Signatures

    If you need to display images or signatures in your PDF pages, you need to make sure to have them available in your flow as file records. Signatures from the signature input provider is by default a file record with some extra fields and are supported by the PDF connector. The Images / Signatures field takes either a file record or a table of file records. The image below gives an example of two signature records being passed to the PDF connector.

    PDF Settings Images / Signatures

    In order to be able to differentiate between the images/signatures in the HTML code, you might need to override the filename component of the file records and give them unique and identifiable file names prior to passing them to the PDF connector. The image below shows a file name being overriden in an assignment step.

    PDF Settings HTML

    To position your image/signature in the document, the HTML IMG tag is used. I.e. <img src=your_file_name.jpg height=40>. See the image under the HTML headline below.

    HTML

    The document layout is defined using HTML. It's recommended to keep the code as simple as possible and build the layout using a bottom-up approach. If you are new to HTML, visit https://wordhtml.com/. However if you use the generated code directly you will get disappointed as there are some important aspects to keep in mind. Most importantly, you need to use percentages instead of absolute values for width. Keep the total width of your columns at about 95%.

    PDF Settings HTML

    NiceLabel

    Printing

    Create directory

    Creates all the directories at specified path.

    Parameters

    Parameter Description
    Path The path to create. Allow subdirectories on path will also be created if they do not exist.
    Allow Everyone to have full control over directory If set to True, all users have full control over directory. If set to False, only the user the Connector is running as can access the directory. Default True.

    Output

    Simple value containing the path to the newly created directory.

    Since

    6.0

    See also

    File System Connector

    Delete directory

    Deletes directory at provided path. Directory must be empty unless 'Also delete all subdirectories (and files)' is true.

    Parameters

    Parameter Description
    Path The path to delete.
    Also delete all subdirectories (and files) If set to True, all files and subdirectories will be deleted. If set to False, the directory must be empty in order to delete it.

    Output

    Simple value,'True' if directory was successfully deleted. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Delete files in directory

    Deletes all files in directory matching specified pattern.

    Parameters

    Parameter Description
    Path The path to the directory to delete files from. Path can be UNC path or local file path.
    Search pattern Pattern to match files against. Supports wildcards * and ? but not regular expressions. Default value "*".

    Output

    Simple value, number of files deleted.

    Since

    6.3

    See also

    File System Connector

    Check if directory exists

    Determains whether directory at specified path exists.

    Parameters

    Parameter Description
    Path The path to check.

    Output

    Simple value,'True' if directory exists. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Get directory modification times

    Gets a record containing directory modification times.

    Parameters

    Parameter Description
    Path The path to get modification times from.
    As UTC True to get the modification times in UTC

    Output

    Record with members 'CreationTime', 'LastWriteTime' and 'LastAccessTime'.

    Since

    6.0

    See also

    File System Connector

    Get all subdirectories of directory (full path)

    Gets the full path of all subdirectories of given directory.

    Parameters

    Parameter Description
    Path The path to get file names from. Path can be UNC path or local file path.
    Search pattern Pattern to match directories against. Supports wildcards * and ? but not regular expressions. Default value "*".
    Also get directories in subdirectories Specifies whether to also include directories in subdirectories of Path. Default value False.

    Output

    Table with column 'value' where each row is a full path to directory in given directory.

    Since

    6.0

    See also

    File System Connector

    Get name of all subdirectories of directory

    Gets the names of all directories in given directory.

    Parameters

    Parameter Description
    Path The path to get directory names from. Path can be UNC path or local file path.
    Search pattern Pattern to match directories against. Supports wildcards * and ? but not regular expressions.

    Output

    Table with column 'value' where each row is the name of a directory in given directory.

    Since

    6.0

    See also

    File System Connector

    Get name of files in directory

    Gets the names (including extension) of all files in given directory.

    Parameters

    Parameter Description
    Path The path to get file names from. Path can be UNC path or local file path.
    Search pattern Pattern to match files against. Supports wildcards * and ? but not regular expressions.

    Output

    Table with column 'value' where each row is the name of a file in given directory.

    Since

    6.0

    See also

    File System Connector

    Get files in directory (full path)

    Gets the full path of all files in given directory.

    Parameters

    Parameter Description
    Path The path to get file names from. Path can be UNC path or local file path.
    Search pattern Pattern to match files against. Supports wildcards * and ? but not regular expressions. Default value "*".
    Also get files in subdirectories Specifies whether to also include files in subdirectories of Path. Default value False.

    Output

    Table with column 'value' where each row is a full path to file in given directory.

    Since

    6.0

    See also

    File System Connector

    Move directory

    Moves a directory to a new location.

    Parameters

    Parameter Description
    Source path The path to directory to move. Path can be UNC path or local file path.
    Destination path The path to directory to move. Path can be UNC path or local file path.
    Overwrite destination directory if it exists If set to True and destination path already exists, it is overwritten. If set to false and destination path already exists, no move operation is done.

    Output

    Simple value, 'True' if directory was successfully moved. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Appends all lines to file

    Appends all provided lines to a file. If the file does not exist, it is created.

    Parameters

    Parameter Description
    Path Path to file to append lines to.
    Lines Lines to append.
    Code page Specifies which code page to write the lines in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    No output.

    Since

    6.0

    See also

    File System Connector

    Appends all text to file

    Appends all provided text to a file. If the file does not exist, it is created.

    Parameters

    Parameter Description
    Path Path to file to append text to.
    Text to append Text.
    Code page Specifies which code page to write the text in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    No output.

    Since

    6.0

    See also

    File System Connector

    Copy file

    Copies a file to a new location.

    Parameters

    Parameter Description
    Source The file to move. Path can be UNC path or local file path.
    Destination The location of the file. Path can be UNC path or local file path.
    Overwrite if destination file exists If set to True and destination file already exists, it is overwritten. If set to false and file already exists, no copy operation is done.

    Output

    Simple value, 'True' if file was successfully copied. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Delete file

    Deletes file at provided path.

    Parameters

    Parameter Description
    Path The path to file to delete.

    Output

    Simple value, 'True' if file was successfully deleted. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Check if file exists

    Determains whether file at specified path exists.

    Parameters

    Parameter Description
    Path The path to the file to check. Path can be UNC path or local file path.

    Output

    Simple value, 'True' if file exists. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Get files modification times

    Gets a record containing files modification times.

    Parameters

    Parameter Description
    Path The path to get modification times from.
    As UTC True to get the modification times in UTC.

    Output

    Record with members 'CreationTime', 'LastWriteTime' and 'LastAccessTime'

    Since

    6.0

    See also

    File System Connector

    Move file

    Moves a file to a new location.

    Parameters

    Parameter Description
    Source The file to move. Path can be UNC path or local file path.
    Destination The location of the file. Path can be UNC path or local file path.
    Overwrite destination file if it exists If set to True and destination file already exists, it is overwritten. If set to false and file already exists, no move operation is done.

    Output

    Simple value, 'True' if file was successfully moved. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Read all bytes from file

    Reads all bytes from a file and puts it a Table variable. Reading too large files can cause performance issues.

    Parameters

    Parameter Description
    Path Path to source file to read lines from.

    Output

    Table with column 'value' where each row is one byte from source file.

    Since

    6.0

    See also

    File System Connector

    Read all lines from file

    Reads all lines from a file and puts it a Table variable. Reading too large files can cause performance issues.

    Parameters

    Parameter Description
    Path Path to source file to read lines from.
    Code page Specifies which code page to read the file in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    Table with column 'value' where each row is one line in source file.

    Since

    6.0

    See also

    File System Connector

    Read all text from file

    Reads all text from a file and puts it a simple value variable. Reading too large files can cause performance issues.

    Parameters

    Parameter Description
    Path Path to source file to read text from.
    Code page Specifies which code page to read the file in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    Simple value variable (string), with all content of file in it.

    Since

    6.0

    See also

    File System Connector

    Write all bytes to file

    Writes all provided bytes to a file. If the file already exist, it is overwritten.

    Parameters

    Parameter Description
    Path Path to file to append text to.
    Bytes A Table containing one column, value, with numeric values (byte, 0-255).

    Output

    No output.

    Since

    6.0

    See also

    File System Connector

    Write all lines to file

    Writes all provided lines to a file. If the file already exist, it is overwritten..

    Parameters

    Parameter Description
    Path Path to file to write lines to.
    Lines Lines to write.
    Code page Specifies which code page to write the lines in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    No output.

    Since

    6.0

    See also

    File System Connector

    Write all text to file

    Writes all provided text to a file. If the file already exist, it is overwritten.

    Parameters

    Parameter Description
    Path Path to file to write text to.
    Text to write Text.
    Code page Specifies which code page to write the text in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    No output.

    Since

    6.1.6

    See also

    File System Connector

    Write stream to file

    Writes the content of a Flow variable that contains a binary stream to a file. This can for instance be used to write data from a camera input to the file system.

    Parameters

    Parameter Description
    Path Path to file to write stream to.
    Source stream Stream to write. Must be a Flow variable.

    Output

    No output.

    Since

    6.2

    See also

    File System Connector

    Add single file to zip

    Compresses a single file and adds it to a zip file.

    Parameters

    Parameter Description
    File File to add to archive.
    Path to zip file Zip file to add file to.
    Password Optional password to the zip file.
    Replace mode Specifies what to do if a specific file already exists in the archive.
    Compression level Specifies the level of compression, valid values are 1-9 where 9 indicates highest level of compression (and slowest). Default value is 6.

    Output

    Simple value, 'True' if operation was successfully. 'False' otherwise.

    Since

    6.3

    See also

    File System Connector

    Add stream to zip

    Compresses the content of a Flow variable that contains a binary stream. This can for instance be used to compress data from a camera input.

    Parameters

    Parameter Description
    Stream Stream to read data from.
    Filename for stream in zip file The name of the file in the archive the content of the stream should be written to.
    Path to zip file Zip file to add stream content to.
    Password Optional password to the zip file.
    Replace mode Specifies what to do if a specific file already exists in the archive.
    Compression level Specifies the level of compression, valid values are 1-9 where 9 indicates highest level of compression (and slowest). Default value is 6.

    Output

    Simple value, 'True' if operation was successfully. 'False' otherwise.

    Since

    6.3

    See also

    File System Connector

    Extract files from zip

    Extracts all files from a zip file which matches provided mask.

    Parameters

    Parameter Description
    Path to zip file Zip file to extract from.
    Destination path Path where to extract files to. If file or directory already exists at destination path, it is skipped (not overwritten). The directory should exist before this operation is called.
    Filter Filet to use when filtering items in archive. Example "*.txt".
    Password Optional password to the zip file.

    Output

    Simple value, 'True' if operation was successfully. 'False' otherwise.

    Since

    6.3

    See also

    File System Connector

    Extract file to stream

    Extracts a single file to a stream. The entire file will be loaded into memory, so do not use this operation with large files.

    Parameters

    Parameter Description
    Path to zip file Zip file to extract from.
    Filename The name of the file in the archive to extract.
    Password Optional password to the zip file.

    Output

    Simple value, read-only binary stream trinket.

    Since

    6.3

    See also

    File System Connector

    Add folder to zip file

    Zips all files and subfolders in a folder into a zip file.

    Parameters

    Parameter Description
    Path Path to read files and folders from.
    Path to zip file Zip file to add folder content to.
    Password Optional password to the zip file.
    Replace mode Specifies what to do if a specific file already exists in the archive.
    Compression level Specifies the level of compression, valid values are 1-9 where 9 indicates highest level of compression (and slowest). Default value is 6.

    Output

    Simple value, 'True' if operation was successfully. 'False' otherwise.

    Since

    6.3

    See also

    File System Connector

    File System

    The File System connector can be used to perform directory and file operations on any file system which the Flow Server can access.

    Operations

    Directory operations
    Check if directory exists
    Create directory
    Delete
    Delete files in directory
    Get all subdirectories of directory (full path)
    Get directory modification times
    Get files in directory (full path)
    Get name of all subdirectories of directory
    Get name of files in directory
    Move directory
    File operations
    Append all text to file
    Appends all lines to file
    Check if file exists
    Copy file
    Delete file
    Get files modification times
    Move file
    Read all bytes from file
    Read all lines from file
    Read all text from file
    Write all bytes to file
    Write all lines to file
    Write all text to file
    Write stream to file
    Zip operations
    Add folder to zip file
    Add single file to zip
    Add stream to file
    Extract file to stream
    Append all text to file

    Read/Write to Flow Environment

    The Flow Environment Connector can be used to read information from the flow 6 database, it can also write new data to said database.

    Available Environment Operations

    Operations

    These are the functions that the connector supports, the flow connector can fetch data and write/update data to the flow 6 database. All operations either returns a table, row or a true/false boolean depending on if the operation was successful or not.

    Connector

    Language

    Properties

    Roles

    Users

    PDF Connector

    Use the PDF connector to create PDF files in your workflow. The connector uses Hypertext Markup Language (HTML) to define the layout of your PDF pages and fully supports using Flow Script.

    PDF Connector Settings Window

    Connector Output

    The output from the connector is a standard file record: [filename:the_file_name, data:binary_pdf_data].

    General Tips & Tricks

    In most use cases, you want to take control over the page breaks in your document. In order to achieve this, you need to specify a maximum length for all dynamic data in your workflow and specify the height of the elements which contains the dynamic data using the HTML DOM Style height property. If you do not to this, the document will grow with its content and you might get undesirable page breaks.

    Tip: Create a simple workflow with a PDF connector and a user step. In the user step, add a file gallery with the generated PDF document(s)
    and use the workflow for designing and debugging your page layouts.
    Another good practice is to use one machine step per page and then supply the previous PDF document (file record) as input parameter for the next PDF task (see Append a new page to an existing PDF below).

    Settings

    This chapter describes the available settings in the PDF connector.

    File Name

    This string defines the filename-key value of the target file record (see Connector Output).

    PDF Settings File Name

    Append new page to an existing PDF

    The connector optionally takes a file record containing a PDF file as an input variable. If suppied, the new page(s) created in the current machine step will be appended to the existing PDF file. The target variable will contain the merged PDF file as a standard file record.

    PDF Settings File Name

    To keep the file name from the previous PDF step, just re-use the filename value from the previous PDF file record:

    PDF Settings File Name

    Margins

    The margin size in points (one inch = 72 points).

    PDF Settings Margins

    Page Size

    <td valign="top">The default setting for page size is A4 format. <br/>
        The page size selector lets you choose from <br/>
        the most common page sizes.</td>
    <td><div style="left: 18px;">![PDF Settings Page Size](pdf_connectorSettingsPageSize.png){ width=100px }</div></td>

    Page Orientation

    Choose between Portrait and Landscape orientation. The default orientation is Portrait.

    PDF Settings Page Orientation

    Images / Signatures

    If you need to display images or signatures in your PDF pages, you need to make sure to have them available in your flow as file records. Signatures from the signature input provider is by default a file record with some extra fields and are supported by the PDF connector. The Images / Signatures field takes either a file record or a table of file records. The image below gives an example of two signature records being passed to the PDF connector.

    PDF Settings Images / Signatures

    In order to be able to differentiate between the images/signatures in the HTML code, you might need to override the filename component of the file records and give them unique and identifiable file names prior to passing them to the PDF connector. The image below shows a file name being overriden in an assignment step.

    PDF Settings HTML

    To position your image/signature in the document, the HTML IMG tag is used. I.e. <img src=your_file_name.jpg height=40>. See the image under the HTML headline below.

    HTML

    The document layout is defined using HTML. It's recommended to keep the code as simple as possible and build the layout using a bottom-up approach. If you are new to HTML, visit https://wordhtml.com/. However if you use the generated code directly you will get disappointed as there are some important aspects to keep in mind. Most importantly, you need to use percentages instead of absolute values for width. Keep the total width of your columns at about 95%.

    PDF Settings HTML

    Utility

    Pinned User Step

    A pinned user step are an information

    It is only possible to use Header, Static Text, Labeled Static Text, Link and List Presentation in pinned user steps, this because a pinned user step is only a why to show the user information.

    Configure a pinned user step

    Configure a pinned user step

    The pinned user step will show up in the side of the screen, and the user need to tap/click on the icon to extend or colaps the pinned user step. In the below picture is the pinned user step to the left and the regular user step to the right. If there is more then one pinned user step in the workflow, will the pinned user step be replaced when the user steps over another pinned user step.

    Pinned user step in the web client

    Pinned user step in the web client

    Create an offline resource

    Use an Offline resource to make data available in an offline workflow. When an offline resource is used, the button Offline data will be available in the clients. Under Offline data can the end user download data to the local device that will be used when executing offline workflows. For every Offline resource used in workflows available for the end user will one row show up under My offline data.


    Use an Offline resource to get data in offline workflows.


    Create a machine workflow that fetches the data needed and connect the Machine workflow to the Offline resource. The Machine workflow must be created as an Offline resource.


    Use the output variable from the Offline resource to use the data from the Machine workflow.

    Create an offline seed inbox

    Seeded inbox can also be fetched from an offline resource. Create an offline resource and connect a machine workflow that fetches the data needed for the seed inbox. Add a machine step and connect the machine step to the start event with a data arrow. In the machine step refer to the output of the offline resource.

    For every fetched row will an inbox item appear in the inbox.

    Read more about how to setup a seeb inbox here

    Create an offline workflow

    When developing an offline workflow, all machine steps that writes data to a system must be placed in a machine swimlane to be able to create offline transactions; start with creating a regular User workflow.
    Add one swimlane to the workflow with the plus sign. Change the mode for one of the swimlanes to offline and the mode of the other swimlane to machine.

    Create an offline transactions

    All machine step that writes data to a system must be placed in the machine swimlane in the offline workflow. It is possible to either use the split step or end the workflow in the machine swimlane. A transaction will be created for every swimlane crossing that is executed.

    Offline workflow

    Two different levels of offline:

    Built-in semi-offline:

    Constant offline:

    Binary Option Input

    A binary option interaction item is used when the operator needs to choose between two values. For example; they are used in conjunction with a decision step to allow the operator to pick a path through the workflow.

    Binary option input have the following properties:

    Calendar

    A calendar with entries that can be viewed, added, edited and removed. Same table setup as in Data grid.

    Example of a calendar in the web client

    Blurbs

    Use blurbs to present day specific data.
    Enter a title of the blurb and either use text, variables or FlowScript to visulize data in the value field.
    Use FlowScript to for example summarize data from the grid part of the calender control, and when the user enter the numbers in the grid the summarized value in the blurb will be live updated.

    Examle:

    Title: Reported
    Value: {sum((dayEntries where internalQuantity > 0).internalQuantity)}

    Configuration

    Style

    Use a case statement to decide what color the columns should have based on a variables value.

    Camera Input

    If the device has a camera the user will be able to take a picture with the camera input. If the camera input runs in a device without a camera the user will be able to choose a picture-file on the device.

    Example of the camera input in the Android client

    Example of the camera input in the Android client

    Check Box Input

    A boolean input interaction item is used when the operator needs to answer a true/false question of lesser importance. Boolean inputs show up as check boxes in the Flow Client.

    Boolean inputs have the following properties:

    Sub Workflows

    A sub workflow is put into a User Step

    There are three types of sub workflows:

    Check List: Executes one workflow for each record in a list of things to do.

    Item Creation: Creates a new item for each time the sub workflow is executed.

    Verb: A side track in the workflow where the sub workflow can be executed one or many times.

    Check List Sub Task

    A sub workflow is created from a User Step. Create a new User Step and add a sub workflow element. Configure the appearance of sub workflow in the client.

    Set the following:

    Item creation sub task example

    Item creation sub task example

    Close the User Step, an icon will now appear that representing the added sub workflow. Double click on the sub workflow icon to open the (empty) sub workflow. Create a workflow, all variables from the main workflow are available in the sub workflow. Return data back to the main workflow, by configuring the End step in the sub workflow.

    Configure sub workflow end task

    Configure sub workflow end task

    Data Grid

    A table that is possible to edit direct in the ongoing workflow.

    Row Selection

    Row Selection

    Data grid example

    Data grid example

    Columns

    Click EDIT to configure the columns in the grid. The Add All Columns button will add all columns in the Source in one click, Remove All Columns will remove them all. Use + or - respectively to add or remove a single column. In a calendar grid a mandatory date column is always added by default, this column is not affected by the Add/Remove All functionality and is not possible to remove.

    Edit columns settings:

    Date Input

    A date input interaction item is used when the operator is required to pick a calendar date.

    Date inputs have the following properties:

    With the file gallery is it possible to show files that the user can open and use on their device. The user can also add files to the gallery.

    A configuration of the file gallery in the designer, and how it looks in the web client

    A configuration of the file gallery in the designer, and how it looks in the web client

    GPS Location Input

    The GPS location input catches the device/users location coordinates.

    A text header is used to display a bold, non-editable, single-line text block to the user. Use your variables (with {}) and Flow script to make your texts generic.

    Text headers only have one property:

    Image Selection Input

    The Image Selection Input is used to show a list of images that are selectable, it supports both single- and multiple selections.

    Images that are selected are imported from image URLs > e.g "http://www.genericimageuploader.org/picture.jpg"

    Image Selection

    Image Selection

    Configuration

    One can import a table with an URL-column of several images to list several images, item description and etc.

    Image selection userstep settings

    Image selection userstep settings

    Image Viewer

    The Image Viewer is used to display images in the User step.

    In order to display an image the following has to configured

    URL - The source url from which the image will be fetched.

    All clients must have direct access to the image source

    Image Viewer

    Image Viewer

    Sub Workflows

    A sub workflow is put into a User Step

    There are three types of sub workflows:

    Check List: Executes one workflow for each record in a list of things to do.

    Item Creation: Creates a new item for each time the sub workflow is executed.

    Verb: A side track in the workflow where the sub workflow can be executed one or many times.

    Item Creation Sub Task

    A sub workflow is created from a User Step. Create a new User Step and add a sub workflow element. Configure the appearance of sub workflow in the client.

    Set the following:

    Item creation sub task example

    Item creation sub task example

    Close the User Step, an icon will now appear that representing the added sub workflow. Double click on the sub workflow icon to open the (empty) sub workflow. Create a workflow, all variables from the main workflow are available in the sub workflow. Return data back to the main workflow, by configuring the End step in the sub workflow.

    Configure sub workflow end task

    Configure sub workflow end task

    Labeled Static Text

    The labeled static text control can be used to structure data in a good way on the screen.
    For example: Label = "Order no:" and text = "{orderNo}" (a variable for the order number). The result will look like this:

    Use your variables (with {}) and Flow script to make your texts generic.

    Labeled static text in the web client

    Labeled static text in the web client

    Example of links in the Android client

    Example of links in the Android client

    List Multi-Selection Input

    A list multi-selection input is used when it should be possible to choose more then one record in a list. It can also be left with no chosen value.

    If a barcode scanner is used in a list multi-selection input, the Flow Client will search the data source for a record where the Key field matches the scanned value and select the corresponding line in the list. If no match is found, the Flow Client will attempt to match the other fields on the data source to the scanned value and select the first line where a match is found.

    List selection inputs have the following properties:

    Example of list selection configuration

    Example of list selection configuration

    If the list looks like it is empty, make sure that varibales from the list is entered in the large and/or small text field.

    List Presentation

    A list presentation item is used to display a list without requiring the user to select any record. Therefore it is no Target Variable property.

    List Selection Input

    A list selection input is used to select a record or value from a data source.

    List selection inputs have the following properties:

    Example of list selection configuration

    Example of list selection configuration

    Example of Match Columns

    Example of Match Columns

    If the list look is empty, make sure that varibales are entered in the large and/or small text fields.

    A menu selection input is used to select a key field value from a machine task or a table. Menu selection inputs take up less space than list selection inputs, but are less practical for large data sources with lots of information in each record.

    Menu selection inputs have the following properties:

    Numeric Input

    A numeric input interaction item is used when the operator is required to supply numeric information, either manually (using a keyboard) or with the aid of a barcode scanner. Numeric inputs treat both points (.) and commas (,) as decimal separators.

    Numeric inputs have the following properties:

    Pinned User Step

    A pinned user step are an information

    It is only possible to use Header, Static Text, Labeled Static Text, Link and List Presentation in pinned user steps, this because a pinned user step is only a why to show the user information.

    Configure a pinned user step

    Configure a pinned user step

    The pinned user step will show up in the side of the screen, and the user need to tap/click on the icon to extend or colaps the pinned user step. In the below picture is the pinned user step to the left and the regular user step to the right. If there is more then one pinned user step in the workflow, will the pinned user step be replaced when the user steps over another pinned user step.

    Pinned user step in the web client

    Pinned user step in the web client

    Signature Capture Input

    The signature capture input allows the user to write their signature directly on the device.

    Example of the signature capture input on Android

    Example of the signature capture input on Android

    Static Text

    A static text is used to display a non-editable multi-line text block to the user. Use your variables (with {}) and Flow script to make your texts generic.

    Text Input

    A text input interaction item is used when the user is required to supply textual information containing letters and/or digits, either manually (using a keyboard) or with the aid of a barcode scanner.

    Text inputs have the following properties:

    Text input example

    Text input example

    Time Input

    A time input interaction item is used when the operator is required to enter a time input.

    Time inputs have the following properties:

    Sub Workflows

    A sub workflow is put into a User Step

    There are three types of sub workflows:

    Check List: Executes one workflow for each record in a list of things to do.

    Item Creation: Creates a new item for each time the sub workflow is executed.

    Verb: A side track in the workflow where the sub workflow can be executed one or many times.

    Verb Sub Task

    A sub workflow is created from a User Step. Create a new User Step and add a verb sub-task element. Configure the appearance of verb sub-task element in the client.

    Set the following:

    Close the User Step, an icon will now appear, representing the added sub workflow.

    Double click on the sub workflow icon to open the (empty) sub workflow.

    Create a workflow, all variables from the main workflow are available in the sub workflow.

    Return data back to the main workflow by configuring the End step in the sub workflow. The output from the sub workflow is put in the target variable of the verb sub-task element. The sub workflow output is available once the user has moved on from the user step the verb sub-task is located in, i.e. it is not possible to use the data in the user step the sub workflow is started from.

    The output from a sub workflow will always be in grid format.

    Item creation sub task example

    Verb sub-task output example

    Item creation sub task example

    The user step contains three verb sub-tasks with the following content:

    1. Add Additional Info
        a.  addInfo ? text input
        b.  finishDate ? date input
    
    2.  Add Picture (Allow multiple runs = TRUE)
        a.  addPicture ? camera input
    
    3.  Add Material (Allow multiple runs = TRUE)
        a.  gridMaterial ? data grid
    
    4. User Step:
    Item creation sub task example
    5. Script Step: outPutPictures
    Item creation sub task example
    6.  Script Step: selectedMaterialAll
    Item creation sub task example
    7.  Assignment: selectedMaterial
    Item creation sub task example
    8.  User Step
    Item creation sub task example
    Sub verb-tasks run in iOS - Pills:
    Item creation sub task example

    Flow script examples

    Scrip Step - Add pictures to table:

    let table1 = table(data, filename); 
        for rec_ in value3 do
            set table1 = table1 & [data: rec_.addPicture.data, filename: rec_.addPicture.filename];
        done
    return table1;

    Scrip Step - Grid ? verb sub task run multiple times (loop in loop):

    let table1 = table(part_no, part_desc);
        for rec_ in value4 do
            for rec1_ in rec_.gridMaterial do
                set table1 = table1 & [part_no: rec1_.part_no, part_desc: rec1_.part_desc];
            done
        done
    return table1;

    Assignment ? fetch first picture:

    Picture = {(*First(value3).addPicture)}

    Assignment ? fetch last grid:

    selectedMaterial = {value4.Skip(value4.Count()-1).First().gridMaterial}

    Annotation

    Use the annotation element to add a comment to the workflow. The comment is not visible to end users.

    Annotation Example

    Annotation Example

    Assertion Step

    Assertion steps are used to perform "sanity checks" on variables in the workflow. An assertion step consists of one or many conditions (see Decision steps) and an error message to be shown to the operator in case the conditions are satisfied.

    If an assertion step generates an error message, the operator is automatically returned to the most recent user step.

    Example

    Example

    Assignment

    Use the assignment to create one or many new variables and assign values to them. It is possible to use Flow script to assign a value to the variable.

    See FlowScript expressions

    Checkpoint

    A checkpoint will notis the user with the message that is configurated in the checkpoint step.

    Checkpoint example

    Checkpoint example

    Decision Step

    Decision steps are used to take different routes through the workflow depending on the contents of variables or data sources.

    Decision steps are invisible to the operator. To allow the operator to decide which route to take in a workflow, use a User step in conjunction with a decision step.

    Outgoing routes
    To configure the outgoing routes for a Decision step, start by connecting the decision step element to two or more items, then double-click on the little cogwheels that appear after the decision step. Route conditions
    Each route has to define one or more conditions for when the route should be taken. The order in which these conditions are evaluated is not defined, except that the default route is always taken last. (See below.)

    Conditions come in two types: Binary and unary. Binary conditions compare one value (L-value or left hand side value) to another value (R-value or right hand side value). A natural language example would be "if A equals B" where A is the L-value and B is the R-value. Unary conditions only have an Lvalue; an example would be "if A exists".

    The following condition types are available for variables:

    The following condition types are available for data sources:

    Decision step example

    Decision step example

    End

    The end step represents where the workflow is ending. It's possible to have one or multiple end steps in a workflow. Double-click on the end step to edit the output variables or linked workflows.

    Linked workflow

    Linked workflow is used to connect a workflow to an existing one. The linked workflow will be runned after the original workflow. Go into the end step to configure the linked workflow.

    linked

    Example of how a linked workflow looks like

    When adding a machine workflow it's possible to configure "linked start variable mapping". It's possible to add input and query settings.
    linked

    Example how the end step editor looks

    Included Workflow

    A workflow fragment is a type of workflow that can be reused in serveral user workflows. Use the Included Workflow step to connect a workflow fragment to a user workflow.

    Create a workflow fragment by clicking on File in the main menu and choose New, choose type Workflow fragment.

    Develop the fragment workflow as wanted. Enter variables in the start step to get input parameters to the fragment workflow and select the output variables in the end step. A fragment must have an end step otherwise there will be an error in the workflow.

    Join

    Use the join task to join....

    Example where join is used

    Example where join is used

    Log Point

    The log point can for example be used to measure time or debug workflows. Log points capture the value of the checked variables and can be stored in a database thru a connected workflow in system events.

    Download a basic log point workflow and a Sql server database here:
    Log Point Workflow - Sql Server 2012
    Log Point Workflow - Sql Server 2014


    Example of a database table to store log point data in



    1. Create a machine workflow. This workflow will run every time a workflow steps over a log point.


    Example of a log point machine workflow

    2. Go to Environment -> System Events, and pick the machine workflow for the log point system event and choose a user that will execute the log point system event.


    3. Add log points in workflows to log data.


    Machine Step

    A machine step is used to read or write data from/to other systems, or to modify the variables in a workflow. Machine steps are invisible to the operator except when something goes wrong (e.g. the ERP system responds with an error message). If a machine step goes wrong, the operator gets an error message and is transported back to the most recent user step.

    Machine steps that potentially modify data in another system are called non-reversible. Incoming connections to non-reversible machine steps are adorned with an orthogonal line indicating that an operator will not be able to user the back button in the flow client once this step has been successfully executed.

    A user step followed by a non-reversible machine step

    A user step followed by a non-reversible machine step

    Avoid consecutive non-reversible Machine steps, because each machine step is executed atomically (in its own transaction), any changes to underlying systems are committed as soon as the step is completed. Therefore, in case a transaction has already been committed, the Flow Client cannot go back to the previous user step without risking data inconsistency. If this happens, the operator is forced to exit the workflow right away.

    In the example below (see picture), the operator would be forced to exit the workflow if machine step B executed successfully but machine step C failed.

    A user step followed by two non-reversible machine step

    A user step followed by two non-reversible machine step

    Connectors:

    Read more about connectors here.

    Offline Resource

    Use an Offline resource to make data available in an offline workflow. When an offline resource is used, the button Offline data will be available in the clients. Under Offline data can the end user download data to the local device that will be used when executing offline workflows. For every Offline resource used in workflows available for the end user will one row show up under My offline data.


    Use an Offline resource to get data in offline workflows.


    Create a machine workflow that fetches the data needed and connect the Machine workflow to the Offline resource. The Machine workflow must be created as an Offline resource.


    Use the output variable from the Offline resource to use the data from the Machine workflow.

    Script Item

    This item is used to execute a FlowScript program and assign the target variable with the script result.

    See FlowScript programming

    Script task example

    Script task example

    Split

    Use the split task to split....

    Example where split is used

    Example where split is used

    The Start step

    The start step is created automatically and cannot be deleted. It represents the first step of the workflow and can be configured with start parameters. Double-click on the start step to edit the start parameters.

    TODO Seed table

    Swimlane start position

    Swimlanes

    Use swimlanes to involve several users in one flow execution.

    The swimlanes can be configured so only a specified role can access a specific swimlane, the remaining swimlanes will still be accessable by the default menu role.

    Configuration

    The swimlanes can be configured to work online, online & offline, offline, or machine.

    When using an offline swimlane, the same restrictions apply as when using offline workflows. You need to fetch the data before going offline, and the transactions will be stored and executed first when you go online again.

    In configuration one can also assign names to the swimlanes, access roles and swimlane colour.

    Crossing Swimlanes

    When crossing swimlanes there will be an swimlane crossing event, in this event you can configure what will happen when the crossing happens.

    Task name is the name of the task that is handed over to the recipient.

    Push notifications enables iOS & Android client to notify the recipient when a new item is handed over to their inbox. Recipients is where one can select who receives these notifications.

    Override Recipient is where you can choose a specific flow user or all users belonging to a role to get this push notification.

    Split/Join

    When working with swimlanes, sometimes parallel user inputs need to be made.

    To do this, use the workflow element "Split" to split the executions into to parallel workflows, this way the original user can continue working in the workflow while the new user works on their swimlane.

    When the new user is done you can use "Join" to join the two parallel executions into one again.

    Table

    A table is used to make internal tables with stored data just for that specific workflow.

    Table example

    Table example

    User Step

    A user step contains a sequence of interaction items, like input controls, lists and static texts. Each interaction item type has a number of properties and preferences. Extend User step in the tree beside to read about all the different user controls.

    Multi exits

    A user step can have multiple exits that will appear like buttons in the clients. There is no restriction on how many exits that it is possible to have, but too many buttons in the client (especially in the mobile clients) can look messy, therefore it can sometimes be better to use a sub workflow instead of a button.

    If a user step got one exit step it's automatically set to default but when having more than one exit you have to manually set one exit to default, otherwise no exit will be selected automatically when using enter or scanning in a workflow.

    Example of a user step with multiple exits
    Click to open the exit step and choose default.

    The first exit button is set to default in the Web Client and the priority of the buttons is set to show in which order they should be displayed.

    Always enabled exit

    Tick the box Always Enabled if an exit should be available even if mandatory data in the user step is missing.

    If data is partly entered in the user step from which an always enabled exit is used, the data is not cleared but can be used later in the workflow. The workflow designer should take care when using always enabled exit so the next step is not dependent of data from the exited step.

    Pinned user steps

    A pinned user step are an information

    It is only possible to use Header, Static Text, Labeled Static Text, Link and List Presentation in pinned user steps, this because a pinned user step is only a way to show the user information.

    Configure a pinned user step

    The pinned user step will show up in the side of the screen, and the user need to tap/click on the icon to extend or collapse the pinned user step. In the below picture is the pinned user step to the left and the regular user step to the right. If there is more then one pinned user step in the workflow, will the pinned user step be replaced when the user steps over another pinned user step.

    Pinned user step in the web client

    History

    From the user step it's possible to edit the text that is displayed in the historical view in the clients.

    Click on historical to configure the historical view. Then enable show in history to be able to see the text in the clients. Enter the preferred text into the text, title and value field.

    View of how the configuration for the historical view can look


    In Universal windows client the configured history step looks like this:

    Designer

    The designer allows for drag-and-drop interaction with the user step. The user can simply drag one item on the left bar and drop it inside the design area. The designer allows for 1, 2, 3 and 4 columns to be added in one row. The web client will expand or shrink depending on the amount of columns added in the designer step.

    User Step Designer

    Workflow

    The Workflow area is where workflows can be created, published and maintained for the Novacura Flow platform.

    A workflow is a visual representation of a sequence of steps, some of which are to be performed by an user, typically on a mobile device. The workflow consists of user steps, which require the user to do something; machine steps, which connects to underlying systems and databases thru connectors; various flow control steps, which for example tell the workflow how to proceed from the current step to the next.

    The sequence of steps is determined by flow sequence arrows that bind them together.

    Below image shows a workflow with a start step, two user steps and a machine step. Above the first user task is a machine step that only retrieves data and it is connected to the user task with a sequence data arrow. To the right of the sequence data arrow is a text annotation.

    Workflow example

    Workflow example

    Get started

    Under the File menu is it possible to create new, open, close and save workflows in the same way as in most other Windows application. When creating a new workflow, you will be a prompted to enter the title and type of the workflow. It is also possible to choose theme color and compose an icon.

    The title and description are shown in the main menu of the Flow Clients and can be changed under the Meta Data panel in the Flow studio. If the workflow should be available in more than one language, add other languages under Languages found in the environment part of the Flow studio.

    Managing workflow elements:

    Managing sequence arrows:

    Configuring sequence arrows:

    To control the behaviour of a Sequence Arrow, double click on the arrow text. The following window should then appear.

    Sequence Arrow configuration dialogue

    For the Sequence Arrow configuration, you can do the following:

    Data in the workflow

    Workflows are all about collecting and consuming data. Pieces of information supplied by the user or fetched from a system or database are stored in named variables in the workflow.

    For example, a user step may prompt the user to scan a part number. We may choose to store this information in a variable called, for instance, partNo. The partNo variable would then be available to all steps from this user step where the variable is created (that is, steps that can be deterministically reached by following the arrows from the user step).

    The Flow studio automatically checks the workflow to ensure that variables are used correctly; making sure that a variable cannot be consumed before creating it. However, unlike in some programming languages, variables don't need to be explicitly declared beforehand - assigning to a variable (in a user step or machine step) automatically brings it into existence.
    When using variables in the user steps (for example in texts and lists) use {} to get a lists of all available variables or write the name of the variable in {} like the picture below. In the machine steps is the syntax of how to get the variables different dependent on what connector that is used, read more about what syntax to use under machine step.

    Using varibales in user step

    To move the view focus to the start item, press the home button on your keyboard.

    Scrolling through the workflow:

    Zooming the workflow in or out:

    Image/PDF export

    Applications

    Application tab gathers all features that is needed to create and develop workflows. Users with type AdministerWorkflows or AdministerBasicData can access this tab.

    Application Package

    Application Package is a way to package, license and lock specific solutions.

    A package can contain workflows, package roles, package properties and portal tabs and can, if licensed, be used by users connected to user type FullUser and AppUser. If the package is unlicensed, it is available to FullUsers.

    Package Settings

    Metadata

    Icons and Theme color: Select the icons and banner color for the package.

    Connectors

    The connectors tab defines which connectors can be used in the package. The technical set up of a connector is still done in Environment - Connectors, the package only contains a mapping.

    Roles
    The Roles tab shows the package access roles. The roles can be added, removed and edited. The roles structure is the same as in the rest of Flow, with a group ID and roles connected to the group.

    Properties
    Package specific properties are added removed and edited in the Properties tab. A package property is set up the same as in Environment - Properties but are only available within the package.

    Portal Tabs
    The portal tab shows the Flow Portal tabs connected to the package. Portal tabs can be added or removed. It is only possible to connect whole portal tabs to a package, not individual portlets.

    Workflows
    Application package workflows are created the same way as normal with the difference that the available connectors are only the ones defined in the Package Settings - Connectors tab. Workflows can be dragged and dropped into a package, the user is then asked to map the connectors used in the workflow to the ones package settings.

    Menu
    A package can contain one or more menus. A package related menu is configured the same way as a non-package menu, ie workflows and inboxes can be added, and roles connected. The roles available for a package menu are the ones defined in package settings.

    Workflows however, are not just limited to the ones in the package but all workflows can be added. An info message is displayed to notify the user if a workflow is not in the package - ?Add external workflow to package menu?, yes or no will either add the workflow or about the action. Package workflows can also be added in external Menus.

    Folders
    A package can contain folders in multiple levels. All workflows and menus in the folders will belong to the same package and have the same package settings data available.

    Package Actions

    Import and Export

    A package can be exported and imported using the right mouse button options in the navigator.

    Individual workflows are exported and imported outside the package.

    The application package only contains connector mappings and not the full connector. Before importing into a new environment, it is recommended to check that all relevant connectors exist.

    Lock
    An application package can be locked by right mouse clicking on the package, selecting Lock. All workflows in a package must be committed before it can be locked. Any package content open in the studio will be closed when the package is locked.

    If a package is locked it is not possible to open workflows or change metadata.

    For a locked package the following is still editable:

    A locked package is exported and imported as locked.

    If importing into an environment where the package id already exists, the user will not get the option to create a new package but only the possibility to replace the existing one.

    Forgotten password
    It is possible to unlock the package for which the password has been forgotten. Contact support for assistance.

    Find

    This panel can be used to search in the active workflow. Do a search by entering a search term in the search text field and pressing the search button or the enter key. The search results will be displayed in the list below the search field. The search function will search in workflow items and their configurations (including scripts). Note that each workflow item will only be displayed once in the search result (even if it has more than one occurrence of the search term).

    The checkboxes in the upper left corner can be used to filter the search result. For example, in the screenshot below, we have filtered the search to display only variable assignments and usage of variables containing the phrase workOrder.

    Search result example

    Search result example

    Tip Double click a search result item to navigate to that item, works even for items in sub workflows.

    Markdown File

    Navigation panel shows an overview of the active workflow and provide a rapid way to navigate in the workflow by dragging the camera around to change view.

    Red box indicate the current view box in workflow

    Red box indicate the current view box in workflow

    Problems

    The Flow Designer will check the workflow for possible errors at regular intervals (or if the F5 key is pressed). Errors are displayed in a list which as of default is located below the workflow, and workflow steps with errors are rendered with a red background.

    Workflows with errors can not be published. Workflows with warnings can be published but is not recommended.

    Most type of errors/warnings can be double clicked and it will highligt the failing step. Some errors/warnings is related to more than one step and in that case a search will be performed when double clicking that row, the search result will be shown in the Find Panel

    Example with both errors and warnings

    Example with both errors and warnings

    Public variables

    Public Variables are visible from outside the current workflow, and are used to provide instance-specific information when configuring the template for an Inbox.

    To create public variables:

    1. Navigate to metadata in your workflow.
    2. Open the panel for public variables.
    3. Create a new public variable.
    4. Choose a name for the new public variable.
    5. Confirm and create the new variable.
    Creating a public variable

    To assign a value to the public variable:

    1. Navigate to Workflow->Public Variables
    2. Click on public variables.
    3. Select your public variable and map it to a system variable.
    4. Press ok to save changes.
    Mapping a public variable

    Workflow Scheduler

    Machine workflows and User workflows* can be started from a schedule in Novacura Flow. This is useful when a workflow should be run at a certain time or/and with a certain recurrence. This function is suitable when moving data between systems or doing system checks that may result in user tasks.

    All scheduled workflows which will be ran in the future are indicated with a clock icon in server content panel. Each scheduled workflow saves a last run status which is shown in the configuration windows. This windows can be found in the server content context menu for each workflow, i.e. Right click on the workflow and select Schedule....

    Server content example

    Server content example

    *User workflows must start in a machine swim lane but can later do a handover to an end-user.

    Configuration

    Example configuration

    Example configuration

    Note: This function is depending on the Novacura Flow windows service which is installed along with all Novacura Flow server installations. This service will check for scheduled workflows on a 10s interval, which means that the granularity can never be more precise than 10s.

    Tips

    More complex repeat patterns can be achived with FlowScript that restrict the execution. For example running a workflow every Monday, Wednesday and Friday at 03AM can be achived by settings start time to 03AM and repeat interval to 24 hours. The workflow should then start with a decision step that checks which day it is. See example below.

    Example every Monday, Wednesday and Friday

    Example every Monday, Wednesday and Friday

    Best practices

    Avoid long running workflows. Workflows can never be run longer than 60min and each machine steps should never take more than 100s.

    Don't run multiple instances at the same time. If a workflow take more time (in worst case scenario) than the repeat interval then it will start parallel executions which may result in unexpected behavior.

    Troubleshooting

    If a workflow wasn't executed as expected follow these steps:

    1. Check the status field, if the execution ended in an error that should be stated here.
    2. Workflow should have a clock icon, or else the configuration is incorrect.
    3. Press Run now... to see that it can be executed with that user and has a published version.
    4. Make sure that windows service is running and correctly configured.
    5. Change log level to info on Novacura Flow server and wait for next execution.

    Server Content

    The Server content panel shows the server content that is stored on the currently connected server. Content can be folders, workflows or menus.

    To create new content right click anywhere and select New... from the context menu. To move the contents, drag and drop the content onto the folder that it should be moved to.

    Export: To export an item and save it as a file, right click on it and choose Export. You can export a single workflow or menu, or right click on a folder to export everything in the folder.
    An exported workflow will get suffix .flow, a menu will get suffix .mflow and a folder will get suffix .wap.

    Import: To import an exported item, right click in the server content panel and choose Import, or choose Import to server from the File menu. Novacura Flow 6 supports import of workflows from version 5.10 and above.

    Server content example

    Server content example



    Folder: A folder can contain different types of workflows and menus.



    Workflow: A regular workflow. The icon is grey when no one is working with it. The icon is blue when the logged in user has the workflow in edit mode. When another user is working on the workflow, it will show a padlock icon.



    Machine Workflow: A machine workflow. The icon is grey when no one is working with it. The icon is blue when the logged in user hae the machine workflow in edit mode. When another user is working on the workflow, it will show a padlock icon.



    Workflow Fragment: A fragment workflow, and the icon is grey when no one is working with it. The icon is blue when the logged in user have the fragment workflow in edit mode. When another user is working on the fragment, it will show a padlock icon.



    Menu: A menu needs to be configurated to make workflows available in the clients.




    Subscribe

    The subscribe function is used to share applications between different Novacura Flow server environments. This makes the transition of workflows from test to prod very simple.

    We recommend that applications are developed in a dev/test environment, and subscribed in the production environment.

    Share

    Share the workflow by clicking on the share icon, right to the edit and publish.
    Enter a comment and click on share.
    Copy the url.


    The workflow need to be published to be able to be shared.

    Subscribe

    Subscribe to an application by right-clicking in the server contect panel area and choose subscribe.


    Enter the copied url for the application that should be subscribed and click OK.
    Subscribed workflows will get a specific icon as in the below picture.


    It is not possible to edit subscribed workflows.

    Update to new version

    When a shared workflow is updated and published with new functionality to a new version, click on the share icon and enter a comment and click share.
    The new version of the application will now be available in all environments where it is subscribed.


    In the environment where the application is subscribed will the application get a star icon, indicating that there is a new version avalibale.
    Right-click on the application and choose update. This will update the application to the latest version.

    Test Bench

    Test Bench is a powerful tool for dynamic workflow analysis, making it possible to detect errors, problems and misbehaviours. By using it, you can follow the execution of your workflow step-by-step with live information about all used variables, inputs and tasks.

    Test Bench panel is divided into two areas: on the left there is a simulation how the step will be presented in the clients; on the right there is a panel with variables available in this step with their values.

    Test Bench overview

    Test Bench overview

    User can start the test bench by clicking on the Play button in the top right of your workflow window. Current element being debugged is highlighted on yellow, if two or more swimlanes are present both paths are being highlighted and user can switch between them by choosing proper tabs in the test bench.

    When using several swimlanes, the test bench can impersonate as another user in the other swimlane(s) from this window that shows up when the workflow moves to another swimlane

    Swimlane user settings

    Swimlane user settings

    User can go to the next step by clicking the button on the preview window. If step requires some action (eg. demands user to provide some text) you cannot move forward without providing it, just like in real execution. By providing different inputs and data user can test the workflow to make sure it works as it is expected.

    If two or more swimlanes are present some steps must be completed before others to make it possible to move forward. Test Bench will prompt the user if action on another swimlane is needed.

    Test session can be stopped by going through the workflow to the end or at any time by clicking the Stop button on the top right corner of the workflow.

    Missing features

    Version Panel

    Start a new workflow version by clicking the Edit button, this will lock the workflow and prevent other users from starting new versions. To indicate edit mode, the server content shows a blue icon to the current user and a lock icon for other users.

    When editing a workflow in edit mode all changes will be saved to the server automatically. In the case when the server can not be reached changes will be saved to local copy and uploaded when server is available. When the changes of the workflow are done click on the Commit button. The commit button is enabled once there is a change in the workflow. If no change is required for a workflow in edit mode, click the Revert button to go back to the previously committed version.

    At commit it is possible to enter a commit message. The commit message is option but is possible to make mandatory by ticking the Force Commit Message box in the workflow metadata.

    When a new version is committed is it possible to publish the new version and make is available for the end-users by clicking on the Publish button.

    - Edit button

    - Commit button

    - Revert button

    - Publish button

    The version panel will show a list of versions. Any version can be opened by double click. Each version can be in a number of different states.

    In order to create a new version that is based on a historical version just open the old version and click the Edit button. This will be shown as a break line. In the example below Version 3 is based on Version 1.

    Version jump example

    Version jump example

    Archive

    When a workflow has more than five (as default, this can be adjusted in the server configuration) versions only the five latest versions will be shown and loaded as default. This enables faster loading since older versions are achieved. Double click on Load all versions to load and show all previous versions.

    Version handling example

    Version handling example

    Elements

    From this panel, elements can be dragged to the workflow canvas.

    Tip The panel adjusts its layout to its size; experiment with different sizes!

    Novacura Flow Android client

    Novacura Flow is an innovative, rule changing software with one sole purpose: to improve your critical business processes. With Novacura Flow, we put the business and the user in focus, allowing you to create intelligent and user friendly business applications in three simple steps: Design, Configure, Run.

    System requirements

    The Android Client requires Android version 5.0 - 7.0.

    Installation

    There are two ways of installing the Novacura Flow Android Client:

    Note! If you download the Android client from your server, you need to enable installation from Unknows Sources on your device. This setting is typically found under Settings/Security.

    Connect and Log In

    In order to be able to run your Novacura Flow applications, you first need to connect to the correct Flow environment.
    When you first start the Novacura Flow app you will get to this screen:

    Screen for connecting to your Flow Environment

    There are three ways of connecting to your Flow environment:

    When you have connected to your Novacura Flow environment, you should get to the login page.

    Screens for the login procedure. To the left; Enter User Name. To the right; Enter Passwords.

    Here you enter your Novacura Flow user name.
    Depending on the set up, you will be prompted to enter one or many passwords. These passwords is either your Flow login password OR passwords for logging in to any connected system. The login can therefore be different for different users.
    For User setup, see User configuration.

    Get started

    Open the Novacura Flow client and enter your Flow server address and press OK. Enter your username and choose environment and language and press Enter to log on.

    All menus are displayed in lists which can be opened to display all workflows that are attached to the menu. Users can only see menus they are allowed to see by assigning the menu to dedicated roles and the same for the user.

    To log out, go offline/online or reload the workflows use the menu in the top right corner.

    Start a new workflow by tapping the workflow you want to run under the Workflow tab. Pause or quit a running workflow with the arrow in the left corner. Online mode If any transactions is done when a workflow is quit, all transactions will still be done as far as the step you are in, no rollback will be done. When the workflow is paused the workflow will be available in the Ongoing tab. Start a paused workflow by taping it the workflow under the Ongoing tab. To delete paused workflow from the Ongoing tab, press and hold on the workflow you wish to kill the ongoing execution on (observe that all transaction that is done in the workflow will not be deleted). When a workflow is completed it will appear with a check mark in the History tab.

    Offline mode

    When working with offline applications in the iOS Flow clients, all transactions that are produced by the workflow are put in a queue. This queue can be found in the Offline Data section, under MY WORK. The transactions are executed automatically in the background when the device have access to internet. Always download or update the offline data under Offline Data -> MY OFFLINE DATA, after that is done, then it will be possible to execute a workflow without internet connection.

    Help request

    Transactions that is done in offline applications will normally execute without any problems and then disappear from the queue. However, if a workflow transaction has failed, then is possible to send a Help Request to an Administrator, so that the problem can be fixed. The Administrator can then either correct the problem in the back-end system or correct the data in the workflow transaction. When the Administrator has sent back the transaction can the transaction be executed again, and if the problem is fixed will the transaction execute without any errors.


    The User can use the following options:

    Scanning

    Scanning functionality levels:

    FULL SUPPORT: We can scan in all applicable controls (text inputs, list selections, etc.). The workflow moves forward automatically when appropriate.
    LIMITED SUPPORT: We can scan in text inputs. The workflow does not move forward automatically, and scanning may not work in list selections and other non-textual controls.
    NO SUPPORT: Scanning will not work at all.

    Novacura Flow iOS client

    Novacura Flow is an innovative, rule changing software with one sole purpose: to improve your critical business processes. With Novacura Flow, we put the business and the user in focus, allowing you to create intelligent and user friendly business applications in three simple steps: Design, Configure, Run.

    System requirements

    Requires the latest two major versions of iOS. Compatible with iPhone, iPad, and iPod touch.

    Installation

    To install the Novacura Flow iOS Client:

    Connect and Log In

    In order to be able to run your Novacura Flow applications, you first need to connect to the correct Flow environment.
    When you first start the Novacura Flow app you will get to this screen:

    Screen for connecting to your Flow Environment

    Screen for connecting to your Flow Environment

    There are three ways of connecting to your Flow environment:

    When you have connected to your Novacura Flow environment, you should get to the login page where you can enter your Novacura Flow user name.

    Depending on the set up, you will be prompted to enter one or many passwords. These passwords is either your Flow login password OR passwords for logging in to any connected system. The login can therefore be different for different users.
    For User setup, see User configuration.

    Get started

    Open the Novacura Flow client and enter your Flow server address and press OK. Enter your username and choose environment and language and press Enter to log on.

    All menus are displayed in lists which can be opened to display all workflows that are attached to the menu. Users can only see menus they are allowed to see by assigning the menu to dedicated roles and the same for the user.

    To log out, go offline/online or reload the workflows use the menu in the top right corner.

    Start a new workflow by tapping the workflow you want to run under the Workflow tab. Pause or quit a running workflow with the arrow in the left corner. Online mode If any transactions is done when a workflow is quit, all transactions will still be done as far as the step you are in, no rollback will be done. When the workflow is paused the workflow will be available in the Ongoing tab. Start a paused workflow by taping it the workflow under the Ongoing tab. To delete paused workflow from the Ongoing tab, press and hold on the workflow you wish to kill the ongoing execution on (observe that all transaction that is done in the workflow will not be deleted). When a workflow is completed it will appear with a check mark in the History tab.

    Offline mode

    When working with offline applications in the iOS Flow clients, all transactions that are produced by the workflow are put in a queue. This queue can be found in the Offline Data section, under MY WORK. The transactions are executed automatically in the background when the device have access to internet. Always download or update the offline data under Offline Data -> MY OFFLINE DATA, after that is done, then it will be possible to execute a workflow without internet connection.

    Help request

    Transactions that is done in offline applications will normally execute without any problems and then disappear from the queue. However, if a workflow transaction has failed, then is possible to send a Help Request to an Administrator, so that the problem can be fixed. The Administrator can then either correct the problem in the back-end system or correct the data in the workflow transaction. When the Administrator has sent back the transaction can the transaction be executed again, and if the problem is fixed will the transaction execute without any errors.


    The User can use the following options:

    Scanning

    Scanning functionality levels:

    FULL SUPPORT: We can scan in all applicable controls (text inputs, list selections, etc.). The workflow moves forward automatically when appropriate.
    LIMITED SUPPORT: We can scan in text inputs. The workflow does not move forward automatically, and scanning may not work in list selections and other non-textual controls.
    NO SUPPORT: Scanning will not work at all.

    Content Access Management

    Content Access is used to control which tabs in the portal that a flow user can access. The access is granted by their assigned flow roles meaning that depending on which flow role(s) a flow users is connected to, the flow user will gain access to a specific set of tabs in the portal.

    By defining specific flow roles for portal content access, one can control what tabs a user can access in the portal.

    Basic Data options

    Flow Roles

    Flow Roles are defined in the Novacura Flow Administration interface and can be used for a variety of purposes. The Roles are organized in a tree structure and can inherit be set to inherit its parents or children. Flow Users can be connected to one or many flow roles. See more about Roles in the Novacura Flow Administration interface

    Set up content access

    1. Choose the flow role which the user needs to access.
    2. Check which tabs the role should have access to.
    3. Press save.

    Document Access Management

    Included in the Flow Portal, is a simple Document Manager. Documents are saved in a Folder structure and access to documents is controlled by granting access to different Folders. This means that depending on which Flow Role(s) a Flow User is appointed to, the Flow User will gain access to a specified set of Document Folders and the documents it contains.

    In the Document Manager Folders all Documents are managed (i.e. created, updated or deleted) by using workflows. All the business logic around document management is thereby defined by the workflows used by the Portal.

    Basic Data options

    Global Variables management

    Global variables are used to set a global context to the portal with one or many variables that are set in the URL to the portal.

    This allows the usage of the global variables as parameters to affect the data that is displayed to the user in many of the portlets.

    Example of URL with parameters:

    http://www.myflowportal.com/#/?GlobalVariable1=ValueA&GlobalVariable2=ValueB

    In this example the global variables GlobalVariable1 and GlobalVariable2 are defined with the values ValueA and ValueB.

    Global Variables

    This is where one defines a list of global variables that are available for usage. By pressing create the user will be forwarded to the definition window to be able to specify a new global variable.

    Definition

    This is where one defines the new global variable, by entering a variable name in the text field Code, one assigns the variable name.

    To save the variable the save button is used and the new variable will be displayed in the Global variables list.

    By selecting a variable in the list and pressing delete in the definition window, one can delete a global variable.

    Basic Data options

    Icons

    Icon Library for Portal

    icons
    icons
    icons
    icons
    icons
    icons
    icons

    Import/Export

    Export allows the user to export the current settings in the portal including values and translations in the portal, tabs, portlets.. there is also an option to export the document folder structure.
    Basic Data options


    NOTE that existing documents will be deleted when importing, so one can not export/import and expect to keep the documents inside the folder structure.

    Import allows the user to import a preconfigured portal from a .json file. When importing the system will ask the user to map the connectors used in the .json file to the corresponding ones in the current server.
    Basic Data options

    List of values management

    In the Table and Record View Portlets, there is a possibility to use a List of Values (a drop-down list with a set of predefined values) when you create or edit a record directly in the Portlet. The List of Values will then define what a user can enter in a specific field.

    The List of Values can also take an input, so that the list could be filtered depending of an existing value in the current record.

    What the list of values are to contain is defined here.

    List of Values

    Name - Select a name in the list to display the list settings to the right in the Definition window.

    Create - Resets the definition window to the right, so one can create a new list of values.

    Definition

    Code - Display name of the list.

    Query - A query to select a set list of values.

    Database Connector - The connector to the database where the query is to be executed.

    Text Column - Text Column is what is shown to the User in the List of Values.

    Value Column - Value column is the actual value chosen when a value is selected in the List of Values.

    Save/Delete - Saves the current definition of the lov or Deletes the selected lov.

    Basic Data options

    Portal Push

    Portlets can be automatically updated by using the Portal Push functionality. If an updated is done in one portlet, a push event can trigger updates to connected portlets. A portal push rest connector must be configured to access this functionality.

    Studio - Workflow

    1. Create a table element with two columns (use the exact column names):
      • PortletInternalName
      • Action
    2. In the PortletInternalName column enter the internal names of the portlets that are to be refreshed
    3. In the Action column enter REFRESH
    4. Create a Machine step to trigger the push event, using the PortalPush connector.
    Portal Push

    Create PortalPush Rest Connector

    1. Log on to Flow Studio, go to Environment - Connectors and click Add
    Portal Push


    1. Set up:
      • Name = The name of the connector
      • Type = Rest Service
      • Base address = XX (in example: http://localhost/Trunk.NovaCura.Portal.Web/api)
      • Encoding for url parameters = Unicode (UTF-8)
      • Cache metadata = No
      • Save
    2. Click on REST connector project - EDIT
    3. Set up:
      • Connector name = XX (in example: DefaultConnectorName)
      • Connector description = the description of the connector
      • Base path = XX (in example: http://localhost/Trunk.NovaCura.Portal.Web/api)
        Click Create/update connector button

    Portal Push


    5. Click Save button in top right corner.

    Portal Push
    1. Use following JSON to generate required models:

          {
              "PushEventModels": [
                  {"PortletInternalName":"pptbl1","Action":"REFRESH"},
                  {"PortletInternalName":"pprv1","Action":"REFRESH"}
              ]
          }

    You can change one of the new created model name from NEWMODEL to for example PUSHMODEL
    Portal Push


    7. Click on DefaultConnectorName and ADD in Operations to create operation. When the requested parameters have been entered click OK.

    Portal Push


    8. Click on Parameters and NEW BODY

    Portal Push


    9. Enter Body data, click OK and then Create/update connector

    Portal Push


    Portal Push


    10. If asked for content type for rest requests, select Set content-type to application/json and click ok

    Portal Push


    11. Save the connector

    Portal Push

    Settings

    The portal settings allows the control of different aspects of the portal.

    There are currently two configuration options available:

    Basic Data options

    Translations management

    The translation management shows a grid of the current translations and its context. This allows for an easy way to customize the language in the portal.

    Show translations by

    This is where one can choose which translation rows that will be displayed.

    Import/Synchronize

    Import button allows the user to import translated tables of data from an external source.

    Export button exports the translation data as an excel file(.xlsx).

    The synchronize button updates the current data with the current set of data from the translation source.

    Basic Data options

    Portal Administration Options

    Todo

    Portal Administration Options

    To the top right is the options drop-down list, it contains:

    Data Visualizer Card Portlet

    The Data visualizer card portlet allows visual representations of data with different types of cards. The usage of this portlet allows the user to get an easy overview of performance figures by viewing live data.
    Currently there are three different types of cards that can be used with this Portlet; Default, Process Card and Speedometer. These three layouts are shown below.

    Default Card

    Default Style

    Process Card

    Process Style

    Speedometer Card

    Speedometer Style

    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Basic Data options

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second.

    Auto Refresh options

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Command options

    Data Source Configuration

    As in all other data based Portlets there are two options to retreive data to the portlet; Database and Workflow.
    To use Database as data source, select a database from the Database connector drop-down and then write your query in the Your query textbox.
    The data retrived from the database should match what is needed in the Output Datasource Configuration section, which is described below.

    Data Source Configuration

    For more information how to set up a Workflow Data Source, please read this section: Fetching data from workflows
    The data retrived from the workflow should match what is needed in the Output Datasource Configuration section, which is described below.

    Output Data Configuration

    This configuration defines what information to show in the Cards.

    Output Data Configuration

    Display Configuration

    There are three different card styles that can be used for displaying data; Default, Process Card and Speedometer.
    Select the one that should be used.
    Depending on style, the Display Configuration offers different possibilities.

    Default and Process Card style

    For the Default or Process Card styles, the following configuration can be made.

    Color Rules Configuration options

    Speedometer Card style

    For the Speedometer Card style, the following configuration can be made.

    Speedometer Display Configuration options

    Data Visualizer Navigator

    The Data Visualizer Navigator shows preconfigured Data Visualizer Cards together to easier get an overview of the processes the cards represents.


    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Basic Data options

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second.

    Auto Refresh options

    Cards

    Select Cards specifies which visualization cards that are to be shown in the navigator portlet (the cards need to be preconfigured in any other portlet container as Data Visualizer Portlet).

    Cards options

    Document List

    The Document list displays the documents stored in the internal document management database. It can be connected to the Document Tree portlet to display all documents contained inside the selected folder in the Document Tree portlet.


    Basic Data

    Internal name - Unique string to identify this portlet.
    Portlet title - Title of the portlet, does not have to be unique.
    Include subfolders - Allows the portlet to include subfolders and their content of the document tree.
    View Documents - Not yet implemented.

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second.

    Query Configuration

    Start node value - todo.

    Page Size - Amount of results showed per page.

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Command options

    Document Tree

    The Document Tree displays the document folder tree stored in the internal document management database. It can be connected to the Document List portlet to display all documents contained in the highlighted folder in the Document Tree portlet.


    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Basic Data options

    Document Viewer

    The document viewer displays the documents contained in the folder structure of the document tree. It connects to the document list to display selected documents inside the portlet.

    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.
    Basic Data options

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second.
    Basic Data options

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Basic Data options

    Filter Portlet

    The Filter portlet allows for customized filter lists and buttons to apply towards other portlets. With this one can choose from a preconfigured list of values or manually typed in a value to send a filter request with the chosen criteria.


    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Basic Data options

    Filter configuration

    Group Headers

    Column Mappers

    Basic Data options

    Setting up the portal

    The portal consists of three elements:

    These are all required to set up an functional portal.


    Portal Tab

    The tabs is a window that can contain one or several containers, each container in turn can contain several portlets. This is to give the portal an easy to use and understand structure.

    On the top right under the user name is an three-line menu, click it and select "add new tab"

    Internal name - choose an unique string to identify this tab.
    Tab title - choose an title of the tab, does not have to be unique.
    Tab Description -Write an description that shows up when you hover over the tab.
    Content access group - select which flow roles that can access this tab.

    Container

    Inside the tab there are containers, each one of these can host several portlets. Click the top right three-line menu of the tab header to create a container

    Internal name - unique string to identify this container.
    title - title of the container, does not have to be unique.
    Disable header - wether the header should show or not.
    Layout - Choose between row or tab layout, grid is strictly for data visualizer plugin.
    Header background color - choose which color the header background should be in.
    Header text color - choose the text color in the header.
    Width - the tab is a total of 12 "units" in width, a container therefore max be 12 in width, with this logic you can for example have 2 container with 6 in width on the same row.

    Portlet container

    Inside a container you can have portlets, these are the applications that visualize, calculate or creates something in the portal.

    In this example we are going to use the flow client as a portlet.

    1. On the top right of the container, choose the three-line menu and select "Add new portlet to portlet container".
    2. Select "Flow Client" under "You can create a portlet from scratch".
    3. Enter a unique portlet name and a portlet title.
    4. Try try out your new flow client inside your portal.

    Now you can experiment yourself by for example creating several containers and tabs, create other kinds of portlets and using the Portal documentation for more assistance.

    Gantt Chart Portlet

    The Gantt chart gives you a time-based view of your projects and tasks; What tasks are planned and when are they to be executed. In the Gantt chart you can also see dependencies between tasks and who is assigned to a task.

    A Gantt chart allows you to see at a glance:

    Gantt portlet

    Basic Data

    Internal name - unique string to identify this portlet.

    Portlet title - title of the portlet, does not have to be unique.

    Checkbox options


    Gantt portlet Basic Data

    Height - sets the height of the activity display window

    List Width - sets the width of the activity navigator list

    Gantt portlet Basic Data2

    Auto Refresh

    Auto Refresh - enables the portlet to refresh the data every SS:second. If data has changed in the columns the table wont refresh until the changes are saved or canceled.

    Gantt portlet autorefresh

    Self-Hosting Flows

    Self-Hosting Flows - enables the portlet to continue running when the user reaches for another portlet.

    Gantt portlet Selfhosting

    Commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Data Source configuration

    Data source configuration enables the portlet to execute a specified query towards the chosen database connector to fetch data, or fetch data from a workflow.

    Fetching data using database query

    Data source configuration enables the portlet to execute a specific query to the chosen database connector.

    Gantt portlet Commands

    Fetching data using workflows

    It is possible to use workflows to fetch data.

    Read more about Workflow Source in: Workflow source.

    Gantt portlet Commands

    Checkbox option

    Map the data columns that are to be displayed in the portlet.

    Gantt portlet Commands


    Dependencies

    In the tab Dependencies it is possible to enter a query or workflow to define the dependencies between tasks.

    Gantt portlet Commands

    A dependency relationship between tasks is indicated by an arrow, as shown in the picture below. If the parent or child task is moved in the Gantt charge, the dependent task will follow accordingly.

    Gantt portlet Commands


    Resources

    The Resources tab fetches the list of employees, resources, that will be assigned to the task in the Gantt chart.

    Gantt portlet Commands


    Assignment

    The Assignment is the information which task is assigned to which resource (based on data provided in Task data source and Resources data source).

    Gantt portlet Commands

    Flow Configuration

    See Flow Configuration in Table Portlet.

    Column Configuration

    In column configuration the column which are to be displayed in the Gantt chart are added. It is possible to change the column order by using the up and down arrows. Us the Add button to add rows, the X on row level to remove.

    Gantt portlet Commands

    The columns will be shown in the same order as in the configuration:

    Gantt portlet Commands

    Task Icon Configuration

    It is possible to display icons on the activities in the Gantt chart.

    Default Icon - field where a default icon value can be added.

    Icon rules - add a row here to enter icons with conditions. It is possible to enter multiple conditions. The first condition that an activity fulfills is the icon that will be displayed on the activity. Us the Add button to add rows, the X on row level to remove.

    Gantt portlet Commands

    The icon Bug shown on a task in the Gantt chart:

    Gantt portlet Commands

    Task Color Configuration

    Activates in the Gantt can be configured in to be displayed different colors. Us the Add button to add rows, the X on row level to remove.

    Color rule setup:

    Gantt portlet Commands

    Task Tooltip Configuration

    In tooltip configuration enter the text and the variables that are to be seen in the Gantt tool tip when the cursor hovers above an activity.

    Fields - add the columns where the data mapper is required, for example remove the time stamp when a date is displayed

    Tooltip - add the text and variables, using {}, which are to be displayed

    Gantt portlet Commands

    Gantt portlet Commands

    Generic Document Viewer

    The Generic Document Viewer can display documents from any database, it supports most document formats and image formats.

    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Basic Data options

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second.
    Basic Data options

    Query Configuration

    Query Configuration enables the portlet to execute specified queries towards the chosen database connector.

    Mime types are defined in the following format: e.g "application/pdf"

    Basic Data options

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Basic Data options

    Generic Document Viewer URL

    The Generic Document Viewer from URL can display documents from an URL, it supports most document formats and image formats.

    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    URL

    URL - Where the url to the document is added. Mime-type - What kind of type of document (pdf, jpg etc) that is to be shown. Needs to be formated as a mime e.g application/pdf.

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Generic Document Viewer

    The Generic Document Viewer can display documents from any database, it supports most document formats and image formats.

    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second.

    Query Configuration

    Query Configuration enables the portlet to execute specified queries towards the chosen database connector.

    Id would mean that start node value would look for values inside the column I.d * Node title - Decides where the portlet will fetch the titles for each node fetched.

    Mime types are defined in the following format: e.g "application/pdf"

    HTML portlet

    The HTML portlet allows the usage of HTML code inside the portal. It can execute SQL queries and use the result with HTML to get a customized presentation of the data.
    Example of how HTML code representing data from an SQL query


    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Basic Data options

    HTML Template

    The HTML template is where the user can customize how the portlet will be displayed. It supports HTML5.

    Header - format the html portlet with a header. Can take in variables from the SQL query e.g. "Welcome {name}" where {name} is fetched from the SQL query.
    Body - format the html portlet with a body. Can also take in variables from the SQL query.

    Html Template options

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second.

    Auto Refresh options

    Query Configuration

    Query Configuration enables the portlet to execute specified queries towards the chosen database connector.

    Query Configuration options

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Command options

    Iframe portlet

    The Iframe portlet displays a website.

    Basic Data options

    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Basic Data options

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second.

    Auto Refresh options

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Command options

    Content

    URL An valid URL-link.

    Content options

    Inbox portlet

    The inbox portlet displays an inbox from a workflow menu. It can be used to see items sent to the inbox.

    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Please Select Inbox - Select which inbox that is to be displayed.

    Basic Data options

    Kanban Portlet

    The Kanban portlet is a work and workflow visualization portlet that enables you to optimize the flow of your work. It gives you a process based view of your activities and shows where in the process are your activities right now.
    Kanban portlet

    Basic Data

    Internal name - unique string to identify this portlet.

    Portlet title - title of the portlet, does not have to be unique.

    Checkbox options


    Kanban basic data

    Auto Refresh

    Auto Refresh - enables the portlet to refresh the data every SS:second. If data has changed in the columns the table wont refresh until the changes are saved or canceled.
    Kanban auto refresh

    Self-Hosting Flows

    Self-Hosting Flows - enables the portlet to continue running when the user reaches for another portlet.
    Kanban Selfhost

    Commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.
    Kanban Commands

    Data Source configuration

    Data source configuration enables the portlet to execute specified query towards the chosen database connector to fetch data, or fetch data from a workflow.

    Fetching data using database query

    Data source configuration enables the portlet to execute a specific query to the chosen database connector.


    Kanban Datasource

    Fetching data using workflows

    Workflow option allows for any type of data table to be retrieved as data that the portlet can show.

    Read more about Workflow Source in: Workflow source.


    Kanban Datasource2

    Map the data columns that are to be displayed in the portlet.

    Column Configuration

    In column configuration the column which are to be displayed in the Kanban are added. Us the Add button to add rows, the X on row level to remove.
    Kanban Column

    Card Configuration

    Column Configuration

    Add the columns that are to be displayed in the portlet and set the Display Text and header color.

    Task Tooltip Configuration

    In tooltip configuration enter the text and the variables that are to be seen in the Gantt tool tip when the cursor hovers above an activity.

    Fields - add the columns where the data mapper is required, for example remove the time stamp when a date is displayed

    Tooltip - add the text and variables, using {}, which are to be displayed
    Kanban Card

    Flow Configuration

    See Flow Configuration in Table Portlet.

    Task Icon Configuration

    It is possible to display icons on the activities in the Kanban.

    Default Icon - field where a default icon value can be added.

    Icon rules - add a row here to enter icons with conditions. It is possible to enter multiple conditions. The first condition that an activity fulfills is the icon that will be displayed on the activity. Us the Add button to add rows, the X on row level to remove.
    Kanban Task Icon

    Kanban Task Icon2

    Task Color Configuration

    Activates in the Kanban can be configured in to be displayed different colors. Us the Add button to add rows, the X on row level to remove.

    Color rule setup:


    Kanban Task Color

    Map Portlet

    The Map portlet shows a geographical map into which markers can be placed based on their longitude and latitude values from the marker basic data. A marker can for example represent a work order from the ERP system. OpenStreetMap is used as the base map.
    Map portlet

    Basic Data

    Internal name - unique string to identify this portlet.

    Portlet title - title of the portlet, does not have to be unique.

    Checkbox options


    Map basic data

    Auto Refresh

    Auto Refresh - enables the portlet to refresh the data every SS:second. If data has changed in the columns the table wont refresh until the changes are saved or canceled.
    Map auto refresh

    Self-Hosting Flows

    Self-Hosting Flows - enables the portlet to continue running when the user reaches for another portlet.
    Map Selfhost

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets: Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Show rows when onRowSelected empty - Tick the box if the portlet is to be populated when no selection is sent from triggering portlets.


    Map Commands

    Data Source configuration

    Data source configuration enables the portlet to execute specified query towards the chosen database connector to fetch data, or fetch data from a workflow.

    Fetching data using database query

    Data source configuration enables the portlet to execute a specific query to the chosen database connector.


    Map Datasource

    Fetching data using workflows

    Workflow option allows for any type of data table to be retrieved as data that the portlet can show.

    Read more about Workflow Source in: Workflow source.

    Map the data columns that are to be displayed in the portlet.

    Default view configuration

    When a map has got markers, the default view is to show all markers with maximum possible zoom. It is possible to set a fixed default view by entering values set longitude and latitude values under the Manual tab.

    Tick the box Remember current state if the map, position and zoom level, should remain unchanged when the portlet is refreshed.

    Map Task Icon

    Flow Configuration

    See Flow Configuration in Table Portlet.

    Marker Icons Configuration

    It is possible to use icons as markers in the Map.

    Default Icon - field where a default icon value can be added. Tick the box Show in Legend if the default icon is to be shown there.

    Icon rules - add a row here to enter icons with conditions. It is possible to enter multiple conditions. The first condition that an activity fulfills is the icon that will be used as the marker. Us the Add button to add rows, the X on row level to remove. It is possible to configure if the icon is to be shown in the legend or not by setting Show in Legend column to Yes or No.


    Map Task Icon

    Marker Coloring Configuration

    Basic markers in the Map can be configured in to be displayed different colors. Us the Add button to add rows, the X on row level to remove.

    Color rule setup:


    Map Marker Color

    Overlay Configuration

    Overlay map data is fetched from a workflow. The format must be GeoJson.

    Select the workflow by ticking the box in the list. Select the output output variables and map the overlay identity column and GeoJSON column.

    It is possible to set the overlay map to a default color and to configure different color rules.


    Map Overlay

    Marker Tooltip and Label Configuration

    In tooltip configuration enter the text and the variables that are to be seen in the Map tool tip when the cursor hovers above a marker. The Label is the static text shown under the marker

    Fields - add the columns where the data mapper is required, for example remove the time stamp when a date is displayed

    Tooltip - add the text and variables, using {}, which are to be displayed

    Label - add the text and variables, using {}, which are to be displayed
    Map Tooltip

    News Viewer

    The news viewer portlet displays a news seed from a workflow menu. It can be used to see items sent to the inbox.

    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Auto Refresh options

    Display

    Display Comments - Wether to display comments or not in the news viewer. Page Size - How many news items that are shown on each page.

    Auto Refresh options

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second.

    Auto Refresh options

    Process Overview Portlet

    The Process Overview portlet can show information in data cards that allows for an easy overview of data from a single or several queries. The portlet can be used to see e.g. statuses in current running processes, employees planned for work on workdays.

    Basic Data

    Internal name - Unique string to identify this portlet.
    Portlet title - Title of the portlet, does not have to be unique.

    Basic Data options

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second. If data has changed in the columns the table wont refresh until the changes are saved or canceled.

    Auto Refresh Option

    Self-Hosting Flows

    Self-Hosting Flows enables the portlet to continue running when the user reaches for another portlet.

    Self-Hosting Flows options

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. This can be used e.g. showing more information from one of the data cards.

    The portlet will listen to the following commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Command options

    Card

    Card Options

    Icon Rule Configuration

    Configure Icon rules on data cards.

    Icon rule configuration

    Color Rule Configuration

    Configure Color rules on data cards.

    DefaultColor - the color on the bar to the left side of the data cards.

    Color rule configuration

    Lane Configuration

    Query Configuration enables the portlet to execute specified queries towards the chosen database connector.

    Lanes

    Flow Configuration

    Double Click Workflow - This option enables a button that runs Machine Workflows, if User Actions is checked you can also choose User Workflows.

    Record Viewer portlet

    The Record Viewer portlet displays one row in a table per page in the portlet. The portlet supports attaching workflows to the record page to be able to edit the data or for customized usage e.g. Dispatching a technician in the selected record.

    Basic Data

    Internal name - Unique string to identify this portlet.
    Portlet title - Title of the portlet, does not have to be unique.
    Read Only - Disable the option to edit the displayed data.
    Number of columns in group - todo

    Basic Data options

    Auto Refresh

    Auto Refresh enables the portlet to refresh the data every SS:second. If data has changed the portlet wont refresh until the changes are saved or canceled.

    Auto Refresh Option

    Self-Hosting Flows

    Self-Hosting Flows enables the portlet to continue running when the user reaches for another portlet.

    Self-Hosting Flows options

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. This can be used e.g. showing more information from one of the data cards.

    The portlet will listen to the following commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Command options

    Query Configuration

    Group Headers

    Column Mappers

    Flow Configuration

    Save Workflow choose the machine workflow that will save the edited data to the corresponding database.

    Custom Workflows

    Resource bucket Portlet

    The Resource Buckets portlet gives you a new and innovative way to easily see who is doing what.

    Resource Bucket portlet

    Basic Data

    Internal name - unique string to identify this portlet.

    Portlet title - title of the portlet, does not have to be unique.

    Checkbox options

    Resource Bucket BasicData

    Auto Refresh

    Auto Refresh - enables the portlet to refresh the data every SS:second. If data has changed in the columns the table wont refresh until the changes are saved or canceled.

    Resource Bucket Autorefresh

    Self-Hosting Flows

    Self-Hosting Flows - enables the portlet to continue running when the user reaches for another portlet.

    Resource Bucket Selfhosting

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets: Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Resource Bucket Command

    Data Source configuration

    Data source configuration enables the portlet to execute specified query towards the chosen database connector to fetch data, or fetch data from a workflow.

    Fetching data using database query

    Data source configuration enables the portlet to execute a specific query to the chosen database connector.

    Resource Bucket Command

    Fetching data using workflows

    It is possible to use workflows to fetch data. For more information about using workflows as the data source go to: Workflow source

    Resource Bucket Command

    Checkbox option *
    Map the data columns that are to be displayed in the portlet.

    Resource Bucket Command

    Resources

    The Resources tab fetches the list of employees, resources, that will be assigned to the task in the Gantt chart.

    Resource Bucket Command

    Assignment

    The Assignment is the information which task is assigned to which resource (based on data provided in Task data source and Resources data source).

    Resource Bucket Command

    Scope Configuration

    In scope configuration it is possible to configure how the portals is going to look by defining the time scale and number of buckets shown in the portlet.

    Resource Bucket Command

    Card Configuration

    The data displayed on the card is by default the title and description columns from the data source configuration. Card configuration adds the possibility for users to configure what data is to be displayed and the order of said data. The data available is what is selected in Tasks. The text is only visible when the card size is a minimum of 200 x 140 pixels.

    Fields - add the columns which need to be formatted, for example dates without formatting will be displayed as text so they need to set to Date or DateTime to be displayed in the correct manner.

    Add the variables and text that are to be displayed in the portlet. A datarow wraps to a maximum of two rows and uses an ellipsis function to indicate omission of text. Header text and Labels display font is bold.

    Resource Bucket Command
    Resource Bucket Command

    Flow Configuration

    See Flow Configuration in Table Portlet.

    Task Icon Configuration

    It is possible to display icons on the Resource Buckets tasks.

    Default Icon - field where a default icon value can be added.

    Icon rules - add a row here to enter icons with conditions. It is possible to enter multiple conditions. The first condition that an activity fulfills is the icon that will be displayed on the activity. Us the Add button to add rows, the X on row level to remove.

    Resource Bucket Command

    Resource Bucket Command

    Legend/Color configuration

    The Legend for the Resource Bucket is set up in Legend/Color configuration and configured in to be displayed different colors. The Legend name is used in Flow Configuration/Create task Workflow to identify the task type created. Use the Add button to add rows, the X on row level to remove.

    Color rule setup:

    Resource Bucket Command

    Resource Bucket Command

    Task Tooltip Configuration

    In tooltip configuration enter the text and the variables that are to be seen in the tool tip when the cursor hovers above a task.

    Fields - add the columns where the data mapper is required, for example remove the time stamp when a date is displayed

    Tooltip - add the text and variables, using {}, which are to be displayed

    Resource Bucket Command

    Resource Bucket Command

    Scheduler Portlet

    The scheduler portlet allows the user to easily schedule, display and edit appointments or tasks. It can be in different time views; day, week, month, timeline, agenda or customized view, and can be grouped horizontally and vertically.

    The scheduler is based on three tables; Resource, Task and Assignment, where the Resource is the who or where, the Task is the what and the Assignment is the connection of the Resource and Task. A resource can be a person that is to perform certain task, or the resource can be a room in which a meeting (the task) is to take place.

    Delete task must be handled by a workflow, consistant with how the other visual planning portlets work.

    Important time zone information: The scheduler is expecting the time standard to be UTC (Coordinated Universal Time). Any adjustments due to server location and setting must be handled in the workflows.

    Basic Data

    Internal name - unique string to identify this portlet.

    Portlet title - title of the portlet, does not have to be unique.

    Checkbox options

    Scheduler View and Custom Timeline

    Scheduler View Timeline Config

    Height - the height of the scheduler shown in the portlet.

    Major tick - the number of minutes each time header represents, ie the setting 60 means the headers will be full hours, 120 every second hour and 1440 a full day. See major tick example below.

    The start time of the week and day views - the first hour the scheduler should show when in day or week views.

    The end time of the week and day views - the last hour in the scheduler when in day or week views.

    Start of the work day - the first hour of the work day. In day and week views it is possible to in the portlet to select to show only business hours.

    End of the work day - the end hour of the work day. In day and week views it is possible to in the portlet to select to show only business hours.

    Scheduler views - configure which views that are to be available to the user. It is possible to select one or multiple.

    Horizontal grouping - tick the box if the resource is to be shown horizontally instead of vertically.

    Show times in header - untick if time is not to be shown in header.

    Custom timeline title - the title that will be shown to the user for customTimeline if included in Scheduler View.

    Custom timeline column width - the width of the columns.

    Number of days to show in custom timeline - the customer timeline will start two days before today so if this field is set to 7, the day before yesterday, yesterday, today and the future four days will be shown. The idea with custom timeline is that the customers can create a rolling timeline configured to their needs when planning etc.

    Auto Refresh

    Auto Refresh - enables the portlet to refresh the data every SS:second. If data has changed in the columns the table wont refresh until the changes are saved or canceled.

    Scheduler Autorefresh

    Self-Hosting Flows

    Self-Hosting Flows - enables the portlet to continue running when the user reaches for another portlet.

    Scheduler Self Host

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets: Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Scheduler Commands

    Data Source configuration

    The scheduler is to be configured with tasks, resources and assignment data.

    Tasks - the datasource must include a unique task identifier, a title and the start and end date and time.

    Scheduler Data Source Config

    Resource - the data source must include a unique resource identifier and as optional a title and a group. The group can be used as a scheduler specific filter, see Filtering Options - Group further down in the text.

    Scheduler Data Source Config

    Assignments - an assignment must have a unique id and the configuration connects the resource id with the task id.

    Scheduler Data Source Config

    Flow Configuration

    See Flow Configuration in Table Portlet.

    Workflows:

    Create Task - this workflow is to be able to create new tasks in the scheduler, the user clicks in a timeslot to run the workflow.

    Drag and Drop - this workflow it to change or move tasks. A task can have the time period extended or decreased, moved in an earlier or later timeslot for the resource or moved to a different resource altogether.

    Double Click - double click on a task to run a workflow.

    Task Icon Configuration

    It is possible to display icons on Scheduler tasks.

    Default Icon - field where a default icon value can be added.

    Icon rules - add a row here to enter icons with conditions. It is possible to enter multiple conditions. The first condition that an activity fulfills is the icon that will be displayed on the activity. Us the Add button to add rows, the X on row level to remove.

    Scheduler Icon

    Task Coloring Configuration

    The tasks for the Scheduler can be configures to be displayed in different colors. Select a default color or set up specfic color rules.

    Color rule setup:

    Scheduler Color

    Task Tooltip Configuration

    In tooltip configuration enter the text and the variables that are to be seen in the tool tip when the cursor hovers above a task.

    Fields - add the columns where the data mapper is required, for example remove the time stamp when a date is displayed

    Tooltip - add the text and variables, using {}, which are to be displayed

    Scheduler tooltip

    Usage in Client

    Scheduler views

    Settings in examples:

    Week/Day view Start and End time = 07:00 - 17:00
    Start and End workday = 08:00 - 16:00
    Major tick = 240
    Horizontal grouping unticked
    Custom timeline column width = 50Day

    Day:
    Scheduler Examples

    Week (shows 7 days, including Saturday and Sunday):
    Scheduler Examples

    WorkWeek (shows 5 days, excluding Saturday and Sunday):
    Scheduler Examples

    Month:
    Scheduler Examples

    Agenda:
    Scheduler Examples

    Timeline (shows one day):
    Scheduler Examples

    TimelineWeek (shows timeline for one week, scrollbar available at the bottom of the portlet):
    Scheduler Examples

    TimelineMonth (shows timeline for one month, scrollbar available at the bottom of the portlet):
    Scheduler Examples

    CustomTimeline:
    Scheduler Examples

    Filter Option - Group

    The resources can be filtered by group, if a group has been mapped in the resource data source configuration. The groups are top right in the scheduler and by ticking and unticking the boxes the resources shown will be filtered. All groups shown:
    Scheduler Examples
    Filtered to only show Group 1:
    Scheduler Examples

    Fetching data from databases with queries

    When configuring the table portlet and want to fetch data from a database using a flow db connector follow these steps:

    Data source configuration enables the portlet to execute specified queries towards the chosen database connector.

    The Add and Map All Columns adds a column or all columns and their respective values to what is displayed in the portlet.

    Fetching data from workflows

    When configuring the table portlet and want to fetch data from workflows one needs to first configure the settings in the portal, then inside the workflow.

    Setting up workflow to fetch data from

    Data source configuration enables the portlet to execute specified workflows to fetch data from the flow.

    We introduce two types of data sources. Based on different use cases, they can be created in Studio or Portal using different machine workflow schemas.

    To be able to use workflows as data source one needs to:
    1. Select a workflow from the list or add a new one on the add button. 2. Press open in Flow Studio

    Workflow Input Configuration

    The input in the workflow will be automatically generated from the portal when creating a new workflow, what the input contains depends on what data is being sent and if its with filtering or not.

    These are added automatically when creating the workflow from the portal, what needs to be added on its own are the variables inside the Input table.

    Input Data

    Workflow Data Source Configuration

    After the input is configured machine steps fetching data can be added, all types of data sources are supported, both API connectors and database connectors.

    Source Data

    Workflow Output Configuration

    To send the data to the portlet the output data needs to be configured. The two important values that need to be sent are:

    These are added by opening the end step, pressing edit output variables and checking each variable that is to be sent to the portal.

    Output Data

    Setting layout and settings for table portlet in portal

    The Add and Map All Columns adds a column or all columns and their respective values to what is displayed in the portlet.

    Query Configuration options

    Table Portlet

    The table portlet can show data from databases as a table by executing SQL queries. It is possible to configure the columns in the table portlet editor to customize how the data is displayed.
    The portlet can export the table as a Microsoft excel file (.xls) and run machine and user workflows by pressing a preconfigured or customized button.

    Example of how a table in the portlet can be displayed

    Basic Data

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.

    Checkbox options

    Basic Data options

    Auto Refresh

    Auto Refresh - enables the portlet to refresh the data every SS:second. If data has changed in the columns the table wont refresh until the changes are saved or canceled.

    Auto Refresh Option

    Self-Hosting Flows

    Self-Hosting Flows - enables the portlet to continue running when the user reaches for another portlet.

    Self-Hosting Flows options

    Commands

    Commands enables the portlet to listen for events sent by other portlets to execute specified commands. The portlet will listen to the following commands

    The portlet will listen to the following portlets Specify which portlet the commands above will trigger from. The portlets that appears will be shown with their unique internal name.

    Show rows when onRowSelected empty - todo

    Command options

    Data Source configuration

    Data source configuration enables the portlet to execute specified queries towards the chosen database connector to fetch data, or fetch data from a workflow.

    Database option queries a database through a flow db connector to retrieve data.
    Database source

    Workflow option allows for any type of data table to be retrieved as data that the portlet can show.
    Workflow source

    Flow Configuration

    Flow Configuration enables the portlet to add machine and user workflows. The variables that are sent to the workflow that needs to be specified in start step are:

    1. Table with table name specified in output.
    2. All columns to be specified as variable inside the table
    3. Type variable which contains the text "update", "add", "delete"

    There are three kinds of workflows that can be used in the Table portlet:

    1. CRUD Workflow - This option executes changes that have been made in the table (UPDATE, CREATE, DELETE) to an attached machine workflow.
    2. Double Click Workflow - This option enables a button that runs Machine Workflows, if User Actions is checked you can also choose User Workflows.
      • Note when this option is checked, data will be sent as a table parameter named DblClickRow
    3. Custom Workflows - This option can be linked to a custom button attached to the table. Machine workflows cannot be used here.
      • Note: Left Value can be values e.g. {VALUE IN COLUMN} from the sql query where Dataset is the specified column.

    User Action checkbox enables the portlet to add user task workflows.

    Flow Configuration options

    Color Rule Configuration

    Configure coloring rules on the table rows.

    Color rule setup

    Color Rule Configuration options

    Text Portlet

    The Text portlet contains a text editor where you can show text, links and images in the portlet container.

    Example of how the text window is displayed in the container

    Text Options

    Internal name - unique string to identify this portlet.
    Portlet title - title of the portlet, does not have to be unique.
    Content - Options to create links, images and format text.

    Example of text editor options

    Novacura Flow Portal Portlets

    Portlets are applications that are added to portlet containers in the Flow Portal and can be configured to do a number of tasks.

    The portal supports a large variety of portlets ranging from a dataset visualizer that supports editing to KPI indicators

    Novacura Flow Portal

    For Settings see Administration.

    For Portlets see Portlets.

    Novacura Windows 10 client

    Novacura Flow is an innovative, rule changing software with one sole purpose: to improve your critical business processes. With Novacura Flow, we put the business and the user in focus, allowing you to create intelligent and user friendly business applications in three simple steps: Design, Configure, Run.

    System requirements

    Computers, tablets and mobile phones running Windows 10.

    Installation

    To install the Novacura Flow UWP client:

    Connect and Log In

    In order to be able to run your Novacura Flow applications, you first need to connect to the correct Flow environment.
    When you first start the Novacura Flow app you will get to this screen:

    Screen for connecting to your Flow Environment

    There are three ways of connecting to your Flow environment:

    When you have connected to your Novacura Flow environment, you should get to the login page where you can enter your Novacura Flow user name.


    Depending on the set up, you will be prompted to enter one or many passwords. These passwords is either your Flow login password OR passwords for logging in to any connected system. The login can therefore be different for different users.
    For User setup, see User configuration.

    Get started

    Open the Novacura Flow client and enter your Flow server address and press the arrow to the right. Enter your username and password then click on login. The main view is displayed with menus and it is related workflows. To reload the menu, change settings or log out use the menu on the top right corner.

    Start a new workflow by tapping on the workflow you want to run under the menu which it is attached to. Pause a workflow with the arrow in the left corner and quit by using the cross in the right corner. A paused workflow is indicated by a play-button in the right corner of the workflow. Start a paused workflow by taping on it from the main view. To delete a paused workflow on a computer, right-click on the workflow and on mobile press and hold on the workflow to kill the ongoing execution (observe that all transaction that is done in the workflow will not be deleted).

    Offline mode

    When working with offline applications in the iOS Flow clients, all transactions that are produced by the workflow are put in a queue. This queue can be found in the Offline Data section, under MY WORK. The transactions are executed automatically in the background when the device have access to internet. Always download or update the offline data under Offline Data -> MY OFFLINE DATA, after that is done, then it will be possible to execute a workflow without internet connection.

    Help request

    Transactions that is done in offline applications will normally execute without any problems and then disappear from the queue. However, if a workflow transaction has failed, then is possible to send a Help Request to an Administrator, so that the problem can be fixed. The Administrator can then either correct the problem in the back-end system or correct the data in the workflow transaction. When the Administrator has sent back the transaction can the transaction be executed again, and if the problem is fixed will the transaction execute without any errors.


    The User can use the following options:

    Scanning

    Novacura Flow Web client

    System requirements

    Installation

    Get started

    Novacura Flow WinCE client

    System requirements

    Windows CE Client requires version 5.0 or newer with .NET Compact Framework 3.5.

    Installation

    Go to http://community.novacuraflow.com/downloads/ to download the WinCE client.

    There are two ways to do the installation either with the .Cab file or the manual way to move the unzipped folder Device to the scanner device.

    Always install the client under the flash drive on the device, otherwise can the installation be lost when doing a reboot

    Install with .cab file:

    Move the file to the scanner and run the file on the device. After the installation is done, change the Novacura Flow server address in the setting.xml.

    Manual installation:

    Change the address to the Novacura Flow server address in the file setting.xml. Copy the Device folder with the changed settings.xml file to the scanner. Create a shortcut to the .exe file on the desktop.

    Good to know

    Microsoft Active Directory Connector

    The Microsoft Active Directory connector can be used to perform various Active Directory related operations.

    Configuration

    Database Connector

    The database connector is used to connect to various databases. Supported databases are Oracle, Microsoft SQL Server, IBM DB2 iSeries, IBM DB2, MySql Server and IFS Applications.

    Configuration

    Security

    The database connects directly to the database using different kinds of authentication protocols according to what kind of database this is connected.

    IFS Applications 10 API

    The IFS Applications 10 API connector can be used to execute procedures (including New__, Modify__ and Remove__) and functions in IFS Applications 9.

    Configuration

    IFS Applications 9 API

    The IFS Applications 9 API connector can be used to execute procedures (including New__, Modify__ and Remove__) and functions in IFS Applications 9.

    Configuration

    IFS Applications Connector

    TODO

    M3 Infor API Connector

    The Infor M3 API Connector is used to integrate with Infor M3.

    Configuration

    Infor M3 REST Connector

    The M3 Rest Connector is used to execute transactions in M3 via the M3-API-REST bulk API.

    Configuration

    Get started

    Press Select operation to select which transaction to execute.

    Input

    The input will of course depend on the transaction to execute. There is one common parameter that always is available though, readtimeoutmillis. In this parameter you can specify the amount of time to wait for response from job.

    Another common feature for all transactions is the possibility to use an iterator. If you select a iterator it means that the transaction will be executed once for each row in the table specified as iterator. Using a iterator will change the output of the cogwheel to a table with the same number of rows as the iterator table, each row in the table is corresponding result of transaction execution for row in iterator table. You can of course map columns in iterator to parameters of transaction. Simply select an iterator, and for a parameter select I Iterator in dropdown menu for parameter and then select the suitable column of iterator table.

    Output

    Record (or table of records if iterator is used).

    Member Description
    HttpStatusCode The status code returned from REST API. Typically 200 if request (not necessarily transaction) was successful. 401 if not authorized etc.
    ReasonPhrase HTTP ReasonPhrase, if any
    AllHeaders Simple variable containing all headers (with line feed between each header) returned by REST API.
    OK A record containing result of transaction if it was successfully executed. Will be empty if transaction failed.
    - Program - Simple variable containing the program executed
    - Transaction - Simple variable containing the transaction executed
    - Records - A table containing the records (if any) returned by transaction. The columns of the table will of course depend on the transaction, but you can always choose not the request particular columns by unchecking the Included checkbox. By doing that, it will not be requested from the REST API, which could boost performance. You can also specify a row limit on Records (default 100).
    Error A record containing error information if transaction failed for some reason. Will be empty if transaction was successfully executed.

    Note that if HttpStatusCode is 200, either OK or Error (never both) contains data. This can be used to take different paths in your workflow. Simply add a 'Decision Step' and add a script rule like transactionResults.Error != nil to check for errors.

    Maximo Generic Connector

    Maximo Generic connector communicates with Maximo Web Services.

    Configuration

    First step is connector configuration in Flow Studio (see picture below)

    Connector Configuration

    Communication with Web Services is always over the HTTP protocol.

    The following parameters are configurable in the configuration:

    Get started

    When connector is configured we can use it in machine steps. We have to do the following steps:

    1. Reload Maximo Web Services
    Reload Web Services

    Connector reads WSDL from Maximo Main Web Services from MaximoWebServiceAddress (configuration):

    for example: http://{MaximoWebServiceAddress}/meaweb/wsdl/MXWSREGISTRY.wsdl

    After that it creates the web service dotnet client object and call Maximo Main Web Services.

    Response from Maximo Main Web Service contains list with all available Maximo Web Services.

    1. Choose specific Maximo Web Service
    Pick Web Service

    When specific web service is chosen the connector reads the WSDL for the SelectedWebService from MaximoWebServiceAddress (configuration):

    for example: http://{MaximoWebServiceAddress}/meaweb/wsdl/{SelectedWebService}.wsdl

    After that it creates web service dotnet client object and calls the selected Maximo Web Service.

    Response from Selected Maximo Web Service contains list with all available methods and their parameters.

    1. Choose Method and fill method parameters
    Fill parameters

    When specific web service method is chosen, the connector reads all input parameters from the method definition and displays it:

    Fill parameters

    When all required parameters are set we can use connector (by running workflow or directly from Flow Studio to test it).

    When Connector is executed it use web service dotnet client (created in point 2) and execute method and read response data.

    Microsoft Dynamics AX Connector

    The Dynamics AX Connector is used to interact with Microsoft Dynamics AX.

    Configuration

    Microsoft Dynamics CRM Connector

    The Dynamics CRM Connector is used to interact with Microsoft Dynamics CRM.

    Configuration

    Oracle Primavera Connector

    The Oracle Primavera Connector can be used to access Oracle Primavera P6.

    Configuration

    Basic API

    About the Novacura Flow Transporter Package
    The Novacura Flow SAP connector will call a number of SAP BAPIs in order to retrieve the interface information. The following functions give the required information:

    1. ZNCFLOW_APPLICATION_COMPONENT: List BAPI application tree
    2. BAPI_MONITOR_GETLIST: Returns a list of all available BAPI's in the SAP system.
    3. BAPI_INTERFACE_GETDOCU: Returns the help text documentation for a BAPI on different levels.
    4. RFC_GET_FUNCTION_INTERFACE: Returns all parameters for a BAPI or function module in SAP.
    5. ZNCFLOW_DDIF_FIELDINFO_GET: Returns the data dictionary specification for parameter fields

    BAPI: BAPI_INTERFACE_GETDOCU

    With this BAPI you will get the documentation for the requested BAPI in the form of help text. This is useful for giving detailed descriptions of the BAPI on a general level or on the Method. If you give the Object you will get text on the object and if you give the object and the method you get details on the method. The fields in the input Is the same as the resulting table (BAPILIST) in the previous BAPI (BAPI_MONITOR_GETLIST).

    Field Description Type Spec Example
    OBJTYPE Object type I CHAR10 SFLIGHT
    OBJNAME Object name I CHAR32
    METHOD Method name of the object type I CHAR32 GetDetail
    PARAMETER Name of parameter in method I CHAR32
    FIELD Field name in the parameter for F4 values I CHAR30
    LANGUAGE Language of the text to be displayed I LANG1
    TEXTFORMAT Format of the text to be displayed I CHAR3
    LINKPATTERN Convert SAPscript Hyperlinks to HTML I CHAR255
    RETURN Return messages O BAPIRET2
    TEXT Table for the text T BAPITGB

    Table: BAPITGB

    Field Description Spec Example
    LINE Line in documentation text CHAR255

    BAPI: BAPI_MONITOR_GETLIST

    This BAPI returns information for BAPI's relating to the position in the BAPI application tree. Giving an * in the first input parameter will give a full list of all BAPI's.
    The other parameters can be left blank thus letting the system using default values. It is possible to select BAPI's for a list of application nodes by sending in a table COMPONENTS2SELECT with rows of nodes in the field COMPONENT. This BAPI together with the first (ZNCFLOW_APPLICATION_COMPONENT) will give you enough information to draw the complete Application tree containing all BAPI's.

    Field Description Type Spec Example
    OBJECTTYPE Object type I CHAR10 * (will result in full list)
    SHOW_RELEASE Release /Reference Release to Display I CHAR4 Use default
    BAPIS_POTENTIAL Display Potential BAPIs I CHAR1 Use default
    BAPIS_NEW Display New BAPIs in Release I CHAR1 Use default
    BAPIS_OLD Display BAPIs from Previous Releases I CHAR1 Use default
    RELEASED_BAPI Release Status of BAPIs I CHAR1 Use default
    RELEASED_FUNC Release Status of Function Modules I CHAR1 Use default
    RETURN Return messages O BAPIRET2
    COMPONENTS2SELECT Application Components/Areas to Select T BAPIMONCOM
    SYSTEMS2SELECT Original System of BAPIs to Select T BAPISRCSYS Use default
    BAPILIST List of Selected BAPIs T BAPIMONSTR

    Structure: BAPIRET2

    Field Description Spec Example
    TYPE Message type: S Success, E Error, W Warning, I Info, A Abort CHAR1
    ID Message Class CHAR30
    NUMBER Message Number NUMC3
    MESSAGE Message text CHAR220
    LOG_NO Application log: log number CHAR20
    LOG_MSG_NO Application log: Internal message serial number NUMC6
    MESSAGE_V1 Message Variable CHAR50
    MESSAGE_V2 Message Variable CHAR50
    MESSAGE_V3 Message Variable CHAR50
    MESSAGE_V4 Message Variable CHAR50
    PARAMETER Parameter Name CHAR32
    ROW Lines in parameter INT4
    FIELD Field in parameter CHAR30
    SYSTEM Logical system from which message originates CHAR10

    Table: COMPONENTS2SELECT

    Field Description Spec Example
    COMPONENT Application component ID CHAR24

    Table: BAPILIST

    Field Description Spec Example
    OBJECTTYPE Object Type CHAR10 SFLIGHT
    OBJECTNAME Object name CHAR32 Flight
    BAPINAME Method name of BAPI CHAR32 GetDetail
    ABAPNAME Function module name CHAR30 BAPI_FLIGHT_GETDETAIL
    COMP Application component ID CHAR24 BC-DWB
    CREA_REL Release at Creation CHAR4 610
    CREATOR Author CHAR12 SAP
    UDATE Changed On CHAR8 18.09.2001
    CHANGER Last changed by CHAR12 SAP
    SOURCESYS Name of the SAP system CHAR8 SAP
    BAPI_AG Application area or BAPI work group responsible CHAR5 Basis
    ISINTERFAC Interface object type CHAR1
    BAPI_REL Release status of BAPI method CHAR1 X
    FUNC_REL Release status of function module CHAR1 R
    OBSOLETE Release in which the status was set to obsolete CHAR4
    FM_DOCU Documentation on function module exist CHAR1
    BO_DOCU Documentation for business object exist CHAR1
    MESTYPE Message type CHAR30
    VERB Object type component CHAR32 GETLIST
    BO_TEXT Description CHAR80 Flight with connection data (SAP training)
    BAPI_TEXT Description CHAR80 Find list of flights

    BAPI: ZNCFLOW_DDIF_FIELDINFO_GET

    This BAPI will return de definition of data dictionary objects. In this case the parameters for BAPI's or function modules returned from BAPI: RFC_GET_FUNCTION_INTERFACE.

    Field Description Type Spec Example
    TABNAME Name of the Table (of the Type) for which Information is Required I CHAR30
    FIELDNAME Use Parameter LFIELDNAME Instead I CHAR30
    LANGU Language of the Texts I LANG1
    LFIELDNAME If Filled, only Field with this Long Name I CHAR132
    ALL_TYPES Take all Types into Consideration I CHAR1
    GROUP_NAMES Take Named Includes into Consideration I CHAR1
    UCLEN Unicode length with which runtime object was generated I RAW1
    DO_NOT_WRITE Write I CHAR1
    X030L_WA Nametab Header of the Table (of the Type) E CHAR30
    DDOBJTYPE Kind of Type E CHAR8
    DFIES_WA Single Information if Necessary E CHAR30
    LINES_DESCR Information about Other Referenced Types E DDTYPEDESC-TYPENAME (CHAR30)-TYPEKIND (CHAR4)-DFIES
    DFIES_TAB Field List if Necessary T DFIES
    FIXED_VALUES Description of Domain Fixed Values T DDFIXVALUES

    Table/Structure: DFIES_TAB

    Field Description Spec Example
    TABNAME Table Name CHAR30
    FIELDNAME Field Name CHAR30
    LANGU Language Key LANG1
    POSITION Position of the field in the table NUMC4
    OFFSET Offset of a field NUMC6
    DOMNAME Domain name CHAR30
    ROLLNAME Data element (semantic domain) CHAR30
    CHECKTABLE Table Name CHAR30
    LENG Length (No. of Characters) NUMC6
    INTLEN Internal Length in Bytes NUMC6
    OUTPUTLEN Output Length NUMC6
    DECIMALS Number of Decimal Places NUMC6
    DATATYPE ABAP/4 Dictionary: Screen data type for Screen Painter CHAR4
    INTTYPE ABAP data type (C,D,N,...) CHAR1
    REFTABLE Table for reference field CHAR30
    REFFIELD Reference field for currency and qty fields CHAR30
    PRECFIELD Name of included table CHAR30
    AUTHORID Authorization class CHAR3
    MEMORYID Set/Get parameter ID CHAR20
    LOGFLAG Indicator for writing change documents CHAR1
    MASK Template (not used) CHAR20
    MASKLEN Template length (not used) NUMC4
    CONVEXIT Conversion Routine CHAR5
    HEADLEN Maximum length of heading NUMC2
    SCRLEN1 Max. length for short field label NUMC2
    SCRLEN2 Max. length for medium field label NUMC2
    SCRLEN3 Max. length for long field label NUMC2
    FIELDTEXT Short Description of Repository Objects CHAR60
    REPTEXT Heading CHAR55
    SCRTEXT_S Short Field Label CHAR10
    SCRTEXT_M Medium Field Label CHAR20
    SCRTEXT_L Long Field Label CHAR40
    KEYFLAG Identifies a key field of a table CHAR1
    LOWERCASE Lowercase letters allowed/not allowed CHAR1
    MAC Flag if search help is attached to the field CHAR1
    GENKEY Flag (X or Blank) CHAR1
    NOFORKEY Flag (X or Blank) CHAR1
    VALEXI Existence of fixed values CHAR1
    NOAUTHCH Flag (X or Blank) CHAR1
    SIGN Flag for sign in numerical fields CHAR1
    DYNPFLD Flag: field to be displayed on the screen CHAR1
    F4AVAILABL Does the field have an input help CHAR1
    COMPTYPE DD: Component Type CHAR1
    LFIELDNAME Field name CHAR132
    LTRFLDDIS Basic write direction has been defined LTR (left-to-right) CHAR1
    BIDICTRLC DD: No Filtering of BIDI Formatting Characters CHAR1
    OUTPUTSTYLE DD: Output Style (Output Style) for Decfloat Types NUMC2
    NOHISTORY DD: Flag for Deactivating Input History in Screen Field CHAR1
    AMPMFORMAT DD: Indicator whether AM/PM time format is required CHAR1

    Table: FIXED_VALUES

    Field Description Spec Example
    LOW Values for Domains: Single Value / Upper Limit CHAR10
    HIGH Values for domains: upper limit CHAR10
    OPTION Option for domain fixed values CHAR2
    DDLANGUAGE Language Key LANG1
    DDTEXT Short Text for Fixed Values CHAR60

    BAPI: RFC_GET_FUNCTION_INTERFACE

    This BAPI will return all parameters and parameter attributes for a specific BAPI or function module. The function module name (FUNCNAME) is the same value that was returned for each BAPI in the call to BAPI_MONITOR_GETLIST (field ABAPNAME in table BAPILIST).

    Field Description Type Spec Example
    FUNCNAME Name of the function module I CHAR30 BAPI_FLIGHT_GETDETAIL
    LANGUAGE Language of the parameter text I LANG1
    NONE_UNICODE_LENGTH Length is also supplied in Unicode systems in non-Unicode format I CHAR1
    REMOTE_BASXML_SUPPORTED BasXML Protokoll E CHAR1
    REMOTE_CALL Function module can be called Remote-Function E CHAR1
    UPDATE_TASK Function module is in the update E CHAR1
    PARAMS Parameter of function module T RFC_FUNINT
    RESUMABLE_EXCEPTIONS Resumable Exceptions T RSEXC

    Table: PARAMS

    Field Description Spec Example
    PARAMCLASS Parameter type CHAR1 I
    PARAMETER Parameter name CHAR30 AIRLINEID
    TABNAME Table Name CHAR30 BAPISFLKEY
    FIELDNAME Field Name CHAR30 AIRLINEID
    EXID ABAP Data Type CHAR1 C
    POSITION Position of field in structure (from 1) CHAR10 1
    OFFSET Field offset from beginning of structure (from 0) INT10 0
    INTLENGTH Internal length of field INT10 6
    DECIMALS Number of decimal places INT10 0
    DEFAULT Default value for import parameter CHAR21
    PARAMTEXT Short text CHAR79 Airline Code
    OPTIONAL Optional parameters CHAR1

    BAPI: ZNCFLOW_APPLICATION_COMPONENT

    This BAPI returns the BAPI application tree. The resulting table contains all nodes in the BAPI tree indicating what level the node is on and what the superior node is. The input parameter can list all nodes (giving only a *) or a specific component. Ending with an * can give all nodes starting with a specific name. For example AP-MD* will give all nodes starting with AP-MD. I.e all nodes below that node.

    Field Description Type Spec Example
    COMP Application Component I CHAR24 * (will result in full list)

    Table: COMPONENTS

    Field Description Spec Example
    COMP Application component ID CHAR24 AP-MD-BF
    NAME Short text CHAR60 Master data
    LEVEL Numc3, internal use NUMC3 002
    SUPERIOR Application component ID CHAR220 AP-MD

    SAP BAPI

    The SAP BAPI Connector can be used to execute any published BAPI (standard or custom) in an SAP ABAP system, including HANA-based systems. Resulting table(s) are available as Flow variables.

    The SAP BAPI connector require Microsoft C++ Runtime DLLs version 10.0 (contained in the Microsoft Visual C++ 2010 Redistributables). MSI installers for these runtimes can be obtained from here.
    This must be installed on the machine running Flow Server.

    Configuration

    Go to the Environment/Connectors section in Flow Studio and Add a new connector. For parameter details, see below.


    Personal user configuration

    If Global runtime user is not specified, SAP username must be configured on the Flow user. For general information on Flow users, see here.


    Authorization requirements for SAP users connecting from Flow

    Authorization object S_RFC containing the following : - Activity 16 (Execute) - RFC_NAME: SYST, RFCPING, RFC1, RFC_GET_FUNCTION_INTERFACE, RFCH, RFC_GET_UNICODE_STRUCTURE - RFC_TYPE: FUGR and FUNC

    On top of this, the S_RFC authorization must also contain the function group and the function module being called, as well as any authorization needed to pass authorization checks in any of the called programs, including authorization for the applicable organization level (for example purchasing organization).

    Security considerations

    The SAP BAPI Connector is using the standard SAP authorization concept. The connector always logs in to the SAP system through RFC with a user that is set-up and active in the SAP system as a dialog, system or service user. Any authorization object checks will be performed the same way it would be done if the user logged in using SAP GUI.

    For more information on RFC security, see SAP?s official RFC security guide.

    Using the SAP Connector for creating workflows

    For details on design-time usage of the SAP connector, see here.

    Getting started

    There are a couple of things that needs to be done before you can start using the SAP connector.

    In short, these four steps needs to be done prior to creating workflows with the SAP connector (assuming that you of course already have installed the Flow Server):

    1. Install the SAP GUI for Windows on the Flow server. This is necessary for Flow to be able to connect to SAP.
    2. Verify that the connection between the Flow Server and SAP works, using the SAP Logon Pad.
    3. Install the Novacura Flow Transporter package in the SAP environment you want to connect to. The Transporter package will install a couple of BAPIs that the connector need to generate an API tree in the Flow Studio. Download Transporter package here.
    4. Make sure you have a license for the SAP Connector, read more; here.
    5. Configure the SAP Connector in the Flow Studio, read more; here.

    Steps 3 to 5 are described below.

    Designing a SAP workflow

    If you want an example of a SAP workflow, you can find a simple workflow here, using the ABAP workbench BAPIs for Flight Booking: http://community.novacuraflow.com/product/sap-flight-booking-example/

    Make sure you have these BAPI in your SAP environment before you use this workflow.

    When in the Flow Studio, adding a Machine Step to your workflow will let you create a connection to SAP. After selecting the SAP connector you have defined in Environment/Connectors, you will be able to configure a method call to SAP with the following steps.

    Get the list of BAPIs: When selecting youe SAP connector in the list of available connectors, press the button with the three dots. This will connect to your SAP environment and generate the entire BAPI tree in the connector. So whatever BAPIs you have in your installatione of SAP will be accessible directly from Flow.


    Select a BAPI: After the generation of the BAPI tree is done, you will see all BAPIs arranged in a folder structure. You can find the BAPI you need by either browse through the structure or by searching for the BAPI using the Filter option.


    Configure the BAPI call (Input):

    There are three tabs that can be used for configuration of the BAPI all:

    First, define the input. You can either set fixed data by just typing the value you need or by using existing (single) variables in the workflow. Note that Input can be set both on the Import and Tables tabs.


    Configure the BAPI call (Output): All data coming out from the called BAPI will end up in the Target Variable, so the Target Variable must be set (as in all Machine Steps returning data). There are two tabs for output; Export and Tables. Export are singe variables returned from the BAPI. Tables are table variables returned from the BAPI. Depending on the BAPI, Export and Tables will look and function differently.


    Configuring Commit step

    Selecting check box This step modifies data will ensure that a BAPI commit step is executed. Check this box for any BAPI that updates or inserts data in the ECC system. For a BAPI that only reads data it can be left unchecked.

    When you have configure the BAPI call, you can test it using the Play button on the top right of the Application Window in the Studio.

    Error handling

    SAP returns errors as output from the BAPI. This means that you will need to handle errors from SAP in the workflow. Like this:


    So, now you can create any app directly on top of your SAP environment!

    Add attached file (from bytes)

    Upload a file as an attachment to task item.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item ID ID of item
    Remote filename Remote filename
    Source bytes Table (consisting of bytes) to read from

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Add attached file (from file system)

    Upload a file as an attachment to task item.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item ID ID of item
    Remote filename Remote filename
    Local filename Full path to file to upload. Note that the user the application pool running Flow Server must have access to the file.

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Add attached file (from stream)

    Upload a file as an attachment to task item.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item ID ID of item
    Filename Remote filename
    Source stream Simple variable containg a stream

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Delete all attached files

    Delete all attachments on provided task item.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item ID ID of item
    Filename Remote filename

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Delete attached file

    Delete an attachment on provided task item.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item ID ID of item
    Filename Remote filename

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.
    1000005 File not found.

    List attached files

    Lists all files attached to specified item.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item ID ID of item

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Filename
  • ServerRelativeUrl
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Delete item

    Deletes item with given ID.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item ID ID of item

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Get items by query

    Gets information about items by provided CAML Query

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    CAML Query The query to send to SharePoint

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Values
    • StaticName
    • Value
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List all items

    Lists all items in Custom List app.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Row limit Limit on how many items to list. A value of -1 indicates no limit

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Values
    • StaticName
    • Value
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List fields of items

    Lists the fields that are available for items in Custom List app.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • StaticName
  • Title
  • Description
  • DefaultValue
  • ReadOnly
  • Required
  • TypeAsString
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Create new item

    Creates a new item in a Custom List app. Returns the ID of created item in Results.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item name Title of new item
    Folder url Url to folder to create item in. Leave empty for root folder. Example if adding item to folder 'folder1' in Custom List 'clist' in subsite 'subsite1': '/subsite1/Lists/clist/folder1'

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Create new item, with field values

    Creates a new item in a Custom List app. Returns the ID of created item in Results.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item name Title of new item
    Field values Table consisting of field values. Note that StaticName of fields needs to be provided, not Title
    Folder url Url to folder to create item in. Leave empty for root folder. Example if adding item to folder 'folder1' in Custom List 'clist' in subsite 'subsite1': '/subsite1/Lists/clist/folder1'

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Update item field

    Updates a field of a given item.

    Parameters

    Parameter Description
    Custom List app name Name of Custom List app in SharePoint (not id)
    Item ID ID of item
    Field Name of field/column (StaticName, not Title)
    Value New value of property

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Check in file

    Checks in a file to SharePoint that the user has checked out

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
    Comment Comment, must not exceed 1023 characters
    Checkin type Specifies check in type

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000002 User has not checked out the file.

    Check out file

    Checks out a file to the SharePoint user the connector is running as.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000003 File already checked out.

    Discard check out

    Undo a check out of a file.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000002 User has not checked out the file.

    Copy file

    Copies a file from a Document Library to another (or the same) Document Library at the same SharePoint site.

    Parameters

    Parameter Description
    Source Document Library Name Name of source Document Library in SharePoint to copy file from
    Source filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt" to move
    Destination Document Library Name Name of target Document Library in SharePoint to copy file to
    Destination filename Name of file in destination Document Library
    Overwrite Specifies whether to overwrite destination file if it already exists

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Delete file

    Deletes a file in the Document Library. If the file does not exist, the operation is considered succesful.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt" to move

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Get file information

    Gets information about a file provided as a releative url, example: '/subsite1/Shared Documents/file.doc'

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Record variable containing the results of operation

    Structure of Results

    Results
  • Author
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckedOutByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • LockedByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • ModifiedBy
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckInComment
  • CheckOutType
  • ContentTag
  • CustomizedPageStatus
  • ETag
  • Exists
  • Length
  • Level
  • MajorVersion
  • MinorVersion
  • Name
  • ServerRelativeUrl
  • TimeCreated
  • TimeLastModified
  • Title
  • UIVersion
  • UIVersionLabel
  • Errors

    Error code Description
    1000 Unspecified error.

    List files

    Lists all files at the root of a Document Library

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Populate user members Specifies whether to populate members that relates to SharePoint users, e.g. Author.

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Author
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckedOutByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • LockedByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • ModifiedBy
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckInComment
  • CheckOutType
  • ContentTag
  • CustomizedPageStatus
  • ETag
  • Exists
  • Length
  • Level
  • MajorVersion
  • MinorVersion
  • Name
  • ServerRelativeUrl
  • TimeCreated
  • TimeLastModified
  • Title
  • UIVersion
  • UIVersionLabel
  • Errors

    Error code Description
    1000 Unspecified error.

    Move file

    Moves a file from a Document Library to another (or the same) Document Library at the same SharePoint site.

    Parameters

    Parameter Description
    Source Document Library Name Name of source Document Library in SharePoint to move file from
    Source filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt" to move
    Destination Document Library Name Name of target Document Library in SharePoint to move file to
    Destination filename Name of file in destination Document Library
    Move operations Specifies move options.

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Update file property

    Parameters

    Parameter Description
    Server relative url An url relative to server, e.g. "/subsite/doclib/folder/file.txt".
    Field name Name of field or column
    New value The new value to set on field

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Create subfolder

    Creates a new folder beneth specfied folder. If the folder already exists, the operations is considered succesful

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Parent folder Name of folder to create sub folders in. E.g. "folder1" or "folder1/subfolder2"
    Name of sub folder Name of folder to create

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Delete folder

    Deletes a folder by its relative url.

    Parameters

    Parameter Description
    Server relative url of folder An url relative to server, e.g. "/subsite/doclib/folder"

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List files in folder

    Lists all files in a specified folder.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Folder Remote folder in Document Library, can include sub folders if applicable. E.g. "subfolder1/subfolder2"
    Populate user properties Specifies whether to populate members that relates to SharePoint users, e.g. Author

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Author
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckedOutByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • LockedByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • ModifiedBy
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckInComment
  • CheckOutType
  • ContentTag
  • CustomizedPageStatus
  • ETag
  • Exists
  • Length
  • Level
  • MajorVersion
  • MinorVersion
  • Name
  • ServerRelativeUrl
  • TimeCreated
  • TimeLastModified
  • Title
  • UIVersion
  • UIVersionLabel
  • Errors

    Error code Description
    1000 Unspecified error.

    List files in folder by relative url

    Lists all files in a folder specified by relative url. Useful for instance if you got a Record containg folder information including its relative url and want to list those files.

    Parameters

    Parameter Description
    Server relative url An url relative to server, e.g. "/subsite/doclib/folder".
    Populate user properties Specifies whether to populate members that relates to SharePoint users, e.g. Author

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Author
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckedOutByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • LockedByUser
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • ModifiedBy
    • Id
    • LoginName
    • Email
    • Title
    • IsSiteAdmin
  • CheckInComment
  • CheckOutType
  • ContentTag
  • CustomizedPageStatus
  • ETag
  • Exists
  • Length
  • Level
  • MajorVersion
  • MinorVersion
  • Name
  • ServerRelativeUrl
  • TimeCreated
  • TimeLastModified
  • Title
  • UIVersion
  • UIVersionLabel
  • Errors

    Error code Description
    1000 Unspecified error.

    List folders in root of Document Library

    Lists all folders in the root of the Document Library.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ItemCount
  • Name
  • ServerRelativeUrl
  • WelcomePage
  • Errors

    Error code Description
    1000 Unspecified error.

    List subfolders of folder

    Lists all subfolders of specified folder.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Folder Name of folder to list sub folders of. E.g. "subfolder1/subfolder2"

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ItemCount
  • Name
  • ServerRelativeUrl
  • WelcomePage
  • Errors

    Error code Description
    1000 Unspecified error.

    Get subfolders by relative url

    Lists all subfolders of specified folder provided by relative url. Useful for instance if you got a Record containg folder information including its relative url and want to list the sub folders of that folder.

    Parameters

    Parameter Description
    Server relative url An url relative to server, e.g. "/subsite/doclib/folder"

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ItemCount
  • Name
  • ServerRelativeUrl
  • WelcomePage
  • Errors

    Error code Description
    1000 Unspecified error.

    Download file by url to file system

    Downloads a single file by server relative url to file system.

    Parameters

    Parameter Description
    Server relative url An url relative to server, e.g. "/subsite/doclib/folder/file.txt".
    Local filename Full path where to download file. Note that the user the application pool running Flow Server must have write access to the file. If the file already exists, it is overwritten.

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Download file by url to stream

    Downloads a single file by server relative url to a simple variable (stream).

    Parameters

    Parameter Description
    Server relative url An url relative to server, e.g. "/subsite/doclib/folder/file.txt".

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.

    Download file to file system

    Downloads a single file from Document Library by path to file system.

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Remote filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
    Local filename Full path where to download file. Note that the user the application pool running Flow Server must have write access to the file. If the file already exists, it is overwritten.

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Download file to stream

    Downloads a single file to a simple variable (stream).

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.

    Upload file from bytes

    Uploads a single file from a Table of bytes to a SharePoint Document Library.

    Parameters

    Parameter Description
    Source bytes Table (consisting of bytes) to read from
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename to use in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
    Overwrite if exists Specifies whether to overwrite remote file if it already exists or abort

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Upload file from local file system

    Uploads a single file from file system to a SharePoint Document Library.

    Parameters

    Parameter Description
    Local filename Full path to file to upload. Note that the user the application pool running Flow Server must have access to the file.
    Document Library Name Name of Document Library in SharePoint (not id)
    Remote filename Remote filename to use in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
    Overwrite if exists Specifies whether to overwrite remote file if it already exists or abort

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Upload file from stream

    Uploads a single file from a stream to a SharePoint Document Library.

    Parameters

    Parameter Description
    Source stream Simple variable containg a stream
    Document Library Name Name of Document Library in SharePoint (not id)
    Filename Remote filename to use in Document Library, including any extensions or folders if applicable. E.g. "file.txt" or "subfolder1/subfolder2/file.txt"
    Overwrite if exists Specifies whether to overwrite remote file if it already exists or abort

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Set description

    Set a new description on a Document Library

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    New description New description to set on Document Library

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Set name

    Set a new title on a Document Library

    Parameters

    Parameter Description
    Document Library Name Name of Document Library in SharePoint (not id)
    New title The new title

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Add attached file (from bytes)

    Upload a file as an attachment to task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Remote filename Remote filename
    Source bytes Table (consisting of bytes) to read from

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Add attached file (from file system)

    Upload a file as an attachment to task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Remote filename Remote filename
    Local filename Full path to file to upload. Note that the user the application pool running Flow Server must have access to the file.

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Add attached file (from stream)

    Upload a file as an attachment to task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Filename Remote filename
    Source stream Simple variable containg a stream

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Delete all attached files

    Delete all attachments on provided task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Filename Remote filename

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Delete attached file

    Delete an attachment on provided task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Filename Remote filename

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.
    1000005 File not found.

    List attached files

    Lists all files attached to specified task item.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Filename
  • ServerRelativeUrl
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Get task information by ID

    Get information such as start date, due date etc about a task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Record variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Get task information by name

    Get information such as start date, due date etc about all tasks with given name.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task name Name of task

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Get task information by query

    Gets information about tasks by provided CAML Query. Example to get all tasks that are 50% or more completed:

    <View>
        <Query>
            <Where>
                <Geq>
                    <FieldRef Name='PercentComplete' />
                    <Value Type='Number'>0.50</Value>
                </Geq>
            </Where>
        </Query>
    </View>
    

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    CAML Query The query to send to SharePoint.

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Get task property value

    Gets the value of a field of a given task. This is an advanced operation that require deeper knowledge on how SharePoint works. The Property parameter is the identifier of a field, which might not be the same as is displayed in SharePoint. E.g use 'Body' as Property to update 'Description'.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Property Name of property

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    List tasks

    Lists all tasks.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Row limit Limit on how many tasks to list. A value of -1 indicates no limit

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List fields of tasks

    Lists the fields that are available for tasks in Task app.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Include read only fields Specifies whether to include fields that can only be read in the results of the operation

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • StaticName
  • Title
  • Description
  • DefaultValue
  • ReadOnly
  • Required
  • TypeAsString
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List tasks assigned to current user

    Lists all tasks assigned to current user. Optionally including finished tasks.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Include already finshed tasks Specifies whether to also include completed tasks

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    List tasks assigned to specific user

    Lists all tasks assigned to specified user. Optionally including finished tasks.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    User ID ID of user
    Include already finshed tasks Specifies whether to also include completed tasks

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • ID
  • ParentID
  • TaskName
  • DueDate
  • StartDate
  • AssignedTo
    • UserID
    • Value
  • Predecessors
    • TaskID
    • Value
  • Priority
  • PercentComplete
  • Description
  • Status
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Add predecessor

    Adds an existing task as a predecessor to provided task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Predecessor task id ID of predecessor task

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Get predecessors

    Gets all predecessors of given task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • TaskID
  • Value
  • Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Remove all predecessor

    Removes all predecessor of provided task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Remove predecessor

    Removes a predecessor of provided task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Predecessor task id ID of predecessor task

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Assign task to user (by username)

    Assign a task to given SharePoint user (by username).

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Username Username of user to assign task to
    Remove other assignees Specfies whether to remove other assignees. Default true

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Delete task

    Deletes task with given ID.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Set task as finished

    Sets the percent complete to 100%.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Update task progress

    Updates the progress of a given task.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    New progress New progress in %

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Update task property

    Updates a field of a given task. This is an advanced operation that requires deeper knowledge on how SharePoint works. The Property parameter is the identifier of a field, which might not be the same as is displayed in SharePoint. E.g use 'Body' as Property to update 'Description'.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task ID ID of task
    Property Name of property
    Value New value of property

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.
    1000004 Item with given id does not exist.

    Create new subtask

    Creates a new subtask in a Task app.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Parent Task ID ID of parent task
    Task name Name of new subtask
    Start date When task is to be started
    Due date When task is to be finished
    Percent complete How much of task that is finished. Default 0
    Description Description of task
    Priority Priority of task
    Status Status of task
    Assigned to (user ID(s)) User ID to assign task to, if any

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Create new task

    Creates a new task in a Task app. Returns the ID of created task in Results.

    Parameters

    Parameter Description
    Task app name Name of Task app in SharePoint (not id)
    Task name Name of new task
    Start date When task is to be started
    Due date When task is to be finished
    Percent complete How much of task that is finished. Default 0
    Description Description of task
    Priority Priority of task
    Status Status of task
    Assigned to (user ID(s)) User ID to assign task to, if any

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    Results Simple variable containing the results of operation

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 User is not authorized to perform operation.

    Assign user to group

    Assigns a user to a group

    Parameters

    Parameter Description
    Group id Id of group
    Login name Login name of user, not id

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    Detach user from group

    Detaches the user from the group

    Parameters

    Parameter Description
    Group id Id of group
    Login name Login name of user, not id

    Output

    Record with information about whether operation failed or not.

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.

    List site groups

    Gets and list all site groups

    Parameters

    Parameter Description

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • AllowMembersEditMembership
  • AllowRequestToJoinLeave
  • AutoAcceptRequestToJoinLeave
  • CanCurrentUserEditMembership
  • CanCurrentUserManageGroup
  • CanCurrentUserViewMembership
  • OnlyAllowMembersViewMembership
  • RequestToJoinLeaveEmailSetting
  • Id
  • LoginName
  • Title
  • Description
  • OwnerTitle
  • Errors

    Error code Description
    1000 Unspecified error.

    List users by group id

    List all users assigned to a group.

    Parameters

    Parameter Description
    Group id Id of group

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Id
  • LoginName
  • Email
  • Title
  • IsSiteAdmin
  • Errors

    Error code Description
    1000 Unspecified error.

    Get user by ID

    Get information about a SharePoint user.

    Parameters

    Parameter Description
    User ID ID of user

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Record variable containing the results of operation

    Structure of Results

    Results
  • Id
  • LoginName
  • Email
  • Title
  • IsSiteAdmin
  • Errors

    Error code Description
    1000 Unspecified error.

    Get user by Login name

    Get information about a SharePoint user.

    Parameters

    Parameter Description
    Login name Login name of user, not id

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Record variable containing the results of operation

    Structure of Results

    Results
  • Id
  • LoginName
  • Email
  • Title
  • IsSiteAdmin
  • Errors

    Error code Description
    1000 Unspecified error.

    List users

    Get list of all users at site.

    Parameters

    Parameter Description

    Output

    Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

    Member Description
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured
    Results Table variable containing the results of operation

    Structure of Results

    Results
  • Id
  • LoginName
  • Email
  • Title
  • IsSiteAdmin
  • Errors

    Error code Description
    1000 Unspecified error.

    Microsoft SharePoint 2013

    The SharePoint 2013 connector can be used to integrate with various apps in SharePoint 2013.

    Configuration

    Business systems

    Under business systems, all third party system connectors are listed, with information about configuration to setup the connector and how to use it.

    Email Connector

    User the email connector to send email in your workflow. It is possible to use Flow script in the email connector to make the email more informative.

    TODO

    Create directory

    Creates a directory at the FTP server. It is not possible to create several levels of directories in one step. If you want to create the directory "./dirA/dirB", the directory "./dirA" must exist. Otherwise you have to do it in two steps; first creates directory "./dirA" and the second one created "./dirA/dirB".

    Parameters

    Parameter Description
    Remote path Path to the directory to create.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Delete empty directory

    Deletes specified empty directory. Note if directory contain a file it will return an error.

    Parameters

    Parameter Description
    Remote path Path to directory to delete

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Directory operations

    Check if directory exists

    Determains whether directory at specified path exists.

    Parameter Description
    Path The path to check.

    Output: Simple value,'True' if directory exists. 'False' otherwise.

    Since: 6.3

    Create directory

    Creates a directory at the FTP server. It is not possible to create several levels of directories in one step. If you want to create the directory ./dirA/dirB", the directory ./dirA* must exist. Otherwise you have to do it in two steps; first creates directory ./dirA and the second one created ./dirA/dirB.

    Parameter Description
    Remote path Path to the directory to create.

    Output: No output.

    Since: 6.3

    Delete empty directory

    Deletes specified empty directory. Note if directory contain a file it will return an error.

    Parameter Description
    Remote path Path to directory to delete

    Output: No output.

    Since: 6.3

    List directory

    Lists all files and directories in a specified path.

    Parameter Description
    Remote path Path to list.
    Mask Mask to use when filtering items in directory. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B"
    Case sensitive Specifies whether to ignore casing or not.
    Include files Specifies whether to include files in the listing.
    Include directories Specifies whether to include directories in the listing.
    Recursive Specifies whether to also search in subdirectories.

    Output: A table consisting of records with the following structure:

    Member Description
    Name The name of the file or directory.
    Size The size, in bytes, of the item.

    Since: 6.3

    See also

    FTP Connector

    List directory

    Lists all files and directories in a specified path.

    Parameters

    Parameter Description
    Remote path Path to list.
    Mask Mask to use when filtering items in directory. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B"
    Case sensitive Specifies whether to ignore casing or not.
    Include files Specifies whether to include files in the listing.
    Include directories Specifies whether to include directories in the listing.
    Recursive Specifies whether to also search in subdirectories.

    Output

    A table consisting of records with the following structure:

    Member Description
    Name The name of the file or directory.
    Size The size, in bytes, of the item.

    Since

    6.3

    See also

    FTP Connector

    Download single file

    Downloads a file from the FTP server to the machine where Flow Server is running.

    Parameters

    Parameter Description
    Remote filename The name of the file to be downloaded
    Local filename Filename of where on Flow Server to store the downloaded file.
    File tranfer mode Specifies how to handle if file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Download multiple files

    Downloads multiple files from the FTP server to the machine where Flow Server is running.

    Parameters

    Parameter Description
    Remote path Path to downloaded files from.
    Remote mask Mask used to filter which files to download. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Local filename Filename of where on Flow Server to store the downloaded files.
    File tranfer mode Specifies how to handle if file already exists.
    File copy mode Specifies what to do with the file after download has been completed.
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to download files from sub directories recursivly.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Download Operations

    Download multiple files

    Downloads multiple files from the FTP server to the machine where Flow Server is running.

    Parameter Description
    Remote path Path to downloaded files from.
    Remote mask Mask used to filter which files to download. Example *.txt. Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].** to list all files starting with A or B.
    Local filename Filename of where on Flow Server to store the downloaded files.
    File tranfer mode Specifies how to handle if file already exists.
    File copy mode Specifies what to do with the file after download has been completed.
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to download files from sub directories recursivly.

    Output: No output.

    Since: 6.3

    Download single file

    Downloads a file from the FTP server to the machine where Flow Server is running.

    Parameter Description
    Remote filename The name of the file to be downloaded
    Local filename Filename of where on Flow Server to store the downloaded file.
    File tranfer mode Specifies how to handle if file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output: No output.

    Since: 6.3

    Download stream

    Downloads a file from FTP server and store it as Flow variable.

    Parameter Description
    Remote filename The name of the file to be downloaded

    Output: Simple value (binary stream).

    Since: 6.3

    See also

    FTP Connector

    Delete file

    Delete a remote file.

    Parameters

    Parameter Description
    Remote path Path to file to delete.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Delete files

    Delete multiple remote files based on mask.

    Parameters

    Parameter Description
    Remote path Path where to delete files.
    Mask Mask used to filter which files to download. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to delete files recursivly.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    File Operations

    Check if file exists

    Checks if a remote file exists.

    Parameter Description
    Remote path Path to check.

    Output: Simple value,'True' if file exists. 'False' otherwise.

    Since: 6.3

    Delete file

    Delete a remote file.

    Parameter Description
    Remote path Path to file to delete.

    Output: No output.

    Since: 6.3

    Delete files

    Delete multiple remote files based on mask.

    Parameter Description
    Remote path Path where to delete files.
    Mask Mask used to filter which files to download. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to delete files recursivly.

    Output: No output.

    Since: 6.3

    Get size of file

    Gets the size, in bytes, of remote file.

    Parameter Description
    Remote path File of interest.

    Output: Simple value, numeric.

    Since: 6.3

    Rename file

    Renames a remote file.

    Parameter Description
    Old path Current name of file.
    New path New name of file.

    Output: No output.

    Since: 6.3

    Get file time

    Get a remote file time.

    Parameter Description
    Path File of interest.

    Output: Simple value, Date.

    Since: 6.3

    Set file time

    Changes a remote file time.

    Parameter Description
    Path File of interest.
    New time New time for the file.

    Output: No output.

    Since: 6.3

    Get list of files

    Get list of files in a directory.

    Parameter Description
    Remote path Path to list.

    Output: A table consisting of records with the following structure:

    Member Description
    Name The name of the file.
    Size The size, in bytes, of the item.

    Since: 6.3

    Get file time

    Get a remote file time.

    Parameters

    Parameter Description
    Path File of interest.

    Output

    Simple value, Date.

    Since

    6.3

    See also

    FTP Connector

    Get list of files

    Get list of files in a directory.

    Parameters

    Parameter Description
    Remote path Path to list.

    Output

    A table consisting of records with the following structure:

    Member Description
    Name The name of the file.
    Size The size, in bytes, of the item.

    Since

    6.3

    See also

    FTP Connector

    Get size of file

    Gets the size, in bytes, of remote file.

    Parameters

    Parameter Description
    Remote path File of interest.

    Output

    Simple value, numeric.

    Since

    6.3

    See also

    FTP Connector

    Rename file

    Renames a remote file.

    Parameters

    Parameter Description
    Old path Current name of file.
    New path New name of file.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Set file time

    Changes a remote file time.

    Parameters

    Parameter Description
    Path File of interest.
    New time New time for the file.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Clear Command Channel

    Clears command channel encryption state, turning off SSL/TLS encryption.

    Parameters

    Parameter Description
    Graceful SSL Closure Send closure notification to the server.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Get Server System

    Get server system operating system.

    Parameters

    Parameter Description

    Output

    Single value, text.

    Since

    6.3

    See also

    FTP Connector

    Server Operations

    Send Command

    Sends a command to the FTP Server.

    Parameters

    Parameter Description
    Send Command Command to send. Send NOOP for a dummy message.

    Output

    Single value, text. Returns a error code.

    Since

    6.3

    Clear Command Channel

    Clears command channel encryption state, turning off SSL/TLS encryption.

    Parameters

    Parameter Description
    Graceful SSL Closure Send closure notification to the server.

    Output

    No output.

    Since

    6.3

    Get Server System

    Get server system operating system.

    Parameters

    Parameter Description

    Output

    Single value, text.

    Since

    6.3

    See also

    FTP Connector

    Upload single file

    Uploads a single file from the Flow Server to the FTP Server.

    Parameters

    Parameter Description
    Local filename File to upload.
    Remote filename Where to upload the file.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Upload multiple files

    Uploads multiple files from the Flow Server to the FTP Server.

    Parameters

    Parameter Description
    Local path Path where to upload files from.
    Mask Mask used to filter which files to upload. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Remote path Path where to upload the files.
    File transfer mode Specifies what to do if the file already exists.
    Case sensitive Specifies whether to ignore casing or not.
    Recursive Specifies whether to also upload from subdirectories.

    Output

    No output.

    Since

    6.3

    See also

    FTP Connector

    Upload operations

    Upload multiple files

    Uploads multiple files from the Flow Server to the FTP Server.

    Parameter Description
    Local path Path where to upload files from.
    Mask Mask used to filter which files to upload. Example *.txt. Regular expressions can also be used by prefixing with regex:, example regex:[A|B].* to list all files starting with A or B.
    Remote path Path where to upload the files.
    File transfer mode Specifies what to do if the file already exists.
    Case sensitive Specifies whether to ignore casing or not.
    Recursive Specifies whether to also upload from subdirectories.

    Output: No output.

    Since: 6.3

    Upload single file

    Uploads a single file from the Flow Server to the FTP Server.

    Parameter Description
    Local filename File to upload.
    Remote filename Where to upload the file.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output: No output.

    Since: 6.3

    Upload stream

    Uploads the content of a Flow variable that contains a binary stream. This can for instance be used to upload data from a camera input.

    Parameter Description
    Local stream Stream to read data from.
    Remote filename Where to upload the data.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output: No output.

    Since: 6.3

    See also

    FTP Connector

    Directory operations

    Check if directory exists

    Determains whether directory at specified path exists.

    Parameter Description
    Path The path to check.

    Output: Simple value,True if directory exists. False otherwise.

    Since: 6.3

    Create directory

    Creates a directory at the FTP server. It is not possible to create several levels of directories in one step. If you want to create the directory ./dirA/dirB, the directory ./dirA must exist. Otherwise you have to do it in two steps; first creates directory ./dirA and the second one created ./dirA/dirB.

    Parameter Description
    Remote path Path to the directory to create.

    Output: No output.

    Since: 6.3

    Delete empty directory

    Deletes specified empty directory. Note if directory contain a file it will return an error.

    Parameter Description
    Remote path Path to directory to delete

    Output: No output.

    Since: 6.3

    List directory

    Lists all files and directories in a specified path.

    Parameter Description
    Remote path Path to list.
    Mask Mask to use when filtering items in directory. Example *.txt. Regular expressions can also be used by prefixing with regex:, example regex:[A|B].* to list all files starting with A or B
    Case sensitive Specifies whether to ignore casing or not.
    Include files Specifies whether to include files in the listing.
    Include directories Specifies whether to include directories in the listing.
    Recursive Specifies whether to also search in subdirectories.

    Output: A table consisting of records with the following structure:

    Member Description
    Name The name of the file or directory.
    Size The size, in bytes, of the item.

    Since: 6.3

    See also

    FTP Connector

    Download Operations

    Download multiple files

    Downloads multiple files from the FTP server to the machine where Flow Server is running.

    Parameter Description
    Remote path Path to downloaded files from.
    Remote mask Mask used to filter which files to download. Example "*.txt". Regular expressions can also be used by prefixing with regex:, example regex:[A|B]." to list all files starting with A or B.
    Local filename Filename of where on Flow Server to store the downloaded files.
    File tranfer mode Specifies how to handle if file already exists.
    File copy mode Specifies what to do with the file after download has been completed.
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to download files from sub directories recursivly.

    Output: No output.

    Since: 6.3

    Download single file

    Downloads a file from the FTP server to the machine where Flow Server is running.

    Parameter Description
    Remote filename The name of the file to be downloaded
    Local filename Filename of where on Flow Server to store the downloaded file.
    File tranfer mode Specifies how to handle if file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output: No output.

    Since: 6.3

    Download stream

    Downloads a file from FTP server and store it as Flow variable.

    Parameter Description
    Remote filename The name of the file to be downloaded

    Output: Simple value (binary stream).

    Since: 6.3

    File Operations

    Check if file exists

    Checks if a remote file exists.

    Parameter Description
    Remote path Path to check.

    Output: Simple value,True if file exists. False otherwise.

    Since: 6.3

    Delete file

    Delete a remote file.

    Parameter Description
    Remote path Path to file to delete.

    Output: No output.

    Since: 6.3

    Delete files

    Delete multiple remote files based on mask.

    Parameter Description
    Remote path Path where to delete files.
    Mask Mask used to filter which files to download. Example *.txt. Regular expressions can also be used by prefixing with regex:, example regex:[A|B].* to list all files starting with A or B.
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to delete files recursivly.

    Output: No output.

    Since: 6.3

    Get size of file

    Gets the size, in bytes, of remote file.

    Parameter Description
    Remote path File of interest.

    Output: Simple value, numeric.

    Since: 6.3

    Rename file

    Renames a remote file.

    Parameter Description
    Old path Current name of file.
    New path New name of file.

    Output: No output.

    Since: 6.3

    Get file time

    Get a remote file time.

    Parameter Description
    Path File of interest.

    Output: Simple value, Date.

    Since: 6.3

    Set file time

    Changes a remote file time.

    Parameter Description
    Path File of interest.
    New time New time for the file.

    Output: No output.

    Since: 6.3

    Get list of files

    Get list of files in a directory.

    Parameter Description
    Remote path Path to list.

    Output: A table consisting of records with the following structure:

    Member Description
    Name The name of the file.
    Size The size, in bytes, of the item.

    Since: 6.3

    FTP

    The FTP Connector is used to upload and download files from an FTP server. It can also perform other operations such as creating remote directories and list files and directories on the FTP server.

    Configuration

    Operations

    Directory operations
    Check if directory exists
    Create directory
    Delete empty directory
    List directory
    Download operations
    Download multiple files
    Download single file
    Download stream
    File operations
    Check if file exists
    Delete file
    Delete files
    Get size of file
    Rename file
    Set file time
    Get time of file
    Get list of files
    Upload operations
    Upload multiple files
    Upload file
    Upload stream
    Server operations
    Send Command
    Clear Command Channel
    Get Server System

    Server Operations

    Send Command

    Sends a command to the FTP Server.

    Parameter Description
    Send Command Command to send. Send NOOP for a dummy message.

    Output: Single value, text. Returns a error code.

    Since: 6.3

    Clear Command Channel

    Clears command channel encryption state, turning off SSL/TLS encryption.

    Parameter Description
    Graceful SSL Closure Send closure notification to the server.

    Output: No output.

    Since: 6.3

    Get Server System

    Get server system operating system.

    Parameter Description

    Output: Single value, text.

    Since: 6.3

    See also

    FTP Connector

    Upload operations

    Upload multiple files

    Uploads multiple files from the Flow Server to the FTP Server.

    Parameter Description
    Local path Path where to upload files from.
    Mask Mask used to filter which files to upload. Example *.txt. Regular expressions can also be used by prefixing with regex:, example regex:[A|B].* to list all files starting with A or B.
    Remote path Path where to upload the files.
    File transfer mode Specifies what to do if the file already exists.
    Case sensitive Specifies whether to ignore casing or not.
    Recursive Specifies whether to also upload from subdirectories.

    Output: No output.

    Since: 6.3

    Upload single file

    Uploads a single file from the Flow Server to the FTP Server.

    Parameter Description
    Local filename File to upload.
    Remote filename Where to upload the file.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output: No output.

    Since: 6.3

    Upload stream

    Uploads the content of a Flow variable that contains a binary stream. This can for instance be used to upload data from a camera input.

    Parameter Description
    Local stream Stream to read data from.
    Remote filename Where to upload the data.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output: No output.

    Since: 6.3

    See also

    FTP Connector

    Modbus

    The Modbus Connector is a communications protocol for PLC systems.

    Configuration

    Get Started

    All commands can be sent in synchronous or asynchronous mode. If a value is accessed in synchronous mode the program will stop and wait for slave to response. If the slave didn't answer within a specified time a timeout exception is called. The class uses multi threading for both synchronous and asynchronous access. For the communication two lines are created. This is necessary because the synchronous thread has to wait for a previous command to finish.

    Operations

    Read operations
    Read Coils Inputs
    Read Digital Inputs
    Read Holding Register
    Read Inputs Register
    Write operations
    Read Write Multiple Holding Register
    Write Multiple Coils
    Write Multiple Holding Register
    Write Single Coil
    Write Single Holding Register

    Read Coils

    Reads Coils

    Parameters

    Parameter Description
    First Address to be read Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    Returns a table with values, true or false.

    Since

    6.4

    See also

    Modbus Connector

    Read Digital Inputs

    Read Digital Inputs

    Parameters

    Parameter Description
    First Address to be read Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    Returns a table with values, true or false.

    Since

    6.4

    See also

    Modbus Connector

    Read Holding Register

    Read Holding Register

    Parameters

    Parameter Description
    First Address to be read Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    Returns a table with values.

    Since

    6.4

    See also

    Modbus Connector

    Read Input Register

    Read Input Register

    Parameters

    Parameter Description
    First Address to be read Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    Returns a table with values.

    Since

    6.4

    See also

    Modbus Connector

    Read Write Multiple Holding Register

    Read Write Multiple Holding Register

    Parameters

    Parameter Description
    First Address to be read Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.
    First address to be written Length of data.
    Holding register inputs to be written Contains the register information.

    Output

    Return table with values.

    Since

    6.4

    See also

    Modbus Connector

    Write Coil

    Write Coil

    Parameters

    Parameter Description
    First Address to be written Address from where the data read begins.
    Number of addresses to be read Length of data.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    No return!

    Since

    6.4

    See also

    Modbus Connector

    Write Single Register

    Write Single Register

    Parameters

    Parameter Description
    First Address to be written Address from where the data written begins.
    Holding register input to be written. Value to write on the address.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    No return!

    Since

    6.4

    See also

    Modbus Connector

    Write Multiple Coils

    Write Multiple Coils

    Parameters

    Parameter Description
    First Address to be written Address from where the data written begins.
    Number of addresses to be set. Values to be set.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    No return!

    Since

    6.4

    See also

    Modbus Connector

    Write Multiple Registers

    Write Multiple Registers

    Parameters

    Parameter Description
    First Address to be written Address from where the data read begins.
    Number of addresses to be read Values to write.
    Slave Address / Unit identifier Unit identifier (previously slave address). In asynchonous mode this unit is given to the callback function.

    Output

    No return!

    Since

    6.4

    See also

    Modbus Connector

    External Oauth 2.0 provider

    The External OAuth 2.0 provider can be used to acquire acess tokens from OAuth 2.0 providers to be consumed in eg the REST connector.

    Configuration

    More can be read about the claim on the specification for JWT: https://tools.ietf.org/html/rfc7519#section-4.1

    Get Started

    There are no settings, only choose what variable you would like to output the token to. This variable can be used in conjuction the REST connector to access Oauth 2.0 authenticated resources, like azure graph api

    Authorization schemes

    Authorization schemes can be applied to operations to set what kind of authorizations are required to use the operation. When there are schemes defined they can be applied to operations simply by clicking the "ADD" button:


    You can also apply an authorization on all children of a given container by selecting the container and then right clicking on it and selecting "Authorization->Apply authorization to all children".

    But first you have to define the schemes. There are three kinds of schemes that can be used.

    OAuth2

    OAuth2 is currently mainly for documentation purposes. There is no requirement to configure this at the moment (6.7). If you import a swagger specification, that specification can contain this information, and it is good to keep track of. It certainly does not hurt to specify OAuth2.

    API Key

    REST API:s often require an API key. Typically it is sent either via a query parameter or as a header. You can specify this yourself on the operation, adding the query parameter or header manually. There certainly are cases when this is a good idea. One example is when you want the api key to be associated with the Flow user. You can then set the api key per flow user and in machine step do like this:


    You can also set the parameter as a 'Constant', effectively hiding it from the workflow designer. But then the key is hard coded in the connector, which of course could be problematic.

    If you want the API key to be configurable in connector configuration you have to apply an API key scheme on applicable operations. Start by creating a new API key:


    Provide a Name for the API Key. This is how you want to identify the key. You can provide description for documentation purposes, but that is not required. "API key name" is required and is what the REST API expects the parameter name to be. Finally you have to define whether the key is sent as a query parameter or as a header.


    Once the API key has been defined it can be applied to operations as described above.

    Finally, after creating the connector, API keys can be set in connector config.


    The key will then be applied to all operations that uses the scheme in runtime.

    Basic authorization

    Another common way for an API to authorize requests is by the use of The 'Basic' Authentication Scheme.

    If the API requires this you must add that scheme to the project and apply it to all operations that should use it. There is nothing more to configure in REST Project Tool, all configuration is done in Flow Studio.

    Either you set the username and password in the connector config:


    Or you can leave it empty and define it per Flow user:


    REST Service

    The REST Service Connector can be used to consume REST services. The configuration for a REST Connector is mainly done in the tool "Novacura REST Connector Project" which is access by pressing the 'EDIT' button in 'REST connector project' section.

    Configuration

    Custom model member

    With the custom data type on a model member you can specify external (from the perspective of the REST project tool) data types. You use Custom specification the specify the type.

    Currently the only available custom data types are types originating from the .NET Base Class Library (BCL). To use a type from BCL you prefix the full name of that type with 'bcl:', for instance 'bcl:System.TimeSpan'. Note that certainly not all types will work, and most of them will make no sense. You can consider this feature as an advanced one with limited support available. It is however powerful and useful in many scenarios and can save you a lot of development time and need of custom connectors by using it properly. Since it can reduce the need for custom connectors it also simplifies deployment and reduces maintenance.

    So, after this warning, let's walk through an example of how it can be used.

    Consider this scenario:
    * You want to fetch pdf documents from a REST API.
    * The REST API returns the pdf documents as base64 encoded strings.
    * You want to store these documents in the filesystem, of course not as base 64 encoded string but as the actual binary data.

    This is how the json looks like when returned from the server:

    {
        Data: "JVBERi...base64 encode data...PDj8OT==",
        Name: "4cdda37a-fa71-1065-a761-141a4ebaf7d3",
        Extension: ".pdf",
        InvoiceId: "401757"
    }

    Since this is what the API will return, we need a model for it. This is quickly done with 'NEW FROM JSON' in the Model part of the REST Project Tool. See Models for more information on how to to that.

    Once we've created the model it will look like this:

    We now need a model that contains not the base 64 encoded string, but instead an instance of System.IO.Stream.

    Since this model will look almost the same as the 'Invoice' model, we can use the 'Clone model' feature. This is accessed by selecting the tree node for the model and right clicking:
    We'll call this second model 'Invoice (binary)'. We now have two identical models:

    Next step is to change the data type of 'Data' in 'Invoice (binary)'. Select the 'Data' member and change 'Type' to 'Custom' and set 'Custom specification' to 'bcl:System.IO.Stream'.

    Next step is to create a model transformation between the two models.

    The code could look something like this:

    Now this transformation can be applied to a GET operation

    Finally the workflow could look something like this:

    Enumerations

    Enumerations can be used in models to limit the possible values a workflow designer can assign to a member of a model.

    Consider for instance an API for 'orders' in a 'store'. We got the operations 'Add new order', 'Update order' and 'Delete order'. Let's look at the 'Order' model:

    'status' is of type 'Enum':

    And if we look at that enum you can see what possible values that member can have:

    Members of the enum can be added and deleted as needed (circled area above).

    Let's look at an operation using the 'Order' model, 'Update order'

    It uses 'PATCH' to only update certain members, accepting a body of model 'Order'.

    Let's look how this will look in Flow Studio:


    When using 'Constant' as mapping to 'status' only the members of the enum are available. You can still mess it up by selecting 'Variable' as mapping and providing an invalid value in the passed variable. But with the usage of enums you can at least guide the person using the connector in Flow Studio in what kind of values are expected.

    Getting started

    To create a REST connector you go to Environment -> Connectors -> Add and select Type "REST Service".

    Provide a 'Name' and click on "EDIT" to get started. You will also be required to provide a base address before you can save the connector.

    When you click on "EDIT" you will open a tool where you'll define the connector.


    Let's walk through all the properties.

    General

    Containers

    The main purpose of containers are to help you organize the operations in a logical way. You do not need to specify any containers, but it usually make senses to use them. Containers can contain operations and other containers. They can also define 'Standard headers' that can be applied to all sub-containers and operations. Containers can also define a 'Path' which is appended to the 'Base path' (described above). The final 'Path' of an operation is the concatenation of all parent containers 'Path' (can be overridden).

    Operations

    In the 'Operations' section you can add and delete operations of the connector. This is most likely the first thing you will do when starting a new REST Connector project.

    Standard headers

    In this section you can specify entity, general, request and response headers that should be applied to all operations of connector. You can for instance set that all operations must send 'Content-Type: application/json'. Sub-containers and operations can always override the header.

    Advanced

    In this section you can specify advanced features that you usually do not need to worry about.

    Global output

    'Global outputs' is used to define output parameters that can be reused on multiple operations.


    A typical use case is when an API returns some kind of error that is always of the same format. The API might return some data depending on the operation with http status code 200. But in case of error it could still return http status code 200, but a different model, containing information about the error. Although each operation has different models in case of success, in the case of failure could be the same.


    Note that priority has been set to a number higher than '1' (in this case '10'). The REST connector will try all defined outputs of given http status code until it succeeds, in the order of 'Priority', starting with the one with highest priority (lowest number). Assuming the operation will be successful more often than not, it makes sense to assign a lower priority on the error output.

    You can also define a "NEW DEFAULT OUTPUT", which is just like normal "DEFAULT OUTPUT", that is an output for all http status codes not defined by other outputs.

    Once you have defined a global output you can add it to any operation.

    Just select "Outputs" on operation and press the 'ADD GLOBAL' button.


    Select output of interest and press 'OK'. You will then be given the option to include the output as a copy or as reference. If added as copy, a new output that looks exactly like the global one will be added to the operation, but there is no connection between the two. So if the global output is changed in any way, the added copy is not affected. If you add it as a reference any changes to the global output will affect the output you added to the operation (it is the same output).

    Global parameters

    'Global parameters' is used to define parameters that can be reused on multiple operations. You can define query, form, body, header and matrix parameters.


    A global parameter is defined like a 'normal' one except that you have to give it a unique identifier once you have defined it. This is to enable you to have multiple global parameters with the same parameter 'Name'. You can of course still only apply one global parameter of given 'Name' to an operation, but this way you can build up a library of useful parameters.

    Once you have defined a global parameter you can add it to any operation (as long as that operation not already has a parameter with the same 'Name').

    Just select parameters on operation and press the 'ADD GLOBAL' button.


    Select parameter of interest and press 'OK'. You will then be given the option to include the parameter as a copy or as reference. If added as copy, a new parameter that looks exactly like the global one will be added to the operation, but there is no connection between the two. So if the global parameter is changed in any way, the added copy is not affected. If you add it as a reference any changes to the global parameter will affect the parameter you added to the operation (it is the same parameter). So if you for instance change the 'Name' of the global parameter, this means that the operation now sends a parameter with a different 'Name'. This can create conflicts. Let's say for instance that you add the global parameter 'q1' to an operation as a reference. You then add the parameter 'q2' to the operation. If you then change the 'Name' of the global parameter to 'q2' the operation will have two parameters with the same 'Name'. This is not allowed, but will not raise any warnings until you try to "Create/update connector".

    Internal parameters

    In the 'Global parameters' section you can create parameters of kind 'Internal'. This kind of parameters can only be add to operations as a reference, never a copy. The purpose of internal parameters are to be able to send in parameters to an operation that can be used in model transformations. They are not sent to the remote API. Internal parameters will always be set to a nullable type. So when you use it in a model transformation this must be considered. Let's say for instance that you have a global internal parameter called 'Remove empty entries' of type 'Boolean', the usage of that parameter could look like this:

    Models

    Models are a central concept when creating a REST connector. They are use both for posting object data to an API and also when receiving object data from an API.

    Models are managed from the "Model" node in the connector tree.

    Below the grid you can create new models. You can create an empty model by pressing the "NEW" button, or you can create a new model based on JSON (sample or Schema Draft 4) or XML sample.

    Let's start with creating an empty model.

    After the model has been created it is empty and pretty much useless. Press "NEW" on "Items" to create members of model

    This will bring up a dialog where you can specify details about the member of the model.


    You can manually create as many members of the model as needed. You can of course also delete and edit members when needed. At the moment there is no way to rearrange the order of the members. The order does not matter in runtime, but for clarity it could have been good to be able to rearrange them.

    While creating the model manually is easy, it is even easier if you already got a JSON or xml representation of it.

    Here is an example of a model from JSON (sample):

    Types are assumed based of the example data, for instance "Prop3" is assumed to be of type Boolean since the example value of it is 'true'. This feature works for most cases, but there are cases where you need to manually specify exactly the type you need (setting an Integer to have Type Format int64 is one example). You can set all data types to 'large ones' by checking 'Use large data types'. Note that all members of type Integer will then have int64 format.

    You can also create models from JSON Schema (draft 4), this is much more accurate than from sample but is not as commonly used as JSON samples.

    Here is an example of a model from JSON Schema:

    As you might notice, id is specified as int64 already in the schema, and this will be stored in the Model. JSON Schema (draft 4) is superior to JSON Sample in almost every way but, as stated above, unfortunately not as commonly used to document REST APIs as JSON samples.

    Another way to get an external representation of a Model into the REST Project is by xml. Currently only sample xml is supported, not from any schema (such as xsd).

    Here is an example of a model from xml sample:

    Embedded models

    When creating models from JSON or XML sample, inner structures of the model are created as 'embedded models'. This is new in version 6.8 of Flow, in earlier versions independent models were created. If a model is used only once it makes little sense to have an independent model. Chances are that you will end up with lots of models and the project will be hard to manage. When using an embedded model all the members of the model is located directly under the model member. This is perhaps best illustrated with an example:

    Consider this structure:

    {
        "property1":"string",
        "property2":"string",
        "property3": 
            {
                "innerProperty1"  : "string",
                "innerProperty2"  : "string",
                "innerProperty3"  : "string"
            },
            "property4": 
            {
                "innerProperty1"  : "string",
                "innerProperty2"  : "string",           
            }       
    }
    With independent models you would end up with models like this:

    This is not wrong, it will work just fine, but as project grows larger the number of models will be problematic. With the use of embedded models you would end up with model like this:

    The two extra models that was referenced by 'model1' are now embedded in the model. This of course means that the model 'property3' cannot be used by another model, but in the situations where that will not happen, this is a better solution.

    Referring to an embedded model in model transformation

    If you want to create an instance of an embedded model in a model transformation you refer to it as 'Model_NAMEOFMODEL.Embedded.NAMEOFPROPERTY'. An example with the 'model1' above:

    public static Model_model1 modeltransform(Model_model1 input)
    {
        var output = new Model_model1();
        //Transformation code start
        output.property3 = new Model_model1.Embedded.property3();
        output.property3.innerProperty1 = "a value";
        //Transformation code end
        return output;
    }

    Converting between embedded and independent models

    By default all inner structures are interpreted as embedded models (possibly with the exception of JSON schemas). You can convert between embedded models and independent models in the tool after they've been created by right-clicking on their usage in the tree view and select 'Convert to independent model' (or 'Convert to embedded model' if already independent). If you convert to an embedded model, the related independent model will not be removed. If the rest project tool detects that the model is not used anywhere you will be prompted with the option to delete it though.

    Base models

    In version 6.8 of Flow the support for base models were added. Basically a model can use another model as a base, meaning that all members of the base model are available also in the new model.

    Here is an example where 'Model2' has 'Model1' as base model and 'Model3' has 'Model2' as base model. All members of both 'Model1' and 'Model2' are available in 'Model3'.

    Model transform

    Model transform is a feature where you as REST connector developer can manipulate the response from a REST API before returning it to the workflow. You can also use it to manipulate an outgoing object (body parameter).

    Transforming incoming models

    Typical use case is when an API returns data like this:

    {
        properties : [
            {
                property: "Property1",
                value : "Value1"
            },
            {
                property: "Property2",
                value : "Value2"
            },
            {
                property: "Property3",
                value : "Value3"
            },
        ]
    }

    When used as an output model in REST connector you would end up with an output looking like this in Flow:

    modeltransform1

    This can be managed with Flow Script, but it can be more convenient and efficient to do the transformation inside the connector. Especially if the connector is used in multiple workflows.

    The output of the remote operation is of course still the data above, so we have to define a model to represent that data:

    modeltransform2

    But we can also define the model that we want to expose to the workflow. Something like this:

    modeltransform3

    Let's add the transformation.

    Select "Model transformations" in connector tree and press the "NEW" button

    modeltransform4

    Give the transformation a descriptive name and select source model and target model

    modeltransform5

    Double click on the newly created transformation in the list, or select it from the connector tree. Something like this should be loaded:

    modeltransform6

    So the actual transformation is done with c# code that you provide. Do not enter any code above //Transformation code start or below //Transformation code end

    This is a very powerful feature. You are, however, limited to provide code that is compliant with c# 5.0. You are also limited to only use types from the following assemblies:

    System
    System.ComponentModel
    System.ComponentModel.DataAnnotations
    System.Core
    System.Data
    System.Drawing
    System.Net.Http
    System.Runtime
    System.Runtime.Serialization
    System.ServiceModel
    System.ServiceModel.Web
    System.Web
    System.Xml
    Note that not all of these assemblies are available by default. The "usings" that all transformation code uses can be changed here:
    modeltransform7

    An example of transformation code for this situation could be:

    public static Model_transformedOutput Operation_output_To_Transformed_output(Model_operationOutput input)
    {
        var output = new Model_transformedOutput();
        //Transformation code start
    
        output.Property1 = input.properties.First(p => p.property == "Property1").value;
        output.Property2 = input.properties.First(p => p.property == "Property2").value;
        output.Property3 = input.properties.First(p => p.property == "Property3").value;    
    
        //Transformation code end
        return output;
    }      

    Note that models are called 'Model_' followed by the name of the model.

    All that is left to do now is to apply the transformation to the operation of interest:

    modeltransform8

    Now when the connector is used in a workflow the output from the operation will look like this:

    modeltransform9

    Which is easier to work with as a workflow designer.

    There are a lot more scenarios that this feature enables. You could for instance add new output members (composed of values from other members for instance) or hide members that are not of interest to the workflow designer.

    The code will run with limited permissions. It is for instance not allowed to access the file system, so code such as

    System.IO.File.AppendAllText(@"C:\logs\values.txt", input.Property1);

    will not work and you will get an error in runtime.

    Transforming outgoing models

    Like incoming models there are scenarios where it makes sense to transform the outgoing models before it is sent to remote API. Let's assume the same data structures as above are in action here as well. The transformation now needs to be from the model 'transformedOutput' to model 'operationOutput'. Names now becomes a bit off, since we are not dealing with output, but I'm sure you get the picture.

    Then the transformation code could look something like this:

    public static Model_operationOutput Transformed_to_real_output(Model_transformedOutput input)
    {
        var output = new Model_operationOutput();
        //Transformation code start
        output.properties = new System.Collections.Generic.List<Model_properties>();
        
        output.properties.Add(new Model_properties() { property = "Property1", value = input.Property1});
        output.properties.Add(new Model_properties() { property = "Property2", value = input.Property2});
        output.properties.Add(new Model_properties() { property = "Property3", value = input.Property3});
        //Transformation code end
        return output;
    }
    Apply the transform.
    modeltransform10
    In the machine step the operation input would then look like this:
    modeltransform11
    Without the transformation the machine step would look like this:
    modeltransform12

    There certainly are situations where the later is preferred, maybe there is already a table with property+values available and so forth. With the transformation feature you can control what best suites your scenario.

    For a more advanced example of model transformation see Custom model member

    Operations

    New operations are added to the project or container by pressing the 'ADD' button.

    There are a couple or properties that can or must be defined for each operation.

    General

    Security

    You specify operation authorization if you have created any in Authorization schemes. This can always be added later, so there is no requirement to set this upfront.

    Press OK to create the operation. Once the operation has been created you can specify input and output of the operation.

    Learn more here:
    Parameters
    Outputs

    Outputs

    The output of an operation needs to be defined so Flow can use it. If you do not need any output, it is safe to define no output. The machine step will still return a record, consisting only of 'HttpStatusCode', 'ReasonPhrase' and 'AllHeaders'.

    But typically you want to define the possible outputs of an operation. When you create a new operation one output is added by default. This output is for http status code '200'. If the operation does not ever return 200 you can delete it.

    You can define multiple outputs for an operation, for example you might want one for http status code '200' another for '400', yet another for '500' etc. You might even need several outputs per http status code. An API can for instance always return '200', but in case of an error return an object describing the error instead of expected object. The REST Connector will try to parse the response from the API until it is successful. To control the order the connector tries to parse the response, use 'Priority' - where the output with highest priority (lower number) will be tried first. If two outputs has the same 'Priority', it's undefined which output is tried first.

    To define a new output you press 'NEW OUTPUT'.



    - Parameter kind
    Always output
    - Http status code Specify for what Http status code that output is valid for.
    - Name
    A unique name for the output
    - Display name
    A more human readable name for the output (not required)
    - Description
    Currently purely a documentation feature for you as a REST connector designer.
    - Priority
    Applicable if there are more than one output on a given http status code.
    - Data type
    Here you specify the kind of output - None - Array - Boolean - Integer - Number - Object - String - File
    - Override content-type
    Here you can specify that REST connector should always consider the returned content to be of a specific content-type, regardless of what the actual response states. Applicable values are "application/json" and "application/xml". This is to mitigate situations where a remote API for instance states content-type "text/plain" even though it actually is "application/json".

    See Parameters for more information about these types. Note that 'File' will translate to a 'Stream' in Flow. So if you download a file from a REST API (output is of type 'File') you can then use for instance the 'File System Connector' to write the stream to disk. Or another connector that can handle streams, such as SFTP, FTP or the Database connector. If the output is 'Object', you can also select an transformation (if there are any transformations available based on the selected model. See Model transform for more information.

    You can also add one (and only one) 'DEFAULT OUTPUT'. The purpose of this output is to capture all http status codes not defined by another output.

    Example

    Let's look at an example with multiple outputs.

    We got two outputs for http status code 200 defined.


    Which leads to that when the operation is later used in Flow, it will have two records, one called 'OK' and one called 'Error'. At most one of the two will have a value after the REST call has been made.


    This can be used for better error handling, for instance like this:


    Parameters

    Most operations will have parameters of some kind. To define them you simple click on 'Parameters' beneath the operation.


    In this example a 'Path parameter' (id) was specified so that is added to the parameters automatically. Path parameters are added and removed directly in the 'Path' by declaring them there. Example: '/{resource}/{id}' where both 'resource' and 'id' are path parameters.

    Query parameters

    Query parameters are very commonly used by REST APIs. They are added at the end of the 'Path', after a '?' and separated by a '&'. But you do not have to worry about any of that, just add query parameters by clicking the 'NEW QUERY' button and the connector will take care of all the details. If you want add multiple parameters at once there is a convenient shortcut accessible by right clicking on 'Parameters' and selecting 'Add multiple query parameters'. You can then enter as many (within reason) parameters as you like. Choose how they are separated (comma, semicolon or new line) and what type they should all be (typically string). You can also decide whether the parameters are required or not.

    The parameters in the example above were all of type 'String', which probably is the most common type you'll use. There are however multiple types available, more information about the different types can be found later in this page.

    Query parameters can be set to be an 'Empty value parameter'. This means that if set to "true" the parameter will be included in the query but without a value. If for instance parameters 'x' and 'y' are defined and set to 'true' the url called by REST connector could look something like this:

    http://theurl?otherParameter=someValue&x&y

    Form parameters

    Form parameters are added to your operation by clicking the 'NEW FORM' button. Form parameters requires you to also set a 'Content-Type' header on the operation - 'application/x-www-form-urlencoded' for GET or 'application/x-www-form-urlencoded' or 'multipart/form-data' for POST. If you are sending a file (binary data) you must use 'multipart/form-data'. If you do not set any header, the tool will force you to do so when clicking the 'Create/update connector' button. Form parameters cannot be used at the same time as body parameters.

    Body parameters

    Body parameters can be used with POST, PUT and PATCH operations. Typically they are used to send object data to an API. Objects are defined as models, see Models for more information. You can use model transformations on the model before it is sent to remote API, see Model transform for more information. Body parameters cannot be used at the same time as form parameters, and you can have only one body parameter in an operation.

    Header parameters

    Header parameters, or custom headers, are parameters that are sent as http headers to the API. One common use case is to send API keys in a header. If the API you are creating a connector for requires this, there are however other options available than creating a custom header, read more in the section 'API Keys' in Authorization schemes for more information.

    Matrix parameters

    Matrix parameters are parameters that are added to the 'Path' before any query parameters. They are separated by a ';'. If you for example has an operation 'op1' with two matrix parameters defined, 'm1' and 'm2' and one query parameter 'q1' which at runtime have the values 'm1Value', 'm2Value' and 'q1Value' the 'Path' (url) would look something like: 'https://site/api/op1;m1=m1Value;m2=m2Value?q1=q1Value'.

    Parameter types

    String

    Path Query Form Body Header Matrix
    x x x x x x

    Strings is a very common parameter type. Default to this if you do not know the type. String supports 'Type formats'. Currently only 'date-time' will have an impact on runtime - causing the parameter to be treated as a datetime. The 'Required' constraint is used to force the Flow designer to provide a value, but the other constraints ('Max length' etc) are currently only for documentation purposes. This can change in future version of Flow.

    Integer

    Path Query Form Body Header Matrix
    x x x x x x

    Integer supports 'Type formats'. Currently only 'int64' will have an impact on runtime - causing the parameter to be treated as a 64-bit integer (instead of a 32-bit integer). The 'Required' constraint is used to force the Flow designer to provide a value, but the other constraints ('Is exclusive maximum' etc) are currently only for documentation purposes. This can change in future version of Flow.

    Number

    Path Query Form Body Header Matrix
    x x x x x x

    Number is a used to support floating-point values. Number supports 'Type formats'. Currently only 'float' will have an impact on runtime - causing the parameter to be treated as a 32-bit floating-point value (instead of 64 bit one). The 'Required' constraint is used to force the Flow designer to provide a value, but the other constraints ('Is exclusive minimum' etc) are currently only for documentation purposes. This can change in future version of Flow.

    Boolean

    Path Query Form Body Header Matrix
    x x x x x x

    Simple type which allows true or false as value. Can be set to 'Required', forcing the Flow designer to provide a value.

    Object

    Path Query Form Body Header Matrix
    x

    Used to send objects (instances of models) to an API. The header 'Content-Type' must be set, typically to 'application/xml' or 'application/json'. See Models for more information. Can be set to 'Required', forcing the Flow designer to provide a value.

    File

    Path Query Form Body Header Matrix
    x
    Only supported on POST, PUT or PATCH operations with the header 'Content-Type' set to 'multipart/form-data'. Can be set to 'Required', forcing the Flow designer to provide a value. Will translate to a 'Stream' in the workflow. One example how to get hold of a 'Stream' is via the 'File Gallery' in 'User Step'. If you select 'upload to single' and output variable name is 'value1', then you can do a variable mapping to a File parameter with 'value1.data'.


    Stream

    Path Query Form Body Header Matrix
    x

    Used to send binary data to API. Similar to the 'File' parameter type, but for body parameters. From a workflow perspective used in the same way. The header 'Content-Type' must be set to 'application/octet-stream'. Can be set to 'Required', forcing the Flow designer to provide a value.

    Array

    Path Query Form Body Header Matrix
    x x x x x x

    Arrays are supported by all parameters, but will behave a bit differently depending on the parameter type. Can be set to 'Required', forcing the Flow designer to provide a value. 'Unique items' constraint is only for documentation purposes at the moment, but this can change in a future release of Flow.

    At it's core arrays are of course collections of something. But you must define what the collection consist of.

    For query, form, header and matrix parameters the 'inner type' can be 'String', 'Integer', 'Number', 'Boolean' or 'Array'. You define how the different items of the array are separated by selecting one of the following:

    For body you can use 'String', 'Integer', 'Number', 'Boolean' and 'Array' as well. But also 'Object'. When set to 'Object' the separation format has no effect.

    When the 'inner type' is string you have the option to specify 'Available options'. The use of this is best described with an example:

    Consider the operation 'GetOrdersByStatus'. As a parameter you can set the parameter 'status' with what statuses you are interested in. Available statuses are 'Pending payment', 'Processing', 'Approved' and 'Shipped'. To do this the API uses a query parameter array with csv separation. An example call would look like: 'https://store/api/GetOrdersByStatus?status=Approved,Shipped' to get all orders that are either 'Approved' or 'Shipped'. You can of course just specify a query parameter of type array with inner type string and csv separation and that is fine. You will then end up in Flow with something like this:


    Either the Flow designer uses 'Single row' and provides one value or defines a table earlier in the workflow with multiple values. Either way, the Flow designer has to know which values are valid and the risk that something is misspelled etc is not neglectable.

    A better way is to use 'Available options'.


    This would result in the following in the machine step:


    The options are identified as 'c1', 'c2', 'c3' etc, so if you want to setup the record outside of the machine step you can use those names. Example:


    The record 'status' can then be used in machine step:


    REST Project Tool

    The REST Project Tool is used to define how your REST connector is going to integrate with a REST API.

    The tool looks something like this:


    This is a REST connector for Google Drive V3.

    On the left side there is a 'Connector tree', where you get an overview over the different parts of the connector. The first node ('Google Drive V3' in the picture above) is all the operations and containers of the connector. This is what will be available in the machine step once the connector has been created. Below the first node there are different sections where you can define different features that the operations can use, such as models. Each feature is described in its own section.

    Getting started
    Operations
    Model
    Enumeration
    Model transformations
    Authorization schemes
    Global parameters
    Global outputs

    In the menu you will find a couple of important features as well.

    When you are done configuring the connector, press 'Create/update connector'-button. If the connector is successfully created, the 'REST Connector Project'-window will close down and you will be back in connector configuration in Flow Studio. Do not forget to press 'SAVE' in connector configuration to save your changes to the connector.

    Create directory

    Creates a directory at the SFTP server. It is not possible to create several levels of directories in one step. If you want to create the directory "./dirA/dirB", the directory "./dirA" must exist. Otherwise you have to do it in two steps; first creates directory "./dirA" and the second one created "./dirA/dirB".

    Parameters

    Parameter Description
    Remote path Path to the directory to create.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Delete directory

    Deletes specified directory. Note that the directory must be empty unless Recursive is set to true.

    Parameters

    Parameter Description
    Remote path Path to directory to delete
    Recursive Specifies whether to also delete all files and subdirectories.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Check if directory exists

    Determains whether directory at specified path exists.

    Parameters

    Parameter Description
    Path The path to check.

    Output

    Simple value,'True' if directory exists. 'False' otherwise.

    Since

    6.3

    See also

    SFTP Connector

    List directory

    Lists all files and directories in a specified path.

    Parameters

    Parameter Description
    Remote path Path to list.
    Mask Mask to use when filtering items in directory. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B"
    Case sensitive Specifies whether to ignore casing or not.
    Include files Specifies whether to include files in the listing.
    Include directories Specifies whether to include directories in the listing.
    Recursive Specifies whether to also search in subdirectories.

    Output

    A table consisting of records with the following structure:

    Member Description
    Name The name of the file or directory.
    IsDirectory True if the item is a directory, false if it is a file.
    Size The size, in bytes, of the item.
    LastAccessTime Last time item was accessed.
    LastModifiedTime Last time the item was modified.
    CreationTime Time of item creation.

    Since

    6.3

    See also

    SFTP Connector

    Download single file

    Downloads a file from the SFTP server to the machine where Flow Server is running.

    Parameters

    Parameter Description
    Remote filename The name of the file to be downloaded
    Local filename Filename of where on Flow Server to store the downloaded file.
    File tranfer mode Specifies how to handle if file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Download multiple files

    Downloads multiple files from the SFTP server to the machine where Flow Server is running.

    Parameters

    Parameter Description
    Remote path Path to downloaded files from.
    Remote mask Mask used to filter which files to download. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    File tranfer mode Specifies how to handle if file already exists.
    File copy mode Specifies what to do with the file after download has been completed.
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to download files from sub directories recursivly.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Download stream

    Downloads a file from SFTP server and store it as Flow variable.

    Parameters

    Parameter Description
    Remote filename The name of the file to be downloaded

    Output

    Simple value (binary stream).

    Since

    6.3

    See also

    SFTP Connector

    Copy remote file

    Copies a remote file into the selected destination.

    Parameters

    Parameter Description
    Remote source path Path where to copy from.
    Remote destination path Path where to copy to.
    Overwrite if already exists True or false.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Delete file

    Delete a remote file.

    Parameters

    Parameter Description
    Remote path Path to file to delete.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Delete files

    Delete multiple remote files based on mask.

    Parameters

    Parameter Description
    Remote path Path where to delete files.
    Mask Mask used to filter which files to download. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Case sensitive Specifies if mask is case sensitive (not applicable if regex is used).
    Recursive Specifies whether to delete files recursivly.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Check if file exists

    Checks if a remote file exists.

    Parameters

    Parameter Description
    Remote path Path to check.

    Output

    Simple value,'True' if file exists. 'False' otherwise.

    Since

    6.3

    See also

    SFTP Connector

    Get size of file

    Gets the size, in bytes, of remote file.

    Parameters

    Parameter Description
    Remote path File of interest.

    Output

    Simple value, numeric.

    Since

    6.3

    See also

    SFTP Connector

    Rename file

    Renames a remote file.

    Parameters

    Parameter Description
    Old path Current name of file.
    New path New name of file.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Upload single file

    Uploads a single file from the Flow Server to the SFTP Server.

    Parameters

    Parameter Description
    Local filename File to upload.
    Remote filename Where to upload the file.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Upload multiple files

    Uploads multiple files from the Flow Server to the SFTP Server.

    Parameters

    Parameter Description
    Local path Path where to upload files from.
    Local mask Mask used to filter which files to upload. Example "*.txt". Regular expressions can also be used by prefixing with "regex:", example "regex:[A|B].*" to list all files starting with "A" or "B".
    Remote path Path where to upload the files.
    File transfer mode Specifies what to do if the file already exists.
    Case sensitive Specifies whether to ignore casing or not.
    Recursive Specifies whether to also upload from subdirectories.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    Upload stream

    Uploads the content of a Flow variable that contains a binary stream. This can for instance be used to upload data from a camera input.

    Parameters

    Parameter Description
    Local stream Stream to read data from.
    Remote filename Where to upload the data.
    File transfer mode Specifies what to do if the file already exists.
    Restart position Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.

    Output

    No output.

    Since

    6.3

    See also

    SFTP Connector

    SFTP

    The SFTP Connector is used to upload and download files from an SFTP server. It can also perform other operations such as creating remote directories and list files and directories on the SFTP server.

    Configuration

    Operations

    Directory operations
    Check if directory exists
    Create directory
    Delete directory
    List directory
    Download operations
    Download multiple files
    Download single file
    Download stream
    File operations
    Check if file exists
    Copy remote file
    Delete file
    Delete files
    Get size of file
    Rename file
    Upload operations
    Upload multiple files
    Upload file
    Upload stream

    Siox

    Before using the Siox connector download the Siox driver from the Siox website.

    The Siox Connector is used to communicate with Siox terminals. Read more on Siox website., and download Siox SDK for the documentations for all the opertations.

    Configuration

    Webservice example: Connector to Microsoft Dynamics AX

    This is an example of how the Web Service connector can be used to consume Microsoft Dynamics AX AIF services.

    How to set up any AIF service, such as a document service, in Microsoft Dynamics AX is beyond the scope of this example, but once that has been done the Web Service connector can be used to consume it. From AX, get the URI to the WSDL of the service.

    Step1

    Step1

    Copy the URI from AX.

    Create connector of type Web Service.

    Provide a name for the connector and paste in the URI. Make sure server address is correct and press "Create/update"-button

    Step2

    Step2

    Wait for the connector to be created

    Step3

    Step3

    Examine the configuration. Might be a good idea to increase maxRecievedMessageSize.

    Step4

    Step4

    Setup Client credentials by expanding Client credentials -> Windows and enter UserName and Password and, if required, domain and impersonation level.

    Step5

    Step5

    Save the configuration

    The connector should now be available to be used in a Machine Step.

    Step6 Step7

    Web Service

    The Web Service Connector can be used to consume SOAP based web services. It can also be used to consume WCF services that are not based on SOAP, such as net.pipe and net.tcp bindings.

    Configuration

    Example

    Creating a connector to AX Document Services

    Web Page Submit

    The Web Page Submit Connector can be used to send HTTP POST and GET requests to a given url. At least one parameter must be sent.

    Configuration

    Communication

    Under communication, all connectors related to generic communication protocols are listed, with information about configuration to setup the connector and how to use it.

    BarTender 2016

    The BarTender connector can be used to integrate with BarTender 2016 R8, typically to print BarTender documents.

    32-bit version of BarTender 2016 R8 Automation Edition or Enterprise Automation Edition needs to be installed on the same machine as Flow Server.

    Configuration

    Example of usage, embedded data

    This is a an example of printing the label "Caterpillar\Master label.btw" which can be found among the example labels installed with BarTender.

    The label looks like this in BarTender:


    It can be configured with embedded data, 1L, 3S, 4S and so on.

    If you select this BarTender document in Flow Studio it will look like this:


    As you can see, the Embedded data is set to Custom record, and this is where you can control the data input to the BarTender document.

    If we provide it with some random data:


    And then print the labels, in this case to an image preview, the output will look like this:


    Example of usage, text database

    This is a an example of printing the label "EU Energy Labels\EU Energy Television A 2010-1062-2011.btw" which can be found among the example labels installed with BarTender.

    The label looks like this in BarTender:


    It takes a text file as data input. Example file looks like this:

    Efficiency;Annual Power Consumption;Power Consumption;Power Switch;Diagonal Inches;Diagonal Centimeters
    0.28;10000;80;1;32;81
    0.40;22222;120;0;32;81
    0.50;23456;140;0;27;69
    0.70;90009;160;0;27;69
    0.85;90809;30;1;42;107
    0.95;90909;40;1;42;107
    1.10;99999;50;0;20;51

    So seven (one per line) labels will be printed.

    If you select this BarTender document in Flow Studio it will look like this:


    As you can see, the Text file database (Text file 1) is expanded, and this is where you can control the data input to the BarTender document. You can for instance select another text file than 'Television Data A.txt'.

    You can also map data from a Flow table to the document. Let's do that. Consider the following flow table:


    So mapping this to the BarTender document can be done like this:


    It is important that the data types matches, for instance will sending in a text to any of these members generate an error. You can see the data type in BarTender. Unfortunately there is no way to know the types from Flow Studio. If you choose to map to a Flow Table, the file ('Television Data A.txt' in this case) will be ignored.

    If you then print the labels, in this case to an image preview, the output will look like this:


    The values does of course not make sense, but hopefully this has given you an idea how to map your data to BarTender documents.

    List printers

    Lists all printers available.

    Output

    Record with information about whether operation failed or not.

    Member Description
    Results Contains a table with information about printers
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Structure of Results

    Results
  • PrinterName
  • DriverName
  • PortName
  • Location
  • IsDefault
  • Errors

    Error code Description
    1000 Unspecified error.

    Manually select BarTender document

    With this operation you can manually select a BarTender document from your local file system.

    The file is stored in the machine step and is not in any way synchronized with the file in your local file system. Once the file has been selected you can export the file by clicking on Export file....

    Note that if you select another operation in the machine step the document will be lost and has to be selected from the file system again.

    The same input and outputs as 'Print' applies, see Print for more information.

    Prints a BarTender document to specified printer or to an image (printing to image requires Enterprise Automation Edition).

    Parameters

    Parameter Description
    Printer Printer to print to, leave empty to use default printer
    Print job name Name of print job, can be omitted
    Document password If applicable, the password to use in order to print the document
    Number of identical copies to print If supported, specifies how many identical copies to print
    Embedded data Values to embedded data can be provided here
    Text file database If the document reads data from a text file, this section can be used to configure it
    Database connection If the document reads data from a database, this section can be used to configure it
    Print to image preview This section can be used to configure that the document should be printed to an image instead of a printer. Requires Enterprise Automation Edition of BarTender

    Output

    Record with information about whether operation failed or not.

    Member Description
    Results Contains a message from BarTender, typically information about the printing
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Errors

    Error code Description
    1000 Unspecified error.
    1000001 Failed to print.
    1000002 Failed due to timeout.

    Sends a BTXML Script to BarTender.

    Parameters

    Parameter Description
    Filename Full path to file containing BTXML Script

    Output

    Record with information about whether operation failed or not.

    Member Description
    Results Contains a record with the xml response from BarTender and a table with messages from BarTender
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Structure of Results

    Results
  • XmlResponse
  • Messages
    • Text
    • ID
    • Severity
    • Category
  • Errors

    Error code Description
    1000 Unspecified error.

    Sends a BTXML Script to BarTender.

    Parameters

    Parameter Description
    Script value String containing the BTXML Script

    Output

    Record with information about whether operation failed or not.

    Member Description
    Results Contains a record with the xml response from BarTender and a table with messages from BarTender
    HasFailed Whether operation has failed or not
    ErrorMessage A description of the failure, if any
    ErrorCode An error code related to operation failure. Is 0 if no failure occured

    Structure of Results

    Results
  • XmlResponse
  • Messages
    • Text
    • ID
    • Severity
    • Category
  • Errors

    Error code Description
    1000 Unspecified error.

    Html to PDF Connector

    Use the PDF connector to create PDF files in your workflow. The connector uses Hypertext Markup Language (HTML) to define the layout of your PDF pages and fully supports using FlowScript.

    PDF Connector Settings Window

    Connector Output

    The output from the connector is a standard file record: [filename:the_file_name, data:binary_pdf_data].

    General Tips & Tricks

    In most use cases, you want to take control over the page breaks in your document. In order to achieve this, you need to specify a maximum length for all dynamic data in your workflow and specify the height of the elements which contains the dynamic data using the HTML DOM Style height property. If you do not to this, the document will grow with its content and you might get undesirable page breaks.

    Tip: Create a simple workflow with a PDF connector and a user step. In the user step, add a file gallery with the generated PDF document(s)
    and use the workflow for designing and debugging your page layouts.
    Another good practice is to use one machine step per page and then supply the previous PDF document (file record) as input parameter for the next PDF task (see Append a new page to an existing PDF below).

    Settings

    This chapter describes the available settings in the PDF connector.

    File Name

    This string defines the filename-key value of the target file record (see Connector Output).

    PDF Settings File Name

    Append new page to an existing PDF

    The connector optionally takes a file record containing a PDF file as an input variable. If suppied, the new page(s) created in the current machine step will be appended to the existing PDF file. The target variable will contain the merged PDF file as a standard file record.

    PDF Settings File Name

    To keep the file name from the previous PDF step, just re-use the filename value from the previous PDF file record:

    PDF Settings File Name

    Margins

    The margin size in points (one inch = 72 points).

    PDF Settings Margins

    Page Size

    <td valign="top">The default setting for page size is A4 format. <br/>
        The page size selector lets you choose from <br/>
        the most common page sizes.</td>
    <td><div style="left: 18px;">![PDF Settings Page Size](pdf_connectorSettingsPageSize.png){ width=100px }</div></td>

    Page Orientation

    Choose between Portrait and Landscape orientation. The default orientation is Portrait.

    PDF Settings Page Orientation

    Images / Signatures

    If you need to display images or signatures in your PDF pages, you need to make sure to have them available in your flow as file records. Signatures from the signature input provider is by default a file record with some extra fields and are supported by the PDF connector. The Images / Signatures field takes either a file record or a table of file records. The image below gives an example of two signature records being passed to the PDF connector.

    PDF Settings Images / Signatures

    In order to be able to differentiate between the images/signatures in the HTML code, you might need to override the filename component of the file records and give them unique and identifiable file names prior to passing them to the PDF connector. The image below shows a file name being overriden in an assignment step.

    PDF Settings HTML

    To position your image/signature in the document, the HTML IMG tag is used. I.e. <img src=your_file_name.jpg height=40>. See the image under the HTML headline below.

    HTML

    The document layout is defined using HTML. It's recommended to keep the code as simple as possible and build the layout using a bottom-up approach. If you are new to HTML, visit https://wordhtml.com/. However if you use the generated code directly you will get disappointed as there are some important aspects to keep in mind. Most importantly, you need to use percentages instead of absolute values for width. Keep the total width of your columns at about 95%.

    PDF Settings HTML

    NiceLabel Connector

    Configuration

    Set up of NiceLabel Automation to accept Flow request.

    1. Start NiceLabel Automation Builder and create new configuration:
      NiceLabel

    2. Select TCP/IP Server Trigger:
      NiceLabel

    3. Note Port number (will be used in Flow configuration):
      NiceLabel

    4. Go to Variable tab on TCP/IP Server:
      NiceLabel

    5. Select DataFileName from Internal Variables:
      NiceLabel

    6. Go to Action tab on TCP/IP Server:
      NiceLabel

    7. From All Action - select Run Command File:
      NiceLabel

    8. Select variable DataFileName as File name. Make sure that File Type is XML File:
      NiceLabel

    9. Save configuration to some suitable folder.
    10. Start Automation Manager and select saves configuration:
      NiceLabel

    11. Start configuration process:
      NiceLabel

    12. Configure NiceLabel connector in Flow. Use TCPIP port number from step 3:
      NiceLabel

    13. When request is send from Flow, trigger will execute it and status will be changed:
      NiceLabel

    14. Example flow looks like this:
      NiceLabel

    15. Send To Nice Label task is set up like this:
      NiceLabel

      Label file and printer need to be available on the NiceLabel server.

    Use the NiceLabel connector

    This instruction assumes that following programs/components are installed:

    1. Start NiceLabel DesignerPro and select to create new label. Select the printer and label size you are using in the Wizard that opens automatically.
      NiceLabel

    2. Add variables; It is important to set correct size for variables, if you send data that exceed the defined size, NiceLabel will fail to print the label.
      NiceLabel

      NiceLabel

    3. Note names of all variables:
      NiceLabel

    4. Design the label layout using created variables.
    1. To add a barcode do as follow:
      NiceLabel

    2. To add a text box do as follow:
      NiceLabel

    1. Save the label file to folder on server that runs NiceLabel Automation.
      NiceLabel

    2. Add Flow machine task and configure it as NiceLabel connector.
    3. Bind variables from the label to local variables in the flow. Variable name in NiceLabel are case sensitive. Label path is relative to NiceLabel automation server (local map on that server).
      NiceLabel

    4. Save flow and execute. Check status on NiceLabel Automation server.

    Printing

    Under printing, all connectors related to printing are listed, with information about configuration to setup the connector and how to use it.

    Custom Connector

    Flow has support for using third party .net assemblies. All public static methods with primitive types as arguments can be executed from a machine step in any type of workflows.

    Follow these steps to setup a custom connector:

    1. Run NovaCura.Flow.Connector.Wrapper.exe from your command line console.
      • It is located in Flow Designer program folder.
      • First argument is output connector dll name, example: CustomConnector.dll
      • Second argument is input assembly path.
      • If input assembly has dependencies to other assemblies those can be entered as arguments. For example: NovaCura.Flow.Connector.Wrapper.exe CustomConnector.dll CustomAssembly.dll CustomUtil.dll
    2. Copy output dll to the current studio version (%appdata%\{{version}}) and to bin/CustomConnectors* folder located in Server installation folder.

    3. Add a connector element to CustomConnectors.xml located in bin/CustomConnectors folder in Server installation folder.

       <!-- Change 'species' to a unique technical name --> 
       <!-- Change 'displayName' to a suitable display name --> 
       <!-- Change 'assemblyname' to the name of the output dll exluding .dll, in the example below the file is named CustomConnector.dll --> 
      <connector 
       species="custom_connector_name"
       displayName="DotNet API Custom Connector" 
       assemblyname="CustomConnector"
       type="NovaCura.Flow.Connector.Wrapper.ConnectorWrapper" 
       uitype="NovaCura.Flow.ApiConnector.UI.ApiConnectorUI" 
       uiassemblyname="NovaCura.Flow.ApiConnector.UI" /> 
    4. Start Flow Designer and verify that a new connector type with the previous specified display name exists in Connectors page under Environments when adding a new connector.

    5. Add the new connector and enter a suitable name.

    6. The new connector should now exist in all machine step configurations.

    Read/Write to Flow Environment

    The Flow Environment Connector can be used to read information from the flow 6 database, it can also write new data to said database.

    The Flow Environment Connector can be used to read information from the flow 6 database, it can also write new data to said database.

    Configuration

    Configuring Flow Connector
    Available Environment Operations

    Operations

    These are the functions that the connector supports, the flow connector can fetch data and write/update data to the flow 6 database. All operations either returns a table, row or a true/false boolean depending on if the operation was successful or not.

    Connector

    Language

    Properties

    Roles

    Users

    Create directory

    Creates all the directories at specified path.

    Parameters

    Parameter Description
    Path The path to create. Allow subdirectories on path will also be created if they do not exist.
    Allow Everyone to have full control over directory If set to True, all users have full control over directory. If set to False, only the user the Connector is running as can access the directory. Default True.

    Output

    Simple value containing the path to the newly created directory.

    Since

    6.0

    See also

    File System Connector

    Delete directory

    Deletes directory at provided path. Directory must be empty unless 'Also delete all subdirectories (and files)' is true.

    Parameters

    Parameter Description
    Path The path to delete.
    Also delete all subdirectories (and files) If set to True, all files and subdirectories will be deleted. If set to False, the directory must be empty in order to delete it.

    Output

    Simple value,'True' if directory was successfully deleted. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Delete files in directory

    Deletes all files in directory matching specified pattern.

    Parameters

    Parameter Description
    Path The path to the directory to delete files from. Path can be UNC path or local file path.
    Search pattern Pattern to match files against. Supports wildcards * and ? but not regular expressions. Default value "*".

    Output

    Simple value, number of files deleted.

    Since

    6.3

    See also

    File System Connector

    Check if directory exists

    Determains whether directory at specified path exists.

    Parameters

    Parameter Description
    Path The path to check.

    Output

    Simple value,'True' if directory exists. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Get directory modification times

    Gets a record containing directory modification times.

    Parameters

    Parameter Description
    Path The path to get modification times from.
    As UTC True to get the modification times in UTC

    Output

    Record with members 'CreationTime', 'LastWriteTime' and 'LastAccessTime'.

    Since

    6.0

    See also

    File System Connector

    Get all subdirectories of directory (full path)

    Gets the full path of all subdirectories of given directory.

    Parameters

    Parameter Description
    Path The path to get file names from. Path can be UNC path or local file path.
    Search pattern Pattern to match directories against. Supports wildcards * and ? but not regular expressions. Default value "*".
    Also get directories in subdirectories Specifies whether to also include directories in subdirectories of Path. Default value False.

    Output

    Table with column 'value' where each row is a full path to directory in given directory.

    Since

    6.0

    See also

    File System Connector

    Get name of all subdirectories of directory

    Gets the names of all directories in given directory.

    Parameters

    Parameter Description
    Path The path to get directory names from. Path can be UNC path or local file path.
    Search pattern Pattern to match directories against. Supports wildcards * and ? but not regular expressions.

    Output

    Table with column 'value' where each row is the name of a directory in given directory.

    Since

    6.0

    See also

    File System Connector

    Get name of files in directory

    Gets the names (including extension) of all files in given directory.

    Parameters

    Parameter Description
    Path The path to get file names from. Path can be UNC path or local file path.
    Search pattern Pattern to match files against. Supports wildcards * and ? but not regular expressions.

    Output

    Table with column 'value' where each row is the name of a file in given directory.

    Since

    6.0

    See also

    File System Connector

    Get files in directory (full path)

    Gets the full path of all files in given directory.

    Parameters

    Parameter Description
    Path The path to get file names from. Path can be UNC path or local file path.
    Search pattern Pattern to match files against. Supports wildcards * and ? but not regular expressions. Default value "*".
    Also get files in subdirectories Specifies whether to also include files in subdirectories of Path. Default value False.

    Output

    Table with column 'value' where each row is a full path to file in given directory.

    Since

    6.0

    See also

    File System Connector

    Move directory

    Moves a directory to a new location.

    Parameters

    Parameter Description
    Source path The path to directory to move. Path can be UNC path or local file path.
    Destination path The path to directory to move. Path can be UNC path or local file path.
    Overwrite destination directory if it exists If set to True and destination path already exists, it is overwritten. If set to false and destination path already exists, no move operation is done.

    Output

    Simple value, 'True' if directory was successfully moved. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Appends all lines to file

    Appends all provided lines to a file. If the file does not exist, it is created.

    Parameters

    Parameter Description
    Path Path to file to append lines to.
    Lines Lines to append.
    Code page Specifies which code page to write the lines in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    No output.

    Since

    6.0

    See also

    File System Connector

    Appends all text to file

    Appends all provided text to a file. If the file does not exist, it is created.

    Parameters

    Parameter Description
    Path Path to file to append text to.
    Text to append Text.
    Code page Specifies which code page to write the text in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    No output.

    Since

    6.0

    See also

    File System Connector

    Copy file

    Copies a file to a new location.

    Parameters

    Parameter Description
    Source The file to move. Path can be UNC path or local file path.
    Destination The location of the file. Path can be UNC path or local file path.
    Overwrite if destination file exists If set to True and destination file already exists, it is overwritten. If set to false and file already exists, no copy operation is done.

    Output

    Simple value, 'True' if file was successfully copied. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Delete file

    Deletes file at provided path.

    Parameters

    Parameter Description
    Path The path to file to delete.

    Output

    Simple value, 'True' if file was successfully deleted. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Check if file exists

    Determains whether file at specified path exists.

    Parameters

    Parameter Description
    Path The path to the file to check. Path can be UNC path or local file path.

    Output

    Simple value, 'True' if file exists. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Get files modification times

    Gets a record containing files modification times.

    Parameters

    Parameter Description
    Path The path to get modification times from.
    As UTC True to get the modification times in UTC.

    Output

    Record with members 'CreationTime', 'LastWriteTime' and 'LastAccessTime'

    Since

    6.0

    See also

    File System Connector

    Move file

    Moves a file to a new location.

    Parameters

    Parameter Description
    Source The file to move. Path can be UNC path or local file path.
    Destination The location of the file. Path can be UNC path or local file path.
    Overwrite destination file if it exists If set to True and destination file already exists, it is overwritten. If set to false and file already exists, no move operation is done.

    Output

    Simple value, 'True' if file was successfully moved. 'False' otherwise.

    Since

    6.0

    See also

    File System Connector

    Read all bytes from file

    Reads all bytes from a file and puts it a Table variable. Reading too large files can cause performance issues.

    Parameters

    Parameter Description
    Path Path to source file to read lines from.

    Output

    Table with column 'value' where each row is one byte from source file.

    Since

    6.0

    See also

    File System Connector

    Read all lines from file

    Reads all lines from a file and puts it a Table variable. Reading too large files can cause performance issues.

    Parameters

    Parameter Description
    Path Path to source file to read lines from.
    Code page Specifies which code page to read the file in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    Table with column 'value' where each row is one line in source file.

    Since

    6.0

    See also

    File System Connector

    Read all text from file

    Reads all text from a file and puts it a simple value variable. Reading too large files can cause performance issues.

    Parameters

    Parameter Description
    Path Path to source file to read text from.
    Code page Specifies which code page to read the file in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    Simple value variable (string), with all content of file in it.

    Since

    6.0

    See also

    File System Connector

    Write all bytes to file

    Writes all provided bytes to a file. If the file already exist, it is overwritten.

    Parameters

    Parameter Description
    Path Path to file to append text to.
    Bytes A Table containing one column, value, with numeric values (byte, 0-255).

    Output

    No output.

    Since

    6.0

    See also

    File System Connector

    Write all lines to file

    Writes all provided lines to a file. If the file already exist, it is overwritten..

    Parameters

    Parameter Description
    Path Path to file to write lines to.
    Lines Lines to write.
    Code page Specifies which code page to write the lines in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    No output.

    Since

    6.0

    See also

    File System Connector

    Write all text to file

    Writes all provided text to a file. If the file already exist, it is overwritten.

    Parameters

    Parameter Description
    Path Path to file to write text to.
    Text to write Text.
    Code page Specifies which code page to write the text in. Default 65001 (UTF-8 with BOM). Use 0 for UTF-8 without BOM.

    Output

    No output.

    Since

    6.1.6

    See also

    File System Connector

    Write stream to file

    Writes the content of a Flow variable that contains a binary stream to a file. This can for instance be used to write data from a camera input to the file system.

    Parameters

    Parameter Description
    Path Path to file to write stream to.
    Source stream Stream to write. Must be a Flow variable.

    Output

    No output.

    Since

    6.2

    See also

    File System Connector

    Add single file to zip

    Compresses a single file and adds it to a zip file.

    Parameters

    Parameter Description
    File File to add to archive.
    Path to zip file Zip file to add file to.
    Password Optional password to the zip file.
    Replace mode Specifies what to do if a specific file already exists in the archive.
    Compression level Specifies the level of compression, valid values are 1-9 where 9 indicates highest level of compression (and slowest). Default value is 6.

    Output

    Simple value, 'True' if operation was successfully. 'False' otherwise.

    Since

    6.3

    See also

    File System Connector

    Add stream to zip

    Compresses the content of a Flow variable that contains a binary stream. This can for instance be used to compress data from a camera input.

    Parameters

    Parameter Description
    Stream Stream to read data from.
    Filename for stream in zip file The name of the file in the archive the content of the stream should be written to.
    Path to zip file Zip file to add stream content to.
    Password Optional password to the zip file.
    Replace mode Specifies what to do if a specific file already exists in the archive.
    Compression level Specifies the level of compression, valid values are 1-9 where 9 indicates highest level of compression (and slowest). Default value is 6.

    Output

    Simple value, 'True' if operation was successfully. 'False' otherwise.

    Since

    6.3

    See also

    File System Connector

    Extract files from zip

    Extracts all files from a zip file which matches provided mask.

    Parameters

    Parameter Description
    Path to zip file Zip file to extract from.
    Destination path Path where to extract files to. If file or directory already exists at destination path, it is skipped (not overwritten). The directory should exist before this operation is called.
    Filter Filet to use when filtering items in archive. Example "*.txt".
    Password Optional password to the zip file.

    Output

    Simple value, 'True' if operation was successfully. 'False' otherwise.

    Since

    6.3

    See also

    File System Connector

    Extract file to stream

    Extracts a single file to a stream. The entire file will be loaded into memory, so do not use this operation with large files.

    Parameters

    Parameter Description
    Path to zip file Zip file to extract from.
    Filename The name of the file in the archive to extract.
    Password Optional password to the zip file.

    Output

    Simple value, read-only binary stream trinket.

    Since

    6.3

    See also

    File System Connector

    Add folder to zip file

    Zips all files and subfolders in a folder into a zip file.

    Parameters

    Parameter Description
    Path Path to read files and folders from.
    Path to zip file Zip file to add folder content to.
    Password Optional password to the zip file.
    Replace mode Specifies what to do if a specific file already exists in the archive.
    Compression level Specifies the level of compression, valid values are 1-9 where 9 indicates highest level of compression (and slowest). Default value is 6.

    Output

    Simple value, 'True' if operation was successfully. 'False' otherwise.

    Since

    6.3

    See also

    File System Connector

    File System

    The File System connector can be used to perform directory and file operations on any file system which the Flow Server can access.

    Configuration

    File System connector should be configured to run as a specific user. If not configured, it will run as the same user as the Flow Server is running as.

    Operations

    Directory operations
    Check if directory exists
    Create directory
    Delete
    Delete files in directory
    Get all subdirectories of directory (full path)
    Get directory modification times
    Get files in directory (full path)
    Get name of all subdirectories of directory
    Get name of files in directory
    Move directory
    File operations
    Append all text to file
    Appends all lines to file
    Check if file exists
    Copy file
    Delete file
    Get files modification times
    Move file
    Read all bytes from file
    Read all lines from file
    Read all text from file
    Write all bytes to file
    Write all lines to file
    Write all text to file
    Write stream to file
    Zip operations
    Add folder to zip file
    Add single file to zip
    Add stream to file
    Extract file to stream
    Append all text to file

    Generate Text Connector

    The Generate Text Connector can be used to output text either to a file or over the network via HTTP or TCP. Flow variables can be used to compose the text to write.

    Configuration

    No configuration is required.

    Google API

    The Google API Connector can be used to access Googles public APIs. Currently only URL Shortener API is supported.

    Configuration

    The Google Connector currently does not use any API that requires authentication, so no configuration is required.

    Table Operations

    Configuration

    Generate Xml Data

    The Generate Xml Data Connector can be used to write Flow variables to an xml file.

    Configuration

    No configuration needed.

    Utility

    Under utility, all utility related connectors are listed, with information about configuration to setup the connector and how to use it.

    Connectors

    Branding

    Branding is only available in the Enterprise version of Flow.

    Logotype

    Change the logotype shown in the left corner of the Flow clients. Click in the up load icon and choose a new logotype.

    Color theme

    With Color Themes is it possible to change colors on the client banner, workflow buttons and the header text.

    Add a new theme by clicking on Add and enter a name of the theme, change the colors and save theme. Activate the theme that should be used by Flow.


    Create your own color palette and use as backgrund colors for the workflows.


    With the color picker is it possible to change the colors. Click on the color that should be changed and either enter RGB, hex code or choose a color from the color palette.
    The workflow colors will apply in the palette where to choose workflow color from.

    If workflow color 1 is changed will all workflows using that color be changed to the new color, and the same with the other workflow colors.

    BarTender 2016

    The BarTender connector can be used to integrate with BarTender 2016 R8, typically to print BarTender documents.

    32-bit version of BarTender 2016 R8 Automation Edition or Enterprise Automation Edition needs to be installed on the same machine as Flow Server.

    Configuration

    Example of usage, embedded data

    This is a an example of printing the label "Caterpillar\Master label.btw" which can be found among the example labels installed with BarTender.

    The label looks like this in BarTender:


    It can be configured with embedded data, 1L, 3S, 4S and so on.

    If you select this BarTender document in Flow Studio it will look like this:


    As you can see, the Embedded data is set to Custom record, and this is where you can control the data input to the BarTender document.

    If we provide it with some random data:


    And then print the labels, in this case to an image preview, the output will look like this:


    Example of usage, text database

    This is a an example of printing the label "EU Energy Labels\EU Energy Television A 2010-1062-2011.btw" which can be found among the example labels installed with BarTender.

    The label looks like this in BarTender:


    It takes a text file as data input. Example file looks like this:

    Efficiency;Annual Power Consumption;Power Consumption;Power Switch;Diagonal Inches;Diagonal Centimeters
    0.28;10000;80;1;32;81
    0.40;22222;120;0;32;81
    0.50;23456;140;0;27;69
    0.70;90009;160;0;27;69
    0.85;90809;30;1;42;107
    0.95;90909;40;1;42;107
    1.10;99999;50;0;20;51

    So seven (one per line) labels will be printed.

    If you select this BarTender document in Flow Studio it will look like this:


    As you can see, the Text file database (Text file 1) is expanded, and this is where you can control the data input to the BarTender document. You can for instance select another text file than 'Television Data A.txt'.

    You can also map data from a Flow table to the document. Let's do that. Consider the following flow table:


    So mapping this to the BarTender document can be done like this:


    It is important that the data types matches, for instance will sending in a text to any of these members generate an error. You can see the data type in BarTender. Unfortunately there is no way to know the types from Flow Studio. If you choose to map to a Flow Table, the file ('Television Data A.txt' in this case) will be ignored.

    If you then print the labels, in this case to an image preview, the output will look like this:


    The values does of course not make sense, but hopefully this has given you an idea how to map your data to BarTender documents.

    Microsoft Active Directory

    The Microsoft Active Directory connector can be used to perform various Active Directory related operations.

    Configuration

    Business systems

    Database

    The database connector is used to connect to various databases. Supported databases are Oracle, Microsoft SQL Server, IBM DB2 iSeries, IBM DB2, MySql Server and IFS Applications.

    Configuration

    Security

    The database connects directly to the database using different kinds of authentication protocols according to what kind of database you connect to.

    Microsoft Dynamics CRM

    The Dynamics CRM Connector is used to interact with Microsoft Dynamics CRM.

    Configuration

    Google API

    The Google API Connector can be used to access Googles public APIs. Currently only URL Shortener API is supported.

    Configuration

    The Google Connector currently does not use any API that requires authentication, so no configuration is required.

    IFS Applications 10 API

    The IFS Applications 10 API connector can be used to execute procedures (including New__, Modify__ and Remove__) and functions in IFS Applications 9.

    Configuration

    IFS Applications 9 API

    The IFS Applications 9 API connector can be used to execute procedures (including New__, Modify__ and Remove__) and functions in IFS Applications 9.

    Configuration

    Infor M3 REST API

    The Infor M3 REST API Connector can be used to consume M3-API-REST bulk API.

    Configuration

    Infor M3 API

    The Infor M3 API Connector is used to integrate with Infor M3.

    Configuration

    Configuring Maximo Connector

    First step is connector configuration in Flow Studio (see picture below)

    Connector Configuration

    Communication with Web Services is always over the HTTP protocol.

    The following parameters are configurable in the configuration:

    IBM Maximo (old)

    The IBM Maximo (old) Connector can be used to access IBM Maximo. This connector is obselete. Use IBM Maximo API instead.

    Configuration

    Oracle Primavera

    The Oracle Primavera Connector can be used to access an Oracle Primavera P6.

    Configuration

    SAP BAPI

    The SAP BAPI Connector can be used to execute any published BAPI (standard or custom) in an SAP ABAP system, including HANA-based systems. Resulting table(s) are available as Flow variables.

    The SAP BAPI connector require Microsoft C++ Runtime DLLs version 10.0 (contained in the Microsoft Visual C++ 2010 Redistributables). MSI installers for these runtimes can be obtained from here. This must be installed on the machine running Flow Server.

    Configuration

    Go to the Environment/Connectors section in Flow Studio and Add a new connector. For parameter details, see below.


    Personal user configuration

    If Global runtime user is not specified, SAP username must be configured on the Flow user. For general information on Flow users, see here.


    Authorization requirements for SAP users connecting from Flow

    Authorization object S_RFC containing the following : - Activity 16 (Execute) - RFC_NAME: SYST, RFCPING, RFC1, RFC_GET_FUNCTION_INTERFACE, RFCH, RFC_GET_UNICODE_STRUCTURE - RFC_TYPE: FUGR and FUNC

    On top of this, the S_RFC authorization must also contain the function group and the function module being called, as well as any authorization needed to pass authorization checks in any of the called programs, including authorization for the applicable organization level (for example purchasing organization).

    Security considerations

    The SAP BAPI Connector is using the standard SAP authorization concept. The connector always logs in to the SAP system through RFC with a user that is set-up and active in the SAP system as a dialog, system or service user. Any authorization object checks will be performed the same way it would be done if the user logged in using SAP GUI.

    For more information on RFC security, see SAP's official RFC security guide.

    Using the SAP Connector for creating workflows

    For details on design-time usage of the SAP connector, see here.

    Microsoft SharePoint

    The Microsoft SharePoint Connector can be used to interact with a SharePoint installation.

    Configuration

    Authorization schemes

    Authorization schemes can be applied to operations to set what kind of authorizations are required to use the operation. When there are schemes defined they can be applied to operations simply by clicking the "ADD" button:


    You can also apply an authorization on all children of a given container by selecting the container and then right clicking on it and selecting "Authorization->Apply authorization to all children".

    But first you have to define the schemes. There are three kinds of schemes that can be used.

    OAuth2

    OAuth2 is currently mainly for documentation purposes. There is no requirement to configure this at the moment (6.7). If you import a swagger specification, that specification can contain this information, and it is good to keep track of. It certainly does not hurt to specify OAuth2.

    API Key

    REST API:s often require an API key. Typically it is sent either via a query parameter or as a header. You can specify this yourself on the operation, adding the query parameter or header manually. There certainly are cases when this is a good idea. One example is when you want the api key to be associated with the Flow user. You can then set the api key per flow user and in machine step do like this:


    You can also set the parameter as a 'Constant', effectively hiding it from the workflow designer. But then the key is hard coded in the connector, which of course could be problematic.

    If you want the API key to be configurable in connector configuration you have to apply an API key scheme on applicable operations. Start by creating a new API key:


    Provide a Name for the API Key. This is how you want to identify the key. You can provide description for documentation purposes, but that is not required. "API key name" is required and is what the REST API expects the parameter name to be. Finally you have to define whether the key is sent as a query parameter or as a header.


    Once the API key has been defined it can be applied to operations as described above.

    Finally, after creating the connector, API keys can be set in connector config.


    The key will then be applied to all operations that uses the scheme in runtime.

    Basic authorization

    Another common way for an API to authorize requests is by the use of The 'Basic' Authentication Scheme.

    If the API requires this you must add that scheme to the project and apply it to all operations that should use it. There is nothing more to configure in REST Project Tool, all configuration is done in Flow Studio.

    Either you set the username and password in the connector config:


    Or you can leave it empty and define it per Flow user:


    Enumerations

    Enumerations can be used in models to limit the possible values a workflow designer can assign to a member of a model.

    Consider for instance an API for 'orders' in a 'store'. We got the operations 'Add new order', 'Update order' and 'Delete order'. Let's look at the 'Order' model:

    'status' is of type 'Enum':

    And if we look at that enum you can see what possible values that member can have:

    Members of the enum can be added and deleted as needed (circled area above).

    Let's look at an operation using the 'Order' model, 'Update order'

    It uses 'PATCH' to only update certain members, accepting a body of model 'Order'.

    Let's look how this will look in Flow Studio:


    When using 'Constant' as mapping to 'status' only the members of the enum are available. You can still mess it up by selecting 'Variable' as mapping and providing an invalid value in the passed variable. But with the usage of enums you can at least guide the person using the connector in Flow Studio in what kind of values are expected.

    Getting started

    To create a REST connector you go to Environment -> Connectors -> Add and select Type "REST Service".

    Provide a 'Name' and click on "EDIT" to get started. You will also be required to provide a base address before you can save the connector.

    When you click on "EDIT" you will open a tool where you'll define the connector.


    Let's walk through all the properties.

    General

    Containers

    The main purpose of containers are to help you organize the operations in a logical way. You do not need to specify any containers, but it usually make senses to use them. Containers can contain operations and other containers. They can also define 'Standard headers' that can be applied to all sub-containers and operations. Containers can also define a 'Path' which is appended to the 'Base path' (described above). The final 'Path' of an operation is the concatenation of all parent containers 'Path' (can be overridden).

    Operations

    In the 'Operations' section you can add and delete operations of the connector. This is most likely the first thing you will do when starting a new REST Connector project.

    Standard headers

    In this section you can specify entity, general, request and response headers that should be applied to all operations of connector. You can for instance set that all operations must send 'Content-Type: application/json'. Sub-containers and operations can always override the header.

    Global output

    'Global outputs' is used to define output parameters that can be reused on multiple operations.


    A typical use case is when an API returns some kind of error that is always of the same format. The API might return some data depending on the operation with http status code 200. But in case of error it could still return http status code 200, but a different model, containing information about the error. Although each operation has different models in case of success, in the case of failure could be the same.


    Note that priority has been set to a number higher than '1' (in this case '10'). The REST connector will try all defined outputs of given http status code until it succeeds, in the order of 'Priority', starting with the one w