ZEISS Knowledge Base
Help
ZEISS Knowledge Base

Basic Concepts

User Interface - Home Screen

The Home Screen is displayed after you log in. The available operating modes depend on your user role.

1

Title Bar

Includes the View menu to zoom the workspace.
To activate light or dark mode, select View > Theme and select Light or Dark, see Customizing Workspace Zoom and Background Color.

The Help menu offers context sensitive online help as well as the option to open the complete online help, see Calling up the Online Help.

2

Operating Modes selection, see Operating Modes.

3

Displays system messages and the synchronization status.

Operating Modes

The software contains different operating modes that correspond to the different ways of working with the microscope. The modes that are available to you depend on your user role.

Icon

Mode

Description

Free Mode

Inspect a sample quickly, easily, and flexibly without defining examination tasks.

Job Mode

Run an examination on a sample according to the step-by-step tasks defined in the job template.

Also, define fixed examination steps to be performed each time a sample is examined.

Manage Templates

Edit and manage templates in the archive:

  • Form templates
  • Report templates
  • Macro templates
  • Image analysis settings
  • Custom workbenches
  • arivis Cloud modules
  • Intellesis object classification models
  • Intellesis segmentation models
  • Standards technical cleanliness
  • Intellesis denoising models
  • AI models

Browse Results

View and manage job results in the archive.

Maintenance

Configure global settings, manage users, calibrate measurements, etc..

Job Mode and Free Mode

is designed to support two fundamental ways of using your microscope:

  • Working with jobs (creating, running, editing and managing jobs) in Job Mode
  • Performing free examinations in Free Mode

Job Mode

In the software, the term job refers to a collection of examination tasks. Jobs can be created to ensure that the same examination tasks are carried out each time the job is run, in the same manner, and with the same settings. Jobs are used mainly in routine quality control examinations where it is essential that identical examinations are performed for each sample.

Free Mode

Free examinations can be used to inspect a sample quickly, easily, and flexibly without defining examination tasks. A typical use is to examine a faulty sample where the cause of the fault is unknown or for one-off examinations that will not be repeated. In such cases only the examination results, reports and images need to be saved rather than the examination tasks.

Customizing Workspace Zoom and Background Color

You can switch the background color and modify the workspace zoom.

Setting the background color

  1. In the Title Bar, select View > Theme > Dark or Light respectively.
  2. The theme changes accordingly.

Zooming in and out the workspace

  1. In the Title Bar, select View > Workspace Zoom and set the zoom level to comfortable view.
  2. The size of the view changes accordingly.

User Roles

User management is an optional component. It is disabled by default. If user management is disabled, the user has all user rights at the same time. When user management is enabled, three types of user roles are defined initially in the software:

  • Administrator
  • Supervisor
  • Operator

The available modes and tasks you can perform in the software depend on your user role. User roles can be added and modified under Maintenance > User Management.

User Role

Tasks

Administrators

Administrators install and configure the software. This includes:

  • Managing system settings
  • Managing users
  • Specifying the connected hardware in the Microscope Tool Box application (MTB)
  • Configuring and managing the archives

Supervisors

Supervisors perform the following main tasks:

  • Creating job templates for the operators to run
  • Performing free examinations (Free Mode)

They are also able to perform the following tasks:

  • Running jobs
  • Managing jobs in the archive (running, editing, deleting)
  • Defining and evaluating job reports
  • Releasing Job Templates

Operators

Operators can only perform a limited number of tasks:

  • Searching for a job
  • Running a job
  • Browsing the job results

Overview of Supervisor Tasks

As a supervisor, the way you perform the majority of individual tasks is independent of whether you are in Free Mode or within Job Mode.

For a detailed overview of the tasks in each mode see:

The tasks that are independent of a mode are described in a corresponding chapter in the order they are typically performed.

Creating and Using Custom Workbenches

You can add or remove tools from a workbench at any time. You can also save a workbench configuration as a custom workbench. This enables you to use it in other job templates or free examinations.

All custom workbenches are saved and managed in the Archive.

In Create a new template and edit it within Job Mode, each workbench is automatically saved in the job template in its current configuration. It is also displayed in the same configuration when running the job.

