ZEISS Microscopy Knowledge Base
Help
ZEISS Microscopy Knowledge Base

ZEN Data Storage Client

Time Deviation

In the very unlikely event that there is a time deviation greater than five minutes between the client and the server, the authentication of the client fails for security reasons. In this case an error message is displayed and working with ZEN Data Storage is not possible. You have to fix the system time of the client and/or server before a retry.

In ZEN core, you can store your data on your computer's file system in your local archive, or you have the option to save your data in a database called ZEN Data Storage.

ZEN Data Storage is an additional product which has to be installed. For more information, refer to the installation guide of ZEN Data Storage. You also need configure ZEN Data Storage as your archive, see Configuring a ZEN Data Storage Archive.

Configuring a ZEN Data Storage Archive

The archive options enable you to specify how and where the Archive is stored, as well as the hierarchy of attributes that can be assigned to templates.

The Archive Setup button needs to be clicked once for the first client to set up the database. On the second client, this is not necessary anymore, even though the button is active.

  1. You are logged in as an administrator in ZEN core.
  2. You have configured a ZEN Data Storage Server and activated the Data Storage Client module in Home Screen > Maintenance > Toolkit Manager.
  1. Click Home Screen > Maintenance > Archive Options.
  2. The Archive Options dialog opens.
  3. As Archive Type, select ZEN Data Storage Archive from the drop-down list.
  4. Only if you have selected ZEN Storage Archive as archive type, you can setup the Archive.
  5. For Settings > URL specify the URL of the ZEN Data Storage server.
  6. The Archive Setup button is displayed.
  7. If you want to use an archive hierarchy, create your hierarchy elements by clicking +, see Creating a hierarchy for the archive and Using a hierarchy for the archive for general information.
  8. Click Archive Setup. This has to be done only on the first system which connects to the ZEN Data Storage.
  9. The storage is set up to work with the software and the standard users are created.
  10. Restart the software to update the user database.
  1. You have set up the ZEN Data Storage Archive as your archive and the database is set up properly. You can now configure the user management, see Basics of User and Group Management.

Opening an Image from ZEN Data Storage

  1. You have added the Load image from ZEN Data Storage tool to the Load File workbench.
  1. In the Load image from ZEN Data Storage tool, click Rounded gray square icon with three centered black dots.
  2. The Browse ZEN Data Storage dialog opens, see Browse ZEN Data Storage Dialog.
  3. If necessary, filter the displayed images form the database, see Filtering Data in ZEN Data Storage.
  4. Select an image in the list and click OK. Alternatively, double-click the respective image.
  5. The Browse ZEN Data Storage dialog closes.

Filtering Data in ZEN Data Storage

  1. You have added the Load image from ZEN Data Storage tool to the Load File workbench.
  1. In the Load image from ZEN Data Storage tool, click Rounded gray square icon with three centered black dots.
  2. The Browse ZEN Data Storage dialog opens.
  3. Enter a term you are looking for in the Search field, e.g., the file name.
  4. The displayed images are filtered instantly based on your input.
  5. To filter images based on their tags, click Tags.
  6. An input field opens as drop-down.
  7. In the search field, enter a term you want to filter for. Alternatively, in the list of available tags, activate all tags you want to filter for and activate Or/And, depending on whether the filtered images should contain all activated tags (And), or at least one of the tags (Or).
  8. The filter for tags is applied.
  1. The available files are filtered and displayed accordingly.

Creating a Collection for Data

You can create collections to structure your data and share it with others.

  1. You have set up ZEN Data Storage as your archive, see Configuring a ZEN Data Storage Archive.
  2. You have started the application with active user management to be able to add users or groups to a collection.
  1. Click Home Screen > Maintenance > Archive Options.
  2. Click Manage Collections.
  3. The Manage Collections dialog opens.
  4. Click Two small square icons with centered plus signs on white background.
  5. The Add Collection dialog opens.
  6. Enter a name for the new collection.
  7. Click Two small square icons with centered plus signs on white background.
  8. The Add Collection Access dialog opens.
  9. On the Groups and/or Users tab, select the group or user you want to grant access to the collection. Selection of multiple users and groups is possible by pressing Ctrl.
  10. Select the Access Level for the currently selected users/groups.
  11. Click OK.
  12. The dialog closes and the selected users and/or groups are granted access based on the selection.
  13. You can now adapt the Access Level of individual users and groups of this collection, if necessary.
  14. Click OK.
  15. The Add Collection dialog closes.
  1. You have created a collection for your data. You can now structure your data and share job results with the people having access to this collection, see Adding Job Results to Collections in Browse Results.

