Versioning Components in Clarity LIMS

The sections below provide two best practice strategies for versioning lab work components in Clarity LIMS.

Strategy A

The following table summarizes Strategy A versioning rules for workflow items.

Entity

In Test Environment

In Production Environment

Master Step

Not versioned with a number

Not versioned with a number

Protocol Step

Not versioned with a number

Not versioned with a number

Protocol

Versioned with Prod version.Test version

Not versioned with a number

Workflow

Versioned with Prod version.Test version.Revision

Versioned with Prod version

Workflow A

Protocol A

Step A

 

 

Step B

 

 

Step C
 

Protocol B

Step D
   

Step E

 

 

Step F
 

Protocol C

Step G

Assumption: You create a workflow in the Test environment.

Recommendation:

• The workflow does not yet exist in the Production environment. Production version is 0.
• As this is the first version in the Test environment, version the workflow and protocols as 0.1, but not the steps / master steps. Test version is 0.1.

Results:

Workflow A - 0.1

Protocol A - 0.1

Step A

 

 

Step B

 

 

Step C
 

Protocol B - 0.1

Step D
   

Step E

 

 

Step F
 

Protocol C - 0.1

Step G

Assumption: You made a configuration error in Step B and need to replace it.

Recommendation:

1. Rename Step B to Step B – deprecated.
2. Recreate Step B with new configuration.
3. Rename Protocol A – 0.1 to Protocol A – 0.1 – deprecated.
4. Recreate Protocol A, naming it Protocol A – 0.2.
5. Archive Workflow A – 0.1.
6. Rebuild Workflow A. For the workflow name (version number), use the number of the most recently created protocol—in this case, Workflow A – 0.2.

Results:

Workflow A - 0.2

Protocol A - 0.2

Step A

 

 

Step B

 

 

Step C
 

Protocol B - 0.1

Step D
   

Step E

 

 

Step F
 

Protocol C - 0.1

Step G

Assumption: You made a configuration error in Step E and need to replace it.

Recommendation:

1. Rename Step E to Step E – deprecated.
2. Recreate Step E with new configuration.
3. Rename Protocol B – 0.1 to Protocol B – 0.1 – deprecated.
4. Recreate Protocol B, naming it Protocol B – 0.2.
5. Archive Workflow A – 0.2.
6. Rebuild Workflow A. For the version number, use the number of the most recently created protocol. In this case, because version 0.2 of the workflow already exists, name it Workflow A – 0.2.1 to indicate the first revision of 0.2.

Results:

Workflow A - 0.2.1

Protocol A - 0.2

Step A

 

 

Step B

 

 

Step C
 

Protocol B - 0.2

Step D
   

Step E

 

 

Step F
 

Protocol C - 0.1

Step G

Assumption: You made a configuration error in Step C and need to replace it.

Recommendation:

1. Rename Step C to Step C – deprecated.
2. Recreate Step C with new configuration.
3. Rename Protocol A – 0.2 to Protocol A – 0.2 – deprecated.
4. Recreate Protocol A, calling it Protocol A – 0.3.
5. Archive Workflow A – 0.2.1.
6. Rebuild Workflow A, naming it with the largest number of its protocols—in this case Workflow A – 0.3.

Results:

Workflow A - 0.3

Protocol A - 0.3

Step A

 

 

Step B

 

 

Step C
 

Protocol B - 0.2

Step D
   

Step E

 

 

Step F
 

Protocol C - 0.1

Step G

Assumption: The workflow is ready to be moved from the Test environment to the Production environment.

Recommendation:

1. Slice the workflow and its components out of the Test environment using the config-slicer tool.
2. Rename the workflow in the XML-based slice to be version 1.
3. Rename the protocols in the XML-based slice, removing version numbers.
4. Slice the workflow into the Production environment.

Results:

Workflow A - 1

Protocol A

Step A

 

 

Step B

 

 

Step C
 

Protocol B

Step D
   

Step E

 

 

Step F
 

Protocol C

Step G

Assumption: Step C is no longer required.

Recommendation in Test:

1. Rename Protocol A – 0.3 to Protocol A – 0.3 – deprecated.
2. Recreate Protocol A, calling it Protocol A – 0.4.
3. Archive Workflow A – 0.3.
4. Rebuild Workflow A, naming it with the largest number of its protocols—in this case Workflow A – 0.4.

Recommendation in Production:

1. Slice the workflow and its components out of the Test environment using the config-slicer tool.
2. Rename the workflow in the XML-based slice to be 2.
3. Rename the protocols in the XML-based slice removing version numbers.
4. Slice the workflow into the Production environment.

Results in Test:

Workflow A – 0.4

Protocol A – 0.4

Step A

 

 

Step B
 

Protocol B – 0.2

Step D
   

Step E

 

 

Step F

 

 

 
 

Protocol C – 0.1

Step G

Results in Production:

Workflow A – 2

Protocol A

Step A

 

 

Step B
 

Protocol B

Step D
   

Step E

 

 

Step F

 

 

 
 

Protocol C

Step G