Creating a custom workbench

  1. Customize your workbench by adding or removing tools.
  2. Right-click the icon of a workbench and select Save as custom workbench.
  3. Enter a name for the custom workbench.
  4. The name is used to identify the workbench and must be unique within the system.
  5. Enter a description for the workbench.
  6. It should describe the purpose or special features of the workbench to help other users know when to select it.
  7. Click Save to save the custom workbench.

Using a custom workbench

  1. Click + Add Task.
  2. Select the My Workbenches category.
  3. Select the desired custom workbench and click + Add.

To ensure data integrity, it is not possible to overwrite existing default or custom workbenches.

Tools and Parameters

Tools enable you to perform a specific action in the software, for example:

  • Acquiring an image
  • Selecting a different hardware magnification
  • Reducing the noise
  • Measuring a length

1

Workbench

2

Tool (e.g. Camera tool)

In order to prevent scrolling if you have added several tools, you can collapse the tools by clicking the tool header:

Click the tool header again to expand the tool:

Your settings are persisted. When you leave the Free Mode, the current state of each tool (collapsed/expanded) is saved.

The tools contained in a workbench may also be present in multiple other workbenches. As a supervisor you can also create new workbenches or modify existing ones by adding and removing tools according to your requirements. These customized workbenches can be saved as new workbenches and reused in other examinations or by other users.

Tool Set

You can create tool sets for the workbenches in Free Mode. A tool set is a selection of tools created for a specific workbench. This is helpful if you need a lot of tools in the workbench and would like to group the tools. You display only the group you need in your current experiment situation.

Creating a Tool Set

Before you add the tools to a tool set, you have to create the tool set and then add the tools. Each workbench can have tool sets.

  1. You are in Free Mode.
  2. You have opened the workbench for which you want to create a tool set.
  1. Right-click on the workbench icon, and from the context-menu, select Create Tool Set.
  2. The Create Tool Set dialog opens.
  3. Enter a name for the new tool set, and in the Tooltip field, enter a description, if necessary. Click Create.
  4. You have created the new tool set.
  5. In the workbench bar, the tool set icon is displayed with it's name as label under the workbench icon.
  6. You can add now or later the desired tools to the tool set. To do so, activate the Add Tool checkbox in the top right-hand corner of the respective tool, or click + Tool and select a tool.
  7. The desired tools are added to the tool set.
  8. Click Apply.
  1. You have created a tool set.
  2. If you leave Free Mode or restart ZEN core, the tool set will remain.

Adding Tools to a Tool Set

You can add tools to the workbenchs' tool set.

  1. You are in Free Mode.
  2. You have created at least one tool set for the workbench.
  3. You have opened the workbench and all tools that you would like to add to a tool set.
  1. Right-click on the tool set, and from the context-menu, select Edit.
  2. An Add Tool checkbox appears in the right corner of each tool.
  3. Add the desired tools to the tool set. To do so, activate the Add Tool checkbox in the top right-hand corner of the respective tool, or click + Tool and select a tool.
  4. The desired tools are added to the tool set.
  5. Click Apply.
  1. You have added tools to the tool set.

Keeping Tool Sets Visible

Tool sets are displayed in the workbench bar below the respective workbench. For a quicker access to Tool Sets, you can specify whether the tool sets should continue to be displayed when you leave the workbench.

  1. You are in Free Mode.
  2. You have created a tool set.
  1. Activate the workbench that contains tool sets. To keep the tool sets visible, even when you deselect the workbench, right click the workbench, and in the context menu, activate Keep Tool Sets Visible.
    To display tool sets only when the workbench is active, deactivate Keep Tool Sets Visible.
  1. The current state visible or hidden when leaving the workbench will be indicated by a checkmark at the beginning of the entry.

Renaming a Tool Set

You can rename tool set.

  1. You are in Free Mode.
  2. You have created at least one tool set for the workbench.
  1. Right-click on the tool set, and from the context-menu, select Rename.
  2. The Rename Tool Set dialog box opens.
  3. Enter the new name of the tool set, and click Save.
  1. You have renamed the tool set.

Closing a Tool Set

You can remove tool sets so that they do no longer appear on the workbench.

  1. You are in Free Mode.
  2. You have created at least one tool set for the workbench.
  1. Right-click on the tool set, and from the context-menu, select Remove.
  2. The tool set disappears from the workbench bar. All unfiltered tools are now displayed under the workbench.
  1. You have removed the tool set.

Templates, Images, and Documents

The software supports various kinds of objects grouped into the following categories:

  • Templates
  • Documents