Editing or Deleting a Data Collection

  1. You have created a collection for your data. For more information, see Creating a Collection for Data.
  2. You have started the application with active user management to be able to add users or groups to a collection or edit them.
  1. Click Home Screen > Maintenance > Archive Options.
  2. Click Manage Collections.
  3. The Manage Collections dialog opens.
  4. To delete a collection, select it and click Delete icon, trash can.
  5. To edit a collection, select it and click Square gray button with a gear symbol beside a small square button showing a plus sign.
  6. The Edit Collection dialog opens.
  7. If you want to change the name, adapt it under Collection Name.
  8. If you want to change the access of a particular user, change the Access Level with the respective dropdown.
  9. To add a new user or group, click Two small square icons with centered plus signs on white background.
  10. The Add Collection Access dialog opens.
  11. On the Groups and/or Users tab, select the group or user you want to grant access to the collection. Selection of multiple users and groups is possible by pressing Ctrl.
  12. Click OK.
  13. The dialog closes and the selected users and/or groups are granted access based on the selection.
  14. Click OK.
  15. The Edit Collection dialog closes.
  16. Click Close.
  17. The Manage Collections dialog closes.

Sharing Job Results in Free Mode

  1. ZEN Data Storage is configured as your archive, see Configuring a ZEN Data Storage Archive.
  2. You are in Free Mode and have finished all your work.
  1. In the Title Bar, click Archive Results dialog showing name 'FreeModeAttachments.czjob', empty Description, and checked collection 'Collection Test' and click Archive Results.
  2. The Archive Results dialog page opens.
  3. Click Select Collections to which saved Results should be added to.
  4. The section with all available collections is displayed. Every collection that is shared with other users/groups is marked with Save Results dialog with name field Grain Size Analysis (Intercept), collection Collection Test checked, Archive link in the Shared column.
  5. If you want to search for a particular collection, input your search term in the Search for Collections field.
  6. The collections displayed in the table are updated accordingly.
  7. In the table, activate the checkbox for each collection the result should be shared with.
    Dialog 'Archive Results' with Name FreeModeAttachments.czjob, checked collection 'Collection Test' (28.05.2021)
  8. Click Archive.

Sharing Job Results in Job Mode

  1. ZEN Data Storage is configured as your archive, see Configuring a ZEN Data Storage Archive.
  2. You are in Job Mode and have finished your Job.
  1. Click Save and Close. Alternatively, click Save and Repeat if you want to repeat the job afterwards.
  2. The Save Results dialog opens.
  3. Click Select Collections to which saved Results should be added to.
  4. The section with all available collections is displayed. Every collection that is shared with other users/groups is marked with Save Results dialog with name field Grain Size Analysis (Intercept), collection Collection Test checked, Archive link in the Shared column.
  5. If you want to search for a particular collection, input your search term in the Search for Collections field.
  6. The collections displayed in the table are updated accordingly.
  7. In the table, activate the checkbox for each collection the result should be shared with.
    Save Results dialog showing Name "Grain Size Analysis (Intercept)", checked collection "Collection Test", Created 28.05.2021
  8. Click Archive.

Creating Custom Metadata

With ZEN Data Storage, you can create and use custom metadata in ZEN core.

  1. You have ZEN Data Storage configured as your archive, see Configuring a ZEN Data Storage Archive.
  2. You are on the Home Screen.
  1. Click Maintenance > Archive Options.
  2. The Archive Options dialog opens.
  3. Under Settings, click Custom Metadata.
  4. The Custom Metadata tab opens and all custom metadata entries are displayed.
  5. Click Two small square icons with centered plus signs on white background.
  6. A new empty field is created.
  7. Enter the name for your custom metadata and press Enter.
  8. Click OK.
  9. The Archive Options dialog closes and the new metadata entry is saved.
  1. You have created custom metadata that are displayed in the Custom Metadata tab of the Archive Options dialog. Note that custom metadata are created case insensitive.
  2. The custom metadata can be used for your jobs by adding them as a Data Link field property in the Form Designer when creating or editing a form template, see Form Designer.
  3. When running a job which includes the form with custom metadata, you can enter a value for the metadata. Additionally, all previously entered values for the respective metadata are available as a dropdown list and sorted alphabetically.
  4. The custom metadata can be displayed as a column in Browse Results and can be used as additional filter criteria for searching the job results, see Filtering Results and Documents using Metadata and Filter Criteria.

