Show navigation

The eCopy Scriptable Workflows

The eCopy Scriptable Workflows let you build custom functionality workflows in C# for a wide variety of workflow behavior.

Important! 

In order to get the most out of it, you must have basic level C# programming skills to compose your new tailor-made workflow. A development environment and familiarity with the eCopy ShareScan Connector SDK are NOT required for usage/proper functionality.

If you already used Database Lookup Extender's C# expression feature, you will find it somewhat similar to Scriptable Workflows. Built-in IntelliSense makes script-writing very intuitive.

If you want to use this workflow with the Email and folder watching service, you need to create a workflow/profile in such a way that it does not require user interaction (express).

By default, each Scriptable profile is in Express mode (can be selected during Watcher configuration) and no controls are placed on the workflow form. This behavior will only be apparent at runtime.

Configuring the workflow

Follow the steps below to configure your Scriptable Workflows. For detailed configuration options, see the Workflow scheme topic.

1. In the Administration Console, select the Scriptable Workflows tab to open the Scriptable Workflows pane. Alternatively, click the Edit workflow scripts button in the Scripting pane.
   
   
2. Click the Create new workflow button. Select an existing profile or specify the name for a new one in the dropdown area.
   Click Save.
   
3. Write or modify each of the four workflow scripts in the script editor window and also configure the workflow profile settings (document services etc.) on the Settings pane.
   
   
4. Click the Save Current Profile or Save Current Profile As button.
5. The newly created scriptable profile is displayed under the My workflows section of the Scriptable Workflows pane.
   

Note: 

The default profile cannot be modified or overwritten, therefore you must use the Save Current Profile As button or right-click the default profile in the My workflows section and select Save As from the pop-up menu.

Workflow Configuration Options

When configuring the workflow, the order of the workflow items is displayed on the left of the Configure workflow (Scriptable) window.

This order dynamically changes as you modify the Workflow section options of the profile's Settings pane. If none of the options are selected, the default order of the workflow items is the following:

Note: 

The workflow items with a lock icon do not have a scriptable feature, they can only be enabled or disabled in the connector Settings pane.

• Workflow button: click this to open the profile's Settings pane to modify how the workflow items are arranged.
• Preview Form: shows where the Preview form appears among the workflow items. You can only hide it if both User data entry During scan and Background processing options are enabled.
• Document Service Form: for this item to be shown in the workflow, at least one document service (Debooklet Extender, Form Overlay Extender, etc.) must be enabled. The position of the Document service form(s) in the item list depends on how you configure their order in the Order of Operation dialog. If two or more Document services are added, their location depends on whether you place them before or after the Scanning with Preview SCREEN shown divider line.
• Initialize Form Script: click this button to open the Initialize Form tab. This tab allows you to modify the default code for form initialization.
• Scriptable Form: click this button to open the Form designer tab. It has a Design View and a Code View section. This tab allows you to modify (both graphically and by coding) how the Scriptable form will look like.
• Validate Form Script: click this button to open the Validate Form Data tab. This tab allows you to modify the default code for form validation.
• Store Result Script: click this button to open the Store Workflow Results tab. This tab allows you to modify the default code for storing workflow results.
• Redirect Form: shows the Redirect form among the workflow items. This item always appears at the end of the workflow process and you can avoid it by enabling the Bypass redirect screen option.

You can configure the following Workflow options:

• User data entry: During scan
• Background Processing: Enabled
• Preview Screen: Hide
• Bypass redirect screen: Enabled
• Logoff automatically: Enabled
  

Note: 

The options below and their combinations are not new functionalities (in terms of ShareScan workflow behavior). They are detailed to illustrate what the effect of these settings are for the visual representation of Scriptable Workflows. All scenarios are detailed without any Document Services added.

User data entry: During scan ENABLED

In this configuration scenario, the Preview Form is displayed between the Validate Form Script and Store result Script sections.

Background Processing ENABLED

If this additional setting is configured, the workflow item order does not change, as compared to when only the User data entry: During scan option is enabled. The only difference is that the output document creation and storing operation is performed in the background, therefore the user is not required to wait at the device (until the Redirect screen is displayed). It is recommended to enable the Background processing mode.

Hide Preview Screen ENABLED

With the Hide Preview screen enabled, the Preview Form disappears from among the workflow items.

Bypass redirect screen ENABLED

Enabling the Bypass redirect screen option removes the Redirect form from among the workflow items.

Logoff automatically ENABLED

Enabling this option does not change how the workflow items are arranged.

Only Hide Preview Screen DISABLED

If you disable the Hide Preview Screen option as compared to the Bypass redirect screen ENABLED step, the workflow items are rearranged to have the Preview Form item between the Validate Form Script and Store result Script items.