Logilab ELN - Protocol Templates

1.1.1 Creating Protocol Template

Each protocol will include the purpose of the test, any pre-requisites that need to be done before testing, and the acceptance criteria for the test. Each protocol is made up of a series of sections. Each section can have the following:

Steps: Series of steps to carry out a procedure/test.

Text: Type the purpose of the test, any pre-requisites required etc. for the test.

Image: Insert reference image.

Attachments: Enables attach files related to the step in the protocol.

Labsheet: Enables insert a labsheet to the step.

Resource: Enables add resources from inventory for the protocol.

Well plate: Enables add a well plate to the step.

Multi-Step Procedure: Helps to add a procedure that has a series of steps.

Chemical Drawing: Enables add chemical formula. Works like the chemical formula section in the lab sheet.

Grid: Helps add tables to the protocol step.

Signature: Enables capture e-signature of the current user.

Checklist: Enables checklists to add input to the test step.

To create a protocol template, follow these steps:

1. On the main menu, click and then click Protocol Templates. The Protocol Templates screen appears as shown in the figure:

FIGURE: Protocol Templates Screen

You can edit a protocol that is in the Created status. You can edit the protocol name, category, and visibility of the protocol. You cannot edit a protocol in any other status.

1. Click NEW. The Create New Protocoldialog appears as shown in the figure:

FIGURE: Create New Protocol Dialog

2. In the Protocol Name field, type the name for the protocol.
3. In the Category field, type template category if any.
4. Under Template Visibility, set template access to Site/ Only Me / Project Team.
5. Click SUBMIT. The screen appears as shown in the figure:

FIGURE: Adding Abstract to the Protocol

6. By default, the Steps tab appears. Under Abstract, you can add abstract/summary of the protocol.

Note: Other tabs in the protocol:

Resources: This tab enables you to add resources / materials and equipements required for  this protocol. You can also create a materia at run-time.

References:This tab enables you to add reference links, citations, protocols, Attachments, files, SOPs etc to the protocol.

Results: Enables to add / import results from the sections/steps in the protocol. You can add editors as you add in the Steps tab to add results.

7. Once you add an abstract, you can add a section to the protocol and type a name for the section. A section can have multiple steps.
8. Click. A new section is added and prompts for a name. Type name for the section.

FIGURE: New Section Added to the Protocol 

9. Click to add a new step to the section. The screen appears as shown in the figure:

FIGURE: Adding New Step to the Protocol Section

10. In the Step field, type a name for the step.

1.1.2 Adding Text Editor to the step

1. Click and then select any one of the following to add content to the step:

11. For example, select Text, and then click ADD. The text editor is inserted and appears as shown in the figure:

12. Type step procedure.
13. Use the following common text editor features to add, edit and format text content in each step:

Feature	Description
Bold/Italics/Underline	Format text using bold or italics
	Click to view more font options
Subscript	Use to add subscript
Superscript	Use to add superscript
Strikethrough	Use to strike through the text
Font Family	Use to change font
Font Size	Use to change font size
Text Color	Use to change text color
Background Color	Use to change background color
Inline Class	Select text, click and then select Code,Highlighted, orTransparent to highlight the text
Inline Style	Select text, click and then select Big Red orSmall Blue to highlight the text in large red font or small blue font
Clear Formatting	Use to clear formatting
	Click to view more paragraph alignment options
Align Left	Use to align selected text to the left
Align Center	Use to align selected text center
Align Right	Use to align selected text to the right
Justify	Use to justify selected text
Ordered List	Use to create a numbered list
Unordered List	Use to create a bulleted list
Paragraph Format	Use to change the format of the text using predefined styles
Paragraph Style	Use to change the format or highlight the text using predefined styles
Line Height	Use to change space between selected text lines
Decrease Indent	Use to decrease indent
Increase Indent	Use to increase indent
Quote	Use to select and highlight the text
Link	Use to insert a link or URL
Insert Table	Use to insert a table
Special Characters	Use to add special characters
Undo & Redo	Use to undo and redo actions
Timer	Add a timer to calculate the time taken to do a certain task, process, or step.
Textbox	Use to add text, number, date, datetime, or color. You can add a small, medium, or large textbox.
Radio Button	Use to add a radio button.
Dropdown	Use to add a dropdown list. You can add a small, medium, or large dropdown.
Checkbox	Use to add a checkbox to the step.

Table: 6 - Creating a Protocol Step –Using Common Text Editor Features

1.1.3 Inserting Image to the step

1. Move the cursor in the step where you want to insert the image and then click. In the ADDdialog select Image as shown in the figure and then click ADD:

FIGURE: Inserting Image to the Protocol Step

The Image editor is inserted and appears as shown in the figure:

FIGURE: Image Editor

14. Drag and drop the image or Click Browseand select the image.
15. Alternatively, click Linkto link images from folders within the ELN.
16. The image appears as shown in the figure:`

FIGURE: Image Added to the Protocol Step

17. Mouse over and use the options to change views, edit, download, view in new tab and delete the image.

FIGURE: Using Full View / Half View Options

18. Clickand then click Full Viewoption to view the image in full screen. The image appears as shown in the figure:

FIGURE: Image Added to the Protocol Step - Full View

1.1.4 Adding an Attachment

To add an attachment to the protocol step, follow these steps:

1. Move the cursor in the step where you want to insert the attachment and then click.  In the ADDdialog select Attachment as shown in the figure and the click ADD:

FIGURE: Add Dialog Showing Selecting Attachment Option

The attachment editor appears as shown in the figure:

FIGURE: Attachment Editor

You can browse and select a file from your local storage to attach / Drag and drop the file.

Or link files within the ELN.

Attach a file from your local storage:

2. Drag and drop the file / click Browseand locate the file from your local storage.

Link files within ELN.

3. Click Link. The dialog appears as shown in the figure:

FIGURE: Link Attachment Dialog

You can see two tabs. Sheet and Protocol.

19. Select a tab. You can see the list of folders on the left side and list of files on the right side in the selected tab.
20. Click to select a file and then click INSERT LINK. The link is inserted as shown in the figure:

FIGURE: File Attached / Linked

1.1.5 Adding a Labsheet

To add labsheet to the protocol step, follow these steps:

1. Move the cursor in the step where you want to insert the labsheet and then click. In the ADDdialog select Labsheet as shown in the figure and the click ADD:

FIGURE: Add Dialog Showing Labsheet Option

The Labsheet editor is added as shown in the figure:

FIGURE: Added Labsheet Editor

21. Clickto import a labsheet. The Sheet Templates dialog appears as shown in the figure:

FIGURE: Sheet Templates Dialog

22. Select a lab sheet and then click IMPORT. The imported labsheet appears as shown in the figure:

FIGURE: Imported Labsheet

1.1.6 Adding Resource

The Resource editor helps you to do the following to the protocol step:

• Add Inventory
• Create Material
• Add Equipment

To add resource, follow these steps:

1. Move the cursor in the step where you want to add resource and then click. In the ADDdialog select Resource as shown in the figure and the click ADD:

FIGURE: Add Dialog Showing Resource Option

Resource editor is added as shown in the figure:

FIGURE: Resource Editor Added

23. Click ADD INENTORY. The Add Resourcedialog appears as shown in the figure:

FIGURE: Add Resource Dialog 

24. Resource added in the Inventory master appears here. Click to select the resources to add and then click INSERT MATERIAL.

The selected inventories are added to the protocol step and appears as shown in the figure:

FIGURE: Inventory Added to the Protocol Step

You can see the inventory added and available quantity in the inventory after adding the inventory to the protocol step.

25. In the Action column, clickto delete the inventory added.

Same way, add material and equipment to the protocol.

1.1.7 Adding Well Plate

The Well Plate editor helps you to add well plate to the protocol step.

To add a well plate, follow these steps:

1. Move the cursor in the step where you want to add well plate and then click. In the ADDdialog select Well plate, in the Plate size field, select plate size as shown in the figure and then click ADD:

FIGURE: Add Dialog Showing Well Plate Option

The Well Plate editor is added as shown in the figure:

FIGURE: Well plate Added

Click on a well id to view its properties as shown in the above figure. You can select sample type to store, volume and result. The well plates are color coded. Based on the selected sample type the color of the well plate appears as shown in the above figure.

26. Click to view the well plate in list view as shown in the figure:

FIGURE: Well Plate - List View

downarrow
27. In the list view, you can fill/update well plate details.
28. Click to import well plate data from Excel file.   
29. Click to export well plate data to the local storage in Excel format.

1.1.8 Adding Multi - Step Procedure

The multi step procedure editor helps you to add multi step procedure to the protocol step. When a step in the protocol section has sub-steps to be carried to complete the main step, you can use the multi-step procedure editor.

To add a multi-step procedure, follow these steps:

1. Move the cursor in the step where you want to add multi step procedure and then click. In the ADDdialog select Multi-Step Procedure as shown in the figure and then click ADD:

FIGURE: Add Dialog Showing Multi-Step Procedure Option

The Multi-Step Procedure editor is added as shown in the figure: Follow the onscreen instruction to add steps to the multi-step procedure:

FIGURE: Creating a Multi-Step Procedure

1.1.9 Adding Chemical Diagram

The Chemical Diagram editor helps you to add chemical diagram to the protocol step.

To add a chemical diagram, follow these steps:

1. Move the cursor in the step where you want to add diagram and then click. In the ADDdialog select Chemical Diagram as shown in the figure and then click ADD:

FIGURE: Add Dialog Showing Chemical Diagram Option

The Chemical Diagram editor is added as shown in the figure:

FIGURE: Chemical Diagram Editor

30. In the text box, type the name of the diagram. Using the tools, draw the chemical diagram as shown in the above figure.

1.1.10 Adding Grid / Table

The grid editor helps you to add tables to the protocol step. The grid editor enables you to do the following:

• Add a table with specified number of rows and columns.
• Define size of each column: Small / Medium / Large
• Define data type of each column: Text / Numeric / Date / Boolean

To add a grid, follow these steps:

1. Move the cursor in the step where you want to add the grid and then click. In the ADDdialog select Grid as shown in the figure and then click ADD:

FIGURE: Add Dialog Showing Grid Option

31. In the Grid sizefield, select the size: Rows X Column. If you select Custom, then you can define the number of rows and columns to the grid.

The grid editor is added as shown in the figure:

FIGURE: Grid Editor

32. Click to edit the columns in the grid.

FIGURE: Grid Editor

33. Follow the onscreen instructions to type column name and datatype.
34. Click SUBMIT. The table is added and appears as shown in the figure:

FIGURE: Table Added to the Step

35. Click to add a new row to the table.
36. Click to import data to the table.
37. Right-click a row and use the options: move the row above / below / delete / insert row above / insert row below as shown in the figure:

FIGURE: Using Right-Click Options

1.1.11 Adding/Defining Digital signature to the Protocol Step

1.1.11.1 Adding Your Signature

You can add your digital signature to a protocol step. To do so, follow these steps:

1. Move the cursor in the step where you want to add the signature and then click. In the ADDdialog select Signature as shown in the figure and then click ADD:

FIGURE: Add Dialog Showing Signature Option

The Signature editor is added as shown in the figure:

38. Click ADD SIGNATUREto add your signature. The E-Signature dialog appears a s shown in the figure:

FIGURE: E-Signature Dialog

39. You can add your signature by typing your Password, Commentand by checking the Yes, I Agree
40. Click SUBMIT. Your signature is added and appears as shown in the figure:

FIGURE: E-Signature Added

1.1.11.2 Defining Signature

You can define a signature to demand a user signature in a protocol step. For example, if you want the QA Manager to approve the protocol step, then you can define a signature as follows:

1. In the Signature editor, click DEFINE SIGNATUREas shown in the figure:

FIGURE: Using the Define Signature Option

The Define Signature dialog appears as shown in the figure:

FIGURE: Define Signature Dialog

41. In the User Rolefield, select a role and then click SUBMIT. The signature is defined and appears as shown in the figure:

FIGURE: Signature Defined

At runtime, to complete the step the selected user must add their E-signature. You can define multiple signatures for a step.

1.1.12 Adding Checklist

To create a checklist, follow these steps:

1. Move the cursor in the step where you want to insert the checklist items and then click. In the ADDdialog select Checklist as shown in the figure and the click ADD:

FIGURE: Add Dialog Showing Selecting Checklist Option

Theappears as shown in the figure: Follow the onscreen instructions to create the checklist.

FIGURE: Adding Checklist to the Protocol Step

1.1.13 Tagging

You can tag a user in the protocol step. The user will receive a notification regarding the same. To tag user, follow these steps:

1. Move the cursor where you want to add the tag in the protocol step.
2. Type @. List of users in ELN workflow appears as shown in the figure:

FIGURE: Tagging Users to the Protocol Step

42. Select a user to tag. The tagged username appears in blue as shown in the figure:

FIGURE: Tagged Users

 And the tagged users will receive a notification regarding the same.

1.1.14 Link Samples and Projects to the Protocol Step

To link samples and projects to the protocol step, follow these steps:

1. Move the cursor where you want to link the sample in the protocol step.
2. Type #s to link sample. Or type #p to link projects. List of samples/projects in ELN appears as shown in the figure:

FIGURE: Linking Samples and Projects to the Protocol Step

1.1.15 Add Section/Step/Text Above / Below

Once you finish designing the step, you can do any of the following:

• Click to save the protocol.
• Each section, step and the editor will display the following options when you mouse over:

• Click to add a section /step/editor above.
• Click to add a section /step/editor below.
• Click to view the section/step/editor in full screen.
• Click to copy/duplicate the section/step/editor. You can duplicate the section/step/editor and edit them as required.
• Click to delete the section/step/editor.

1.1.16 Approve Protocol

1. The protocol created should be approved for further use. To approve the protocol, open the protocol, click to select Approveand then click SUBMIT as shown in the figure:

FIGURE: Approving Protocol

1.1.17 Exporting Protocol / Selected Sections to JSON and PDF

1. Click and then click Export Json to export the protocol into Json format. You can also select sections in the protocol to export to Json.
2. Click and then click Export PDF to export the protocol into PDF format. You can also select sections in the protocol to export to PDF format. The Export dialog appears as shown in the figure:

FIGURE: Export PDF Dialog

44. Click to view print preview as shown in the figure:

FIGURE: Print Preview Dialog

45. You can preview the pages by scrolling-down and then click Printto print the pages.

1.1.18 Exporting Sections to Another Protocol

You can export selected sections in the protocol and export them to another protocol. To export sections to another protocol, follow these steps:

1. Click the checkbox that appears near the section name to select a section. You can select multiple sections to export.
2. Clickand then click Export Section as shown in the figure.

FIGURE: Exporting the Protocol Section

The Export Section dialog appears as shown in the figure:

FIGURE: Export Section Dialog

46. Select a protocol to which you want to export the selected sections.
47. Click EXPORT. The sections are exported to the selected protocol.

1.1.19 Import Json

The import Json option helps you to import a Json file to a protocol. You can import a Json file to create protocol. To do so, follow these steps:

1. Open the protocol where you want to import the Json file.
2. For example, here I have created a new protocol and imported a Json file to import content.
3. In the new protocol screen, click and then click Import Jsonas shown in the figure:

FIGURE: Importing Json file

50. In the Opendialog, locate and select the JSON Source File and then click Open as shown in the figure:

FIGURE: Importing the JSON File

You can see the Json file is imported and the imported sections and steps appears as shown in the figure:

FIGURE: Imported Sections and Steps

1.1.20 Import Section

To import a section, follow these steps:

1. Open the protocol. Click and then click Import Section as shown in the figure:

FIGURE: Importing Section

 The Import Section dialog appears as shown in the figure:

FIGURE: Import Section Dialog

51. You can see the list of protocols in the dialog. Select a protocol and then click IMPORT. List of sections in the selected protocol appears as shown in the figure:

FIGURE: Sections Dialog

Select the sections to import and then click IMPORT SECTIONS. You can see the sections imported to the protocol as shown in the figure:

FIGURE: Sections Imported

You can edit and rearrange the sections in the protocol.

1.1.21 Navigation

The Table of Contents panel that appears on the left side of the protocol screen lists the sections, steps, and editors in the protocol.

You can see the section name, list of steps in each section and list of editors in each step appears as shown in the figure:

FIGURE: Navigating Through Protocol Sections / Steps / Editors

1. Under Table of Contents, click to jump to a section / step /editor.
2. Click go to the top / beginning of the protocol.

1.1.22 Adding Comments to Protocol Steps

Logilab ELN enables you to add and reply to comments to the protocol steps. You can tag users in the comment. The users can reply to your comments.

To add comment to the protocol step, follow these steps:

1. Click that appears near a as shown in the figure:  

FIGURE: Adding Comment to Protocol Step

52. The Commentsdialog appears. Click Start a conversation as shown in the figure:

53. The chat dialog appears. Type @and select a user to tag. Type your comments and then click Post as shown in the above figure.

FIGURE: Comments Added and REPLY Option

1.1 Rearrange Protocol Sections, Steps and Editors

1.1.1 Rearrange Sections

Once created, you can rearrange the protocol sections, steps, and editors.

To rearrange, follow these steps:

1. Open the protocol to rearrange. In the Table of Contents, click as shown in the figure:

FIGURE: Table of Contents

The Rearrange dialog appears as shown in the figure:

FIGURE: Rearranging Sections in a Protocol

By Default, the Rearrange Sections option is selected, and you can see the list of sections in the protocol.

54. Drag a section and drop it to a new place in the list to rearrange the sections.

1.1.2 Rearrange Steps

1. Click to select the Rearrange Step List of steps in the protocol appears as shown in the figure:

FIGURE: Rearrange Steps Within Sections

55. You can see the list of steps in each section. Drag and drop the steps to rearrange the steps within the section.

Note: You can rearrange the steps only within the section and you cannot move a step to another section.

1.1.3 Rearrange Editors

1. Click to select the Rearrange Editor List of editors in each step in the protocol appears as shown in the figure:

FIGURE: Rearrange Steps Within Sections

56. You can see the list of editors in each step. Drag and drop the editors to rearrange the editors within the step.

Note: You can rearrangethe editors only within the step and you cannot move an editor to another step.

1.1.4 Edit Template

You can edit template details that are in the Created status. Click Edit to edit template name, category and template visibility for templates in Created status. When you select a template in Created status, the EDIT option will be enabled as shown in the figure:

FIGURE: Editing Template Details