Skip to main content

Adding Images to instructions

Where can images be embedded?

Images can be embedded into any of the following types of instruction fields:

  • Protocol level instructions - configured in the Protocol Details panel. In L7 MES Protocol level instructions will appear at the top of the Step before any custom field. In L7 LIMS Protocol level instructions will appear in the Protocol Details panel.

  • Instruction custom field - custom field belonging to the Type "Instructions". In L7 MES instruction fields can be added anywhere in the EBR and are independent of user specified input values. Not supported in L7 LIMS, except in document view.

  • Field level instructions - added as a field detail to any type of custom field. In L7 MES, these instructions will appear before the input value. However, if the field belongs to a sub-step table, then the instructions will render as a tooltip that is only displayed when the cursor is hovered over the field. Not supported in L7 LIMS, except in document view.

  • Workflow level instructions - configured in the Workflow Details panel. In L7 MES Workflow level instructions will appear in the Procedures & Outline panel. Workflow level instructions are not supported in L7 LIMS.

Note

Instructions are based in HTML, the rich text editor will automatically convert your content to HTML. If you prefer to write your own HTML and paste it into the instruction fields, then you may do so.

How to add images to instructions

Images can be added using the instruction field rich text editor once the image file has been uploaded to L7 Data app.

First upload the image to L7 Data app

  1. Go to L7 Data app

  2. Click + Upload Files

  3. Select the image file to upload (instruction field supports jpg, png, gif, and tiff files)

  4. Optionally add a Desc and File Tags

  5. Click Upload

Tip

To view the image, click it's name from the L7 Data app landing page, then go to the Contents tab.

Then add the image to the instructions

  1. Go to the instruction field of interest in L7|MASTER

  2. Hover cursor over the Instruction field to activate the popup icon, which will bring you to the rich text editor

  3. Click Insert Image

  4. Select the image file of interest

  5. Click Submit

  6. Click the X to exit the rich text editor

  7. Click Save

Caution

Image height cannot exceed 600 pixel

Adjusting image properties

Overview of basic image properties

To view and manage image properties, double click the image. Then you can make changes to the following parameters:

  • Src - the source URL of the image being referenced. By default, it will include the image file UUID as seen in L7 Data app. See Referencing the image Name instead of UUID for best practice on how to update this URL.

  • Title - text that is displayed when users hover their cursor over the image.

  • Alternative - text that is display if the image fails to render and is used by screen readers for the vision impaired.

  • Link - makes the image hyperlinked, enter the URL you want to direct users to. If you do not want users to be redirect from their current page, then select the Open link in new tab checkbox.

Overview of advanced image properties

To view and manage advanced image properties, double click the image. Then click the Advanced tab, you can make changes to the following parameters:

  • Margins - alignment based on top, right, bottom, or left

  • Align - can select left, center, or right

  • Styles - can set width and other style settings used in HTML

  • Classes - refers to HTML classes

  • ID - refers to HTML IDs

  • Border radius - size of image border

Referencing the image name instead of UUID (best practice)

As best practice, if you have an image you wish to persist in your L7|ESP instance across builds and will be referenced in instructions, then update the "src" path to use the image name rather than UUID.

Why? UUIDs may change each time a new tarball is deployed, by referencing the image file name instead, you ensure your embedded images continue to render properly.

Procedure

  1. Double click image

  2. Go to the Src field

  3. Delete the UUID located between "/api/files/" and "download?attachment=false"

    Example, delete the bolded text: /api/files/caf22a39-787d-4fde-a2fe-fa2c51aeffc8/download?attachment=false

  4. Delete "attachment=false"

    Example, delete the bolded text: /api/files/download?attachment=false

  5. Add "name=" followed by the name of the image file that's in the L7 Data app

    Example, add the bolded text: /api/files/download?name=CellBag Schematic

  6. Click Apply

  7. Click the X

  8. Click Save

Note

Referencing the image Tag instead of UUID or Name

If you'd rather, src can also be updated to reference the image files tag value instead of the UUID or Name. However, if multiple images have the same tag, then only the most recently tagged image will be displayed.

Example: /api/files/download?tags=cellBag

In this section: