2022 June Release

Properties of FSCOWSWF@1.1001 Permanent link for this heading

Type

Property

Name

string

actinstparticipantdisp

Representation of the Workflow Participant

string

activityclassname

Object Class

string

activityname

Name

Configuration

clientdomconf

Open Web Services Workflow

string

contencryptionname

Readable name for used content encryption

string

contobjaddress

The id of the content object

ComponentObject

cpcpmobileappmappingapplication

Virtual Application for Mapping with Mobile Application

string[]

cpcpmobileappmappinginputparams

Dictionary with Additional Values for Mobile Application

string

cpcpmobileappmappingmobileapplication

Reference for Mobile Application

CPMobileAppMapping[]

cpmobileappmapping

Mapping for Virtual Application to Mobile Application

string[]

executeexpr

Expression to Replace Virtual Application

string[]

instobjectlist

Objects Concerned

string

instobjectlistobjaddress

Concerned Objects List Object Address

WorkItemEntry[]

menusubentries

Submenus

string

objchangedby

Last Change by

string

objclassname

Object Class

string

objcontentextension

File Extension of Content

string

objcontentmimetype

MIME Type of Content

string

objcontenturl

URL for Content

string

objiconurl

URL for Symbol

string

objoverviewurl

URL for PDF Overview

string

objpreviewurl

URL for Preview

string

objthumburl

URL for Thumbnail

boolean

TV_WS_EXECUTION

Executed Using a Webservice

string

wiamaction

Application

string

wiamobjaddress

Object

dictionary

wiamparams

Additional Parameters for Client

string

wiamreference

Reference for Mobile App

WorkItemApplicationMapping[]

wieapplmapping

Mapping for Application to Object

boolean

wieexecuted

Work Item Executed

boolean

wiehasgui

Work Item uses GUI

string

wieiconurl

URL for Symbol

string

wiemenuaction

Menu Action

boolean

wiemust

Must be executed

string

wiename

Work Item Name

string

wiestate

Work Item State

integer

wllcount

Worklist List Entry Count

string

wlliconurl

URL for Symbol

string

wllname

Worklist List Name

string

wllreference

Worklist List Reference

string

worklistobjaddress

Worklist Object Address


Representation of the Workflow Participant (FSCOWSWF@1.1001:actinstparticipantdisp) Permanent link for this heading

The representation of the workflow participant.

string FSCOWSWF@1.1001:actinstparticipantdisp

Additional Information


Object Class (FSCOWSWF@1.1001:activityclassname) Permanent link for this heading

The name of the class of the activity

string FSCOWSWF@1.1001:activityclassname

Additional Information


Name (FSCOWSWF@1.1001:activityname) Permanent link for this heading

The name of the activity

string FSCOWSWF@1.1001:activityname

Additional Information


Open Web Services Workflow (FSCOWSWF@1.1001:clientdomconf) Permanent link for this heading

Configuration FSCOWSWF@1.1001:clientdomconf

Additional Information


Readable name for used content encryption (FSCOWSWF@1.1001:contencryptionname) Permanent link for this heading

The user readable name of the used content encryption

string FSCOWSWF@1.1001:contencryptionname

Additional Information


The id of the content object (FSCOWSWF@1.1001:contobjaddress) Permanent link for this heading

The id of the content object

string FSCOWSWF@1.1001:contobjaddress

Additional Information


Virtual Application for Mapping with Mobile Application (FSCOWSWF@1.1001:cpcpmobileappmappingapplication) Permanent link for this heading

Can be an action (to override all mapped virtual applications, e.g.: OpenObject) or the direct application which should be implemented.

ComponentObject FSCOWSWF@1.1001:cpcpmobileappmappingapplication not null

Additional Information


Dictionary with Additional Values for Mobile Application (FSCOWSWF@1.1001:cpcpmobileappmappinginputparams) Permanent link for this heading

Defines a dictionary to transport data to the mobile application.
Either return some global configurations or access the actual activity through transaction variables:

string[] FSCOWSWF@1.1001:cpcpmobileappmappinginputparams (
  object application)

Local Scope: dictionary
Returns: dictionary

Name

Description

application

Additional Information


Reference for Mobile Application (FSCOWSWF@1.1001:cpcpmobileappmappingmobileapplication) Permanent link for this heading

