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.

This module allows you to store your data on your computer's file system. Additionally, you have the option to save your projects and images in a database called ZEN Data Storage. This makes the information more accessible, as you can search within the database and filter your results. The data storage is an additional product which has to be installed. For more information, refer to the installation guide of ZEN Data Storage.
To activate the access and use of the database, you need to go to Tools > Toolkit Manager to activate Data Storage Client. Afterwards restart the software.

Setting up ZEN Data Storage Server

After the installation of ZEN Data Storage (for information see the Installation Guide ZEN Data Storage), you have to set up the server in ZEN. This setup has to be done once on every machine using the data storage.

  1. You have installed ZEN Data Storage.
  2. You are logged in as an administrator (if you use ZEN with user management).
  3. Under Tools > Toolkit Manager, the Data Storage Client module is activated.
  1. Click Tools > Options > Settings.
  2. On the Simple tab, change the Host Name if necessary.
  3. Select the Hosting Scheme you use for the server.
  4. Set the Storage Server Port.
  5. Click Server Setup.
  6. Click Yes to confirm the message and setup ZEN Data Storage.
  7. The server is set up in ZEN and a setup dialog opens.
  8. Click Close to exit the setup dialog.
  9. Your server settings are also automatically validated and the result is displayed below the Validate Settings button.
  10. Click OK to close the Tools > Options dialog and save all settings.
  1. You have successfully set up your ZEN Data Storage server in ZEN.

Validating the ZEN Data Storage Settings

When setting up your ZEN Data Storage on the Settings tab of the Tools > Options dialog, your server settings are usually validated automatically. For a manual validation and to look up the status, take the following steps:

  1. You have installed ZEN Data Storage.
  2. You are logged in as an administrator (if you use ZEN with user management).
  3. Under Tools > Toolkit Manager, the Data Storage Client module is activated.
  1. Click Tools > Options > Settings.
  2. A status message is displayed on the page.
  3. Click Validate Settings.
  4. The status message below the button is updated. In case the validation succeeded, the message displays the currently used server version as well as the minimal required version. In case the validation failed, an error message is displayed.

Saving an Image to ZEN Data Storage

You can save any image to the data storage. You can also open images from the data storage, update them, and save the updated image to the data storage.

  1. You have opened an image.
  1. Click on File > ZEN Data Storage > Save Image.
  1. The image is saved to the data storage.

Saving a ZEN Connect Project to ZEN Data Storage

Changes to local project

If you save a ZEN Connect project to the ZEN Data Storage, the local project file is changed and cannot be used any more to open the project in ZEN. The project has to be opened from the ZEN Data Storage, see Opening or Deleting a ZEN Connect Project from ZEN Data Storage.

You can save existing ZEN Connect projects that are currently saved on your computer to the data storage. If you save a project with images, the image information is contained in the Project View. You can check it in the Layers View.

Optionally, you can create a new project and save it immediately to the data storage.

  1. You have loaded a ZEN Connect project that is saved to your computer, or you are in the process of creating a new Connect project.
  1. Click File > ZEN Data Storage > Save and Convert ZEN Connect Project.
  1. The ZEN Connect project is saved to ZEN Data Storage.

Exporting a ZEN Connect Project from ZEN Data Storage

Saving changes

If you have made changes to a ZEN Connect project opened from ZEN Data Storage, you have to first save the project back to the database (via File > ZEN Data Storage > Save ZEN Connect Project) before you export it.

In ZEN, you can export a ZEN Connect project from the ZEN Data Storage to use it locally, e.g. on a machine with no access to the database.

  1. You have opened your project from ZEN Data Storage in ZEN, see Opening or Deleting a ZEN Connect Project from ZEN Data Storage.
  1. In the ZEN Connect tool, select Export Project... for the Export button.
  2. In the file browser, select the location where you want to export your project.
  3. Click OK.
  4. Your project is exported to the selected location. The state of the export is displayed in the progress bar. For each exported project a subfolder is created in the selected export location.

Uploading Images Automatically After Acquisition

If you have a ZEN Connect project open, you cannot upload the image to ZEN Data Storage. The folder in the Auto Save tool is automatically set to the path of the project and you cannot select an upload to the server.

Using Direct Processing and ZEN Data Storage

If you are using the ZEN Data Storage server as the location for storing your data, all acquisition and processing computers involved must have access to the transfer share defined in ZEN Data Storage.