Adding an Active Directory User

Domain Administrator

It is not possible to use the initial Active Directory domain administrator as a user for ZEN Data Storage. The administrator account for the Active Directory domain should only be used for the administration of the Active Directory itself.

When you are using ZEN core with ZEN Data Storage, you can add individual Active Directory users to your user management.

  1. ZEN core is open with active user management and you are signed in as administrator.
  2. You have ZEN Data Storage configured as your archive and have configured an Active Directory group, see Configuring a ZEN Data Storage Archive and Setting up the Login with Windows Credentials (Active Directory) respectively.
  3. During the installation of ZEN Data Storage, you have set the parameter Enable Active Directory to True on the Settings tab of the installer. For more information also refer to the installation guide for ZEN Data Storage.
  4. The ZEN Data Storage server must be part of the same Windows domain from where the software tries to login with its Windows credentials.
  1. Click Maintenance > User Management.
  2. The User and Group Management dialog opens.
  3. Click Users.
  4. The tab displays all currently configured users.
  5. Click Two small square icons with centered plus signs on white background.
  6. The New User dialog opens.
  7. For Type, select Active Directory.
  8. For Name, click Rounded gray square icon with three centered black dots.
  9. The Select User dialog opens.
  10. The fields for object type and location are filled with a default. To change them, click Object Types or Locations to open another dialog to select the respective Object Types or Locations.
  11. In the text field below, enter the name of the user you want to select. If you are not sure if your name is correct, click Check Names to open a dialog and select the suitable entry.
  12. Click OK.
  13. The name is displayed in the New User dialog.
  14. Click OK to close the New User dialog.
  15. The respective Active Directory is added to the list of users.
  16. Click OK to close the User and Group Management dialog.
  1. You have configured an Active Directory user. You can now assign this user to a group to grant him certain rights and privileges.

Add to Collection Dialog

Parameter

Description

Search for Collections

Searches the collections according to the input.

Table

Displays all available collections.

Name

Displays the name of the collection.

Activated: The image is shared with the respective collection.

Shared

Shared collections are marked with Save Results dialog with name field Grain Size Analysis (Intercept), collection Collection Test checked, Archive link.

Manage Collections

Opens the Manage Collections dialog to manage the collection.

Save

Saves the changes and closes the dialog.

Cancel

Closes the dialog without saving.

Manage Collections Dialog

Here you can manage collections for your data and specify their access.

Parameter

Description

Collection table

Displays the existing collections.

Collection Name

Displays the name of the collection.

Collection Owner

Displays the owner of the collection.

Access Granted To

Displays the groups/users that have access to this collection.

Two small square icons with centered plus signs on white background
Add

Opens the Add Collection dialog to add a collection.

Delete icon, trash can
Delete

Deletes the selected collection.

Square gray button with a gear symbol beside a small square button showing a plus sign
Edit

Opens the Edit Collection dialog to edit the selected collection.

Share and Manage Access Dialog

Parameter

Description

Enter Name

Searches all available users and groups according to the input and selects a user or group from a dropdown.

Access Rights dropdown

Read

Grants the group/user access to see, open and download a document.

Write

Grants the group/user access to modify a document.

Manage

Grants the group/user access to modify the access control list.

Add

Adds the selected user or group with the selected access right to the table.

User and Group table

Displays all users and groups added for sharing the file.

User or Group

Displays the name of the user or group.

Access Right

Displays the access right for the respective user or group and allows you to change the access.

Remove

Removes the entry by clicking the button.

Save

Shares the file with the users and groups defined here and closes the dialog.

Cancel

Closes the dialog without sharing the file.

Load image from ZEN Data Storage Tool

This tool enables you to load an image from the ZEN Data Storage.

Parameter

Description

File Name

Displays the name of the selected file.

Rounded gray square icon with three centered black dots
Browse

Opens the Browse ZEN Data Storage Dialog to select an image.

Last Changed

Displays information on when the file was last changed.

Impressum
Carl-Zeiss-Strasse 22
73447 Oberkochen
Germany
Legal