The reference of the view that should be shown on the device.
  • "Empty" - nothing is shown in the app
  • "OpenObject" - the document of the object may be opened in an app on the device
  • "RemarkObject" - a view for entering a remark is shown in the app on the device
  • "SignObject" - a view for signing the object is shown in the app on the device
  • "UploadFiles" - a view for uploading files is shown in the app on the device

string FSCOWSWF@1.1001:cpcpmobileappmappingmobileapplication

Additional Information


Mapping for Virtual Application to Mobile Application (FSCOWSWF@1.1001:cpmobileappmapping) Permanent link for this heading

This customization point is used to support the web service WSExecuteWorkItem. When a work item is implemented by a virtual application, it can not be executed regularly.
This customization point can provide a mapping for a vApp with complimentary execution done by a web service.
Only simple vApps can be re-implemented using this technique.
The customization point can define inputparams which will be evaluated by WSGetWorkItems.
(see WorkItemEntry with WorkItemApplicationMapping and wiamparams)
These parameters can then be used by the web service client to do some processing.
When the web service client has finished its work, the web service method WSExecuteWorkItem might be called.
The parameter dictionary executeparams by WSExecuteWorkItem will then again be passed as parameters to this customization point executeexpr.
So this customization point can provide parameters for a client and do again some work with other parameters provided by a client.
The client can further be steered by defining a special view via mobileapplication which can be interpreted by a client to know what is the intended work.