Also note that the images are only uploaded to ZEN Data Storage after they are now longer open in ZEN.

  1. You have set up ZEN Data Storage in ZEN.
  2. You have defined a default transfer share in the server management (or during the installation) of ZEN Data Storage. Both the server and ZEN need to have access to this folder. For information, also refer to the installation guide of ZEN Data Storage.
  1. On the Acquisition tab, activate Auto Save.
  2. The Auto Save tool is displayed on the Acquisition tab.
  3. In the Auto Save tool, select Store in ZEN Data Storage Server from the dropdown menu.
  4. If you want to directly add the image to a collection, select it in the respective dropdown.
  5. Setup and start your experiment as usual.
  1. After the experiment is finished and the images are closed in ZEN, they are automatically uploaded to ZEN Data Storage and added to the selected collection after the acquisition is finished.

Opening or Deleting an Image from ZEN Data Storage

  1. Click File > ZEN Data Storage > Open Image.
  2. The Stored Documents dialog is displayed.
  3. Double-click the image you want to open. Alternatively, select the image and click Open.
  1. The Stored Documents closes and the image is loaded in ZEN.

Deleting an image from the data storage

  1. You have opened the Stored Documents dialog.
  1. Right-click the image you want to delete, and select Delete document. Alternatively, select the image and click White trash bin on dark blue rounded-square icon.
  2. You are prompted to confirm the operation.
  3. Click Yes.
  1. The image is deleted from the data storage.

Opening or Deleting a ZEN Connect Project from ZEN Data Storage

Working locally

If you have opened a ZEN Connect project from ZEN Data Storage, but you want to work with it locally, use the export functionality before you make any changes to the opened project, see Exporting a ZEN Connect Project from ZEN Data Storage.

  1. You have saved a ZEN Connect project to ZEN Data Storage, see Saving a ZEN Connect Project to ZEN Data Storage.
  1. Click File > ZEN Data Storage > Open ZEN Connect project.
  2. The Stored Documents dialog opens.
  3. Select the ZEN Connect project and click Open.
  1. In the ZEN Connect Project View, the current state of the project is displayed. In the Image View, the sample holders are marked and previously acquired images are displayed. Note that the project including its images is linked in the data storage. So take care that these files are not moved or deleted as the links will be broken.
  2. The current stage position is marked with a cross hair.

Deleting a Connect project from ZEN Data Storage

  1. You have opened the Stored Documents dialog.
  1. Right-click the project you want to delete and select Delete Document. Alternatively, select the project and click White trash bin on dark blue rounded-square icon.
  2. You are prompted to confirm the deleting.
  3. Click Yes.
  1. The ZEN Connect project is deleted from ZEN Data Storage.

Configuring the Stored Documents Table

In the Stored Documents dialog, you select Connect projects or images to open or to delete. You can configure the columns of the table according to your needs.

  1. Click File > ZEN Data Storage > Open ZEN Connect Project or File > ZEN Data Storage > Open Image.
  2. The Stored Documents dialog opens.
  3. Right-click into the header of the table and activate the columns you want to see in the table.
  1. You have configured the table.

Filtering Connect Projects and Images in ZEN Data Storage

  1. Click File > ZEN Data Storage > Open ZEN Connect Project or File > ZEN Data Storage > Open Image.
  2. The Stored Documents dialog opens.
  3. Click White gear (cog) icon centered on dark blue rounded square button.
  4. The search area with filter panel and metadata of the search results is displayed. The number in brackets indicates the amount of search results.
  5. To limit the search results, select a term of interest.
  6. The available images are displayed accordingly.
  7. Optionally, enter a term you are looking for in the Search field, e.g., the file name.
  8. To filter images based on their tags, click Tags.
  9. An input field opens as dropdown.
  10. 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).
  11. The filter for tags is applied.
  1. The available files are filtered and displayed accordingly.

Adding and Deleting Tags for ZEN Data Storage Images

To structure your image data in ZEN Data Storage, you can also add tags to individual images.

  1. You have opened the Stored Documents Dialog.
  1. In the data table, select the image.
  2. A preview of the image is displayed on the right side of the dialog.
  3. Under the preview of the image, open the Metadata section by clicking Blue circular button with white right-pointing triangle.
  4. An additional section with the image metadata opens.
  5. For Tags, click +.
  6. A text field is displayed.
  7. Enter the respective name and press Enter.
  8. The tag is added to the image.
  9. To delete a tag, click X in the tag name.
  10. The tag is removed.
  1. You have added (or deleted) a tag for an image in ZEN Data Storage.

