T25-2019 for BIOVIA Workbook

Using the Symyx.Workflow.Utility.exe to manage Workflows in Workbook

Program

BIOVIA ELN 6.9.x, BIOVIA Workbook 2016, 2017, 2018, 2019

Operating System

All operating systems supported for BIOVIA Workbook.

Description

The “Symyx.Workflow.Utility” is designed to help Administrators manage workflows for individual experiments (documents). The utility does not affect the use of the Workflow Designer or the workflow portions of the Vault Administration Console.

The utility allows Administrators to display the workflow information about an experiment and alter that information. Types of alterations include: moving an experiment to a new workflow stage, removing the current workflow instance, adding a workflow instance, and cleaning up the workflow tasks and security on an experiment. This utility can only work on checked-in experiments.

The utility is located by default at “C:\Program Files (x86)\BIOVIA\Vault\Utilities” and contains a usage help screen as shown below:

To use the utility you must always define the user, password, and server and the user must be an administrative user in Workbook.

Below are some example statements:

List the Workflow instances for an experiment:

>Symyx.Workflow.Utility.exe -server xxx.com -user xxx -pass xxx -oi Document.565fe46f-6fc3-466f-9f17-5e1bbd652de4 -ali

About to list workflow instances...

Found '1' workflow instances

Workflow instance

     Name: RegressionWF_Test_V2019

     Instance ID: 722413a8-81cc-4692-9a16-4a0657171d76

     Current stage: Start

     Object id: Document.565fe46f-6fc3-466f-9f17-5e1bbd652de4

     Object title: test_1_1

     Object Creator: intg.local\qc-admin

     Object date: 05/09/2018 12:29:53 -07:00

             Event name: symyxTransitionActivity1

…

List the Workflow Definitions for the whole system:

>Symyx.Workflow.Utility.exe -server -server xxx.com -user xxx -pass xxx -ald

Listing workflow definitions...

Found 6 workflow definitions

Workflow definition

     ID: WorkflowDef.18849b39-6bb2-42e3-a636-54e10ef5038b

     Title: TestWorkflow_2

     Description: Test

     Type: Symyx.Workflow.NewWorkflow, TestWorkflow_2, Version=19.1.1.3296, Culture=neutral, PublicKeyToken=null

Workflow definition

    ID: WorkflowDef.1bd21ce1-5e8a-4983-b931-66aeb7e21092

     Title: RegressionWF_Test_V2019

     Description: RegressionWF_Test_V2019

     Type: Symyx.Workflow.NewWorkflow, RegressionWF_Test_V2019, Version=19.1.1.3296, Culture=neutral, PublicKeyToken=null

Workflow definition

…

Remove the workflow from an experiment:

>Symyx.Workflow.Utility.exe -server -server xxx. com -user xxx -pass xxx -oi Document.565fe46f-6fc3-466f-9f17-5e1bbd652de4 -wi 722413a8-81cc-4692-9a16-4a0657171d76 -ar

About to remove from workflow...

Removing from workflow...

Workflow ID 722413a8-81cc-4692-9a16-4a0657171d76 removed from workflow

Symyx Workflow utility finished.

Add a new workflow to an experiment:

>Symyx.Workflow.Utility.exe -server -server xxx. com -user xxx -pass xxx -oi Document.565fe46f-6fc3-466f-9f17-5e1bbd652de4 -dt RegressionWF_Test_V2019 -aa

About to add to workflow...

Object Document.565fe46f-6fc3-466f-9f17-5e1bbd652de4 added to workflow 0173a39a-c715-456d-9de2-462d6819e29d

Symyx Workflow utility finished.

Note: If error occurs, the maximum number of activations may need to increase in the Vault Administration Console’s Workbook Definition properties screen.

Move the experiment from one stage to another within the current workflow:

>Symyx.Workflow.Utility.exe -server -server xxx. com -user xxx -pass xxx -oi Document.565fe46f-6fc3-466f-9f17-5e1bbd652de4 -wi 0173a39a-c715-456d-9de2-462d6819e29d -ws Review1 -am

   About to move to stage...

   Called async move to stage for object Document.565fe46f-6fc3-466f-9f17-5e1bbd652de4 in workflow 0173a39a-c715-456d-9de2-462d6819e29d to stage Review1

   To see if it transitioned, list the instance with -oi 0173a39a-c715-456d-9de2-462d6819e29d

   Symyx Workflow utility finished