Strategy B

The following table summarizes Strategy B versioning rules for workflow items.

Entity

In Test Environment

In Production Environment

Master Step

Versioned with a number

Versioned with a number

Protocol Step

Versioned with a number

Versioned with a number

Protocol

Versioned with Major version.Minor Version

Versioned with Major version.Minor version

Workflow

Versioned with Major version.Minor version.Revision (if necessary)

Versioned with Prod version.Test version.Revision (if necessary)

Workflow A

Protocol A

Step A

 

 

Step B

 

 

Step C
 

Protocol B

Step D
   

Step E

 

 

Step F
 

Protocol C

Step G

Assumption: You have revised a test workflow, but it is likely to undergo several iterations before it goes live.

Recommendation:

• As the workflow does exist in Production, with version 1, this new version becomes 2.
• As this is the first version in Test, version everything as 2.1.

Results:

Workflow A - 2.1

Protocol A - 2 .1

Step A - 2 .1

 

 

Step B - 2.1

 

 

Step C - 2.1
 

Protocol B - 2.1

Step D - 2.1
   

Step E - 2.1

 

 

Step F - 2.1
 

Protocol C - 2.1

Step G - 2.1

Assumption: You have made a mistake in configuration and need to replace Step B.

Recommendation:

1. Recreate Step B with new configuration, leading to version 2.2.
2. Rename Protocol A – 2.1 to Protocol A – 2.1 – deprecated.
3. Recreate Protocol A, naming it Protocol A – 2.2.
4. Archive Workflow A – 2.1.
5. Rebuild Workflow A, naming it with the largest number of its protocols, in this case Workflow A – 2.2.

Results:

Workflow A - 2.2

Protocol A - 2 .2

Step A - 2 .1

 

 

Step B - 2.2

 

 

Step C - 2.1
 

Protocol B - 2.1

Step D - 2.1
   

Step E - 2.1

 

 

Step F - 2.1
 

Protocol C - 2.1

Step G - 2.1

Assumption: You have made a mistake in configuration and need to replace Step E.

Recommendation:

1. Recreate Step E with new configuration, leading to version 2.2.
2. Rename Protocol B – 2.1 to Protocol B – 2.1 – deprecated.
3. Recreate Protocol B, naming it Protocol B – 2.2.
4. Archive Workflow A – 2.2.
5. Rebuild Workflow A, naming it with the largest number of its protocols. As version 2.2 of the workflow already exists, and this is the first revision of the workflow, the new workflow name is Workflow A – 2.2.1. This indicates that it is the first revision of 2.2.

Results:

Workflow A - 2.2.1

Protocol A - 2 .2

Step A - 2 .1

 

 

Step B - 2.2

 

 

Step C - 2.1
 

Protocol B - 2.2

Step D - 2.1
   

Step E - 2.2

 

 

Step F - 2.1
 

Protocol C - 2.1

Step G - 2.1

Assumption: You have made a mistake in configuration and need to replace Step C.

Recommendation:

1. Recreate Step C with new configuration, leading to version 2.2.
2. Rename Protocol A – 2.2 to Protocol A – 2.2 – deprecated.
3. Recreate Protocol A, naming it Protocol A – 2.3.
4. Archive Workflow A – 2.2.1.
5. Rebuild Workflow A, naming it with the largest number of its protocols—in this case Workflow A – 2.3.

Results:

Workflow A - 2.3

Protocol A - 2 .3

Step A - 2 .1

 

 

Step B - 2.2

 

 

Step C - 2.2
 

Protocol B - 2.2

Step D - 2.1
   

Step E - 2.2

 

 

Step F - 2.1
 

Protocol C - 2.1

Step G - 2.1

Assumption: The workflow is ready to be moved from the Test environment to the Production environment.

Recommendation:

1. Slice the workflow and its components out of the Test system using the config-slicer tool.
2. Slice the Workflow into the Production environment.

Results:

Workflow A - 2.3

Protocol A - 2 .3

Step A - 2 .1

 

 

Step B - 2.2

 

 

Step C - 2.2
 

Protocol B - 2.2

Step D - 2.1
   

Step E - 2.2

 

 

Step F - 2.1
 

Protocol C - 2.1

Step G - 2.1

Assumption: Step C is no longer required.

Recommendation in Test:

1. Rename Protocol A – 2.3 to Protocol A – 2.3 – deprecated.
2. Recreate Protocol A, calling it Protocol A – 2.4.
3. Archive Workflow A – 2.3.
4. Rebuild Workflow A, naming it with the largest number of its protocols—in this case Workflow A – 2.4.

Recommendation in Production:

1. Slice the Workflow and its components out of the Test system using the config-slicer tool.
2. Slice the Workflow into the Production system.

Results:

Workflow A - 2.4

Protocol A - 2 .4

Step A - 2 .1

 

 

Step B - 2.2
 

Protocol B - 2.2

Step D - 2.1
   

Step E - 2.2

 

 

Step F - 2.1

 

 

 
 

Protocol C - 2.1

Step G - 2.1