The software handles the objects differently depending on where they are managed or how you interact with them.

Templates

Templates contain pre-defined content, for example the tasks required to run a job, or the fields required to complete a form.

Templates include, for example, the following objects:

  • Job templates
  • Free Mode setups
  • Form templates
  • Report templates
  • Custom workbenches
  • Image analysis
  • Macros

Templates are managed in the archive. When your workflow requires selecting one of the above items, e.g. choosing a job template to run or a report template to use, you are presented with the items stored in the archive. In general, you only interact with items in the archive; you do not interact with the file system.

Documents

Various document types exist, for example:

  • Images
  • Data tables that contain for example measurement results
  • Forms
  • Tables
  • Reports

During examination, the software generates documents that are archived in the local storage or in the archive. However, you can load and save documents to/from the file system by using tools in workbenches. You also have the option to export and import results or result documents.

Data Handling

ZEN core allows you to flexibly handle and store the data into the included archive. When you finish your work you can decide whether you want to keep the data readily available or store/upload it to the archive. (In Free Mode only.) The upload task is performed in the background; you can continue working in ZEN core while the data is being transferred. You can perform multiple transfer actions simultaneously.

In case that you do not want to use the archive, you can save the results to a local folder on the disk.

Data are generated during a session in Free Mode or when executing a job in Job Mode. You store data in a result set that includes result items. The most important (but not the only ones) are the following:

  • Images (*.czi)
  • Tables (*.czt)
  • Documents (*.docx or *.pdf)

Basically, you have the following options for data handling when leaving Free Mode or Job Mode:

  • Archive: You have finished your work and want to archive the data.
  • Discard: You have finished your work but you do not want to keep your unsaved changes.

When you are leaving the Free Mode or are at the end of a job, you can decide which option to choose.

In Free Mode only, you can also save your data locally, for example if you want to pause your work and resume to it later without the need to upload the data to the archive.

You can export data to your local drive, which you can trigger within Free Mode.

Local Storage

The local storage is a dedicated folder location to save results during work before uploading them to the archive. Once uploaded successfully to the archive, the results are deleted from the local storage. If you download data from the archive, they are stored in the local storage.

Saved results are accessible in the Browse Results.

The local storage location is set in the Archive Options.

Archive

The archive is the central location for storing and managing result sets and templates.

Basically, the archive can be split in three areas:

  • Area for organizing all kind of templates except job templates which is found under Manage Templates.
  • Area for all results which is found under Browse Results.
  • Area for all jobs to be managed under Job Mode.

Access to the items in the archive depends on the current user's privileges, which can be set up in the software for each usergroup of the system. Technically the software supports the following archive types:

  • Local archive: suitable for a single system (free)
  • ZEN Data Storage archive: ZEN Data Storage provides a client/server database solution for microscopy customers who deal with the storage of large amounts of data originating from one or several microscopes. ZEN Data Storage allows the exchange of data and workflows and supports microscopists who want to separate image acquisition from post-acquisition work. In this way it also facilitates correlative workflows where the data of a sample can be accessed from a centralized location.

The archive is set in the Archive Options.

Project Folder

The project folder is a folder on the disk where the results can be saved to or loaded from. It is used as an alternative for users who do not want to use the archive.

The results are only accessible from the folder. Unlike using the archive, the results are not accessible in the Browse Results.

Loading Results from a Project Folder

You can load recent projects from the project folder on the local disk.

  1. You have saved results in your project folder.
  1. Open the Free Mode or run a job in Job Mode.
  2. The Project Folder Mode dialog opens.
  3. Select Recent Projects.
  4. The last 10 projects per user are displayed.
  5. Select the project you want to load, and click Open.
  1. The results of the experiment stored in the project folder are loaded into the current session.

Browsing for Results in Project Folder Mode

You can open results and corresponding result documents of a project folder that are not part of a recent project but are saved locally on your PC.

  1. You have saved results in a project folder on your local PC.
  2. The folder contains a czjob file.
  3. You are in Free Mode.
  1. In the Project Folder Mode dialog, select Recent Projects, and click Browse Files.
  2. The Folder Browser dialog opens.
  3. Navigate to the desired result folder, and click OK.
  4. All results and result documents are opened in Free Mode.
Impressum
Carl-Zeiss-Strasse 22
73447 Oberkochen
Germany
Legal