The Fabasoft Apps (Fabasoft Cloud, Fabasoft) currently support these views to perform actions on the device:
  • Empty - nothing is shown in the app
    No inputparams can be sent to the device. Nothing will be passed to the executeexpr.
    If you want that the work item should not appear in the app at all you may hide it by using IsWorkItemCalledByWebservice in its precondition. Here is a sample:
    
    activity ConfTravelExpenseReport {
      ...
      step OpenContentTravelExpenseReport required multiple {
        execute = OpenContent;
        precond = expression {
          // hide this work item in the mobile worklist app
          return !activity.IsWorkItemCalledByWebservice();
        }
      }
      ...
    }
    
  • OpenObject - the document of the object may be opened in an app on the device
    No inputparams can be sent to the device. Nothing will be passed to the executeexpr.
    There is a default configuration available for OpenObject and OpenContentObjectApp.

  • RemarkObject - a view for entering a remark is shown in the app on the device
    A dictionary with the following members may be provided as inputparams:
    • boolean mustremark - if true the user must enter a remark on the device.
    • content remarks - the remarks that should be displayed on the device in a format as stored in boremarks

    In the executeexpr you will find the following parameters in the global scope:
    • string remark - The remark entered by the user on the device.
    You may use #TV.WFVAR_THIS.boenterremark = ::remark; to store the remark on the object.

  • SignObject - a view for signing the object is shown in the app on the device
    A dictionary with the following members may be provided as inputparams (You may use EvaluateSignatureSettings to get these parameters from the current signature configuration.):
    • SignatureVerification verification - can define modifications for forms.
      The Fabasoft Worklist Apps only support SIGNVER_PASSWORD by showing and transmitting a password field.
    • boolean useremark - if true the user may enter a remark on the device.
    • boolean mustremark - if true the user must enter a remark on the device.
    • SignatureList[] signatures - a list of signatures already assigned to the object.
    In the executeexpr you will find the following parameters in the global scope:
    • string password - The password entered by the user on the device
    • string remark - The remark entered by the user on the device
    • PDFSignature[] pdfsignatures - The list of pdf signatures entered by the user on the device
    You may use coouser.SignObjectWithType(#TV.WFVAR_THIS, <signtype>, ::remark, ::password, ::pdfsignatures); to sign the object in the executeexpr.

  • UploadFiles - a view for uploading files is shown in the app on the device
    A dictionary with the following members may be provided as inputparams:
    • sys_object - when not specified, the main object of the process will be used for performing the upload
    • sys_view - when not specified, the default view according to CMIS implementation will be used for performing the upload.
      Only relevant when object for which the upload will be performed is an instance of CompoundObject.
    The executeexpr will contain no extra information, as the actual uploads will already be performed by the app on the device.

    Depending on the object class of the main object of the process it will be available to upload just a single file or a bunch of files.
    Following actions may be available:
    • Browse local files
    • Take photo by camera
    • Take video by camera
    • Paste from clipboard
    • Create textfile
    When the object for which the view is opened is an instance of A progress bar is shown for each file being uploaded.
    The view will be blocking and can only be left after successfully uploading all selected files or by canceling the view.
    Note: Cancel the view will not undo successful uploads.



Sample configuration:

customize CPMobileAppMapping <OpenObject> {
  mobileapplication = "OpenObject";
  inputparams = expression {
  }
  executeexpr = expression {
  }
}
customize CPMobileAppMapping <ObjectSignAcceptApproval> {
  mobileapplication = "SignObject";
  inputparams = expression {
    dictionary dict = coouser.EvaluateSignatureSettings(#TV.WFVAR_THIS, #SIGN_DIGITAL);
    if (#TV.WFVAR_ACTIVITY.actinstremark) {
      dict.actinstremark = #TV.WFVAR_ACTIVITY.actinstremark;
    }
    return dict;
  }
  executeexpr = expression {
    coouser.SignObjectWithType(#TV.WFVAR_THIS, #SIGN_DIGITAL, ::remark, ::password, ::pdfsignatures);
  }
}
customize CPMobileAppMapping<AddRemark> {
  mobileapplication = "RemarkObject";
  inputparams = expression {
    return {
      useremark: true,
      mustremark: true,
      remarks: #TV.WFVAR_THIS.boremarks
    };
  }
  executeexpr = expression {
    if (::remark) {
      #TV.WFVAR_THIS.ObjectLock(true, true);
      #TV.WFVAR_THIS.boenterremark = ::remark;
    }
  }
}
customize CPMobileAppMapping <ObjectWFUpload> {
  mobileapplication = "UploadFiles";
  inputparams = expression {
    if (#TV.WFVAR_THIS.HasAttribute(cootx, #content)) {
      // do not provide sys_view for content object
      return;
    }
    // provide first drop target
    Object[] attrdefs = #TV.WFVAR_THIS.GetDropTargets();
    object viewattrdef = (count(attrdefs) == 1 && #TV.WFVAR_THIS.CheckSetAccess(cootx, attrdefs)) ? attrdefs[0] : null;
    if (viewattrdef) {
      return {
        sys_view : viewattrdef.GetAddress()
      }
    }
  }
}

unique CPMobileAppMapping[] FSCOWSWF@1.1001:cpmobileappmapping

Additional Information


Expression to Replace Virtual Application (FSCOWSWF@1.1001:executeexpr) Permanent link for this heading

Define the expression to be used with CPMobileAppMapping. Needed to declare the local scope variables.

string[] FSCOWSWF@1.1001:executeexpr (
  object[] object,
  ProcessInstance process,
  ActivityInstance activity,
  integer workitem)

Name

Description

object

the main object, may be a list when process operates on multiple objects at once

process

the whole process object

activity

the current activity

workitem

the index of the current work item

Additional Information


Objects Concerned (FSCOWSWF@1.1001:instobjectlist) Permanent link for this heading

The list of objects concerned by the activity. Will represent either actinstobject, actinstobjects or actinstprocinst

string[] FSCOWSWF@1.1001:instobjectlist

Additional Information


Concerned Objects List Object Address (FSCOWSWF@1.1001:instobjectlistobjaddress) Permanent link for this heading

The object address of the list of objects concerned by the activity, see instobjectlist.

string FSCOWSWF@1.1001:instobjectlistobjaddress

Additional Information


Submenus (FSCOWSWF@1.1001:menusubentries) Permanent link for this heading

unique WorkItemEntry[] FSCOWSWF@1.1001:menusubentries

Additional Information


Last Change by (FSCOWSWF@1.1001:objchangedby) Permanent link for this heading

The name of the user who changed the object

string FSCOWSWF@1.1001:objchangedby

Additional Information


Object Class (FSCOWSWF@1.1001:objclassname) Permanent link for this heading

The name of the class

string FSCOWSWF@1.1001:objclassname

Additional Information


File Extension of Content (FSCOWSWF@1.1001:objcontentextension) Permanent link for this heading

The file extension of the content

string FSCOWSWF@1.1001:objcontentextension

Additional Information


MIME Type of Content (FSCOWSWF@1.1001:objcontentmimetype) Permanent link for this heading

The mime type of the content

string FSCOWSWF@1.1001:objcontentmimetype

Additional Information


URL for Content (FSCOWSWF@1.1001:objcontenturl) Permanent link for this heading

The url to the content of the object

string FSCOWSWF@1.1001:objcontenturl

Additional Information


URL for Symbol (FSCOWSWF@1.1001:objiconurl) Permanent link for this heading

The url of the icon

string FSCOWSWF@1.1001:objiconurl

Additional Information


URL for PDF Overview (FSCOWSWF@1.1001:objoverviewurl) Permanent link for this heading

The url of the pdf overview

string FSCOWSWF@1.1001:objoverviewurl

Additional Information


URL for Preview (FSCOWSWF@1.1001:objpreviewurl) Permanent link for this heading

The url of the large preview image

string FSCOWSWF@1.1001:objpreviewurl

Additional Information


URL for Thumbnail (FSCOWSWF@1.1001:objthumburl) Permanent link for this heading

The url of the thumbnail image

string FSCOWSWF@1.1001:objthumburl

Additional Information


Executed Using a Webservice (FSCOWSWF@1.1001:TV_WS_EXECUTION) Permanent link for this heading

boolean FSCOWSWF@1.1001:TV_WS_EXECUTION readonly(ui)

Additional Information


Application (FSCOWSWF@1.1001:wiamaction) Permanent link for this heading

string FSCOWSWF@1.1001:wiamaction

Additional Information


Object (FSCOWSWF@1.1001:wiamobjaddress) Permanent link for this heading

string FSCOWSWF@1.1001:wiamobjaddress

Additional Information


Additional Parameters for Client (FSCOWSWF@1.1001:wiamparams) Permanent link for this heading

dictionary FSCOWSWF@1.1001:wiamparams

Additional Information


Reference for Mobile App (FSCOWSWF@1.1001:wiamreference) Permanent link for this heading

string FSCOWSWF@1.1001:wiamreference

Additional Information


Mapping for Application to Object (FSCOWSWF@1.1001:wieapplmapping) Permanent link for this heading

The list of mappings with application and a reference for a mobile app complementary and the object to use for each application

unique WorkItemApplicationMapping[] FSCOWSWF@1.1001:wieapplmapping

Additional Information


Work Item Executed (FSCOWSWF@1.1001:wieexecuted) Permanent link for this heading

If the work item has already been executed

boolean FSCOWSWF@1.1001:wieexecuted

Additional Information


Work Item uses GUI (FSCOWSWF@1.1001:wiehasgui) Permanent link for this heading

True when the work item has a gui action (vApp) or false when it can be executed directly (expression, script, action)

boolean FSCOWSWF@1.1001:wiehasgui

Additional Information


URL for Symbol (FSCOWSWF@1.1001:wieiconurl) Permanent link for this heading

The url of the icon used for the work item

string FSCOWSWF@1.1001:wieiconurl

Additional Information


Menu Action (FSCOWSWF@1.1001:wiemenuaction) Permanent link for this heading

The action of the menu for the dynamic menus from the activity

string FSCOWSWF@1.1001:wiemenuaction

Additional Information


Must be executed (FSCOWSWF@1.1001:wiemust) Permanent link for this heading

If the work item must be executed

boolean FSCOWSWF@1.1001:wiemust

Additional Information


Work Item Name (FSCOWSWF@1.1001:wiename) Permanent link for this heading

The name of the work item

string FSCOWSWF@1.1001:wiename

Additional Information


Work Item State (FSCOWSWF@1.1001:wiestate) Permanent link for this heading

The state of the work item ("Multiple", "Completes Activity", ...)

string FSCOWSWF@1.1001:wiestate

Additional Information


Worklist List Entry Count (FSCOWSWF@1.1001:wllcount) Permanent link for this heading

The count of entries within the worklist list.

integer FSCOWSWF@1.1001:wllcount

Additional Information


URL for Symbol (FSCOWSWF@1.1001:wlliconurl) Permanent link for this heading

The url of the icon used for the worklist list.

string FSCOWSWF@1.1001:wlliconurl

Additional Information


Worklist List Name (FSCOWSWF@1.1001:wllname) Permanent link for this heading

An translated string for the worklist list that can be shown on the UI

string FSCOWSWF@1.1001:wllname

Additional Information


Worklist List Reference (FSCOWSWF@1.1001:wllreference) Permanent link for this heading

An identifier for a particular worklist list (like To Do, Tasks, etc.)

string FSCOWSWF@1.1001:wllreference

Additional Information


Worklist Object Address (FSCOWSWF@1.1001:worklistobjaddress) Permanent link for this heading

The object address of the worklist

string FSCOWSWF@1.1001:worklistobjaddress

Additional Information