Creating a Collection for Data

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

  1. You have started the application with active user management to be able to add users or groups to a collection.
  1. Go to Tools > Options > Collections.
  2. Click White plus sign centered on dark blue rounded-square icon.
  3. The Add Collection dialog opens.
  4. Enter a name for the new collection.
  5. Click White plus sign centered on dark blue rounded-square icon.
  6. The Add Collection Access dialog opens.
  7. 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.
  8. Select the Access Level for the currently selected user(s)/ group(s).
  9. Click OK.
  10. The Add Collection Access dialog closes and the selected user(s) and/or group(s) are granted access based on the selection.
  11. You can now adapt the Access Level of individual users and groups of this collection, if necessary.
  12. Click OK.
  13. The Add Collection dialog closes.
  1. You have created a collection for your data. You can now structure your data and also share it with the people having access to this collection.

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. Go to Tools > Options > Collections.
  2. To delete a collection, select it and click White trash bin on dark blue rounded-square icon.
  3. To edit a collection, select it and click White gear (cog) icon centered on dark blue rounded square button.
  4. The Edit Collection dialog opens.
  5. If you want to change the name, adapt it under Collection Name.
  6. If you want to change the access of a particular user, change the Access Level with the respective dropdown.
  7. To add a new user or group, click White plus sign centered on dark blue rounded-square icon.
  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. Click OK.
  11. The Add Collection Access dialog closes and the selected user(s) and/or group(s) are granted access based on the selection.
  12. Click OK.
  13. The Edit Collection dialog closes.
  14. Click OK.
  15. The Tools > Options dialog closes.
  1. You have edited (or deleted) this collection.

Adding Data to a Collection

In ZEN Data Storage you can share your data with a collection.

  1. You have created collections for ZEN Data Storage, see Creating a Collection for Data.
  1. Click File > ZEN Data Storage > Open Image if you want share an image, or click File > ZEN Data Storage > Open ZEN Connect Project if you want to share a project.
  2. The Stored Documents dialog opens.
  3. Select the files you want to share. To select multiple files, press Ctrl while clicking on the files.
  4. Right click on the selected images or projects and select Add to Collection. Alternatively, click Square icon with left-pointing arrow.
  5. The Add to Collection dialog opens.
  6. In the table, activate the checkbox for every collection you want to share the data with.
  7. Click Save.
  1. You have shared your images or projects with other users/groups that are part of a collection.
  2. Shared files are marked by Square icon showing two person silhouettes in the Shared column.

Sharing Data Directly With Users and Groups

In ZEN Data Storage you can directly share your data with other users or groups.

  1. Click File > ZEN Data Storage > Open Image if you want share an image, or click File > ZEN Data Storage > Open ZEN Connect Project if you want to share a project.
  2. The Stored Documents dialog opens.
  3. Select the file you want to share.
  4. Right click on the selected images or projects and select Share and Manage Access. Alternatively, click Blue app icon showing two white user silhouettes side by side.
  5. The Share and Manage Access dialog opens.
  6. Enter the name of the user or group you want to share the data with and select it from the list.
  7. In the access dropdown, select the access level for the respective user or group and click Add.
  8. The user or group is added to the table and the access right is displayed.
  9. Repeat the previous steps until all users and groups that you want to share your data with are added to the table.
  10. Click Save.
  1. You have directly shared your image or project with other users and groups.
  2. Shared files are marked by Square icon showing two person silhouettes in the Shared column.

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 with ZEN Data Storage, you can add individual Active Directory users to your user management.

  1. ZEN is open with active user management and you are signed in as administrator.
  2. You are using ZEN Data Storage and have configured an Active Directory group to be able to use Active Directory in ZEN, see Setting Up the Login with Windows Credentials (Active Directory).
  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. Go to Tools > Users and Groups.
  2. The User and Group Management dialog opens.
  3. Go to Users.
  4. The tab displays all currently configured users.
  5. Click White plus sign centered on dark blue rounded-square icon.
  6. The New User dialog opens.
  7. For Type, select Active Directory.
  8. For Name, click Dark rounded square button with three white horizontal 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 user 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 names of the collections.

Activated: The image is shared with the respective collection.

Shared

Shared collections are marked with Square icon showing two person silhouettes.

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.

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.

Impressum
Carl-Zeiss-Strasse 22
73447 Oberkochen
Germany
Legal