MetaClientManual V2.1.0

Download as pdf or txt
Download as pdf or txt
You are on page 1of 283

MetaServer

MetaClient Data Management


Version 2.1 Software
MetaServer MetaClient V 2.1 Manual

Copyright

Doc. No. H-1050-043-EN Rev. 1 © 2015 MetaSystems GmbH - All rights reserved.

No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including
photocopying, recording, taping, or information storage and retrieval systems - without the written permission of
MetaSystems Hard & Software GmbH (MetaSystems) or its affiliates.

Trademarks

Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective
owners. MetaSystems makes no claim to these trademarks.

Liability Disclaimer

While every precaution has been taken in the preparation of this document, MetaSystems and/or its affiliate(s) disclaim all
warranties with respect to this document or from the use of programs and source code that may accompany it, expressed
or implied, including but not limited to those of merchantability, fitness for a particular purpose, or non-infringement. To
the extent allowed by law, in no event shall MetaSystems and/or its affiliate(s) be liable, whether in contract, tort,
warranty, or under any statute or on any other bases for special, incidental, indirect, punitive, multiple or consequential
damages in connection with or arising from this document, including but not limited to the use thereof.
Table of
Contents

Part I Introduction - How to Use This Help


..............................................................................................................1
1.1 Text.................................................................................................................................................2
Conventions
1.2 .................................................................................................................................................3
Safety and Operational Information
1.3 How.................................................................................................................................................5
to Obtain More Information
1.4 .................................................................................................................................................5
Features

Part IX
1.4.1 ......................................................................................................................................................................
New Features in Version 2.1 7
1.5 .................................................................................................................................................12
Network Requirements

Part II Getting..............................................................................................................14
Started
2.1 .................................................................................................................................................14
Starting MetaServer
2.2 .................................................................................................................................................14
Shutdown MetaServer
2.3 .................................................................................................................................................15
Starting MetaClient
2.3.1 ......................................................................................................................................................................
Security Mode 16
2.3.2 ......................................................................................................................................................................
Edit Server 16
2.4 .................................................................................................................................................17
Quit MetaClient

Part III MetaClient Views


..............................................................................................................18
3.1 .................................................................................................................................................20
Overview
3.2 .................................................................................................................................................25
'Case List' View
3.3 .................................................................................................................................................29
'Tree' View
3.3.1 ......................................................................................................................................................................
Aspects for Ikaros / Isis 33
...................................................................................................................................................................................... 34
History
File......................................................................................................................................................................................
List 35
......................................................................................................................................................................................
Cell List 37
......................................................................................................................................................................................
Cell Gallery 41
......................................................................................................................................................................................
Cell Review 47
......................................................................................................................................................................................
Comb. Karyo 51
3.3.2 ......................................................................................................................................................................
Aspects for Metafer 59
...................................................................................................................................................................................... 59
Data
......................................................................................................................................................................................
Pass List 63
......................................................................................................................................................................................
Cell Gallery 65
3.3.3 ......................................................................................................................................................................
Aspects for VSlide 66
Data...................................................................................................................................................................................... 66
File......................................................................................................................................................................................
List 69
......................................................................................................................................................................................
Run List 69

Table of Contents
I
......................................................................................................................................................................................
VSlide List 70
......................................................................................................................................................................................
VSlide Gallery 71
...................................................................................................................................................................................... 73
Overview
3.4 .................................................................................................................................................73
'Statistics' View
3.5 .................................................................................................................................................78
'Problems' View

Part IV Data Management


..............................................................................................................80
4.1 .................................................................................................................................................80
Root Directories Management
4.2 .................................................................................................................................................83
Administer Data at Different Levels
4.2.1 ......................................................................................................................................................................
Ikaros/Isis File Administration 84
......................................................................................................................................................................................
Interaction between Ikaros/Isis and MetaClient 94
......................................................................................................................................................................................
Workflow Bar and Cell Categories 97
4.2.2 ......................................................................................................................................................................
Metafer File Administration 100
4.2.3 ......................................................................................................................................................................
VSlide Case Management 102
4.3 .................................................................................................................................................106
Mirroring Data
4.4 .................................................................................................................................................107
Recovering and Eliminating Cases and Images

Part V Queries
..............................................................................................................109
5.1 .................................................................................................................................................111
Default Queries

Part III
5.2
5.3
.................................................................................................................................................113
Query Editor
.................................................................................................................................................120
Patterns

Part VI Reporting
..............................................................................................................122
6.1 .................................................................................................................................................123
Printing Reports
6.2 .................................................................................................................................................125
Default Reports
6.3 .................................................................................................................................................125
Report Editor
6.3.1 ......................................................................................................................................................................
Report Buffer 139

Part VII Reference Section


..............................................................................................................140
7.1 .................................................................................................................................................140
Installation and Configuration
7.1.1 ......................................................................................................................................................................
Installation Guide - Part 1 140
7.1.2 ......................................................................................................................................................................
Installation Guide - Part 2 143
7.1.3 ......................................................................................................................................................................
Installation Guide - Part 3 146
7.1.4 ......................................................................................................................................................................
Installation Guide - Part 4 155
7.1.5 ......................................................................................................................................................................
Installation Guide - Part 5 158
......................................................................................................................................................................................
Common Settings 158
......................................................................................................................................................................................
Settings for Ikaros / Isis Root Directories 166
......................................................................................................................................................................................
Settings for Metafer Root Directories 179
......................................................................................................................................................................................
Settings for VSlide Root Directories 181
7.1.6 ......................................................................................................................................................................
Installation Guide - Part 6 183
7.2 .................................................................................................................................................184
Data Field References
7.3 .................................................................................................................................................200
Custom Filter
7.4 .................................................................................................................................................202
Query Function Block Reference
7.5 .................................................................................................................................................217
Report Component Reference
7.5.1 ......................................................................................................................................................................
Text Editor 232
7.5.2 ......................................................................................................................................................................
Condition Editor 234
7.5.3 ......................................................................................................................................................................
Converting Ikaros/Isis Print Formats 236
7.6 .................................................................................................................................................240
Overview: Shortcut Keys and Icons

II Table of Contents
7.6.1 ......................................................................................................................................................................
Key and Mouse Shortcut Commands 240
7.6.2 ...................................................................................................................................................................... 246
Icons
......................................................................................................................................................................................
General Icons 246
......................................................................................................................................................................................
Icons specific for Ikaros/Isis Root Directories 249
......................................................................................................................................................................................
Icons specific for Metafer Root Directories 252
......................................................................................................................................................................................
Icons specific for VSlide Root Directories 253
7.7 .................................................................................................................................................254
Overview: Menus and Context Menus
7.7.1 ......................................................................................................................................................................
MetaClient Menu Bar 254
......................................................................................................................................................................................
Menu Items specific for Ikaros/Isis Root Directories 257
......................................................................................................................................................................................
Menu Items specific for Metafer Root Directories 261
......................................................................................................................................................................................
Menu Items specific for VSlide Root Directories 262
7.7.2 ......................................................................................................................................................................
MetaClient Context Menues 263
......................................................................................................................................................................................
For Ikaros/Isis Root Directories 263
......................................................................................................................................................................................
For Metafer Root Directories 266
......................................................................................................................................................................................
For VSlide Root Directories 267
7.7.3 ......................................................................................................................................................................
MetaServer Menu Bar 268
7.8 .................................................................................................................................................269
Troubleshooting
7.8.1 ......................................................................................................................................................................
Filing Exception Reports 269
7.9 .................................................................................................................................................270
Updating MetaServer and MetaClient

Part VIII Software Protection Devices - Dongles


..............................................................................................................274

Part VII
Part IX Security Package for Ikaros / Isis and Metafer
..............................................................................................................276

Table of Contents
III
Introduction -
How to Use This
I Help
Purpose of This Manual

The MetaServer / MetaClient V2.1 Manual provides information about using and configuring MetaSystems MetaServer
and MetaClient software tools:

a An installation guide for MetaServer and MetaClient


a Step-by-step procedures for all essential MetaClient functions.
Technical specifications do change from time to time and the information in this manual needs to be treated accordingly.

Audience

This manual is intended for novice and experienced MetaServer / MetaClient users who use the MetaSystems imaging
systems, namely laboratory staff operating, maintaining, and analyzing data generated by MetaSystems Ikaros/Isis,
Metafer, or VSlide systems.

Assumptions

This help assumes you have:


a Basic computer literacy, including a general understanding of data storage, file transfers, and copying and pasting
a Sufficient knowledge of applicable laboratory techniques to interpret images generated by MetaSystems Metafer,
VSlide, Ikaros, and Isis imaging systems.

1 Part I Introduction - How to Use This Help


1.1 Text Conventions

This help uses the following conventions:

Mouse Clicks
Mouse clicks you are instructed to perform appear as symbols indicating the different types of left, middle and right
mouse clicks, respectively. The descriptions herein refer to a mouse on the right side of the keyboard for right-hand users.

Mouse Click Symbols Meaning

g A short mouse click on the left mouse button.


R A long mouse click on the left mouse button (hold for about 1 sec).
G A double-click (= 2 consecutive clicks) on the left mouse button.
h A short click on the middle mouse button.
T A long click on the middle mouse button.
H A double-click on the middle mouse button.
j A short mouse click on the right mouse button.

Typographical Conventions
Please observe the following typographical conventions when using this help file:
a Keys you are instructed to press (shortcuts) appear [framed].
a When you need to press key combinations, they are connected by a '+' sign.
For example, you can also choose the sharpening filter by pressing [F], or with only 50% strength by pressing [Shift] +
[F].
a (Menu) Commands , parameters and file paths are displayed in bold.
a Macros are outlined in a dedicated font.
a Internal links to other paragraphs are marked by k.
a External links to websites or email addresses are highlighted by l (g-click to engage).

Cytogenetic Nomenclature

MetaServer / MetaClient V 2.1 follow the revised nomenclature as recommended by ISCN 2005:
"The terms karyogram, karyotype and idiogram have often been used indiscriminately. The term karyogram should be
applied to a systematized array of the chromosomes prepared either by drawing, digitized imaging, or by photography,
with the extension in meaning that the chromosomes of a single cell can typify the chromosomes of an individual or even
a species. Karyotype is the use of nomenclature to describe the normal or abnormal, constitutional or acquired, chromo-
somal complement of an individual, tissue or cell line. We recommend that the term idiogram be reserved for the dia-
grammatic representation of a karyotype."

MetaServer & MetaClient 2.1


MetaSystems 2
Idiograms and band numbering are in line with the modifications presented in ISCN 2009.

References:
ISCN (2005): An International System for Human Cytogenetic Nomenclature, Shaffer L. G., Tommerup, N. (eds.); S. Karger, Basel 2005

ISCN (2009): An International System for Human Cytogenetic Nomenclature, Shaffer, L. G., Slovak, M. L. , Campbell, L. J. (eds.); S. Karger, Basel 2009

ISCN (2013): An International System for Human Cytogenetic Nomenclature, Shaffer, L. G., McGowan-Jordan J., Schmid M. (eds.); S. Karger, Basel 2013

1.2 Safety and Operational Information

General Safety
All systems produced by MetaSystems are laboratory devices and, thus, may only be operated by qualified and trained
persons. Your system was built and thoroughly tested according to our quality system. In order to ensure continuous safe
and reliable operation please observe the safety notices and caution signs below. Using this product in a manner not spe-
cified in the user documentation may result in personal injury or damage to the instrument or device. Ensure that anyone
using this product has received instructions in general safety practices for laboratories and the safety information
provided in this document and in the MetaSystems User Guide.

User Attention Words and Symbols Used

Symbols Intended Perception

ATTENTION! or CAUTION!
Text boxes marked with this symbol and the word ATTENTION! and should be read with great care in order to
prevent any software or hardware problems.
Text boxes marked with this symbol and the word CAUTION! indicate a potentially hazardous situation that, if
not avoided, may result in minor or moderate injury. It may also be used to against unsafe practices.
Text boxes marked with this information sign contain important information on new or revised software fea-
tures or settings.

Safety and Operational Instructions

CAUTION: Biological Samples !

Patient specimens and all material coming in contact with them should be handled as if capable of transmitting
infection and disposed of with proper precautions.

CAUTION: Power Point !

Plug the individual system components into properly grounded electrical outlets. The cables are equipped with
3-prong plugs to ensure proper grounding. If you must use an extension cable, use a 3-wire cable with properly
grounded plugs. Do not remove the grounding prong from a cable. Consult also the safety instruction in the
product information supplied with the individual components.

3 Part I Introduction - How to Use This Help


Text Conventions
ATTENTION: Dust !

Protect the microscope and camera from dirt and dust, which may impair with the functionality of the camera
and other system components. If you remove the camera from the microscope, please ensure that the sensor is
pointing downwards. The sensor of may not protected by a glass filter. Do not touch the sensor and do not try
to clean the camera yourself. Cameras should only be cleaned by the camera manufacturer or by MetaSystems.

ATTENTION: Build-up of Heat !

Obstruction of vents may cause a build-up of heat in one of the system components. This may cause damage or
fire in extreme circumstances. Ensure that the vents are always kept clear of obstructions (min. distance 15 cm).

ATTENTION: Warming up of the Camera !

Cameras can get warm during operation. This may lead to a poorer signal-to-noise ratio causing a reduction in
image quality. Ensure a tight connection between camera and microscope (camera adapter) to dissipate this
heat energy through the microscope.

CAUTION: Gas Discharge Lamps !

Microscopes with fluorescence equipment, used in conjunction with MetaSystems systems, may include gas dis-
charge lamps. They can explode if safe handling and operation is not observed. Gas discharge lamps emit ultra-
violet radiation that may burn the eyes and skin. You must follow the safety and operating instructions given by
the microscope manufacturer.

ATTENTION: Sensitive Fluorescence Filter !

If your microscope is equipped with fluorescence filters, you should be aware that they are particularly sensitive
to heat radiation. Prolonged exposure to fluorescence light may cause irreversible damage leading to a com-
plete loss of functionality. Ensure that proper heat protection filters are positioned in the light path between
lamp and fluorescent filters. Please follow the guidelines of the filter manufacturer with regard to filter mainten-
ance and cleaning.

CAUTION: Injuries ! Damage !

On microscopes with a motorized focus drive do not place your hand or any object between microscope stage
and objectives, while the stage is moving upwards. The same care should be taken when the stage is moving
downward. You may be injured and/or damage the microscope in both instances. Please consult the safety and
operating instructions of the microscope manufacturer.

ATTENTION: Rescaling of Program Windows !

Do not switch off the monitor while MetaSystems software is operational, if the monitor is connected via Dis-
playPort or HDMI cable with the computer. Switching off the monitor will trigger a cascade of events on the level
of the Windows operating system, leading to complete rescaling of program windows. As a result it may be im-
possible to reach important program functions and/or to close Ikaros / Isis in a controlled manner. Ikaros / Isis
have to be shut down using the Windows Task Manager and restarted.

Compatible File Formats


MetaServer supports Ikaros/Isis MMI/MSI and MCI files (V5.7 or earlier), Metafer MSD files (V 3.12 or earlier), and VSlide
VSI files (V 1.0 or pre-release versions).

MetaServer & MetaClient 2.1


MetaSystems 4
1.3 How to Obtain More Information

MetaSystems Representatives
MetaSystems is an international company with offices in Germany (headquarters), in Italy (Milano), in the U.S.A. (Boston),
in India (Bangalore), and in Hong Kong. Additionally MetaSystems is proud to have a global network of partners, which is
covering the local business in almost all regions of the world. Please visit www.metasystems-international.com for inform-
ation on local MetaSystems representatives.

Errors and Suggestions


If you spot any mistakes in this online help or if you have any suggestions for improvement, please contact MetaSystems
in Germany (see backcover for contact details).

1.4 Features

IMPORTANT!
a MetaServer and MetaClient are auxiliary software tools provided by MetaSystems to improve the user ex-
perience when using MetaSystems' Ikaros, Isis, Metafer and/or VSlide.
a The installation of MetaServer and MetaClient is not mandatory for the proper execution of the named pro-
grams.
a MetaServer and MetaClient are available free of charge to all MetaSystems users who have purchased at
least one of the named programs in the required software version.
a MetaServer and MetaClient are compatible with Ikaros/Isis V5.4 or higher, Metafer V3.10 or higher and
VSlide 1.0.

MetaServer and MetaClient add a new level of data management to your MetaSystems installation. The software bundle,
which comes with every new system or a software update, is a comprehensive dashboard to maintain, filter, search and
analyze case and image data from all systems in the network.

a MetaClient is the new control center for MetaSystems' software application, integrating the access to Ikaros/Isis,
Metafer, and VSlide data.
a While MetaClient is the user front end, MetaServer acts in the background and administers all data on all hierarchy
levels.
a Instead of finding particular items or information in large data volumes, MetaClient relies on the comprehensive in-
dexes that are created and constantly updated by MetaServer. By this means network load can be effectively reduced
and performance of the entire installation significantly increased.
a MetaClient’s user interface is highly customizable and can be easily optimized to fit in with your workflow and make
you more productive.
a MetaClient and MetaServer support root directories up to 3 TB in size.

5 Part I Introduction - How to Use This Help


How to Obtain More Information
MetaServer

MetaServer is a remote central service, keeping track of all your Ikaros/Isis, Metafer and VSlide data and extracting relev-
ant information.

Indexing
a Indexing of all registered root directories. Indexes cover all information from Ikaros/Isis, Metafer, and VSlide as well
as related data (associated files).

Mirroring
a Data can be mirrored to external storage device or second server. Mirroring service creates and maintains an exact
copy of the original data set.

Preserving Data Integrity


a Detecting inconsistencies in the file structure and providing tools to repair these inconsistencies.

MetaClient

MetaClient provides you with all you need to browse, manage and analyze data created by Ikaros/Isis, Metafer, and VSlide.
It includes functions for:

Data Browsing
a Powerful and very fast filtering, searching and sorting capabilities.
a Multiple views: Overview, Case List, Tree, and Statistics.
a Hierarchical tree view from studies to (VSlide) images, including culture and slide levels. The number of levels visible
can be customized.
a Flexible and fast image gallery.

Integration with Ikaros and Isis


a Open cases and cells in Ikaros or Isis from MetaClient.
a Ikaros / Isis cell galleries.
a Deleting cases or cells in MetaClient.
a Moving cells to other cases in MetaClient.
a Moving cases to other root directories and sub directories of the current root directory in MetaClient.
a Renaming cases or cells in MetaClient.
a Cell Analysis sheet and support tools for combined karyograms.

Integration with Metafer


a Open scan runs in Metafer.
a Display Metafer cell galleries.

MetaServer & MetaClient 2.1


MetaSystems 6
Integration with VSlide
a Open VSlides in VSViewer.
a Display VSlide previews.

Data Analysis and Statistics


a A customizable overview presents data 'at a glance'.
a Statistical queries, combining different kinds of data, can be created using an intuitive graphical editor.
a Informative diagrams and tables are generated from these statistical queries.
a Basic workflow and productivity tracking can be established easily using these tools.

Reporting
a Very flexible graphical report editor allows you to define report templates that can then be printed with dynamic data
in just a few clicks.
a Reports can be printed, exported to PDF documents or exported to XML files for easy interfacing with other systems
you are employing (like a LIMS).

Numerous new features were introduced in V2.1. The tables below lists new features and directs you to the correspond-
ing manual pages.

1.4.1 New Features in Version 2.1

General New Features in MetaClient

Feature Introduced
in Version

Automatic Log off


a Automatic log off (in password-protected and security mode) after a pre-defined time of 2.1 k 276

inactivity of the current Windows user.

Code Meter Support


a WIBU CodeMeter is now supported. When started for the first time, MetaClient asks the 2.1 k 274

user if it should work with a local dongle, a network dongle or no dongle (VSlide only).

Context Menus
a Context menus in the Tree View - all actions available in the main menu for the selected 2.1 k 254

item are also available in the context menu.


a Context menus in Gallery and List aspects. 2.1 k 254

Hierarchy Levels - Visibility of


a Hierarchy settings (i. e. which hierarchy levels are visible) are now stored for each root 2.1 k 162

directory type separately (Ikaros / Isis, Metafer and VSlide).

7 Part I Introduction - How to Use This Help


Features
Feature Introduced
in Version

Messaging Service
a It is possible to send messages to all active users. 2.1 k 256

Mirror
a Improved validation when a mirror is created: 2.1 k 148

s Same alias cannot be used twice


s Same target path cannot be used twice
s Target path must be valid

Queries
a The visibility of queries in Statistics view can now be controlled individually. A query is 2.1 k 77
either public (all users can execute it) or only accessible by supervisors and administrat-
ors. By default, all queries are public.

Reporting
a Word wrap: dynamic word wrapping for text fields and columns (parameter) 2.1 k 224

a Faster export to Word 2010. 2.1

Root Directories Administration k 80

a Only supervisors and administrators can add new root directories in MetaClient. 2.1
a Exclusivity Check - It is no longer possible to create two root directories with the same 2.1
path.
2.1
a It is no longer possible to add root directories with local paths from MC. Only UNC net-
work paths and mapped network drives are allowed.
2.1
a It is now possible to create a new path to the root directory when adding a root direct-
2.1
ory.
a It is no longer possible to change the type of a root directory after it has been created.

Software Update / Backup Mechanism - Controlled by MetaServer


a MetaServer and MetaClient provide a MetaServer-controlled update mechanism: 2.1 k 270

MetaClient checks for software updates when connecting to MetaServer and is automat-
ically updated, if a newer version is available in the designated update folder.

Trash - Delete Individual Items k 108

a Maintenance task - scheduled file removal from Trash folder after a given period of 2.1
time.
2.1
a Delete individual items from the Trash folder, for example the largest files to save
space.

MetaServer & MetaClient 2.1


MetaSystems 8
New Features in MetaClient for Ikaros / Isis Root Directories

Feature Introduced
in Version

Case Data Fields - Import from Ikaros / Isis


a Import Ikaros / Isis case data fields - default and customized fields - into MetaClient. 2.1 k 185

Cell Categories k 171

a It is now possible to group cells into up to 10 individual categories. 2.1 k 97

a Each category is marked with a description and a color mark. 2.1


a The color marks are used in the Cell List and Cell Gallery to highlight the assigned cat- 2.1
egories.
2.1
a Cells can be sorted or filtered in the Cell Gallery by category.
2.1
a A summary panel provides an 'at a glance' overview about categorized cells per case in
Cell List, Cell Gallery, and Cell Review aspects.

Cell Review 2.1 k 33

a Improved navigation - based on cells and not on image fields anymore.


a A progress bar indicates the proportion of reviewed cells.
a Analysis Sheet:
a Significance threshold: the minimum incidence of an aberration to be scored as signific-
ant can be set independently for chromosome losses and chromosome gains / struc-
tural aberrations.
s Trisomies and Polysomies are highlighted in on-screen display and printed reports.
s All marker chromosomes are included in printed reports and exported analysis
sheets.

Combined Karyogram 2.1 k 51

a Many improvements, only the major features are listed here.


a New Aberration summary table below the combined karyogram with the following (se-
lected) features:
s Table shows every noted aberration with incidence score.
s Choice of Detailed aberrations or Compact aberrations.
s Table is sortable - clicking a column header sorts the table by that column (in ISCN
compliant manner).
s Copy cell aberrations to case karyotype by double-clicking.
a Edit aberrations in the combined karyogram (for a particular cell) or in the aberration
summary table (for all cells carrying a particular aberration) (requires an Ikaros / Isis V
5.7 or higher). Editing a karyotype is limited to supervisors and administrators.
a When saving the karyotype, the karyotype is normalized (unnecessary commas, line
breaks and spaces removed, case corrected)
a When inserting an aberration and the karyotype is empty, chromosome count and sex
chromosomes are automatically generated and inserted.

9 Part I Introduction - How to Use This Help


Features New Features in Version 2.1
Feature Introduced
in Version

a Printing:
s A combined karyogram is printed in the selected display mode.
s An aberration summary table is included in the report on a separate page at the
end of the report.
s The case karyotype is printed below the list of aberrations (with text wrapping).
a Export to Microsoft Excel: all chromosome classes are included in the exported spread-
sheet.

CVViewer / PGViewer Support 2.1 k 259

a Integration of CVViewer and PGViewer: directly open CV Viewer and PGViewer from
MetaClient to view Cytovision and Power Gene images, respectively.

Delete Unprocessed Cells 2.1 k 38

a Remove all unprocessed cells from Cell List aspect with the Delete Unused Cells com-
mand.

Delete Cells at different Hierarchy Levels 2.1 k 87

a In a Case it is possible to delete all Cultures, Slides, Tests and Regions including all cells
which are part of the respective tree item.

Display Modes 2.1 k 49

a MetaClient supports the image display modes available in Ikaros / Isis:


s Display modes for Ikaros images: Grayscale and inverted grayscale.
s Display modes for Isis image: RGB, Grayscale and inverted grayscale, modified,
merged and false colors (primary), as well as combined false colors but only as 'Dis-
play Max'.
a The initial display mode is read from the saved image, except for Isis images in Com-
bined Karyogram, for which the RGB mode is used by default.
a The display mode can be changed in MetaClient, but cannot be saved.
a A display mode can be applied and fixed for all images in a case.

Information Panel 2.1 k 38

a Dynamic layout:
s Information Panel bar grows horizontally, smart word wrapping for long entries like
karyotypes or result text.
s No interactive height adjustment anymore - the height of the infopanel grows with
the presented content, so that all entries are completely visible. The minimum
height is one line or four lines, respectively, if the workflow is visible.

Integration with Ikaros / Isis 2.1 k 94

a MetaClient can substitute genuine Ikaros / Isis case and file navigation and selection
functions.

MetaServer & MetaClient 2.1


MetaSystems 10
Feature Introduced
in Version

Parse entries from Ikaros/Isis Metaphase Remarks field 2.1 k 96

a Entries in the Metaphase Remarks field in Ikaros / Isis can be transferred to cell data
fields in MetaClient:
s Spot-ID in Ikaros/Isis is parsed to new cell data field Region Number in MetaClient.
This allows easy sorting of cell gallery by clone/region/spot and to define computed
fields based on clone/region/spot information.
s It is possible to define new custom cell data fields and use the identifiers in Ikaros/
Isis for automatic recognition and parsing.

Reporting 2.1
a All Isis color display modes are available for printing images (grids).
a Hide sex chromosomes: sex chromosomes can be excluded from karyotypes and karyo- k 218

grams.

Workflow Bar 2.1 k 97

a Dynamic layout, settings and behavior:


s Workflow bar grows horizontally, if numerous workflow stages are used.
s The longest stage name determines the width of all stages.

Overview Aspect 2.1 k 20

a Added case list default column "Workflow state". Added query "Cases by Workflow" as a
default query and added this query to the default dashboard.

New Features in MetaClient for Metafer Root Directories

Feature Introduced
in Version

Coordinate Transformation 2.1 k 180

a Display transformed Metafer coordinates below gallery images Cell Gallery aspect and
in queries.
a Coordinate transformation in MetaClient uses the same procedure as Metafer and
Ikaros/Isis with shared reference file (StageTra.DAT).

Metafer Support 2.1


a MetaClient support Metafer files generated up to V 3.12.

Recursive Indexing 2.1


a MetaServer indexes Metafer root directories also in sub-directories of the given path in
order to locate all Metafer files.

Gallery Snapshot 2.1 k 63

a Display a snapshot of the Metafer gallery in the Pass List and Pass Data aspects.

11 Part I Introduction - How to Use This Help


Features New Features in Version 2.1
New Features in MetaClient for VSlide Root Directories

Feature Introduced
in Version

VSlide viewer 2.1 k 103

a VSlides can be opened with the corresponding viewer in the VSlide List and the Run List
aspects. MetaClient checks for the presence of a valid viewer instance before opening a
VSI VSlide.

Open two Vslides side-by-side 2.1 k 103

a It is possible to compare two VSlides side-by-side in MetaViewer. Open the second VSlide
with the command Open VSlide (New Instance).

Label image 2.1 k 70

a It is possible to display label images for VSI VSlides in the VSlide List aspect.

Stack Videos and Snapshots 2.1 k 69

a MetaClient supports focus stack videos and snapshots generated by VSViewer. Stack
videos and snapshots appear as items in the File List aspect.

VMD Upload 2.1 k 262

a VSlides can now be uploaded to a VMD server directly from MetaClient.


a A new tab VMD has been added for the required settings.
a Upload VSlides from Case List, VSlide List, VSlide Gallery, and Run List.
a Upload process monitor (incl. Cancel option). Uploads proceed as background process.

1.5 Network Requirements

In general, MetaServer can run on any computer in the network as long as this computer is reachable from all computers
that use MetaClient. Nevertheless, there are two configurations that are preferable in terms of performance and minimal
network traffic:

a MetaServer runs on a dedicated server computer that also stores the


root directories. In this case, background indexing does not produce
any additional network traffic and should be very fast. Note that this
is only possible if the computer storing the root directories runs a Mi-
crosoft Windows © operating system.

Network setup with dedicated server for MetaServer.

MetaServer & MetaClient 2.1


MetaSystems 12
a The root directories are stored on a dedicated data server (or a NAS
storage device) and MetaServer runs on any other computer in the
network. MetaServer now uses Windows notification mechanism in
addition to the background scanning to detect changes in the root
directory. This does not work on all shares (Linux shares, NAS) but
avoids the need for explicit change notifications on Windows shares
to find new / modified / deleted files.

Network setup without dedicated server - MetaServer


runs on a MetaClient PC.

Additionally, the following requirements must be met:


a All computers in the network must have the TCP/PIP protocol installed (this should be installed by default on any re-
cent system)
a Firewalls must be configured to allow incoming and outgoing TCP traffic using the port that MetaServer and MetaCli-
ent use (port 1050).
a The computer running MetaServer should have enough main memory.
Note that normally there should be only one MetaServer running in the network. In cases where local root directories are
needed (in research projects for example), additional MetaServer applications can run locally.

IMPORTANT! A particular root directory shall be administered only by one MetaServer. Different MetaServer in-
stances cannot operate the same root directory. If multiple MetaServer applications are required (to support
local root directories), please use different root directory lists referring to different (!) root paths.

13 Part I Introduction - How to Use This Help


Network Requirements
Getting Started

II
In order for MetaClient to work properly the following prerequisites must be met:
a At least one MetaServer must be running on a computer in the network.
a The firewall must be configured to allow network communication between MetaServer and MetaClient.
a MetaServer and MetaClient must be configured correctly.

2.1 Starting MetaServer

As pointed out already in the chapter Network Requirements (k 12 ), MetaServer should run on a dedicated server ma-
chine or, if no such server is available, on one of the client computers:
a On a dedicated server, MetaServer should run as a scheduled task with active maintenance options (k 153 ). By this
means MetaServer can run in the background and requires almost no user interaction: MetaServer will start automat-
ically, when the server is (re-) booted.
a If, however, MetaServer runs on a client PC, MetaServer can be started either manually or also as a scheduled task:

s Start manually: G-click the desktop icon to start MetaServer - see Installation Guide - Part 3 for configura-
tion details (k 151 ).
s Run as a scheduled task: see Installation Guide - Part 3 how to setup MetaServer as a scheduled task on a
server computer (k 154 ).
The MetaServer program window can be minimized to a tray icon (k). When moving the mouse over the tray icon, some
performance characteristics of MetaServer are displayed as a hint (number of connections, memory used, root director-
ies loaded, running time).

2.2 Shutdown MetaServer

IMPORTANT! Please note, that MetaClient strictly depends on an active MetaServer!

Before you shut down MetaServer, make sure that all users have completed their work in their MetaClient sessions.

MetaServer & MetaClient 2.1


MetaSystems 14
On the computer running MetaServer,

a G-click the MetaServer tray icon to enlarge the MetaServer program window.

a j-click the tray icon to display a context menu:

Command Description

Show MetaServer Displays (hides) the MetaServer program window.


(Hide MetaServer)

Shutdown Shuts down MetaServer in a controlled fashion. MetaServer displays a confirmation dialog
during shutdown, pointing out that all MetaClients will loose connection, if MetaServer is
shut down.

2.3 Starting MetaClient


1. Start MetaClient by G-clicking the MetaClient icon on the Windows desktop.
2. MetaClient starts up with a welcome screen, indicating the loading progress:

MetaClient's wellcome screen. The user login window of MetaClient.

3. Next, the User Login window is presented. The user login is displayed:
a Automatically upon program start.
a After pressing [Esc] in the MetaClient main window.
MetaClient checks, whether the login window has been moved outside the visible area of the desktop, and move the
window back to the center of the desktop, if necessary.

4. The User Login presents the name of the connected server.


If you have more then one MetaServer up and running you can g-click the command button to
open a Select Server window, in which you can select another server by alias name. You can also edit existing server
or add a new MetaServer by g-clicking the command button (for details, k 16 ).
Confirm your selection by g-clicking , or g-click to leave the window without commencing
any changes.
5. If the user list is long, use the smart filter box to find your user name quickly: enter the first letter of your user name
after the symbol: MetaClient shows only the matching user names.

6. Select a User Name and g-click , or cancel the user login and terminate MetaClient at any time by press-
ing [Esc] or by g-clicking .

15 Part II Getting Started


Shutdown MetaServer
7. When you g-click , MetaClient loads the previously active root directory. To switch to another root direct-
ory, g-click the menu command Root Directory and select another root directory.

For all Ikaros/Isis root directories, MetaClient checks the Ikaros/Isis configuration for correctly configured change notifica-
tions. It creates a 'problem' entry on the Problems tab in MetaClient for missing or incorrect notification settings, but also
offers an an automatic solution to mend the problem (k 155 ). Please note, that you have to be logged on as an adminis-
trator user to see and resolve the notification problems.

2.3.1 Security Mode

Customers, who are running Metafer and/or Ikaros/Isis in encrypted secure mode, must use MetaClient in secure mode
as well!

Root directories in MetaServer can be specified as "secure" indicating that the data in the root directory is encrypted. In
order to handle both types of root directories - normal and secure - two global configuration paths must be specified in
MetaServer:
a one for security clients and
a one for non-security clients.
This allows mixed installations, where Metafer runs in security mode and Ikaros / Isis in normal mode or vice versa.

Please note, that MetaClient can only handle one type of root directories: either normal or security mode. The mode is de-
termined by a configuration switch in the copy-protection device (dongle). A 'normal' MetaClient is compatible with non-
encrypted root directories, while a MetaClient in security mode can only open encrypted root directories.

2.3.2 Edit Server

It is possible to run several active MetaServer at the same time. Each MetaServer may handle a particular root directory or
a set of root directories exclusively. Two MetaServer instances cannot control the same root directory.

You can administer the availability of MetaServers in the User Login window of MetaClient.

1. g-click the command button to open a Select Server window, in which you can select another server
by alias name.
2. Or edit existing server or add a new MetaServer by g-clicking the command button. A table in the Edit
Servers window lists all currently available servers with their Alias, the Computer Name of the computer running
MetaServer, and the Server Port in the network.

Add a New Server


1. To add a server to the list, g-click the (Add) icon in the Edit Servers window. In the New Server window add
Alias, Computer Name, and Server Port.
On stand-alone systems, which run one
MetaServer and one MetaClient instance on the
same machine, it is recommended to g-click the
button: a new server with Alias: Local
Server, Computer Name: localhost, and Server
Port: 1050 is created.

MetaServer & MetaClient 2.1


MetaSystems 16
New Server window

2. Confirm your selection by g-clicking , or g-click to leave the window without commencing any
changes.

Edit an Existing Server

1. In the Edit Servers window, select a server from the list and g-click (Edit) icon to open an Edit Server win-
dow, which resembles the New Server window, except for the missing button.
2. Introduce the required changes and confirm them by g-clicking , or g-click to leave the win-
dow without commencing any changes.

Delete a Server

1. In the Edit Servers window, g-click (Delete) icon. Deletes entry from the list without confirmation. This
step does not delete the respective MetaServer installation.
2. Confirm your selection by g-clicking , or g-click to leave the window without commencing any
changes.

2.4 Quit MetaClient

You can logout from MetaClient by any of the following methods:


a Pressing [Esc] .
a G-clicking or the j-clicking user field in the status bar at the bottom of the program window.

You can exit MetaClient by:


a g-clicking the close button in the upper right corner of the Title Bar.
a g-clicking the button in the User Login window.
a Pressing the key combination [Alt] + [F4].

17 Part II Getting Started


Starting MetaClient Edit Server
MetaClient
Views
III
After MetaClient has successfully connected to MetaServer, the main window of MetaClient is displayed. MetaClient has
four different views arranged as tabs:

a Overview - an 'at a glance' summary of the lab status - k 20 for details.


a Case List - a detailed case list (very much alike the Ikaros / Isis detailed case list) - k 25 for details.
a Tree - show all hierarchy levels within a study or case, including the cell / karyogram gallery - k 29 for details.
a Statistics - running queries (combined searches) and summarize results in tables or diagrams - k 73 for details.
a There is also the Problems view, which is only displayed when data inconsistencies occur - k 78 for details.
You can switch among views by g-clicking the respective tab sheet header. You can customize the visibility of the differ-
ent tabs in the General Settings - User Interface (k).

Menu Bar

Menu Functions available

Root Directory In the menu you can see the list of all registered root directories. MetaServer/MetaClient V 2.1 sup-
port Ikaros/Isis, Metafer and VSlide root directories. Select a root directory from the list by g-click-
ing the respective entry (k 80 ).
Case The Case menu includes case management operations like opening cases in Ikaros or Isis, deleting,
moving and renaming cases, creating new cases, and opening the data sheet (k 83 ).
Reporting The Reporting menu provides access to the respective functions in MetaClient. You can print re-
ports using existing report templates or edit and modify these templates to adopt them to your
needs and preferences. How to use the Report Editor is outlined in details in a separate chapter (k
122 ).

Configure MetaClient / MetaServer can be adapted considerably to your requirements. In the Configure
menu, you can change the server configuration, the shared settings and the user preferences (k 146

).
Trash The two commands in the Trash menu allow you to restore previously deleted data or to clear the
trash (k 107 ).
Tools The menu contain various commands to start the CV and PG Viewers and send messages to other
MetaClient users.
Diagnostics MetaClient comes with tools to record and analyze performance problems, if required (k 256 ).

MetaServer & MetaClient 2.1


MetaSystems 18
Menu Functions available

Windows The Report Editor (k 125 ) and Query Editor (k 113 ) are presented in MetaClient as separate (non-
modal) windows. If you try to close MetaClient while an editor window is still open, it is brought to
the front. It is only possible to exit MetaClient, if all editor windows have been closed. This measure
shall prevent you from losing any data or modifications made in an editor.
Help The Help menu provides assistance in the use of the software as well as details on the system in
case support is needed. You can view this manual as a help file and all standard hotkeys used by
MetaClient plus a detailed system and software version information.

How Can I ... ?

Switch root directory

You can switch between root directories by selecting another root directory from the Root Directory menu. The list of
available root directories is administered by MetaServer, but you may add new root directories in MetaClient (users with
administrator/supervisor rights, k 164 ). MetaServer provides a management console for adding, editing or deleting root
directories (k 147 ).

Refresh Displayed Data

Refresh

Refresh MetaClient by any of these methods:


a g-click the Refresh command icon, or
a Press [F5].
Refreshing causes MetaClient to request all data again from MetaServer.

Toggle Fullscreen

Toggle Fullscreen

The fullscreen view mode offers more space for viewing cytogenetic images and data by simultaneously hiding the view
tabs and the menu bar and expanding the program window to fill the monitor completely. Toggle the fullscreen mode by
any of these methods:

a g-click the command icon, or


a Press [F11].
The status bar is (temporarily) hidden in fullscreen mode.

19 Part III MetaClient Views


Find Cases and Cells in an Instant (Quick Search)

Quick Search

Use the quick search to find cells and/or cases that meet the search criterion. You can search for any alphanumeric string
- as used in case names, patient names, karyotypes - or dates - like case creation date or patient birth date. Just type the
string and search: MetaClient will present a list of all items matching.
1. Start Quick Search by any of these methods:

a g-click the command icon.


a Press [F3].

a In the Case List and Tree views, you can also use the Quick Search field: .

2. In the the Quick Search window, type the search string and g-click the Search command button.
3. By default, the search result list may contain cells and cases. You can shorten a list by toggling the Cases and/or Cells
options and/or by increasing the specificity of the search string.
4. Open an item by G-clicking its list entry.
5. g-click the Close button to hide the quick search window. MetaClient does not clear the result list when you close
the window. The search results will be available until you conduct a new search.

3.1 Overview

The overview is intended to provide an overview over the current root directory by displaying the results of a configurable
set of statistical queries. Queries can be utilized in two ways:

a Widgets - A widget is a small window that displays the results of a query (a table or a diagram). You can resize and
move around widgets.
a Dashboard - A dashboard is a collection of widgets. The overview supports multiple dashboards (k 22 Switch dash-
board 22 below).

With V 2.1, Overview and Statistics views are also available for Metafer and VSlide root directories, too.

MetaServer & MetaClient 2.1


MetaSystems 20
Overview View for Ikaros / Isis Root Directories.

Legend

1 Root Directory selection 2 Menu Bar


3 View tabs 4 Locked / Unlocked dashboard
5 Dashboard selection 6 Global Commands
(Refresh - Quick Search - Fullscreen Mode)
7 Query results 8 Status Bar
(Alias of server currently connected to, user name,
alias and type of current root directory, content of
report buffer, items matching current filter condi-
tions). The Status Bar is hidden in fullscreen view
mode.

21 Part III MetaClient Views


Overview
MetaClient comes with standard dashboards for Ikaros/Isis, Metafer, and VSlide featuring different combinations of wid-
gets :

For Ikaros / Isis Root Directories

Cases by Karyotype Cases by Specimen

Cases by Year Cases by Workflow State

For Metafer Root Directories

Classifiers Scanned by System (-ID)

Throughput per Week

For VSlide Root Directories

Magnification Light Modes (Illumination) VSlide SystemID

Metafer Application

Stitched Runs by Month

How Can I …?
Operations marked with a * are only available if editing is unlocked.

Lock and Unlock Editing

1. The overview supports two modes (see 4 ):

= Locked:Dashboards and widgets cannot be modified. This should be used in routine work to avoid unwanted
modifications.

= Unlocked: Dashboards and widgets can be modified, deleted and created.

2. You can switch between the two modes by g-clicking on the lock/unlock symbol.

Switch Dashboards

1. MetaClient supports multiple dashboards. Three dashboard layouts - one for Ikaros/Isis, one for Metafer, and one for
VSlide root directories are already included.
2. You can create new dashboards (k 23 ) Create a new dashboard. Users can switch between dashboards by selecting
another dashboard from the dropdown list (see 5 ).

MetaServer & MetaClient 2.1


MetaSystems 22
Create a New Dashboard

1. In order to create a new dashboard you must activate the editing mode by unlocking the current dashboard (k 22 ).
2. Then g-click the New button. You are then asked for a name for the new dashboard. After g-clicking OK, a new
empty dashboard is created.
3. You can then add widgets to the new dashboard.

Rename a Dashboard*

1. If you want to change the name of an existing dashboard, switch to this dashboard, activate the editing mode (k 22 ).

2. g-click the Rename button and enter the new name and g-click OK.

Delete a Dashboard*

1. If you want to delete an existing dashboard, switch to this dashboard, activate the editing mode (k 22 ).

2. g-click the Delete button. You are then asked to confirm the deletion of the dashboard. Note that deleted dash-
boards cannot be restored.

Add a Widget to a Dashboard*

1. To add a new widget to the current dashboard,activate the editing mode (k 22 ).


2. g-click the Add Widget button. The new widget is then added in the upper left corner of the dashboard.
3. You can then move the widget to the desired position (k 23 ), change its size (k 23 ) and select a query for it (k 24 ).

Move Widgets on a Dashboard

1. To move a widget, move the mouse over the widget. Note how the cursor changes: .
2. Hold the left mouse button down and then move the mouse to the desired position. Release the left mouse button as
soon as the widget is at the desired position.

Resize Widgets

1. To resize a widget on the current dashboard, move the mouse over the lower right corner of the widget, marked by
. Note how the mouse cursor changes: .
2. Hold the left mouse button down and move the mouse to resize the widget. Release the left mouse button as soon as
the widget has the desired size.

23 Part III MetaClient Views


Overview
Remove a Widget from a Dashboard

Remove widget

To remove a widget permanently from the current dashboard, g-click the Remove Widget icon in the upper right
corner of the widget. Note that deleted widgets cannot be restored.

Refresh a Widget

Refresh widget

1. All widgets are automatically refreshed whenever you refresh MetaClient either by g-clicking the Refresh button
in the upper right corner of the MetaClient main window or by pressing [F5].
2. If you want to refresh just a particular widget, g-click the Refresh Widget icon in the upper right corner of the wid-
get.

Select a Query Result for a Widget

Select a query result Query execution time

A widget displays a result of a query. To change the query result it displays, L-click the Select Query icon in the upper
right corner of the widget. The following dialog appears:

Select Widget Query window

Select a query from the Query: list on the left panel. On the right Result: panel, you see all output options for the selected
query. Query results can be displayed either as tables or as diagrams. For more information on the standard queries,
please k 111 .
The information behind the symbol in the lower left corner of the dialog shows you the approximated execution time of
this query. You should only select queries that execute in a short time for dashboard widgets since these queries are ex-
ecuted every time you refresh MetaClient.
After you have selected a query result, g-click OK to apply the changes.

MetaServer & MetaClient 2.1


MetaSystems 24
3.2 'Case List' View

The Case List view provides an overview over all cases of the selected root directory that match the specified filter condi-
tion and were created in the specified period.

Case List view. As of V 2.1 the Case List view includes a Workflow state column. This makes it easy to sort cases by their degree of completion.

Legend

1 Root Directory selection 2 Menu Bar


3 View tabs 4 Locked / Unlocked dashboard
Global Commands
5 Quick Search 6
(Refresh - Quick Search - Fullscreen Mode)
7 Commands for Case Management 8 Case List Panel
9 Status Bar
(Alias of server currently connected to, user name,
alias and type of current root directory, content of
report buffer, items matching current filter condi-
tions). The Status Bar is hidden in fullscreen view
mode.

25 Part III MetaClient Views


'Case List' View
How Can I ... ?

Select a Case

You can select a case in the Case List view by g-clicking it. You can also use the following keyboard commands to navig-
ate the list view:

Key Action

[<] Select the previous case.

[>] Select the next case.

[y] Select the case directly above the currently selected case.

[Y] Select the case directly beneath the currently selected case.

[PgUp] Move one page up

[PgDn] Move one page down

[Home] Select the first case in the list

[End] Select the last case in the list

Select Multiple Cases

You can select multiple cases. One of the selected cases is always the current case. The current case is highlighted in red,
the other selected cases are highlighted in silver. Some commands affect only the current case while others affect all se-
lected cases.
To select multiple cases in the Case List view use one of the following methods:
a Hold the left mouse button down over the first case you want to select, then move the mouse to the last case you
want to select and release the left mouse button.
a g-click a case, then hold the [Ctrl] key down and g-click another case to add this case to the selection.
a g-click the first case you want to select. Then hold the [Shift] key down and g-click the last case you want to se-
lect.
a Press [Ctrl] + [A] to select all cases in the list view.
a Press [Ctrl] + [I] to invert the selection.

Open a Case in Ikaros or Isis

Ikaros Isis

You can open the current case in Ikaros or Isis (V 5.4 or higher) by any of the following methods:

MetaServer & MetaClient 2.1


MetaSystems 26
a G-click a case. This opens the case in Ikaros or Isis, depending on which of the programs is selected as the preferred
image viewer. You can change the Default Viewer on the Configure - Settings... - General tab (k 159 ).
a Choose Open in Ikaros or Open in Isis from the Case menu.
a g-click the Open in Ikaros or Open in Isis command icon.
a j-click the case and choose Open in Ikaros or Open in Isis from the context menu.
a Press [Enter].

Open a Case in Metafer

Open in Metafer

The procedure described herein requires Metafer V3.10 or later! Metafer must be installed on the same computer as
MetaClient.
1. You can open a selected case in Metafer by any of these three methods:
a g-click the Open in Metafer command in the Case menu.
a g-click the respective command icon in the Case List view.

a Select a pass in the Tree view by a g-click and then g-click the command icon.
2. Metafer opens the first or the selected pass (scan run).

Open VSlide

Open VSlide

NOTE! The virtual slide viewer program MetaViewer was renamed to VSViewer 2.x , and the old VSViewer 1.0
program was renamed to ZViewer 1.0.

The procedure described herein requires VSViewer V2.0 or later! VSViewer must be installed on the same computer as
MetaClient.
1. You can open a selected case in MetaViewer by any of these methods:
a g-click the Open VSlide command in the Case (Test, Culture, Slide,...) menu.
a g-click the respective command icon in the Case List view.

a In the Tree view, select a run on the Run List or VSlide List tabs by a g-click and then g-click the com-
mand icon.

a In the Tree view, select a gallery image in the VSlide Gallery tab by a g-click and then g-click the com-
mand icon.
2. VSViewer opens the selected run.

27 Part III MetaClient Views


'Case List' View
Manage Cases

Create Case ... Move Case Rename Case Delete Case

You can create, rename, move, and delete cases in the Case List view. For more details on these functions, please refer to
the chapter

Restrict the Time Interval

An easy way to narrow down the number of cases being displayed simultaneously, is by choosing a fixed Period of time.
You can select 1 Week, 2 Weeks, 1 Month, 3 Month, 12 Months, or a flexible period From - To for which you freely set
the begin and end dates. However, if you choose Any period, then no selection is made.

NOTE! For optimal performance, we recommend to choose a shorter period (1 month or 3 months) whenever
possible.

Filter Cases

Besides the filtering by period (see above), you can also apply other filter conditions to retrieve the desired case(s).
Simple Filter
A simple filter condition always consists of a filter field and a filter value. You can filter by any data field allocated. Please
note that different sets of data fields are available for Ikaros/Isis, Metafer and VSlide root directories (for full references, k
184 ). In order to broaden the range of a filter, you may use the wildcards * (any number of characters) and ? (a single

character) in the filter value.

1. To select a simple filter, g-click the button next to the Filter by field.
2. Select a filter criterion from the drop-down list. The selected filter will be applied immediately.

Custom Filter
In addition to the default simple filter options, MetaClient enables you to apply more complex filter conditions easily.

1. To create a new custom filter g-click the button next to the Filter by field and select (Custom) from the drop-
down list.

2. Then g-click the button next to the Filter by field.


3. This opens a new Custom Filter window, in which you can create your own filter. In contrast to previous versions of
MetaClient, you do not have to select logical (Boolean) operators and conditions anymore, but create a filter condition
using natural (English) language phrases (k 200 for details on how to build a filter).
4. To apply an existing custom filter, g-click the Load command button and select the wanted filter from the query
definition folder (...\MetaSystems\QryDef).

NOTE! In the Cell Gallery, Cell List, and VSlide Gallery aspects:
a It is possible to toggle on / off filter conditions using the [F] key: if a filter condition is active, pressing [F] dis-
ables the filtering (= all cells), and vice versa.
a If you create a new case, that does not match the conditions of an active filter, you will have the possibility
to disengage the filter in order to make the new case visible.

MetaServer & MetaClient 2.1


MetaSystems 28
Sort Cases

1. Cases can be sorted using the selected data field from Sort By list as the primary and the Case Name as the second-
ary sort criterion. You can switch the sort direction by g-clicking respective icons:

- Ascending: A...Z; 0,1,2…

- Descending: Z..A; …,2,1,0.

2. Alternatively, g-click a column header in the Case List view: cases will be sorted by the selected column header. The
default sort direction is ascending. By g-clicking the header again, you can reverse the sort direction. The Case List
can be customized: new columns can be added and existing columns can be removed (k 166 ).

The sorting sequence depends on the data type, whenever the data type is apparent. Empty entries are always moved to-
ward the bottom of the sequence.

3.3 'Tree' View

The Tree View is the most flexible way of looking at your data.

Tree View

The particular layout of the program window support a clear workflow: Item selection in the Tree -> Aspect -> Content -
> Actions.

29 Part III MetaClient Views


'Case List' View
You can hide / display the Tree , Infopanel / Workflow Bar (Ikaros/Isis only) and Analysis Sheet (Ikaros/Isis only) panels by
g-clicking the , and buttons in the center panel, respectively.

Adjust the Width of Tree and Gallery


You can adjust the width of the item Tree and image gallery simply by moving the separator line between both panels. To
do so, move the mouse pointer on the separation line. The mouse pointer changes from the standard cursor to a sizer
cursor. Press the left mouse button and move the cursor to the left or right in order to increase or decrease the width of
the the case tree, respectively.

Data Selection

Hierarchy Levels

The left hand panel features a Tree by which you can select the set of data you want to deal with. The tree is fully custom-
izable and you can hide or display hierarchy levels (see here). By g-clicking one of the / nodes, you can expand or
collapse a branch of the tree, respectively. The figure below summarizes the hierarchy levels available:

Data Hierachy Level Icon Comments


Level Status*

Study O Combines several cases (experiments) in one study, for ex-


ample for biological dosimetry - hidden by default.
Case F Case (or experiment) level - this level is present all the time
and cannot be hidden.
Test O This level can be used to distinguish between different types of
staining or FISH probes, for example - hidden by default.
Culture D For each cell culture condition another culture can be defined
(in Ikaros/Isis or Metafer) - visible by default.
Slide D Shows all slides prepared from different cultures - visible by de-
fault.
Pass O Slides could be scanned in Metafer with different parameters
(classifiers), each stored scan run is a 'pass' - hidden by default.
Region O Region of interest or cell clone on a slide (as defined in Metafer
of VSlide Viewer) - hidden by default.
Cell F Cell (or image) level - this level is present all the time and
cannot be hidden.
Field O Capture fields that belong to one cell (Ikaros/Isis - Add. Capture
or Metafer - AutoCapt) - hidden by default.
Run O VSlide virtual slide stitching procedures with different para-
meter sets - hidden by default.
VSlide O VSlide virtual slide images - hidden by default.

* Level Status: F: Fixed, D: Default, O: Optional

The Case and Cell (previously Image) levels are fixed (F) and cannot be hidden. Some levels are visible by default (D), but
may be hidden, while others are hidden by default (O), but can become visible.

MetaServer & MetaClient 2.1


MetaSystems 30
Item Tree

Display / Hide the Tree

The Tree is displayed by default. You can hide / display the Tree panel by g-clicking the button in the center panel.

Browse the Tree View

The top level in the item tree usually corresponds to Cases (or to Studies - if they are active, k 162 ). A in front of an item
means, that the item has child items and can be expanded by g-clicking . Note, how turns into ' ' when you expand
an item. An expanded item can be collapsed by clicking .
The numbers in parentheses behind the Case, Culture and Slide items tell you:
a for Ikaros / Isis root directories: how many metaphases belong to that item and how many of those metaphases have
a karyogram. For example, a tree entry means that case 123test has 5 metaphases of which 2 also
have a karyogram. The number in parentheses behind cell items tells you of how many fields the cell consists. For ex-
ample, a metaphase Cell 05 with cell fields A, B and a karyogram K would look like this: .
a for Metafer root directories: how many passes belong to that item.
a for VSlide root directories: how many VSlides belong to that item.

Select an item in the Tree View

You can select an item in the tree by g-clicking it.

Navigate in the Tree

You can select items in the Tree view by g-clicking it. You can also use the following keyboard commands to navigate
among items in the Tree view:

Key Action

[y] Select an item directly above the currently selected item.

[Y] Select an item directly below the currently selected item.

[>] Open a branch in the tree.

[<] Close a branch in the tree.

[PgUp] Move one page up.

[PgDn] Move one page down.

[Home] Select the first case in the list.

[End] Select the last case in the list.

31 Part III MetaClient Views


'Tree' View
Context Menus

By j-clicking an item in the Tree you can open a context menu with commands matching the selected hierarchy level.
The content of the context menu resembles the respective entry in the menu bar. k 263 for a reference of all context
menus.

Aspects

In order to refine the selection of the presented data, you can choose one of the available aspects:

Aspects available for

Ikaros / Isis Root Directories Metafer Root Directories VSlide Root Directories

History Pass List File List

File List Data Run List

Cell List Cell Gallery VSlide List

Cell Gallery VSlide Gallery

Cell Review Data

Comb. Karyo Overview

The availability of aspects is subject to change according to the selected hierarchy level. Not all aspects listed in the table
above are available for all hierarchy levels. For a detailed description of the different aspects, please the next section.

Infopanels and Workflow Bar

NOTE! Infopanels and Workflow Bar are only available for Ikaros/Isis root directories.

Infopanels

Information panels or Infopanels display a selection of case data. The data fields presented can be customized for every
hierarchy level individually.
While the width of an infopanels is determined by the visibility of the workflow bar (see below), the height of an infopanel
is now adjusted dynamically, so that no data field entry becomes hidden: all information shall be visible all the time. If the
workflow bar is displayed, then the minimum height is equivalent to four rows, if the workflow bar is hidden, then the min-
imal height is one row.
For a detailed description, how to customize infopanels, please k 174 .

Workflow Bar

The Workflow Bar can provide an 'at-a-glance' information on the current processing status of the selected Ikaros/Isis
case. By default, the workflow bar is visible at the case level and at all hierarchy levels below. The pre-configured Workflow
Bar includes five stages: Created - Captured - In Analysis - Analyzed - Checked. You can display / hide the Workflow Bar
for each hierarchy level individually in the Info Panel Settings.

MetaServer & MetaClient 2.1


MetaSystems 32
g-click a 'node' in the workflow bar to add (progress) or remove (regress) one or more steps in the status of a case.
Please be aware, that you cannot set the workflow state for inactive cases any longer.

For a detailed description, how to customize the workflow bar, please k 177 .

Display / Hide Infopanels and Workflow Bar

Infopanels and Workflow Bar are displayed by default. You can hide / display them by g-clicking the button in the
center panel.

Analysis Sheet

NOTE! The Analysis Sheet is only available for Ikaros/Isis root directories.

The Analysis Sheet displays the analysis and check marks assigned to chromosomes in the Cell Review aspect (k 47 ).
The Analysis Sheet lists all chromosome classes and the chromosome analysis / check marks by chromosome class and
by karyogram. For a detailed description, how to customize the Analysis Sheet, k 174 .

Display / Hide Analysis Sheet

The Analysis Sheet is displayed by default. You can hide / display them by g-clicking the button in the center panel.

3.3.1 Aspects for Ikaros / Isis

After selecting a hierarchy level in the tree and an item in a branch, it is possible to reduce complexity even further by
choosing among different aspects. An aspect represents a particular view of the given data or a detailed extract of the
data of interest. Aspects are represented by a stack of tabs between the tree on the left and the central content (gallery)
panel. Clicking an aspect changes the displayed content and determines the possible actions.

33 Part III MetaClient Views


'Tree' View
The following aspects are available:

Aspect: Displays: Available for:

History MetaServer/MetaClient track the major events in the history of


every Ikaros/Isis case - k 34 .

File List The File List displays all associated files belonging to a case, for ex-
ample reports, exported images, and Ikaros/Isis view images - k 35
.
Cell List The Cell List provides detailed information on the acquired images
in an Ikaros/Isis case - k 37 .

Cell Gallery An Ikaros/Isis Cell Gallery displays all cells (metaphases) and karyo-
grams belonging to a Ikaros/Isis case, culture, slide or regions (on a
slide). A Metafer Cell Gallery may display all cells found in a
MSearch (metaphase finder) or MetaCyte (spot counting) run - k 41
.

Cell Review The Cell Review aspect constitutes a special tool for the advanced
analysis of individual cells - k 47 .

Comb. Karyo The combined karyogram functions in MetaClient offer new unique
features not available yet in Ikaros/Isis.It should be mentioned
here, that the combined karoygram in MetaClient is restricted a
single case. The possibility of Ikaros to compare chromosomes
from different cases will be added in a later version of MetaClient -
k 51 .

Pass List The Pass List provides detailed information on Metafer pass, i. e. a
scan run - k 63 .

Run List The Run List summarizes some technical information on VSlide
scan runs - k 59 .

Data The Data aspect provides detailed information on a VSlide run. All
kinds of parameters determining the search and stitching condition
as well other important data related to a scan run are listed and be-
ing displayed together with an overview of the scanned and
stitched area on the actual slide - k 66 .

VSlide List The VSlide List summarizes some technical information on VSlide
stitching run. - k 70 .

VSlide Gallery The VSlide Gallery displays virtual slides created by the concerted
action of Metafer and VSlide - k 71 .

History

NOTE! The History aspect is only available for Ikaros/Isis root directories.

MetaServer/MetaClient track the major events in the history of every Ikaros/Isis case. The case history can be viewed in
MetaClient in the History tab of the Tree View.

MetaServer & MetaClient 2.1


MetaSystems 34
The following events are tracked:
a Case created a Case moved a Case renamed
a Cells deleted a Cell renamed a Cell moved
a Analysis sheet edited a Analysis sheet printed a Analysis sheet exported
a Analysis sheet cleared a Report printed a External file added
a External file removed a Changes to the workflow state of a
case

Each event is tracked with Time stamp (date and time), User and Event type and stored in a <CASE>.HIS file together with
the other files of a case. g-click a column header to sort the table by a category.

Add Custom Events

1. You can add (custom) events yourself to the History list by g-clicking the command button. In the Add Event
window you can type a text describing the event.
2. g-click the button or press [Enter] to accept new event entry, or g-click or press [Esc] to exit
without committing any changes.

Print History
1. It is possible to print the case history: g-click the command button. This will open a Report Viewer window (k
123 ), which allows you to produce a paper printout or an electronic copy as PDF, WORD document, email attachment,

or XML file.

File List

Ikaros / Isis

It is possible to amend Ikaros/Isis cases by various type of files, for example, but not limited to DOCs, PDFs, or JPGs.

In principle, any file format is suited, as long the matching software to open a file is available on the same computer run-
ning MetaClient. MetaClient can only open MetaSystems file formats. External files associated to Ikaros/Isis cases must be
opened with external applications. By default, MetaClient uses the Windows settings for file extensions and 'open with
standard application'. If Windows does not feature a registered software for a particular file type, or if you would prefer to
use another application to open a particular file type, you can customize the association between file type and application
(k 165 ).

The File List displays all associated files belonging to a case, for example reports, exported images, and Ikaros/Isis view
images. The File List is updated automatically: for all files a small Preview, their Filename, creation date (Created), last
modification date (Last Changed) and the file Size is displayed. g-click a column header to sort the table by this cat-
egory.

35 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
How Can I ... ?

Associate External Files with Ikaros/Isis Cases in MetaClient

1. Select the Tree view by g-clicking the respective tab.


2. Choose the File List aspect. There are two different ways to add a file to a case:
a By 'Drag-and-Drop'
i. In the Windows Explorer (or any alternate file explorer), navigate to the folder containing the file(s) you
want to add.
ii. Select the file and move it by 'drag and drop' onto the (empty) File List panel in MetaClient. MetaClient is
brought to the front.
iii. When you release the mouse button, you are prompted to confirm the addition of the file.
iv. Repeat the steps to add another file, if necessary.

a Add Files... command

i. g-click the command icon.


ii. This will open a Select File window, in which you can select one file (g-click) or several files (hold [Ctrl] +
g-clicks).
iii. Then g-click the Open command button to add the selected file(s) to the File List of the current case.

NOTE! The original files are preserved. MetaClient creates copies of all associated files and modifies the file
names as: <CASE>.<ORIGINAL FILENAME>.EXT.

Delete Associated Files from MetaClient

1. Select the Tree view by g-clicking the respective tab.


2. Choose the File List aspect.
3. Highlight the associated file in the list.

4. Then either press [Del] or g-click the command icon. After confirmation the selected is file is going to be de-
leted.

Save Associated Files in Another Folder

1. Select theTree view by g-clicking the respective tab.


2. Choose the File List aspect.
3. Highlight the associated file in the list.

4. Then either press [Del] or g-click the command icon. After confirmation the selected is file is going to be de-
leted.

MetaServer & MetaClient 2.1


MetaSystems 36
Cell List

NOTE! The Cell List is only available for Ikaros/Isis root directories.

The Cell List provides detailed information on the acquired images in an Ikaros/Isis case. By default, the table includes the
following columns:

Culture - Slide - Cell - Category - Created (Date) - Creation User - Coord. (Coordinates) - Karyotype - Meta Remarks -
Karyo Remarks

The Cell List columns can be customized in Configure - Settings - Cell List. For details on how to customize the list
columns, k 166 .

The screenshot below displays an Ikaros/Isis gallery:

Cell List aspect for Ikaros/Isis root directories

37 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Select Filter / Sort Criteria for Cells

Global Commands
5 Quick Search 6
(Refresh - Quick Search - Fullscreen Mode)

Case List Panel


7 (the number in parenthesis refer to the number of cells and/or 8 Information Panel
karyograms per case)

9 Workflow Bar (only for Ikaros/Isis root directory) 10 Aspect selection

Cell List Commands for Case or Image Management


11 12
(with cell category summary at the bottom) (hierarchy and aspect specific)

13 Filter / Sorting of Cell Gallery 14 Show / Hide Case Tree and Case Information Area panels

Status Bar
(Alias of server currently connected to, user name, alias and type
15
of current root directory, content of report buffer, items matching
current filter conditions)

Delete Unused Cells

As of the function Delete Unused Cells is available in the Cell List view. "Unused" means here, that cells have been cap-
tured, but have not processed in Ikaros/Isis, yet (= original state). This can be very helpful, for example, when using
Metafer MSearch in AutoCapt mode to acquire metaphases automatically after slide scanning.

1. To delete all unused cells in a case, g-click the command icon in the Cell List view ( 12 ).
2. In order to prevent the accidental loss of images, the unused cells are listed in a separate table in a new window. By
default, all cells are marked, but you can selectively toggle off the selection mark. g-click to confirm dele-
tion of all marked cells or g-click to exit with no action.

See Cell Information at a Glance

Case Information Area (Ikaros/Isis)

NOTE!
a Information panels (Infopanels) are only available for Ikaros/Isis root directories.
a The visibility of Infopanels is dependent on the settings for the individual hierarchy levels (k 162 ).

The Case Information and Image Information Panels available in MetaClient V1.0 and V1.1 were replaced by fully cus-
tomizable Infopanels for all hierarchy levels ( 8 ).
The height of the infopanel is now calculated automatically, so that all values are always displayed completely. The height
is automatically reduced if there are only a few fields displayed. For example if a culture is selected, by default only the
culture name is displayed. Then the height of the information panel could be reduced to one line (or the height of the
workflow bar if enabled). It is no longer possible to change the height interactively (only be choosing less values to be dis-
played). The minimum height if the workflow is visible is four lines, if not it is one line.
The display of long values (for example long karyotype in tumor cytogenetics or long result) in the information panel are
improved. Very long values are wrapped, so that no information becomes cut off or invisible.

MetaServer & MetaClient 2.1


MetaSystems 38
The example above shows the default infopanel for the Case hierarchy level. You can add or remove data fields and also
alter the sequence in which they appear. The screenshot below displays a customized infopanel with an extra data field
Scanned Metas (Metaphases):

A detailed description on how to customize infopanels is available here: k 174 .

Cell Categories

Cell Categories can provide an 'at-a-glance' overview of the current processing status of all cells in a Ikaros/Isis case in the
Cell List aspect of the Tree view (in contrast to the Workflow Bar, which visualizes the status of a case).
It is possible to define and customize up to ten different categories (k). Each category should have a descriptive title and a
colored square ( 11 ).
1. You can also assign another category from the pre-defined list:
a j-click a particular gallery image to open the context menu and select the Assign Category command. Then
choose a category from the list or re-set the category to the 'Unassigned' state.
a Select a cell by a g-click and type a number from 1 ... 9, 0, corresponding to categories 1 ... 10.
You can also assign and change cell categories in the Cell Gallery view (k 41 ).

2. The assigned category appears in the Category column of the Cell List. Each category is marked by a colored square
and a descriptive title ( 11 ).
3. At the bottom of the Cell List you will find a (per case) Cell Category Summary, presenting the number of cells per
category. This allows you to quickly gather, for example, how many cells need to be counted or karyotyped in the cur-
rent case in order to meet your laboratory requirements.
Please be aware, that the summary is only displayed, if at least one cell has been categorized.

NOTE!
a Cell Categories are also available in the Cell Gallery (k 41 ) and Cell Review (k 47 ) views.
a A categorized cell is set back to the 'undefined' state, when a cell is moved to another case. However, a cat-
egory state is preserved upon renaming a cell within the same case.

39 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
Control Visibility of Information

Panels

In order to concentrate on just a particular information or to gain more space, you can toggle the Tree and Inforation
Area panels on / off by g-clicking the respective icons at the bottom of the tree view window ( 14 ).

Filter and Sort Cell List

For cases with a large number of cells, it might be helpful to filter or sort the cells. The Cell List and Cell Gallery share the
same filtering and sorting options ( 13 ):
Filter conditions available: Analyzed Cells*, Category, My Cells, Custom (filter).
Sort conditions available: By Name, by Capture Date, by Category, Last Modified First, and Cus-
tom (sort criterion).
* Analyzed Cells include counted, classified, cells with a karyogram, and/or cells, for which the Ka-
ryotype field is not empty.
The Cell List displays all cells in a case by default. In order to filter or sort cells, select the respective display option:
1. g-click the or button to open either the Cell Filter or the Cell Sorting configuration window:

As of V 2.1 it is also possible to sort (to group) and filter cells:


a by category (k 39 ).

a by using the new possibilities for Custom filter and sort conditions utilizing the new Iks/Iss Identifier option for
data fields (k). For example, Metafer writes the Spot-ID, defining clones, regions or spot information, to the
Metaphase Remarks image data field in Ikaros or Isis. This information is automatically parsed to the Region
Number field in MetaClient and can be used to group gallery images by clone or region. Likewise, you can parse
other information, like chromosome overlap count or FISH spot counts generated by the extended count func-
tion in Ikaros/Isis V5.7 or later (see Ikaros/Isis manual for details).
2. g-click a filter or sort option and confirm by g-clicking the button.

MetaServer & MetaClient 2.1


MetaSystems 40
NOTE! In the Cell List, Cell Gallery, and VSlide Gallery aspects:
a It is possible to toggle on / off filter conditions using the [F] key: if a filter condition is active, pressing [F] dis-
ables the filtering, and vice versa. Disabling a filter condition is equivalent to the All Cells filter option.
a If you create a new case, that does not match the conditions of an active filter, you will have the possibility
to disengage the filter in order to make the new case visible.

Cell Gallery

NOTE! The Cell Gallery is available for Ikaros/Isis and Metafer root directories.
a The Ikaros/Isis is available for Case, Culture, and Slide levels.
a The Metafer Cell Gallery is only available for Slide and/or Pass levels.

The screenshot below shows an Ikaros/Isis gallery:

Cell Gallery aspect for Ikaros/Isis root directories

41 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Select Filter / Sort Criteria for Cells

Global Commands
5 Quick Search 6
(Refresh - Quick Search - Fullscreen Mode)

Case List Panel


7 (the number in parenthesis refer to the number of cells and/or 8 Case Info Panel
karyograms per case)

9 Workflow Bar (only for Ikaros/Isis root directory) 10 Aspect selection

Commands for Case or Image Management


11 Cell Gallery 12
(aspect-specific)

13 Adjust gallery image size 14 Filter / Sorting of Cell Gallery

Status Bar
Show / Hide Case Tree, Case Information Areal and Analysis (Alias of server currently connected to, user name, alias and type
15 16
Sheet panels of current root directory, content of report buffer, items matching
current filter conditions)

An Ikaros/Isis Cell Gallery displays all cells (metaphases) and karyograms belonging to a Ikaros/Isis case, culture, slide or
regions (on a slide). Likewise, a Metafer Cell Gallery may display all cells found in a MSearch (metaphase finder) or
MetaCyte (spot counting) run.

Gallery images for encrypted images are now displayed using the symbol .

NOTE! In the Cell Gallery, Cell List, and VSlide Gallery aspects:
a It is possible to toggle on / off filter conditions using the [F] key: if a filter condition is active, pressing [F] dis-
ables the filtering (= all cells), and vice versa. Disabling a filter condition is equivalent to the All Cells filter
option.
a If you create a new case, that does not match the conditions of an active filter, you will have the possibility
to disengage the filter in order to make the new case visible.

See Cell Information at a Glance

Case Information Area (Ikaros/Isis)

NOTE!
a Information panels (Infopanels) are only available for Ikaros/Isis root directories.
a The visibility of Infopanels is dependent on the settings for the individual hierarchy levels (k 162 ).

The Case Information and Image Information Panels available in MetaClient V1.0 and V1.1 were replaced by fully cus-
tomizable Infopanels for all hierarchy levels ( 8 ).
The height of the infopanel is now calculated automatically, so that all values are always displayed completely. The height
is automatically reduced if there are only a few fields displayed. For example if a culture is selected, by default only the
culture name is displayed. Then the height of the information panel could be reduced to one line (or the height of the
workflow bar if enabled). It is no longer possible to change the height interactively (only be choosing less values to be dis-
played). The minimum height if the workflow is visible is four lines, if not it is one line.
The display of long values (for example long karyotype in tumor cytogenetics or long result) in the information panel are
improved. Very long values are wrapped, so that no information becomes cut off or invisible.

MetaServer & MetaClient 2.1


MetaSystems 42
The example above shows the default infopanel for the Case hierarchy level. You can add or remove data fields and also
alter the sequence in which they appear. The screenshot below displays a customized infopanel with an extra data field
Scanned Metas (Metaphases):
For a detailed description, how to customize infopanels, please k 174 .

Gallery Info and Gallery Hints

While a Metafer Gallery just shows the Cell ID as the sole piece of information, a Ikaros/Isis Cell Gallery can provide vari-
ous data in different ways:

Gallery Info
In the corners of the gallery images, important information about the images is displayed. In the standard configuration
the Cell Name (fixed), the cell Karyotype, the capture date (Created), and the user, who made the last modifications (Last
Modif. User) are displayed:
The information displayed in the corners of Ikaros/Isis gallery images is configurable
(k 169 ).

Gallery Hints
When you move the mouse pointer over an gallery image, a semi-transparent hint window is displayed.

In the standard configuration these data fields are included in a gallery hint:

43 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
The active data fields in the gallery hint can be configured (k 169 ).

Cell Categories

Cell Categories can provide an 'at-a-glance' overview of the current processing status of all cells in a Ikaros/Isis case in the
Cell Gallery aspect of the Tree view (in contrast to the Workflow Bar, which visualizes the status of a case).
It is possible to define and customize up to ten different categories (k). Each category should have a descriptive title and a
distinctive color mark.

The colored category marks are visible as small colored triangles in the upper right corner of the metaphase gallery im-
ages and as colored squares in the gallery hints. Unassigned cells carry a white triangle. At the bottom of the Cell Gallery
you will find a (per case) Cell Category Summary, presenting the number of cells per category. This allows you to quickly
gather, for example, how many cells need to be counted or karyotyped in the current case in order to meet your laborat-
ory requirements. Please be aware, that the summary is only displayed, if at least one cell has been categorized.

Assigning a Cell Category rank to individual cells


1. By g-clicking a triangle you increase the category rank by one level, indicated by an immediate color change.
2. You can also assign another category from the pre-defined list:
a j-click a particular gallery image to open the context menu and select the Assign Category command. Then
choose a category from the list or re-set the category to the 'Unassigned' state.
a Select a cell by a g-click and type a number from 1 ... 9, 0, corresponding to categories 1 ... 10.

MetaServer & MetaClient 2.1


MetaSystems 44
Assigning a Cell Category rank to a group of cells

Select cells in the gallery as described here (k 89 ). If the category for one cell among a group of selected cells is changed,
then all other cells in the group adopt the same category regardless of their former category.

NOTE!
a Cell Categories are also available in the Cell List (k 37 ) and Cell Review (k 47 ) views.
a A categorized cell is set back to the 'undefined' state, when a cell is moved to another case. However, a cat-
egory state is preserved upon renaming a cell within the same case.
a At the bottom of the Cell List you will find a (per case) Cell Category Summary, presenting the number of
cells per category. This allows you to quickly gather, for example, how many cells need to be counted or ka-
ryotyped in the current case in order to meet your laboratory requirements.
Please be aware, that the summary is only displayed, if at least one cell has been categorized.

Control Visibility of Information

Image Size, Image Type, and Panels

Image Size
In the Cell Gallery for Ikaros/Isis and Metafer as well as the VSlide Gallery it is possible to adjust the gallery images scaling
in nine steps using the the image size slider ( 13 ):

Image Type
You customize the layout of the gallery by toggling Metas and Karyos on/off using the metaphase and karyogram se-
lector:

Panels

In order to concentrate on just a particular information or to gain more space, you can toggle the Tree , Information
Area , and Analysis Sheet panels on / off by L-clicking the respective icons at the bottom of the tree view window
( 15 ).

45 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
Filter and Sort Cell Gallery

For cases with a large number of cells, it might be helpful to filter or sort the cells. The Cell List and Cell Gallery share the
same filtering and sorting options ( 14 ):
Filter conditions available: Analyzed Cells*, Category, My Cells, Custom (filter).
Sort conditions available: By Name, by Capture Date, by Category, Last Modified First, and Cus-
tom (sort criterion).
* Analyzed Cells include counted, classified, cells with a karyogram, and/or cells, for which the Ka-
ryotype field is not empty.
The Cell List displays all cells in a case by default. In order to filter or sort cells, select the respective display option:
1. g-click the or button to open either the Cell Filter or the Cell Sorting configuration window:

As of V 2.1 it is also possible to sort (to group) and filter cells:


a by category (k 39 ).

a by using the new possibilities for Custom filter and sort conditions utilizing the new Iks/Iss Identifier option for
data fields (k). For example, Metafer writes the Spot-ID, defining clones, regions or spot information, to the
Metaphase Remarks image data field in Ikaros or Isis. This information is automatically parsed to the Region
Number field in MetaClient and can be used to group gallery images by clone or region. Likewise, you can parse
other information, like chromosome overlap count or FISH spot counts generated by the extended count func-
tion in Ikaros/Isis V5.7 or later (see Ikaros/Isis manual for details).
2. g-click a filter or sort option and confirm by g-clicking the button.

NOTE! In the Cell Gallery, Cell List, and VSlide Gallery aspects:
a It is possible to toggle on / off filter conditions using the [F] key: if a filter condition is active, pressing [F] dis-
ables the filtering, and vice versa. Disabling a filter condition is equivalent to the All Cells filter option.
a If you create a new case, that does not match the conditions of an active filter, you will have the possibility
to disengage the filter in order to make the new case visible.

Coordinates Transformation (for Metafer Root Directories)

As of V 2.1 it is possible to display transformed coordinates below Metafer gallery images in the Cell Gallery. The coordin-
ate display can be configured in Configure - Settings - Cell Gallery (k 180 ):
a Display Transformed Coordinates - Toggle on / off display of coordinates below gallery images.
a Stage Transformation Path - Path to Metafer configuration with StageTra.DAT (usually: ...\MetaSystems\MsCfg).

MetaServer & MetaClient 2.1


MetaSystems 46
a Coordinate System - Coordinate system used for coordinate display (Metafer Absolute, Metafer Relative, Mic1,
Mic2, ...). Coordinates are transformed from Metafer relative coordinates to the specified target coordinate system.
a Apply automatic stage calibration offsets - If enabled, MetaClient reads the offsets from Metafer.ini, IksGlobal.ini
or IssGlobal.ini in the same path as the StageTra.DAT.

Navigate the Gallery

The following hotkeys are available in the gallery:

Scroll up one page [PgUp]

Scroll down one page [PgDn]

Select previous item [<]

Select next item [>[

Go to gallery start [Home]

Go to gallery end [End]

Scroll current image into view [Space]

Toggle filtering on/off [F]

Toggle display of metaphases on/off (Ikaros/Isis gallery only) [M]

Toggle display of karyograms on/off (Ikaros/Isis gallery only) [K]

Increase image size [+]

Reduce image size [-]

Display of a zoomed version of the current image (gallery image interpolated) [Z]

Hide zoomed version of the current image any key

Switch to review mode [G]

Add selection to report buffer [B]

Print a report [P]

Delete selected items [Del]

Open current item [Enter]

Cell Review

NOTE! The Cell Review aspect is only available for Ikaros/Isis root directories.

The Cell Review aspects constitutes a special tool for the advanced analysis of individual cells. In conjunction with the
Combined Karyograms aspect (Comb. Karyo, k 51 ) it allows for a very thorough analysis and review process of cytogen-
etic data. For details on the Cell Review Analysis Sheet, please k 50 . You will find a detailed description on the analysis
tools for combined karyograms k 51 .

47 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
Cell Review aspect for Ikaros/Isis root directories

Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Locked / Unlocked dashboard

5 Quick Search 6 Global Commands


(Refresh - Quick Search - Fullscreen Mode)

7 Case List Panel 8 Case Info Panel

9 Workflow Bar 10 Aspect selection

11 Cell Gallery 12 Analysis Sheet

13 Commands for Case or Image Management 14 Display Modes


(aspect-specific) Ikaros images: gray scales or inverted gray scales
Isis images: all color display modes

15 Show / Hide Case Tree, Case Info Panel and Analysis Sheet 16 Cell Info Panel (with cell category mark)

17 Image Selection (first, previous, next, last metaphase/karyogram) 18 Metaphase / Karyogram Preview, displaying the alternate view of
and Progress Bar the cell

19 Status Bar
(Alias of server currently connected to, user name, alias and type
of current root directory, content of report buffer, items matching
current filter conditions)

MetaServer & MetaClient 2.1


MetaSystems 48
Display Modes

In the Cell Review, Ikaros or Isis images can be displayed in different display modes ( 14 ):
a Display modes available for Ikaros images: Grayscale and Inverted Grayscale.
a Display modes available for Isis images: RGB, Grayscale and Inverted Grayscale, Modified Colors, Merged Colors,
and False Colors (primary), as well as Combined False Colors (displayed with max. intensity) (see Isis Manual for de-
tails).

When you load an image, an image is displayed with the display mode as it has been saved in Metafer, Ikaros, or Isis. You
can select another display mode in MetaClient, but you cannot save the changes. It is possible, although, to fix a certain
display mode for all images in a case, for example:
a Load the first image of a case and set the display mode to Inv. Gray Scale by ticking the respective check box.
a g-click the Fixed option to enable the Inv. Gray Scale mode for all images in the current case. The Inv. Gray Scale
is then applied to all images, irrespective of which display mode has been saved.
a The selected fixed display mode is highlighted in red.

Cell Information Panel

Following information is displayed below the review images ( 16 ):


a Hierarchy path from the Case level down to the Cell level (excluding case name).
a Cell Karyotype.
a Metaphase or Karyogram Remarks, depending on, whether a metaphase or karyogram is currently displayed.
a List of users, who have been working on the current cell including associated milestone in image processing.

Cell Navigation

The navigation in the cell review has changed compared to previous versions: it is now based on the cells. Thus, the four
navigation buttons allow you to go to the first, previous, next, and last cell ( 17 ).
You can switch between metaphases and karyogram by g-clicking the small preview image ( 18 ). Cells which do not
contain a field of the type displayed in the main window are skipped for navigation. A change between the fields of the
displayed cell is now possible by clicking on the image in the lower right corner. This image displays the corresponding
metaphase or karyogram (if available) depending on which field is displayed in the main image. Below the navigation but-
tons a progressbar is displayed. The progress is dependent on the number of cells with fields of the kind displayed in the
main image.

Cell Categories

Cell Categories can provide an 'at-a-glance' overview of the current processing status of all cells in a Ikaros/Isis case in the
Cell Gallery aspect of the Tree view (in contrast to the Workflow Bar, which visualizes the status of a case). For details, see
chapter Cell List (k 39 ). It is possible to define and customize up to ten different categories (k). Each category should
have a descriptive title and a distinctive color mark.

49 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
NOTE!
a Cell Categories are also available in the Cell List (k 37 ) and Cell Gallery (k 41 )views.

a A categorized cell is set back to the 'undefined' state, when a cell is moved to another case. However, a cat-
egory state is preserved upon renaming a cell within the same case.
a At the bottom of the Cell List you will find a (per case) Cell Category Summary, presenting the number of cells
per category. This allows you to quickly gather, for example, how many cells need to be counted or karyotyped
in the current case in order to meet your laboratory requirements.
Please be aware, that the summary is only displayed, if at least one cell has been categorized.

Analysis Sheet

The Analysis Sheet is a new tool in MetaClient for tracking and documenting the analysis and review progress in cyto-
genetics. The analysis sheet is displayed next to the metaphase and karyogram image in the Cell Review aspect. It can be

enabled and disabled using the command icon (see 15 ).


The rationale for the Analysis Sheet was to develop a tool that allows to introduce 'analysis marks' and 'checking marks'
independently from each other. Thus, two different users can go over a set of karyograms and simply 'tick off' chromo-
somes or parts thereof.
The Analysis Sheet consists of a table with cells as rows and all chromosome classes as columns. These annotations are
available:

Cleared Checked
= Analysis Mode = Checking Mode

Chromosome
p-arm
q-arm
Not cleared
not checked
Additional chromosomes
(based on 2n) the actual number of marked chromo- the actual number of marked chromo-
somes is given somes is given

You can apply annotations by:


a sequentially g-clicking a chromosome
a j-clicking a chromosome and selecting an annotation from the context menu.

The chromosome class number are colored depending on their status - the default target number for cleared and
checked is '4':
a red - the number of cleared chromosomes is not sufficient.
a green - four or more chromosomes cleared and checked.
a yellow - four chromosomes cleared, but <4 chromosomes checked.

If necessary, you can clear the entire analysis sheet by g-clicking the Clear command button.

Male Karyotype
A Male ? checkbox allows to specify, whether a male karyotype is expected (changes the Y chromosome class from green
to red).

MetaServer & MetaClient 2.1


MetaSystems 50
Marker Chromosomes
Additional (marker) chromosome classes can be added to the analysis sheet. Go to Configure - Settings... - Analysis
Sheet to customize the number of marker chromosomes and their labels (k 174 ).

Swap Analysis / Checking Roles


You can swap roles by ticking the Analysis or Checking option.

Print Analysis Sheet

When you are g-clicking the command button, a pre-configured Analysis Sheet report is generated in the Re-
port Viewer . In contrast to previous versions, the Analysis Sheet report now includes (up to four) marker chromosome
classes instead of the cell karyotype.
Here you have the possibility to send the print job to a printer, to convert the report into a PDF, WORD, or XML file. For de-
tails, please k 123 . If you use Save as PDF and add to Case icon, the report will be saved as a PDF document with an
extended file name: CASE.AnalysisSheet-YYYYMMDDHHMMSS.PDF.

Export Analysis Sheet

It is also possible to export an analysis sheet as a text file for use with external applications. g-click the command
to open a Export Analysis Sheet window, in which you can choose an export folder. By default, the local ...\MetaSystems
\Tnp folder is used. The file name is generated as [CaseName]-AnalysisSheet.txt.

Comb. Karyo

NOTE! The Comb. Karyo (Combined Karyogram) aspect is only available for Ikaros/Isis root directories.

The combined karyogram in MetaClient offer unique features for karyotype analysis not available in Ikaros/Isis, yet:
a create clonal or composite case karyotypes from cell karyotypes
a aberration summary table
a analysis sheet

It should be noted, however, that the combined karyogram in MetaClient is restricted to the current case only. The possib-
ility of Ikaros / Isis (with color karyotyping) to compare chromosomes from different cases will be added in a later version.
When you select the Comb. Karyo aspect, all chromosomes from all karyograms in the selected case are automatically
collected and presented in a table. The table includes all cells with a karyogram or at least a cell karyotype (but no karyo-
gram). Cells without karyotype and/or karyogram are excluded from the analysis, because they do not contribute any in-
formation to the analysis.
Chromosomes are displayed in the same display mode that was active, when the image (karyogram) was saved, but you
may switch to another display mode to gain more information (see Color Display Modes below).

51 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
Combined Karyogram aspect for Ikaros/Isis root directories

Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Select Filter / Sort Criteria for Cells

5 Quick Search 6 Global Commands


(Refresh - Quick Search - Fullscreen Mode)

7 Case List Panel 8 Case Info Panel

9 Workflow Bar 10 Aspect selection

11 Combined Karyogram 12 Command Buttons

13 Display Selection and Settings 14 Show / Hide Case Tree, Case Info Panel and Analysis Sheet

15 Aberration Summary Table 16 Case Karyotype (with specific command buttons)

17 Status Bar
(Alias of server currently connected to, user name, alias and type
of current root directory, content of report buffer, items matching
current filter conditions)

Customize the Combined Karyogram

In the default display mode, both chromosomes and aberrations are displayed in the combined karyogram. If you prefer
to see just chromosomes or aberrations, tick of the respective option ( 13 ):

MetaServer & MetaClient 2.1


MetaSystems 52
Settings

Display settings for combined karyograms are now combined in the View Settings. g-click the button to open
the dialog ( 13 ).

View Settings window for the Combined Karyogram aspect

Table Orientation
You can pivot the combined karyogram table:
a Display cells as rows - with Culture, Slide, Cell, CloneXChr. Cnt, and the chromosome class numbers as column
headers and image numbers as row titles.
a Display cells as columns - with image numbers as column headers and Culture, Slide, Cell, and chromosome class
numbers as row titles.

Aberrations
a Detailed aberrations - Displays the assigned detailed aberration below chromosome classes. The Aberration Sum-
mary table lists aberrations by chromosome number (ascending, see below).
a Compact aberrations - Assigns placeholders for aberrations - A: aberration 1, B: aberration 2, C: aberration 3,... -
and displays the letters below chromosome classes instead of the full aberration text. The Aberration Summary
table list aberrations by compact aberration letter (ascending, see below).

Chromosome Class and Cell Selection

If you interested to compare not all chromosome classes, but just some particular ones, use the Chromosome Class and
Cell Selection possibilities to limit the displayed content of the combined karyogram:
a g-clicking opens a Select Chromosome Numbers window, in which you select / deselect the
displayed chromosome classes. You can either tick classes individually or select or . Confirm with
or exit with .
a g-clicking opens a Select Cells window, in which you select / deselect the cells included in the
analysis. The Cell table features six columns: Name (cell number), Culture, Slide, Clone, Karyo (karyogram present),
and Karyotype. The column width can be adjusted individually. You can either tick classes individually or select
or . Confirm with or exit with .

53 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
The parameters in the central panel modify the presented information. You can choose, whether you want to:

a Display Culture - Toggle on /off the culture designation in the combined karyogram table.
a Display Slide - Toggle on /off the slide name in the combined karyogram table.
a Display Chromosome Count - Toggle on /off the chromosome count in the combined karyogram table.
a Display Incomplete - An optional column inc can be displayed in the combined karyogram that marks cells with in-
complete karyotypes with an x. For clonal/composite karyotypes inc is added to the calculated karyotype if at least
one included karyotype is incomplete.

Color Display Modes

The various display modes for Ikaros / Isis images are also available for the combined karyogram in MetaClient: RGB (de-
fault), Gray Scale, Inverted Gray Scale, Merged Colors, Modified Colors, Primary False Colors, Combined False Colors
(max. intensity).

Assign Cells to Clones

You can assign cells to clones in the combined karyogram, when you choose the Display cells as rows orientation (Set-
tings, see above).
1. Move the mouse pointer over the respective field in the Clone column in the combined karyogram. The background
of the selected field will switch to black.
2. By g-clicking the and symbols you can increase or decrease the clone number assigned to the cell.
3. Repeat for other (all) cells in the case.

Definition of a Clone
A clone is defined as a cell population derived from a single progenitor. It is common practice to infer a clonal origin when a
number of cells have the same or closely related abnormal chromosome complements. A clone is therefore not necessarily com-
pletely homogenous because subclones may have evolved during the development of the tumor. A clone must have at least two
cells with the same aberration if the aberration is a chromosome gain or a structural rearrangement. If the abnormality is loss
of a chromosome, the same loss must be present in at least three cells to be accepted as clonal. (ISCN 2013)

Aberrations Summary Table

The Aberrations Summary Table below the combined karyogram is a helpful tool to establish a case karyotype, espe-
cially from variable cell karyotypes ( 15 ).
The summary table has the following features:
a Aberrations are extracted from the cell karyotypes and listed. All cells of a case and all chromosome classes contrib-
ute to the aberration table, irrespective of the current filter and display options.
a The count of occurrences is given for every aberration.
a The automatic sorting of the aberration table depends on the settings (k 53 ):

a Detailed aberrations: Aberrations are sorted according to the rules of ISCN.

MetaServer & MetaClient 2.1


MetaSystems 54
a Compact aberrations: For simple, numeric aberrations, the first column of the table remains empty, but for
complex, non numeric aberration the first column list the substitute letter (A, B, C,...) in the first column and aber-
rations are sorted accordingly.

a Sort the table manually by g-clicking a column header - the table is sorted by the selected column (ascending). g-
clicking the header again inverts the sort direction.
a G-clicking an aberration copies the aberration to the case karyotype editor.
a If a case karyotype already exists, new aberrations are inserted at valid insert positions only (as the first aberration,
between two aberrations, after the last aberration) and properly separated by commas. This makes it easy to build up
a consolidated ISCN-compatible case karyotype from different cell karyotype.
a The aberration summary table is included in reports and printed on a separate page at the end of the report.

Analysis Sheet

In order to extract a maximum of information from the combined karyogram, you can also insert the analysis sheet (see
previous chapter). To do so, g-click the icon (and hide the case tree temporarily by g-clicking the icon).

Case Karyotype

Derive Composite Karyotype / Clonal Karyotype from Cell Karyotypes

MetaClient is capable of generating a case karyotype from individual cell karyotypes automatically following the rules of
ISCN 2013.

ATTENTION!
a Only ISCN 2013 compliant cell karyotypes can be scored automatically. If cell karyotypes contain non-ISCN
conform entries, theses entries will be omitted. A corresponding message will warn you, if such an entry is
detected while building a a composite or clonal karyotype.
a Non-conform cell karyotype entries will be ignored entirely.

Assume a case, which exhibits a great variety of chromosomal aberrations - both numerical and structural. Some cell ka-
ryotypes, picked at random, illustrate the problem to consolidate the individual karyotypes into one comprehensive form:
:::
Metaphase 005 47,XX,+X,add(1)(p36.?3),+5,-6,+7,add(12)(q13),t(14;18)(q32;q21),-20,-21,+mar1
:::
Metaphase 012 48,XX,+X,add(1)(p36.?3),+5,-6,+7,add(12)(q13),t(14;18)(q32;q21),-20,+mar1
:::
Metaphase 027 45,XX,add(1)(p36.?3),-6,add(12)(q13),t(14;18)(q32;q21),-20,+mar1
:::

Building a case karyotype from the individual cell karyotypes is a tedious and time-consuming task. MetaClient features
two complementary functions to derive a case karyotype in an instant. The combined karyotype from all of the meta-
phases in the example case would lead to a Composite Karyotype:

42~48,XX,+X[5],add(1)(p36.?3)[15],add(1)(p36.3)[3],+5[5],-6[18],+7[6],add(12)(q13)[21],t(14;18)(q32;q21)[20],+17[8],-
20[18],+mar1[15],+mar2[2][cp21]

The same karyotype expressed as a Clonal Karyotype will result in:

47~48,XX,+X[5],add(1)(p36.?3)[6],+5[5],-6[6],+7[6],add(12)(q13)[6],t(14;18)(q32;q21)[6],-20[6],+mar1[6][cp6]/

55 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
45,XX,add(12)(q13),der(14)t(14;18)/
45~46,XX,add(1)(p36.?3)[8],add(1)(p36.3)[3],-6[11],add(12)(q13)[11],t(14;18)(q32;q21)[11],+17[7],-20[11],+mar1[8],
+mar2[2][cp11]/
42,XX,add(1)(p36.?3),-5,-6,-10,add(12)(q13),-13,-14,t(14;18)(q32;q21),+17,-20,+mar1/
46,XX,add(12)(q13)[2],t(14;18)(q32;q21)[2][cp2]

Composite Karyotype

1. To generate a composite karyotype, g-click the command button ( 16 ).


2. In the Composite Karyotype Settings you can define 'significance thresholds' for aberrations, i. e. how often an ab-
erration has to be observed before it is taken into account for the composite karyotype. You set thresholds independ-
ently for the two categories Chromosome Loss (default value: 3) and Chromosome Gain and Structural (default
value: 2) (as suggested by ISCN 2013, p.88).
3. Confirm with or exit with .

ATTENTION!
a An existing case karyotype will be overwritten, if you leave the settings window by g-clicking .
a The aberration summary table is not affected by these settings.

Clonal Karyotype

1. To generate a clonal karyotype, g-click the command button ( 16 ).


It is obvious, that a clonal karyotype can only be derived, if cells have been assigned to clones. Thus, a warning mes-
sage is displayed and the function is aborted, if you have not assigned at least one cell to a clone.
2. Follow steps 2 and 3 for a Composite Karyotype.

Edit Cell and Case Karyotypes

NOTE!
a Only supervisors and administrators can edit the karyotype in the combined karyogram aspect.
a Karyotype editing requires also the presence of Ikaros / Isis V5.7.

Edit Individual Cell Aberrations


It is possible to edit individual cell aberrations in the combined karyogram:
1. You can edit cell aberrations by j-clicking an aberration in the combined karyogram. Choose the
command from the context menu.

MetaServer & MetaClient 2.1


MetaSystems 56
Edit Aberration in Combined Karyogram
1. In the Replace Aberration window you can edit the selected aberration:

Replace Cell Aberration window


1. While the original aberration text on the left hand side is fixed, you can edit the copy in the field on the right hand side
of the window. Confirm with or exit with . After confirmation, the edited aberration text is inserted
into the combined karyogram. Likewise, the Aberration Summary Table is updated accordingly.

Edit Aberrations in the Aberrations Summary Table


It is possible to edit individual cell aberrations in the combined karyogram:
a You can edit cell karyotypes by j-clicking a list entry. Choose the command from the context menu.
a In the Replace Aberration window you can edit the selected aberration (see above). After confirmation the aberra-
tion text is updated in all cells carrying this particular aberration.

Copy Cell Aberrations to Case Karyotype


It is easy to copy an aberration from the Aberrations Summary Table to the Case Karyotype:
a If a case karyotype already exists, g-click the position in the karyotype, where you wish to insert the next aberra-
tion.
a Then G-click an aberration in the Aberration Summary Table. The selected entry is marked by a red background
color, copied to the case karyotype and inserted at the previously defined cursor position.

Edit Case Karyotype Manually


Case karyotypes can be directly edited:
a g-click the Case Karyotype panel to insert free text.
a Existing text can be edited or amended.
a When inserting an aberration into an empty Case Karyotype panel, the total chromosome count and the sex chro-
mosomes are automatically derived from the combined karyogram and inserted.
a For clonal karyotypes, you can introduce line breaks by pressing [Enter].

Clear Case Karyotype


You can delete an entire case karyotype in the Case Karyotype panel:
a g-click the button.

57 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
Save Case Karyotype
When you save case karyotype in MetaClient, the karyotype is automatically adjusted - unnecessary commas, line breaks
and spaces will be removed and lowercase/uppercase characters corrected.

a g-click the icon. The case karyotype is automatically to the Ikaros Case Datasheet (please note, that this step
will fail, if the Case Datasheet of the current case is already open in Ikaros).

Print Reports

Print Combined Karyogram Report

A pre-configured combined karyogram report includes all chromosome classes from all individual karyograms, and a ab-
erration summary table plus case karyotype on a separate page. Empty chromosome class columns/rows are omitted
from the report. The combined karyogram is printed using the selected display mode.

1. To print a combined karyogram report , g-click the command button.


2. A report is generated in the Report Viewer. Here you have the possibility to send the print job to a printer, to convert
the report into a PDF, WORD, or XML file (for details k 123 ).

Print Analysis Sheet

It is also possible to print the Analysis Sheet in the Comb. Karyo aspect.

1. If not visible, toggle the Analysis Sheet on by g-clicking the button.


2. g-click the button in the Analysis Sheet panel. A dedicated Analysis Sheet report is generated and displayed
in the Report Viewer (for details k 123 )
As of V 2.1, the report also includes marker chromosomes.

Export Data

Combined Karyogram

You can export combined karyotypes as Microsoft Excel tables. The exported table have a header consisting of Case
Name, Patient Name and Print Date.

1. g-click the button to export the displayed combined karyogram to Excel.


2. There are three options available that directly influence the content of the exported table:
Options for Combined Karyogram export:
a Export Karyotype of Cells - toggle on/off the Karyo-
type column in the prior to exporting.
a Export Aberration Summary Table - Include / ex-
clude Aberration Summary Table from the exported
file.
a Combine Cells with matching Karyotype - Group
and sort cells by matching aberrations / karyotype.

MetaServer & MetaClient 2.1


MetaSystems 58
Exported combined karyotype table - with Export Karyotype to Cells and Export Aberration Summary Table

Analysis Sheet

You can export the Analysis Sheet of a case also from the Combined Karyotype aspect as Microsoft Excel tables (for de-
tails k 51 ). The exported table have a header consisting of Case Name, Patient Name and Print Date.

3.3.2 Aspects for Metafer

After selecting a hierarchy level in the tree and an item in a branch, it is possible to reduce complexity even further by
choosing among different aspects. An aspect represents a particular view of the given data or a detailed extract of the
data of interest. Aspects are represented by a stack of tabs between the tree on the left and the central content (gallery)
panel. Clicking an aspect changes the displayed content and determines the possible actions.
The following aspects are available:

Aspect: Displays: Avail-


able for:

Pass The Pass List provides detailed information on Metafer pass, i. e. a scan run - k 63 .
List

Run The Run List summarizes some technical information on Metafer scan runs - k 59 .
List

Cell A Metafer Cell Gallery displays all cells found in a MSearch (metaphase finder) or in a MetaCyte (spot
Gallery counting) run - k 41 .

Data

NOTE! The Data aspect is only available for Metafer and VSlide root directories.

59 Part III MetaClient Views


'Tree' View Aspects for Ikaros / Isis
The Data aspect provides detailed information on a Metafer run. All kinds of parameters determining search condition
and cell selection as well other important data related to a scan run are listed and being displayed together with small
previews of Gallery, Overview Image, Label Image, Search Window, Diagram 1, and Diagram 2.

Data aspect for VSlide root directories

Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Select Filter / Sort Criteria for VSlides

5 Quick Search 6 Global Commands


(Refresh - Quick Search - Fullscreen Mode)

7 Case List Panel 8 Aspect Selection

9 Data Panel 10 Commands for Case or Image Management


(aspect-specific)

11 Overview Image 12 Show / Hide Case Tree

13 Status Bar
(Alias of server currently connected to, user name, alias and type
of current root directory, content of report buffer, items matching
current filter conditions)

Panels

In order to gain more space for VSlide data, you can toggle the Tree panel on / off by g-clicking the respective icons
at the bottom of the tree view window.

MetaServer & MetaClient 2.1


MetaSystems 60
Data Fields

The following Metafer data are listed, they grouped for better readability:

Data Field Description

General

Case Case name.

Culture Culture designation.

Slide Slide number.

Pass Pass number.

Slide Comment Slide comment added in Metafer.

Application Metafer scanning application / mode.

Classifier Name of scan classifier.

Scoring Sheet

Computer Name Name of scanning computer / Metafer system-ID.

Original Program Version Metafer program version in which a file was created.

Program Version Current Metafer program version.

Cells

Cells Current total number of cells.

Original Cells Number of cells in the original Metafer gallery.

Undefined Cells Number of undefined cells in the Metafer gallery.

Marked Cells Number of marked cells in the Metafer gallery.

Rejected Cells Number of rejected cells in the Metafer gallery

Highlighted Cells Number of highlighted cells in the Metafer gallery.

Search

Magnification Effective objective magnification, read from Metafer settings.

CCD Camera Pixel Size Length/width of camera pixel.

Search Window Either predefined search window (read from Metafer settings or actual area.

Capture Image Size Image size given in pixels (width x height).

Analysis Image Size Image size given in pixels (width x height).

Gallery Image Size Size of square gallery images (length/width, in pixel).

Gallery Image Colors Color mode for gallery images.

Counterstain Channel Number of color channel defined as counterstain

Search Duration Duration of search run (in HH:MM:SS).

61 Part III MetaClient Views


'Tree' View Aspects for Metafer
Data Field Description

Scanned Fields Number of captured image fields.

Rejected Fields Number of rejected fields.

Nucleus Count Result of automatic count of cell nuclei ('0', if disabled in Metafer)

Manual Mitotic Index Calculated mitotic index.

Flags

Fluorescence Mode (tagged): fluorescence illumination / 'blank': brightfield illumination.

Raw Bayer Mode (tagged): Raw Bayer mode / 'blank': standard RGB mode.

RGB Color Camera (tagged): RGB color camera / 'blank': monochrome camera.

Position List Scan (tagged): Position list scan / 'blank': Contiguous scan.

Has Comet Information (tagged): Includes Comet Assay information / 'blank': no Comet Assay informa-
tion.

External Overview Image (tagged): external overview image included / 'blank': no external overview im-
age available.

Internal Overview Image (tagged): internal overview image included / 'blank': no internal overview image
available.

Label Image (tagged): label area image included / 'blank': no label area image included.

Users & Dates

Search User User, who performed the Metafer search run.

Search Date Time stamp, when scan was started (date & time: DD.MM.YYYY HH:MM:SS).

First Evaluation User Short name of the user, who evaluated this pass first.

First Evaluation Date Date, when this pass was evaluated first (date & time: DD.MM.YYYY HH:MM:SS).

Last Evaluation User Short name of the user, who evaluated this pass last.

Last Evaluation User Date, when this pass was evaluated last (date & time: DD.MM.YYYY HH:MM:SS).

Lock User Short name of the user, who locked this pass.

Lock Date Date, when this pass was locked (date & time: DD.MM.YYYY HH:MM:SS).

MetaServer & MetaClient 2.1


MetaSystems 62
Pass List

NOTE! The Pass List is only available for Metafer root directories.

Pass List aspect for Metafer root directories

Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Select Filter / Sort Criteria for Metafer

5 Quick Search 6 Global Commands


(Refresh - Quick Search - Fullscreen Mode)

7 Case List Panel 8 Aspect Selection

9 Pass List 10 Content Selection

11 Show / Hide Case Tree 12 Status Bar


(Alias of server currently connected to, user name, alias and type
of current root directory, content of report buffer, items matching
current filter conditions)

63 Part III MetaClient Views


'Tree' View Aspects for Metafer
Snapshot of Metafer gallery.
Low magn. overview created by fusing all capture fields (no high-quality stitching). G-click
the Overview image to enlarge to full-size.
Snapshot of slide label (e. g. barcode label).
Schematic overview of the search window (search area).
Metafer diagram 1.
Metafer diagram 2.
Name Pass designation.
Application Metafer application engaged in the pass.
Classifier Name of Metafer classifier.
Comment Slide comment.
Cells Number of cells in the gallery (cell count).
Created Creation date (= end of search).

While you can toggle on/off the visibility of the first group of columns presenting graphical elements, the remaining
columns can be customized in Configure - Settings- Pass List (k 166 ).

MetaServer & MetaClient 2.1


MetaSystems 64
Cell Gallery

NOTE! The Cell Gallery is available for Ikaros/Isis and Metafer root directories.
a The Ikaros/Isis Cell Gallery is available for Case, Culture, and Slide levels.
a The Metafer Cell Gallery is only available for Slide and/or Pass levels.

The screenshot below shows a Metafer gallery of G-banded metaphases in MetaClient:

Cell Gallery aspect for Metafer root directories

Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Select Filter / Sort Criteria for Metafer

5 Quick Search 6 Global Commands


(Refresh - Quick Search - Fullscreen Mode)

7 Case List Panel 8 Aspect Selection

9 Cell Gallery 10 Content Selection

11 Status Bar 12
(Alias of server currently connected to, user name, alias and type
of current root directory, content of report buffer, items matching
current filter conditions)

MetaClient can display Metafer galleries of found cells. The galleries are shown in the same display mode as they have
been saved in Metafer.

65 Part III MetaClient Views


'Tree' View Aspects for Metafer
Gallery Image Size
1. You can adjust the size of the gallery images by moving the Image Size slider with the pressed left mouse button to the
left (smaller) or right (larger).

Allocate Maximum Space for Gallery Display

1. In order to see more gallery images at once, you can temporarily hide hide the tree on the left side: g--click the
icon to toggle the tree.

3.3.3 Aspects for VSlide

After selecting a hierarchy level in the tree and an item in a branch, it is possible to reduce complexity even further by
choosing among different aspects. An aspect represents a particular view of the given data or a detailed extract of the
data of interest. Aspects are represented by a stack of tabs between the tree on the left and the central content (gallery)
panel. Clicking an aspect changes the displayed content and determines the possible actions.
The following aspects are available:

Aspect: Displays: Available for:

Data The Data aspect provides detailed information on a VSlide run. All
kinds of parameters determining the search and stitching condition
as well other important data related to a scan run are listed and being
displayed together with an overview of the scanned and stitched area
on the actual slide - k 66 .

File List The File List displays all associated stack videos and snapshot files
belonging to a VSlide - k 69 .

Run List The Run List summarizes some technical information on VSlide scan
runs - k 69 .

VSlide List The VSlide List summarizes some technical information on VSlide
stitching run. - k 70 .

VSlide Gallery The VSlide Gallery displays virtual slides created by the concerted ac-
tion of Metafer and VSlide - k 71 .

Overview The Overview displays an enlarged preview image of the entire VSlide
- k 73 .

Data

NOTE! The Data aspect is only available for VSlide and Metafer root directories.

The Data aspect provides detailed information on a VSlide run. All kinds of parameters determining the search and stitch-
ing condition as well other important data related to a scan run are listed and being displayed together with an overview
of the scanned and stitched area on the actual slide.

MetaServer & MetaClient 2.1


MetaSystems 66
Data aspect for VSlide root directories

Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Select Filter / Sort Criteria for VSlides

5 Quick Search 6 Global Commands


(Refresh - Quick Search - Fullscreen Mode)

7 Case List Panel 8 Aspect Selection

9 Data Panel 10 Commands for Case or Image Management


(aspect-specific)

11 Overview Image 12 Show / Hide Case Tree

13 Status Bar
(Alias of server currently connected to, user name, alias and type
of current root directory, content of report buffer, items matching
current filter conditions)

Panels

In order to gain more space for VSlide data, you can toggle the Tree panel on / off by g-clicking the respective icons
at the bottom of the tree view window.

67 Part III MetaClient Views


'Tree' View Aspects for VSlide
Data Fields

The following VSlide data are listed, they grouped for better readability:

Data Field Description

General

Case Case name.

Culture Culture designation.

Slide Slide number.

Pass Pass number.

Run Run number.

Slide Comment Slide comment added in Metafer.

Magnification Effective objective magnification, read from Metafer settings.

Search

Application Metafer scanning application / mode.

Classifier Name of scan classifier.

Computer Name Name of scanning computer / Metafer system-ID.

Metafer Version Metafer program version.

Search Window Size of the actual search window (in Metafer relative coordinates).

Stitching

Stitch Mode Stitching mode.

Parameter Set VSlide stitching parameter set (*.VSP).

Computer Name Name of stitching computer / Metafer-VSlide system-ID.

VSlide Version VSlide program version.

Flags

Fluorescence (tagged): fluorescence illumination / 'blank': brightfield illumination.

Raw Bayer Mode (tagged): Raw Bayer mode / 'blank': standard RGB mode.

RGB Color Camera (tagged): RGB color camera / 'blank': monochrome camera.

Position List Scan (tagged): position list scan / 'blank': contiguous scan.

Mirrored Horizontally (tagged): image mirrored horizontally (to compensate for inverting phototube /
sideport) / 'blank': image not mirrored horizontally.

Mirrored Vertically (tagged): image mirrored vertically (to compensate for inverting phototube / side-
port) / 'blank': image not mirrored vertically.

Users & Dates

Search User User, who performed the Metafer search run.

MetaServer & MetaClient 2.1


MetaSystems 68
Data Field Description

Search Start Time Time stamp, when scan was started (date & time: DD.MM.YYYY HH:MM:SS).

Search End Time Time stamp, when scan ended (date & time: DD.MM.YYYY HH:MM:SS).

Stitch System User User, who performed the VSlide stitch run.

Stitch Start Time Time stamp, when stitching was started (date & time: DD.MM.YYYY HH:MM:SS).

Stitch End Time Time stamp, when stitching ended (date & time: DD.MM.YYYY HH:MM:SS).

File List

MetaClient supports stack videos and snapshots generated by MetaSystems' VSViewer. Use the Store As Additional Slide
File option in VSViewer to store these additional files together with the *.VSI source file.

When loading a *.VSI file, MetaClient detects the presence of additional files and adds them automatically to the File List
aspect. The File List is updated automatically: for all files a small Preview, their Filename, creation date (Created), last
modification date (Last Changed) and the file Size is displayed. 8L-click a column header to sort the table by this category.

Delete associated stack video and snapshot files from MetaClient


1. Select the Tree view by g-clicking the respective tab.
2. Choose the File List aspect.
3. Highlight the associated file in the list.

4. Then either press [Del] or g-click the command icon. After confirmation the selected is file is going to be de-
leted.

Save associated stack video and snapshot files in another folder


1. Select theTree view by g-clicking the respective tab.
2. Choose the File List aspect.
3. Highlight the associated file in the list.

4. Then either press [Del] or g-click the command icon. After confirmation the selected is file is going to be de-
leted.

Run List

NOTE! The Run List is only available for VSlide root directories.

The table in the Run List summarizes some technical information on VSlide scan runs.
The table displays the Label Image (optional*), the Stitch End time, the magnification used in image acquisition (Magn.),
the Metafer application (MF Appl.), the Metafer Classifier (MF Classif.), a Slide Comment, and the Parameter Set defin-
ing the stitching conditions in VSlide.
You can customize the table in Configure - Settings - Run List (k 181 ).

69 Part III MetaClient Views


'Tree' View Aspects for VSlide
Control Visibility of Label Image and Panels

Label Image
Because preview images of the slide's label area make the Run List table less readable and reduce the number of visible
table rows, you can toggle on/off the visibility of label images in the list:

Panels

In order to concentrate on just a particular information or to gain more space, you can toggle the Tree panel on / off
by g-clicking the respective icons at the bottom of the tree view window.

VSlide List

NOTE! The VSlide List aspect is only available for VSlide root directories.

The VSlide List summarizes some technical information on VSlide stitching runs.
The table displays the Label Image (optional*), the Tissue ID the Stitch End time, the magnification used in image acquisi-
tion (Magn.), the Metafer application (MF Appl.), the Metafer Classifier (MF Classif.), a Slide Comment, the Parameter
Set defining the stitching parameters in VSlide, the output file Format, the File Size (KB) of the output file and the Output
Type.
You can customize the table in Configure - Settings - VSlide List (k 182 ).

MetaServer & MetaClient 2.1


MetaSystems 70
VSlide Gallery

NOTE! The VSlide Gallery is only available for VSlide root directories.

VSlide Gallery aspect for VSlide root directories

Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Select Filter / Sort Criteria for VSlides

5 Quick Search 6 Global Commands


(Refresh - Quick Search - Fullscreen Mode)

7 Case List Panel 8 Aspect Selection

9 VSlide Gallery 10 Adjust Gallery Image Size

11 Filter / Sorting of Cell Gallery 12 Show / Hide Case Tree

13 Status Bar
(Alias of server currently connected to, user name, alias and type
of current root directory, content of report buffer, items matching
current filter conditions)

The VSlide Cell Gallery aspect displays virtual slides created by the concerted action of Metafer and VSlide.

71 Part III MetaClient Views


'Tree' View Aspects for VSlide
See Cell Information at a Glance

Gallery Info and Gallery Hints

Gallery Info
For each VSlide gallery image, a label area is displayed. The label presents information about the image:

Corner Field

Upper Left Color mode

Upper Right Creation Date & Time

Lower Left File Format

Lower Right File Size

Gallery images for encrypted images are now displayed using the symbol .

Gallery Hints
When you move the mouse pointer over an gallery image, a semi-transparent hint window is displayed.

Control Visibility of Information

Image Size, Image Type, and Panels

Image Size
In the Cell Gallery for Ikaros/Isis and Metafer as well as the VSlide Gallery it is possible to adjust the gallery images scaling
in nine steps using the the image size slider ( 10 ):

MetaServer & MetaClient 2.1


MetaSystems 72
Panels

In order to concentrate on just a particular information or to gain more space, you can toggle the Tree panel on / off
by g-clicking the respective icons at the bottom of the tree view window ( 12 ).

Filter and Sort VSlide Gallery


It is possible to sort and filter a VSlide Gallery.

1. In the gallery, g-click the or button to open either the Gallery Filter or the Gallery Sort-
ing configuration window. You can use the fixed options or create a Custom filter or sorting.

To filter a VSlide Gallery, create a Custom filter (k 200 how to define filter conditions). Use either one of the four given
sorting criteria or choose a Custom sort criterion. All VSlide specific data fields can be applied here (k 197 for a list of
VSlide data fields).

2. You can toggle on / off filter conditions using the [F] key: if a filter condition is active, pressing [F] disables the filtering,
and vice versa. Disabling a filter condition is equivalent to the All VSlides filter option.

3. g-click a filter or sort option and confirm by g-clicking the button.

Overview

NOTE! The Overview aspect is only available for VSlide root directories.

The Overview aspect displays an enlarged preview of the selected VSlide.

3.4 'Statistics' View

The Statistics view provides a user interface for executing, creating and managing queries.

Queries are more or less complex computation tools to extract meaningful information from data sets. Specific informa-
tion is retrieved from different data sources, processed and correlated, and the final output can be presented as tables or
diagrams of various types.

73 Part III MetaClient Views


'Tree' View Aspects for VSlide
MetaClient already includes a number of pre-made queries (k 111 ). They can be used directly or serve as a starting point
for the development of your own customized queries. In the Query Editor you can modify existing queries or create new
ones (k 113 ).

With V 2.1,Overview and Statistics views are available for Metafer and VSlide root directories. VSlide queries use the ex-
tension VDEF, VSlide dashboards use the extension VDBD.

The example below shows a complex custom query producing four different outputs:

Statistics View

Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Locked / Unlocked dashboard

5 Query Selection and Query Command Buttons 6 Global Commands


(Refresh - Quick Search - Fullscreen Mode)

7 Query Panel 8 Query Diagrams and Tables

9 Commands for Query Management 10 Status Bar


(Alias of server currently connected to, user name, alias and type
of current root directory, content of report buffer, items matching
current filter conditions). The Status Bar is hidden in fullscreen
view mode.

The main purpose of the statistics view is to display the results of queries. Query results can be presented as tables or dia-
grams. A query can have multiple results (as shown in the example above). The available space is partitioned into displays
depending on the selected display mode. Each display is assigned to another query output.

MetaServer & MetaClient 2.1


MetaSystems 74
How can I …?
Operations marked with a * are only available if editing is unlocked.

Lock and Unlock Editing

1. The statistics view supports two modes (see 4 ):

= Editing
Locked: Only the execution of existing queries is allowed. This should be used in routine work to avoid
unwanted modifications to queries.

= Editing Unlocked: Queries can be created, modified and deleted.

2. You can switch between the two modes by g-clicking on the lock/unlock symbol.

Execute a Query

You can execute a query by following these steps:


1. Select the query in the Query Box in the upper left corner of the statistics view.
2. g-click the Execute button.
Depending on the complexity of the query, execution can take a couple of seconds. The results of the query are then dis-
played in the lower part of the statistics view.

Select a Display Mode

Several display modes are available for displaying the query results. A display mode governs how the available space is
partitioned into displays and how many query results can be displayed at once. The following display modes are available:

All available space is used to display one query result.

The available space is split horizontally and two query results are displayed next to each other.

The available space is split vertically and two query results are displayed.

The available space is split vertically and the lower half is split horizontally. That way, three query results can be
displayed together.

The available space is split vertically and both halves are split horizontally. That way, four query results can be
displayed together.

You can customize the partitioning of the available space by moving the mouse over the line between two displays until
the cursor changes to a or sizer cursor. Then hold the left mouse button down and move the mouse to adjust the
size of the displays.

75 Part III MetaClient Views


'Statistics' View
Assign a Query Result to a Display

To assign a query result to a display you can use any of the following methods:
a G-click the query result in the query result list. You are then asked to select a display. Displays are numbered clock-
wise starting in the upper-left corner of the statistics view.
a 'Drag and drop' a query result from the query result list to a display.

Auto-Arrange Query Results

Auto-arrange query results

You can return to the original display mode, by g-clicking the Auto-arrange query results icon in the lower left corner
of the statistics view.

Export Query Results

Export query results

Query results can be exported to:


a Microsoft® Excel®
a XML files
To export query results, g-click the Export query result icon in the lower left corner of the statistics view. This opens
the Export Query Results dialog.
Select an export mode and g-click OK. In case of an XML file export, you then need to specify the filename of the result-
ing XML file.

NOTE! In order to export query results to Microsoft® Excel® you need to have Excel© installed on your com-
puter.

Print Query Results

Print query results

You can print the query results by g-clicking the printer icon in the lower left corner of the statistics view. This opens
the Print Query Results dialog.
In the upper part of the dialog you can specify which query results you want to include in your printout. In the lower part
of the dialog you can:
a Specify if query results should be printed on individual pages or not.
a Enable or disable color-printing.

MetaServer & MetaClient 2.1


MetaSystems 76
Edit a Query

To edit the selected query, make sure that the g-click the Edit button. This opens the query editor (k 113 ).

Rename a Query

You can rename the selected query by g-clicking the Rename button. You are then asked for a new name for the query.
Enter the name and g-click OK.

Delete a Query

You can delete the selected query by g-clicking the Delete button. You are then asked to confirm the deletion. Note that
deleted queries cannot be restored.

Create a New Query

To create a new query, g-click the New... button. You are then asked for a name for the new query. After g-clicking
OK the query editor is opened (k 113 ).

Set Availability of a Query by User Status

ON: Available to Supervisors and Adminis- OFF: Available to all users


trators

The visibility of each query can now be controlled in statistics view. A query is either public (all users can execute it) or only
for supervisors and administrators. By default, a query is public. To change the availability state of a query:
1. Go to the Statistics view tab and select the Query in question from the drop-down list.

2. Unlock this query by G-clicking icon.


3. g-click the Only Supervisors button. The button should change its appearance to a "blue glow" in order to indicate
its active state. Now, the selected is only available to supervisors and administrators.

Jump to a Related Item

It is possible to jump from a query list entry directly to the related item(s) by G-clicking an output value in a query result
table:

77 Part III MetaClient Views


'Statistics' View
a If only a single item (e. g.: a case, an image) is linked to a value (e. g.: case name), then MetaClient switches to the Tree
view and highlights the item.
a If multiple items (e. g.: a list of cases, a list of images) is linked to a value (e. g.: review percentage), then MetaClient
opens a new window Items linked with value ..., which lists all linked items. You can jump to a linked item by G-
clicking the matching list entry. MetaClient switches to the Tree view and highlights the item.

3.5 'Problems' View

Problems View

Legend
1 Root Directory selection 2 Menu Bar

3 View tabs 4 Pending Problems

5 Suggestions for manual Problem Resolution 6 Suggestions for automatic Problem Resolution

7 Status Bar
(Alias of server currently connected to, user name, alias and type
of current root directory, content of report buffer, items matching
current filter conditions). The Status Bar is hidden in fullscreen
view mode.

MetaServer & MetaClient 2.1


MetaSystems 78
If MetaServer detects an inconsistency in the data structure or a configuration error, a Problems tab is being displayed
until the problem is solved.
When you add a root directory in MetaServer, the new root directory should be scanned for problems (k 147 ) and prob-
lems should be solved straight away following the suggestions provided by MetaServer. If new problems arise during nor-
mal operation, however, MetaServer displays the warning messages on the Problems tab in MetaClient.

The Problems tab is divided into three panels:


a The list of pending problems is shown in the top panel. Each problem is identified by its Name, Type and Time
stamp. For detailed information on the problem, please consult the Description column. g-click the Refresh but-
ton to see the latest problems.
a MetaServer/MetaClient offer suggestion on how to resolve a particular problem. Under the Manual Resolution head-
line you will the suggestions for the problem highlighted in the Pending Problems list. Once you implemented the re-
quired changes, g-click the Mark as Resolved button and then Refresh to remove the problem from the list.
a For greater comfort, MetaServer/MetaClient also offer Automatic Solutions, in most instances. Just g-click the Re-
solve button and then Refresh to check, whether the problem was resolved properly.

79 Part III MetaClient Views


'Problems' View
Data
Management
IV
4.1 Root Directories Management

Root Directories are the top level organization unit for data generated by MetaSystems' systems. On the level of the Win-
dows operating system they are represented by folders in the 'root' of a local or network drive, for example '<SERVER>/
Msd_BoneMarrow'.

MetaServer and MetaClient support three different types of root directories:


a For Ikaros/Isis - Karyotyping and FISH image files and CIFs (case information files).
a For Metafer - Scan run files (= passes) - *.MSD and *.MSX files - from all applications: MSearch, MetaCyte (light),
RCDetect.
a For VSlide - Virtual slide images from tissue sections, captured in transmitted and epi-fluorescent light. Various file
formats are supported.
If you have not configured root directories already during installation of MetaServer (Setup Wizard, k 143 ), you can add,
edit, and/or delete root directories at any time in MetaServer or MetaClient.

NOTE!
a Only supervisors and administrators can add root directories in MetaClient.
a It is no longer possible to create two root directories with the same path.
a It is no longer possible to change the type of a root directory after it has been created.

MetaServer & MetaClient 2.1


MetaSystems 80
How can I ... ?

Add Root Directories

Please observe the notes on secure root paths, k 142 .

Add Root Directories in MetaServer

NOTE! Local root directories can only be configured in MetaServer! Nevertheless, MetaServer displays a warning
when adding a local root directory where the path is neither a UNC network path nor a mapped network drive.

1. In MetaServer, navigate to the Root Directories tab. If MetaServer has been reduced to the Windows System tray,
j-click the MetaServer icon first in order to open the context menu and choose the Show MetaServer command.
2. g-click the Add... command button.

3. In the Add Root Directory window choose an informative Alias. Then type the whole (network) Path or click the
folders icon to navigate to the respective folder. It is important to select the right Type of data source: Ikaros/Isis,
Metafer, or VSlide. Tick the Secure option, if you run Ikaros/Isis or Metafer in 'security mode'.
4. When adding a new root directory in MetaServer, you have the possibility to scan this root directory for problems (see
below 82 ).

Add Root Directories in MetaClient

NOTE! Root directories can be added in MetaClient as a UNC network path or a mapped network drive only!

1. In MetaClient, g-click the Root Directory menu in the menu bar, navigate down to the Manage Add Root Direct-
ory ... command.

2. In the Add Root Directory window choose an informative Alias. Then type the whole (network) Path or click the
folders icon to navigate to the respective folder. It is important to select the right Type of data source: Ikaros/Isis,
Metafer, or VSlide.
3. Then g -click the Manage - Reload Root Directory List command to update the list accordingly.

Special: Importing Root Directory Information from Existing Ikaros/Isis Configuration


MetaServer can import information on root directories registered with Ikaros or Isis directly from the respective Ikaros/
Isis configuration files - IksRootPathList.ini or IssRootPathList.ini.
1. In MetaServer, navigate to the Root Directories tab. If MetaServer has been reduced to the Windows System tray,
j-click the MetaServer icon first in order to open the context menu and choose the Show MetaServer command.
2. g-click the Import... command button. In the Select Configuration File window you can navigate to any local or
network folder in order to select different another configuration file.

Edit Root Directories in MetaServer

1. In MetaServer, navigate to the Root Directories tab. If MetaServer has been reduced to the Windows System
tray, j-click the MetaServer icon first in order to open the context menu and choose the Show MetaServer
command.

81 Part IV Data Management


Root Directories Management
2. g-click the respective root directory in the list and then g-click the Edit ... command button.
3. In the Edit Root Directory window choose an informative Alias. Then type the whole (network) Path or click the
folders icon to navigate to the respective folder. It is important to select the right Type of data source: Ikaros/
Isis, Metafer, or VSlide. Tick the Secure option, if you run Ikaros/Isis or Metafer in 'security mode'.
4. If the Alias of a root directory has been changed, g -click the Manage - Reload Root Directory List command
to update the list accordingly.

NOTE! Local root directories can only be configured in MetaServer! Nevertheless, MetaServer displays a warning
when adding a local root directory where the path is neither a UNC network path nor a mapped network drive.

Delete Root Directories

1. In MetaServer, navigate to the Root Directories tab. If MetaServer has been reduced to the Windows System
tray, j-click the MetaServer icon first in order to open the context menu and choose the Show MetaServer
command.
2. g-click the respective root directory in the list and then h-click the Delete command button.
3. After confirmation the selected root directory is removed from the list of root directories in MetaServer.

NOTE! When you delete a root directory, the actual data are not removed, but only the root directory's registra-
tion within MetaServer and all associated index files.

Scan Root Directories for Errors

MetaServer can scan a selected Ikaros or Isis root directory for problems affecting the data integrity of the selected root
directory, for example for missing case information files and duplicate images or cases.

NOTE! Metafer and VSlide root directories cannot be scanned for errors.

1. In MetaServer, navigate to the Root Directories tab. If MetaServer has been reduced to the Windows System tray,
j-click the MetaServer icon first in order to open the context menu and choose the Show MetaServer command.
2. g-click the respective Ikaros / Isis root directory in the list and then g-click the Scan ... command button.
3. MetaServer then scans the entire content of the root directory and creates a summary report:
a If the file structure of the scanned root path is consistent, MetaServer will come back with a No problems found
message.
a However, if problems occur another tab is displayed on which the problems are listed in detail and solutions to
solve the problems are offered (see Special: Handling of Duplicate Cases k 148 ).

MetaServer & MetaClient 2.1


MetaSystems 82
4.2 Administer Data at Different Levels

Data Hierarchy Levels

In the Tree View you can display and select data at different levels of the Data Hierarchy. The available hierarchy levels
are listed below. The Case and Cell (previously Image) levels are fixed (F) and cannot be hidden. Some levels are visible by
default (D), but may be hidden, while others are hidden by default (O), but can become visible.

A particular hierarchy level includes all the information of the hierarchy levels below.

Data Level Icon Comments


Hierachy Status*
Level

Study O Combines several cases (experiments) in one study, for example for
biological dosimetry - hidden by default.
Case F Case (or experiment) level - this level is present all the time and
cannot be hidden.
Test O This level can be used to distinguish between different stainings or
FISH probes, for example - hidden by default.
Culture D For each cell culture condition another culture can be defined (in
Ikaros/Isis or Metafer) - visible by default.
Slide D Shows all slides prepared from different cultures - visible by default.

Pass O Slides could be scanned in Metafer with different parameters (classifi-


ers), each stored scan run is a 'pass' - hidden by default.
Region O Region of interest or cell clone on a slide (as defined in Metafer of
VSlide Viewer) - hidden by default.
Cell F Cell (or image) level - this level is present all the time and cannot
be hidden.
Field O Capture fields that belong to one cell (Ikaros/Isis - Add. Capture or
Metafer - AutoCapt) - hidden by default.
Run O VSlide virtual slide stitching procedures with different parameter sets -
hidden by default.
VSlide O VSlide virtual slide images - hidden by default.

* Level Status: F: Fixed, D: Default, O: Optional

83 Part IV Data Management


Administer Data at Different Levels
1. You can select the visibility of hierarchy levels by j-clicking an icon in Tree View.
2. The figure on the left shows the context menu with all hierarchy levels activated.
3. Toggle the visible levels on/off as needed for your type of experiments. It is recommen-
ded, to limit the number of visible hierarchy levels to those which provide valid informa-
tion. This measure will simplify selection, and, thus, speed up the workflow.

4.2.1 Ikaros/Isis File Administration

The major hierarchy levels for Ikaros/Isis are Cases and Cells (images, metaphases). A Case includes dependent Test, Cul-
ture, Slide, Pass, and Cell hierarchy levels. The visibility of hierarchy levels can be adjusted to meet your workflow require-
ments (k 83 ).

Cases

How can I …?

Select items - Navigate the Case List or Tree View

You can select an item case in the Case List or Tree view by g-clicking it, or use the following keyboard commands for
navigation:

Select an item directly above the cur- [y]


rently selected one.

Select an item directly below the cur- [Y]


rently selected one.

Open a branch in the tree. [>]

Close a branch in the tree [<]

Move one page up [PgUp]

Move one page down [PgDn]

Select the first item in the list [Home]

Select the last item in the list [End]

MetaServer & MetaClient 2.1


MetaSystems 84
The Case List also support multiple selection:

Select several cases Hold [Ctrl] + g-click cases.


Select contiguous group of cases g-click first case, then hold [Shift] + g-click last case or use [>] / [Y] keys to mark
cases.

Cancel selection [Ctrl] + [N]

Open a Case in Ikaros / Isis

Open in Ikaros Open in Isis

The procedure described herein requires Ikaros/Isis V5.4 or later! Cases are opened in Ikaros or Isis, depending on which
of the programs is selected as the preferred image viewer (k 159 ).
1. You can open the selected case in Ikaros or Isis by any of the following methods:

a G-click a case in the Case List.

a g-click the or icon.

a g-click Open in Ikaros or Open in Isis in the Case , Test, Culture, Slide, Region, Pass or Cell menu (depend-
ing on the selected hierarchy level).

a j-click a case to open a context menu and g-click the Open in Ikaros or Open in Isis command.

2. See the Ikaros/Isis Help file on how to work with Ikaros or Isis.

Print a Report

Print Report

1. You can print a report for a selected case by any of these two methods:
a g-click the Print Report command in the Reporting menu.

a g-click the respective icon in the Case List view.


a j-click a cell to open a context menu and g-click Print Report ... .

2. In the Print Report window you can choose the report Template.
3. g-click to start printing or g-click to exit with no action.
4. When the information has been processed successfully, the final report is presented in the Report Viewer window.
Here you have the possibility to send the print job to a printer, to convert the report into a PDF, WORD or XML file. For
details, please k 123 .

85 Part IV Data Management


Administer Data at Different Levels Ikaros/Isis File Administration
Export Case List

Export Case List

1. You can export a case list as displayed. The Period (k 28 ) Filter by (k 28 ) and Sort by (k 29 ) conditions apply. g-
click the respective icon in the Case List view.
2. In the Export Case List window you can choose among the Microsoft Excel and CSV File options.
3. g-click to export or g-click to exit with no action.
4. If you choose Microsoft Excel as export format and Microsoft Excel is available, MetaClient triggers Excel to open and
display the exported *.xls file. Otherwise, MetaClient opens a Save As... window, in which you can select the folder for
the exported *.CSV file.

Create a New Case

Create Case

1. You can create a new case by any of these two methods:


a g-click the Create Case ... command from the Case, Test, Culture, Slide, Region, Pass or Cell menu (depend-
ing on the selected hierarchy level).
a g-click the icon in the Case List view.

2. This opens the Create New Case window, in which you can:

Create New Case window

a Specify the new Case Name.


a Select a Subdirectory, in which the case should be created either by scrolling the list of available subdirectories
or typing the subdirectory name in the smart filter field.
a Create a new Subdirectoy by entering the subdirectory name in the smart filter field:

Add a new Subdirectory

MetaServer & MetaClient 2.1


MetaSystems 86
3. g-click the button to create a new case, or g-click to exit with no action.

NOTE! If you create a new case, that does not match the conditions of an active Case filter (Filter by:), you will
have the possibility to disengage the filter in order to make the new case visible.

Delete a Case

Delete case

1. You can delete selected cases (and their dependent Culture, Slide, Test, Region, and Cell hierarchy levels) by any of
these two methods:
a g-click the Delete command in the Case, Test, Culture, Slide, Region, Pass or Cell menu (depending on the
selected hierarchy level).
a g-click the icon in the Case List view.
a j-click the item to open the context menu and j-click the Delete command.

NOTE! If you delete a Culture, a Slide, a Test or a Region, all cases and cells, which are part of the deleted
item will be deleted as well!

2. After confirmation, the selected case and all its images are moved to a "trash" subfolder. If you incidentally delete the
wrong data, you can selectively recover them (k 107 ).

Rename a Case

Rename case

1. You can rename a selected case by any of these two methods:


a g-click the command icon.
a j-click the item to open the context menu and g-click the Rename Case ... command.

2. This opens the Rename Case dialog, where you must specify a new name for the case.

Rename Case window

In order to avoid conflicts with Windows file name conventions, the following rules apply:

Not Allowed Characters Not Allowed Case or File Names

< > : " / \ | ? * CON PRN AUX NUL COMn (n= 1...9) LPTn (n= 1...9)

87 Part IV Data Management


Administer Data at Different Levels Ikaros/Isis File Administration
Move Case(s)

Move Case(s)

1. You can move a case by any of these two methods :


a Select a case in the Case List or Tree view. The Case List also supports multiple selection (k 84 ). Then g-click
the Move Case(s) ... command from the Case menu.
a Select a case in the Case List or Tree view. Then g-click the icon in the Case List view.

Move Cases window

2. This command opens the Move Cases window, in which you can:
a Select a Root Directory.
a Select a Subdirectory, to which the case(s) should be moved to either by scrolling the list of available subdirect-
ories or typing the subdirectory name in the smart filter field.
a Create a new Subdirectoy by entering the subdirectory name in the smart filter field:

Add a new Subdirectory

3. g-click the button to move cases, or g-click to exit with no action.

MetaServer & MetaClient 2.1


MetaSystems 88
Cells (Images)

How can I …?

Select One or More Images - Navigate the Cell List or Cell Gallery

You can select a single image or a group of images either in the Cell List or in the Cell Gallery in the Tree view: You can
also use the following keyboard commands to navigate the list view.
The following navigation / selection hotkeys are available in the Cell List:

Select ...

... previous cell [<]

... next cell [>]

The following hotkeys are available in the Cell Gallery for easy navigation / selection and more:

Go to gallery start [Home]

Go to gallery end [End]

Scroll up one page [PgUp]

Scroll down one page [PgDn]

Select ...

... previous cell [<]

... next cell [>]

... all gallery images [Ctrl] +[A]

... a group of dispersed images in the gallery Hold [Ctrl] + g-click image 1, + g-click image 2,
+ g-click image 3 ...
... a contiguous group of images in the gallery g-click first image, then hold [Shift] + g-click last case or
use [y] / [Y] keys to mark cases

... invert gallery selection [Ctrl] + [I]

... cancel gallery selection [Ctrl] + [N]

Scroll current image into view [Space]

Toggle cell filtering on/off (= all cells) [F]

Toggle display of metaphases on/off (Cell Gallery only) [M]

Toggle display of karyograms on/off (Cell Gallery only) [K]

Increase image size [+]

Reduce image size [-]

89 Part IV Data Management


Administer Data at Different Levels Ikaros/Isis File Administration
Display of a zoomed version of the current image [Z]
(gallery image interpolated)

Hide zoomed version of the current image any key

Switch to review mode [G]

Add selection to report buffer [B]

Print a report [P]

Delete selected items [Del]

Open current item [Enter]

Open a Cell in Ikaros / Isis

Open in Ikaros Open in Isis

The procedure described herein requires Ikaros/Isis V5.4 or later!


1. You can open a selected cell in Ikaros or Isis by any of these methods:
a G-click a cell in the Cell Gallery (or Cell List).

a g-click the the or icon in the Cell List or Cell Gallery view.
a g-click the Open in Ikaros or Open in Isis command in the Cell menu.
a j-click a cell to open the context menu and g-click the Open in Ikaros or Open in Isis command.

2. See the Ikaros/Isis Help file on how to work with Ikaros or Isis.

Print a Report

Print Report

1. You can print a report for the selected cell by any of these methods:
a g-click the Print Report command in the Reporting menu.

a g-click the command icon in the Cell List or Cell Gallery view.
a j-click a cell to open the context menu and g-click the Print Report ... command.

2. In the Print Report window you can choose the Report template (k 122 ).
3. g-click the button to start printing or g-click Cancel to exit with no action.
4. When the information has been processed successfully, the final report is presented in the Report Viewer window.
Here you have the possibility to send the print job to a printer, to convert the report into a PDF, WORD or XML file. For
details, please k 123 .

MetaServer & MetaClient 2.1


MetaSystems 90
Delete a Cell

Delete Cell

1. You can delete a selected cell or a group of cells by any of these methods:
a g-click the Delete command from the Cell menu.
a g-click the icon in the Cell List or Cell Gallery view.
a j-click a cell to open the context menu and g-click the Delete command.

NOTE! If you delete a Culture, a Slide, a Test or a Region, all cases and cells, which are part of the deleted
item, will be deleted as well!

2. After confirmation, the selected case and all its images are moved to a "trash" subfolder. If you have deleted the
wrong data, you can selectively recover them (k 107 ).

Rename a Cell

Rename case

1. You can rename the selected cell by any of these methods:


a g-click the Rename command in the Cell menu.
a g-click the command icon.
a h-click a cell to open the context menu and g-click the Rename command.
2. This opens the Rename Case dialog, where you must specify a new name for the case.

Rename Cell window

3. In order to avoid conflicts with Windows file name conventions, the following rules apply:

Not Allowed Characters Not Allowed Case or File Names

< > : " / \ | ? * CON PRN AUX NUL COMn (n= 1...9) LPTn (n= 1...9)

91 Part IV Data Management


Administer Data at Different Levels Ikaros/Isis File Administration
Move Cell(s)

Move Cell(s)

1. You can move selected cells to another case by any of these methods:
a g-click the Move Cell(s) command from the Cell menu.
a g-click the command icon in the Tree - Cell Gallery view.
a j-click a cell to open the context menu and g-click the Move Cell(s) command.

Move Cells window

2. This opens the Move Cells window, in which you can:


i. Select a target Root Directory alias from the pull-down list of all registered root directories.
ii. Directly select a target Case from the case list, or
iii. Search for a target Case by typing the search string in the smart filter field.
Depending on the number of selected cells, moving may take some time. A progress bar shows you the progress of
the move operation.

3. g-click the button to move cells, or g-click Cancel to exit with no action.

Delete Unused Cell(s)

Delete Unused Cells

1. You can delete all unused cells by g-clicking the command icon. A cell is 'unused', if at least one of these condi-
tions is met:
a No karyogram exists
a No karyotype has been entered
a Count function not used
a Classify function not used

MetaServer & MetaClient 2.1


MetaSystems 92
The Delete Unused Cells window displays all cells in a case fulfilling the criteria. It is possible to tick off individual
cells to exclude them from deletion.

Delete Unused Cells window

2. g-click the button to delete cells, or g-click to exit with no action.


3. After confirmation, the selected case and all its images are moved to a "trash" subfolder. If you have deleted the
wrong data, you can selectively recover them (k 107 ).

Activate Inactive Cases and cells

If you have configured the automatic Maintenance functions in MetaServer (k 153 ), so that unused or all cells in a case
are deactivated after a certain period of time, you can selectively activate cells in MetaClient:
a in the Case List: inactive cases are marked in gray text and a red cross .
i. Select one or more cases and h-click to open the context menu.
ii. g-click the Activate Case(s) command to set the status of the selected case(s) to 'active'. This will take effect
immediately.

a in the Tree View: if a case contains inactive images, this message is displayed: Case is inactive (not all cells are
displayed).
i. L-click the command button to set the status of the selected cells and the case to 'active'. This will take
effect immediately.

93 Part IV Data Management


Administer Data at Different Levels Ikaros/Isis File Administration
Resolve Image Number Conflicts / Duplicate Cases

If MetaServer detects an image number conflict, a warning notification is displayed on the Problems tab in MetaClient
(this tab is not visible, if there are no problems/conflicts!). You can either follow the suggestion for Automatic Solutions
and just g-click the Resolve button (repeat for every listed problem) or edit the respective root path configuration
manually (k 183 ) and then g-click the Mark as Resolved button. When all problems are solved, the Problems tab disap-
pears automatically.

Interaction between Ikaros/Isis and MetaClient

Communication with MetaServer/MetaClient

NOTE! The messaging service described herein is only available as of Ikaros/Isis V5.4.

In order to establish proper communication between Ikaros and Isis on one side and MetaServer and MetaClient on the
other, it is advised to create a respective section in the IksRootPath.ini and/or IssRootPath.ini. These entries are re-
quired to enable communication from Ikaros / Isis to MetaServer about any changes to the data directory (new cases, new
images, new image fields, changes in the case data). For example:
[Global]
MetaSrvName=Server
MetaSrvPort=1050
When you create a new root path, the MetaSrvName and MetaSrvPort are copied automatically from the previous entry.

Use MetaClient for Image Navigation

NOTE! the functions described below only work as intended in combination with Ikaros / Isis V5.7. Please do
NOT use these functions with Ikaros / Isis V5.5 or earlier. If you wish to update to Ikaros / Isis V5.7, please con-
tact MetaSystems or your local MetaSystems representative. For contact details, please see backcover.

The possibilities for close interaction between Ikaros / Isis and MetaServer/MetaClient have been improved with
MetaServer / MetaClient V2.1 and Ikaros/Isis V5.7. This combination allows you to use case and image navigation func-
tions of MetaClient directly in Ikaros/Isis: the Case List and the Image/Metaphase Gallery as well as the Karyogram Gallery
can be (temporarily) substituted by the corresponding functions in MetaClient.
In order to activate this option, activate the Ikaros / Isis parameter Use MetaClient for Image Navigation in General Set-
ting - General (see Ikaros / Isis Help). It goes without saying that MetaServer/MetaClient must be active to be employed.
MetaClient and Ikaros / Isis can run side-by-side. Use the [Tab] key to switch among both applications.

These are the advantages of using MetaClient functions:

a G-click the Case Name field in Ikaros/Isis: switch to MetaClient Case List View.
a G-click the Image Number field: switch to MetaClient Tree View.
a In Ikaros / Isis, you can still use the arrow buttons tu to the left and right of the image number, and also the keys
[PgDn] and [PgUp].

a In MetaClient, cases can be filtered by Period or another criterion from the Filter list and sorted.

MetaServer & MetaClient 2.1


MetaSystems 94
a Likewise, you can filter and sort galleries in the the Tree View of MetaClient.
a When you G-click a case or an image in MetaClient, it will be opened in Ikaros or Isis. If the Ikaros/Isis and MetaCli-
ent use a login without password, then a unified login procedure for MetaClient and Ikaros/Isis is used, i. e. you not
have to login to Ikaros/Isis, when you are already logged in at MetaSetup.

a MetaClient V2.1 features a new edit function for numerical and structural aberrations in the Combined Karyogram
(k 51 ). If you edit and replace aberrations, this will be transferred automatically to the case Karyotype field on the
Result tab sheet of the Ikaros/Isis datasheet.

Data Exchange

Default Data Fields


All default Ikaros / Isis data fields are also available in MetaClient. While a data field reference for Ikaros /Isis can be found
in the Ikaros / Isis Help, the corresponding list of data fields in MetaClient is available in the chapter Data Field Refer-
ences (k 184 ).

Import Custom Data Fields

Ikaros / Isis allow to create custom data fields (see Ikaros / Isis Help). MetaClient can import these custom data fields in or-
der to make them available in Infopanels (see below), reports (k 122 ), and queries (k 109 ):

1. To import Ikaros / Isis data fields, go to the Datafield Editor (menu Configure - Datafield Editor ...) and select the
Case hierarchy level.

2. g-click the icon on the right hand side of the editor window.
3. Choose Import DataSheet.ini ... to import customized fields TEXT01...TEXT12, SWITCH01...SWITCH12 or any user-
defined new data field.
4. Navigate to the respective DataSheet.ini file (on the server), g-click the file and then OK.

Information Panels

NOTE!
a Infopanels are only available for Ikaros/Isis root directories.
a The visibility of Infopanels is dependent on the settings for the individual hierarchy levels (k 174 ).

Information panels or Infopanels display a selection of case data. The data fields presented can be customized for every
hierarchy level individually.
The example above shows the default infopanel for the Case hierarchy level. You can add or remove data fields and also
alter the sequence in which they appear. The screenshot below displays a customized infopanel with an extra data field
Scanned Metas (Metaphases):

95 Part IV Data Management


Administer Data at Different Levels Ikaros/Isis File Administration
Customized Infopanel for Case hierarchy level (Ikaros/Isis root directory)

While the width of an infopanel is determined by the visibility of the workflow bar (k 97 ), the height of an infopanel is now
adjusted dynamically, so that no data field entry becomes hidden: all information shall be visible all the time. If the work-
flow bar is displayed, then the minimum height is equivalent to four rows, if the workflow bar is hidden, then the minimal
height is one row. For a detailed description, how to customize infopanels, please k 174 .

Display / Hide Infopanels

Infopanels and Workflow Bar are displayed by default. You can hide / display them by g-clicking the button in the
center panel.

Interpret Metaphase Remarks

MetaClient can parse and interpret entries in the (image/metaphase) Remarks field in Ikaros/Isis.

Remarks Syntax
Only entries following a particular syntax can be imported, all other remark will be ignored:
a The Identifier must be written left of the linker, which can be a = or :. The linker (assignment operator) is followed by
the actual value.
a No blanks allowed within a remark.
a Values with a blank must be written in " ".
a Various remarks can be separated either by comma or by blank.
Example: Both variants of the example metaphase remarks will be parsed and interpreted in the same way:

Identifier (left) Linker Value

CID = 37
MetaQual : "Very good"

Custom Remarks and Metafer Remarks


Metaphase remarks can be created:
a manually in Ikaros / Isis by typing the desired remark following the syntax as outlined above.
a semi-automatically in Ikaros / Isis with the extended count function in V5.7 or above - see Ikaros / Isis Help for details.
a in Metafer for exported images.

MetaServer & MetaClient 2.1


MetaSystems 96
Remarks in Ikaros / Isis Remarks generated by Metafer in exported images

Variable Categories - Examples: Fixed Categories:

Remark Category* Description Remark Category* Description


(Identifier) (Identifier)

SpotGrn Green FISH spots CID Cell ID (automatically generated)


SpotOrn Orange FISH spots SpotNo Spot number (automatically gener-
ated)
Fusion Fusion Count SpotID
Spot ID (descriptive label)
TissueID
Tissue ID (descriptive label)
MetaQual Metaphase quality
OVL Chromosome Overlaps

* In Ikaros / Isis, new categories / object types can be created in General Settings - Metaphase tab (see Ikaros / Isis
Help).

Create Custom Data Fields on the Cell Hierarchy Level


As of V 2.1 it is possible to define user-defined fields on the Cell hierarchy level (k 184 ). If the File Identifier of a new cus-
tom cell field matches an identifier used in the Remarks field, MetaClient can connect a cell/metaphase remark in Ikaros
or Isis with the corresponding data field and transfer the Value to the respective data field. After successful transfer into
the matching custom data field, the File Identifier and the Value are removed from the metaphase Remarks field in
MetaClient (although they are still visible in the Metaphase Remarks of Ikaros or Isis).

This feature can be used, for example, to parse:


a the Metafer Spot ID to a custom data field Region Number - this would allow to the cell gallery by clone/region/spot
and to define computed fields based on clone/region/spot information.
a the number of customized Objects Types in Ikaros/Isis (Additional Object Types in Count Function, see Ikaros / Isis
Help file) - this could be:

Count of overlaps=OVL

Count of chromosome clusters=CCL

Of course, you can combine several metaphase remarks and parse them to different data fields in MetaClient, for ex-
ample:

Spot-ID:15 OVL:8 CCL:2

Workflow Bar and Cell Categories

Workflow Bar

The Workflow Bar can provide an 'at-a-glance' information on the current processing status of an Ikaros/Isis case.
By default, the workflow bar:
a Is visible at the case level and at all hierarchy levels below. You can hide the Workflow Bar completely in the Info
Panel Settings (k 174 ).

97 Part IV Data Management


Administer Data at Different Levels Ikaros/Isis File Administration
a Has five levels: Created - Captured - In Analysis - Analyzed - Checked, of which the levels Created and Checked are
fixed.
1. When you move the mouse pointer over a node, the mouse pointer changes to a 'pointing hand'.
2. In order to progress on the Workflow Bar, g-click the an still unmarked node to the right.

This does not has to be the next node. If you process a case accordingly, you may jump more than one step ahead.
Any standard user can set workflow state (progress), but only supervisors / administrators are allowed to reset a
workflow state (regress). It is not possible to change the workflow state of inactive cases.

The pre-configured Workflow Bar includes five stages: Created - Captured - In Analysis - Analyzed - Checked. You can
display / hide the Workflow Bar for each hierarchy level individually in the Info Panel Settings. To customize the Work-
flow Bar, go to Configure - Workflow Settings ... . In the Workflow Settings window, you can set the Permissions to al-
ter the workflow progression, and you can edit the visible Workflow Stages (k 177 ).

Display / Hide Infopanels and Workflow Bar

Infopanels and Workflow Bar are displayed by default. You can hide / display them by g-clicking the button in the
center panel.

Cell Categories

Cell Categories can provide an 'at-a-glance' overview of the current processing status of all cells in a Ikaros/Isis case in the
Cell Gallery aspect of the Tree view (in contrast to the Workflow Bar, which visualizes the status of a case).

It is possible to define and customize up to ten different categories (k 171 ). Each category should have a descriptive title
and a distinctive color mark.

The colored category marks are visible as small colored triangles in the upper right corner of the metaphase gallery im-
ages and as colored squares in the gallery hints. Unassigned cells carry a white triangle.

Assigning a Cell Category rank to individual cells


1. By g-clicking a triangle you increase the category rank by one level, indicated by an immediate color change.
2. You can also assign another category from the pre-defined list:
a j-click a particular gallery image to open the context menu and select the Assign Category command. Then
choose a category from the list or re-set the category to the 'Unassigned' state.
a Select a cell by a g-click and type a number from 1 ... 9, 0, corresponding to categories 1 ... 10.

MetaServer & MetaClient 2.1


MetaSystems 98
Assigning a Cell Category rank to a group of cells
Select cells in the gallery as described here 89 . If the category for one cell among a group of selected cells is changed,
then all other cells in the group adopt the same category regardless of their former category.

NOTE! A categorized cell is set back to the


'undefined' state, when a cell is moved to
another case. However, a category state is
preserved upon renaming a cell within the
same case.

Configuring Cell Categories


MetaClient comes with a few pre-configured Cell Categories: green, orange, red, and white (= undefined). You can config-
ure the Cell Categories in Configure - Settings - Cell Categories (k 171 ). The two examples below demonstrate the po-
tential use of Cell Categories marks:

Examples of Different Use of Cell Categories

Filter or Sort Cells by Category


You can use the cell categories to filter or sort the Cell List or Cell Gallery of a case.

It is possible to sort and filter the cells by category. In the filter and sort settings dialog the cell category is included in the
directly accessible filter respectively sort criteria. To easily select the category for filtering a color combo box is used to
display the active categories with color and description. This combobox is only visible, when the filter criterion “Category”
is chosen. Disabled categories are still used in sorting, but it is not possible to filter inactive cell categories.

1. g-click the or button to open either the Cell Filter or the Cell Sorting configuration window:

99 Part IV Data Management


Administer Data at Different Levels Ikaros/Isis File Administration
Cell Filter Settings Cell Sorting Settings

4.2.2 Metafer File Administration

NOTE! Depending on the selection of visible hierarchy levels, not all levels mentioned herein may be directly
available in your MetaClient (for details, k 83 ) 83 .
The file management functions described below include all subsequent elements in the hierarchy of the selec-
ted (unless stated otherwise):

Case

Test

Culture

Slide

Pass

How can I …?

Open in Metafer

Open in Metafer

The procedure described below requires Metafer V3.10 or later! Metafer must be installed on the same computer as
MetaClient.
1. You can open a selected item in Metafer by any of these three methods:
a g-click the Open in Metafer command in the respective Case , Test , Culture , Slide , or Pass menu.
a g-click the command icon in the Case List or Tree - Pass level view.
a j-click the item to open a context menu and g-click the Open in Metafer command.

2. Metafer opens the first or the selected pass (scan run).

MetaServer & MetaClient 2.1


MetaSystems 100
Delete

Delete

NOTE! When you delete data, they are moved to a "trash" subfolder. If you have deleted the wrong data, you
can selectively recover them (k 107 ).

1. You can selected cases and their corresponding passes by any of these three methods:
a g-click the Delete command from the Case, Culture , Slide , or Pass menu.
a g-click the command icon in the Case List or Tree - Pass level view.
a h-click the item to open the context menu and g-click the Delete command.
2. After confirmation, the selected case and all its images are moved to a "trash" subfolder. If you incidentally delete the
wrong data, you can selectively recover them (k 107 ).

Move Pass(es)

Move Pass(es)

NOTE! Moving a Metafer Pass to a local Export Path is no longer possible in MetaClient, unless MetaServer is
running on the same computer in order to prevent unpredictable and unwanted results due to the fact that a
'local path' points to physically different drives on a MetaClient or on a MetaServer.

1. You can selected cases and their corresponding passes by any of these three methods:
1. You can move a case by any of these three methods:
a g-click the Move Pass(es) ... command from the Case menu.
a g-click the command icon in the Case List view.
a Select a pass in the Tree view by a g-click and then g-click the icon.

Move Passes Window

2. This opens the Move Passes window, in which you can:


a Select a Root Directory.from the list of registered Metafer root directories.
a Select an Export Path Find Folder window into which the selected pass(es) should be moved to.

3. g-click the button to move pass(es), or g-click to exit with no action.

101 Part IV Data Management


Administer Data at Different Levels Metafer File Administration
Copy pass(es)

Copy Pass(es)

NOTE! Copying a Metafer Pass to a local Export Path is no longer possible in MetaClient, unless MetaServer is
running on the same computer in order to prevent unpredictable and unwanted results due to the fact that a
'local path' points to physically different drives on a MetaClient or on a MetaServer.

1. You can copy Metafer passes by any of these three methods:


a g-click the Move Pass(es) ... in the Case menu.
a g-click the command icon in the Case List view.
a Select a pass in the Tree view by a g-click and then g-click the command icon.

Copy Passes Window

2. This opens the Copy Passes window, in which you can:


a Select a Root Directory from the list of registered Metafer root directories.
a Select an Export Path in a Find Folder window into which the selected pass(es) should be copied to.

3. g-click the button to copy pass(es), or g-click to exit with no action.

4.2.3 VSlide Case Management


1

NOTE! Depending on the selection of visible hierarchy levels, not all levels mentioned herein may be directly
available in your MetaClient. How to adjust the visibility of hierarchy levels, k 83 .

NOTE! The MetaSystems VSlide viewer software previously known as MetaViewer was renamed to VSViewer,
because MetaViewer® is a registered trademark of Metafile Information Systems, Inc.. Consequently, the old
VSViewer was renamed to ZViewer, too.

MetaServer & MetaClient 2.1


MetaSystems 102
How can I …?

Open VSlide on all Hierarchy Levels

The procedure described herein requires VSViewer V2.1 or later! VSViewer must be installed on the
Open VSlide same computer as MetaClient.

1. You can open a selected VSlide in VSViewer by any of these methods:


a g-click the Open VSlide command in the Case (Test, Culture, Slide,...) menu .
a g-click the respective command icon in the Case List view.

a In the Tree view, select a run on the Run List or VSlide List tabs by a g-click and then g-click the icon.

a In the Tree view, select a gallery image in the VSlide Gallery tab by a g-click and then g-click the icon.
2. VSViewer opens the selected VSlide.

Open another VSlide Instance

The procedure described herein requires VSViewer V2.1 or later! VSViewer must be installed on the
same computer as MetaClient.
1. You can open a selected VSlide in another VSViewer instance:
a j-click an item in the Tree View (either in the Tree or in the Run List, VSlide List, or VSlide Gallery aspect) to
open a context menu, and g-click Open VSlide or Open VSlide (New Instance). The new Open VSlide (New
instance) command allows to compare two or more VSlides side-by-side.

2. VSViewer opens the selected VSlide.

Delete VSlide(s) on all Hierarchy Levels

Delete VSlide(s)

1. You can delete a VSlide by any of these methods:


a g-click the Delete command from the Case (Culture, Slide, Pass,...) menu.

a g-click the command icon in the Case List view.


a j-click an item in the Tree View (either in the Tree or in the Run List, VSlide List, or VSlide Gallery aspect) to
open a context menu. Select the Delete command.
2. A dialog prompt you to confirm the deletion step. g-click the button to confirm, or g-click to
abort deletion.

103 Part IV Data Management


Administer Data at Different Levels VSlide Case Management
Move VSlide(s) on all Hierarchy Levels

Move VSlide(s)

NOTE! Moving a VSlide to a local Export Path is no longer possible in MetaClient, unless MetaServer is running
on the same computer in order to prevent unpredictable and unwanted results due to the fact that a 'local path'
points to physically different drives on a MetaClient or on a MetaServer.

1. You can move a VSlide by any of these methods:


a g-click the Move VSlide(s) ... command from the Case (Culture, Slide, Pass,...) menu.

a g-click the command icon in the Case List view.


a j-click an item in the Tree View (either in the Tree or in the Run List, VSlide List, or VSlide Gallery aspect) to
open a context menu. Select the Move VSlide(s) ... command.

2. Select a pass in the Tree view by a g-click and then g-click the icon.

Move VSlide Window

3. This opens the Move VSlides window, in which you can:


a Select a Root Directory from the list of registered Metafer root directories.
a Select an Export Path into which the selected pass(es) should be moved.

4. g-click the button to move VSlide(s), or g-click to exit with no action.

Copy VSlide(s) on all Hierarchy Levels

Copy VSlide(s)

NOTE! Copying a VSlide to a local Export Path is no longer possible in MetaClient, unless MetaServer is running
on the same computer in order to prevent unpredictable and unwanted results due to the fact that a 'local path'
points to physically different drives on a MetaClient or on a MetaServer.

1. You can copy VSlides by any of these two methods:


a g-click the Copy VSlide(s) ... command from the Case (Culture, Slide, Pass,...) menu.

a g-click the command icon in the Case List view.


a j-click an item in the Tree View (either in the Tree or in the Run List, VSlide List, or VSlide Gallery aspect) to
open a context menu. Select the Copy VSlide(s) ... .

2. Select a pass in the Tree View by a g-click and then g-click the icon.

MetaServer & MetaClient 2.1


MetaSystems 104
Copy VSlide

3. This opens the Copy VSlide window, in which you can:


a Select a Root Directory from the list of registered Metafer root directories.
a Select an Export Path into which the selected VSlide(s) should be copied to.

4. g-click the button to copy VSlide(s), or g-click to exit with no action.

VMD Upload

Upload VSlide(s)

MetaClient V 2.1 can upload VSlides directly to VMD* (Virtual Microscopy Database). This service requires a working VMD
installation. Please see here 183 for more details how to configure MetaClient for VMD.
The upload routine is available in the Case List as well as in the Run List, VSlide Gallery, VSlide List aspects.
1. You can upload VSlides by any of these two methods:
a j-click an item in the Cast List or the Tree View (in the Run List, VSlide List, or VSlide Gallery aspects) to
open a context menu. Select the Upload VSlide(s) command.

a g-click the command icon in the Case List view.

2. When MetaClient has connected to the VMD server, a window with the Ongoing VMD Uploads is displayed:
a For every queued file, the file size is indicated.
a For every uploading file, also the remaining upload time is shown.

3. You can close the window by g-clicking the Close button, uploading continues as a background process. You can
check the progress of the uploading by re-opening the window with the Show VMD uploads in the Tools menu.
4. It is possible to cancel uploads:
a Particular uploads can be canceled selectively, by g-clicking the button behind a list entry.
a To cancel the entire upload process, g-click the Cancel All command button.
If you close MetaClient while uploading VSlides is still in progress, a message will prompt you decide, whether you
want continue or cancel the current uploads.

* VMD is manufactured by Lightfields GmbH, Berlin, Germany.

105 Part IV Data Management


Administer Data at Different Levels VSlide Case Management
Focus Stack Videos and Snapshots

MetaClient supports Stack Videos and slide Snapshots, created by Metafer and VSlide. Stack videos and snapshots are
displayed as separate file in the File List aspect. If the file formats are linked to suitable program executables, they can be
opened by G-click (k 165 ).

4.3 Mirroring Data

A mirroring service is available in MetaServer. By engaging the mirroring service, MetaServer can create additional copies
of your data on local drives (USB / SATA hard disks) or network drives (NAS (network attached storage) or file servers)
automatically. In case of emergency, case data can be restored (manually) from the mirror. The consistency of the data set
on the mirror greatly depends on the frequency by which data is mirrored.

NOTE ! Mirroring data is not intended to substitute your data backup / archive routines. The mirroring service of
MetaServer should be considered only supplementary to increase data safety. It is possible to mirror one root
directory onto two (or more) mirroring devices - add one mirroring service for every mirror device. All data man-
agement functions also affect the mirrored data set(s):
a deleting of cases/images a updating of cases/images
a adding of cases/images a renaming of cases/images

Please refer to the Installation Guide chapter how to configure the mirroring service (k 148 ):
a Add, edit and delete mirrors.
a Set up the synchronization mode - manually or scheduled.

Synchronize Manually
1
If you have not set the synchronization mode to 'scheduled' (k 148 ), you should synchronize your data with the mirror site
on a regular basis:
1. On the computer running MetaServer, go to the Mirror tab in MetaServer. If MetaServer is running minimized, j-
click the MetaServer tray icon and select Show MetaServer from the context menu.
The Mirror tab displays a status summary of the server(s): server alias, activity (idle/synchronize), elapsed time since
the last synchronization run.
2. g-click the Synchronize command button. MetaServer executes the synchronization routine.
3. When the synchronization is complete, the status summary is updated automatically.

MetaServer & MetaClient 2.1


MetaSystems 106
Restore Data from Mirror

If your original data set have been damaged, you may want to restore the data from the mirror site:
1. On the computer running MetaServer, go to the Mirror tab in MetaServer. If MetaServer is running minimized, j-
click the MetaServer tray icon and select Show MetaServer from the context menu.
2. g-click the Restore command button.

Restore from Mirror Window

3. In the Restore from Mirror window you can select the target folder for the data. Please select an empty folder, be-
cause all existing data will be overwritten!
4. g-click the button to start the restoration process, or g-click to exit without restoring any data.

4.4 Recovering and Eliminating Cases and Images

MetaClient includes data management functions for Ikaros/Isis and Metafer files.
For example, you can delete:
a cells and cases from Ikaros/Isis root directories
a passes from Metafer root directories
a associated files

Deleting these files in MetaClient sends them to dedicated 'trash' sub-folders. There is one trash folder for every root dir-
ectory.

NOTE! The current version V 2.1 does not support 'trash' functionality for VSlide data as it would acquire too
much of disc space on the server hard disk to keep obsolete VSlide data for a longer period of time. Deleting
VSlide files eliminates them irrevocably from the root directory.

Deleted files can be viewed in the Manage Trash window.


1. To open the Manage Trash window, g-click the Manage... command in the Trash menu.
2. The table in the Manage Trash window display all recently deleted cases and files in a sortable table. You can sort
the Trash content by Type, Name, Deletion Date, User, Subdirectory (Iks/Iss root directories) or File Size (Metafer
root directories) simply by g-clicking the respective column header.

107 Part IV Data Management


Mirroring Data
Restore

Deleted files can be easily recovered and restored from the trash folder:
1. g-click the item you want to restore and then g-click the Restore command button.
The restoration routine checks, whether an item with the same name is present at the original site and in the entire root
directory. If a matching item is found, a message informs you, that the selected item cannot be restored.

Delete

IMPORTANT! The following step deletes the selected file(s) from the trash folder irrevocably!

Manually
It is possible to delete individual items, for example the largest Metafer files to free disk space, from the trash. Trash: Be-
fore deleting a single item, a confirmation dialog is displayed.
1. g-click the item you want to delete and then g-click the Delete command button.
2. A dialog prompt you to confirm the deletion step. g-click the button to confirm, or g-click to
abort deletion.

Automatically - Scheduled
Items from the trash can now be removed automatically after a configurable time. The removal schedule can be con-
figured in MetaServer on the Maintenance tab (k 153 ). Files will be deleted after the given number of days.

Empty Trash Folder


In order to increase the free disk space, you can finally remove items from the trash folder:
a g-click the Empty command in the Trash menu. 1

a g-click the Empty command button in the Manage Trash window.


In the Empty Trash window, you can decide, whether you want to remove All files or only Files older than .... day(s). You
can adjust the period freely for the latter instance.

IMPORTANT! The Empty command deletes files in the trash folder irrevocably!

MetaServer & MetaClient 2.1


MetaSystems 108
Queries

V
This chapter introduces the query and statistics framework integrated into MetaClient. The framework combines flexibil-
ity and power with an easy-to-use graphical editor.

Queries are requests for information retrieved from a set of data. The extracted data travel along data flows and are pro-
cessed in function blocks. Function blocks receive input, process that input and generate output, which can be presented
as tables or diagrams of various types.

MetaClient already includes a number of pre-made queries (k 111 ). They can be used directly or serve as a starting point
for the development of your own customized queries. In the Query Editor you can add function blocks and data flows,
moving function blocks, delete function blocks and data flows, or edit the properties of function blocks (k 113 ). It is also
possible to save groups of function blocks as modules or patterns and to re-use them in other queries (k 120 ).

Data Flow Diagrams

Queries are represented as data flow diagrams. A data flow diagram consists of Function Blocks and Data Flows
between these function blocks. Function blocks are represented as rectangles, data flows are represented as arrows
pointing in the direction of the data flow.

A function block has a number of Input Ports and a number of Output Ports. When data is available at all input ports,
the function block processes the data and produces output on its output ports. The produced output travels along the
defined data flows to the next function blocks.
Function blocks without input ports are called Source Blocks and function blocks without output ports are called Destin-
ation Blocks. A simple example of a function block would be a block that takes two numbers as input and calculates the
sum of these two numbers. Input ports accept only cases.

109 Part V Queries


Groups of Function Blocks

a Input - Data Source (Cases or Images), User Input, Constant File Input, Environment (k 202 ).
a Output - Table, Diagram, File Output, Debug Log, Meta Information (k 204 ).
a Processing - Data Transfer, Data Access, Filter, Group, List Processing, Text Processing, Data Processing, Number
Processing (k 206 ).
a Flow Control - Delay, Multiplexer, Demultiplexer, Storage (k 205 ).

MetaClient comes with a set of pre-made queries. A complete list of these standard queries with explanations can be
found here 111 .

Data Flow and Execution Sequence

Function blocks are strictly executed in a hierarchical order from top to bottom. Each block is executed as soon as the in-
put is available. Thus, it is important to observe the following two simple rules in order to ensure that each block receives
the required input in a timely manner:
a The logical hierarchy should be reflected by their vertical position in the Query Editor panel.
a If two blocks have exactly the same vertical position, they will be executed from left to right.

Query Results Output

Query results can be presented as:


a Tables - Tables can have a variable number of columns. Result tables can be sorted by g-clicking the respective
column header. By g-clicking a table cell, you can highlight the linked item in the tree view. A G-click on a table cell
highlights the linked item and switches to the tree view.
a Diagrams - MetaClient offers different diagram forms: vertical and horizontal bars, pie, lines, points. 1

Exporting Query Results

You can export query results to:


a Microsoft Excel
a XML File
a CSV File

by g-clicking the button and choosing the respective export format.

Each table or diagram is exported as a separated file, for which the file name is built as <QueryName>-<TableName>.EXT
or <QueryName>-<DisplayName>.EXT (EXT: XLS, XML, or CSV). If a table or diagram has no assigned title, 'Table' or 'Dia-
gram' and a unique number is used instead. In case exported files with identical names already exist in the same folder,
they will be overwritten without user consent.

By default, query results are exported to the folder specified as the Export Path (C:\MetaSystems\Tmp, k 161 ), but in the
Find Folder window you can select another folder.

MetaServer & MetaClient 2.1


MetaSystems 110
5.1 Default Queries

Each MetaClient installation comes with a set of default queries that you can use and customize without creating your
own queries from scratch. This section describes the available default queries and their purpose.

Query Name Description

Cases by Karyotype Groups cases by karyotype and computes the number of cases per karyotype.
Provides an overview of karyotype distribution.

Cases by Specimen Groups cases by specimen type and computes the number of cases per specimen
type. Provides an overview of specimen type distribution.

Cases by Year Computes the number of cases per year and displays them as a table and as a bar
chart.

Cases per Work User and Year Computes the number of cases per user and year. The results are presented as a
table, as a horizontal bar and as a pie chart.

Cases per Work User Computes the number of cases per user in the current year. The results are
presented as a table, as a horizontal bar and as a pie chart.

Cases Tri 21 over 35 Lists cases for patients over 35 yrs. and carrying pregnancies with a trisomy 21.

Coordinate Transformations Transforms a list of x/y coordinates of a source microscope into a list of coordin-
ates for a target microscope based on the coordinates offsets as defined by the
StageTra.DAT (see here 180 ).

Image Count Generates an overview of all images from the selected Ikaros/Isis root directory.
Images counts are presented by year (table/bar chart) and by experiment type
(table/pie chart),

Image User List Computes the Creation User, Work User, Karyo User and Review User for all im-
ages (sorted by case) in the selected Ikaros/Isis root directory and generates an
output table.

Images by Work User Counts images per user and presents the results as horizontal bar and pie charts.

MF - Classifiers Computes the number of Metafer runs by scan classifier and presents them as a
table and as a horizontal bar chart.

MF-Systems Computes the number of Metafer scanned slides per system and presents them as
a table and as a pie chart.

MF-Throughput Computes the number of Metafer search runs per week and presents them as a
table and as a bar chart.

Patient List Creates a patient list for a given year.

Physician List Creates a list of referring physicians sending patients in a given year. Also summar-
izes the number of cases per referring physician.

Recent Cases / Creates a history log of cases / images for the active user (using the image 'User'
Recent Images field as criterion).

Review Percentages Computes the case and image review percentages (number of reviewed cases or
images in relation to the total number of cases or images) for each year.

111 Part V Queries


Default Queries
Query Name Description

Turnaround Times by Spec Type Computes the average turnaround time (time between sample arrival and report
(in Year X) date) for each specimen type.

Turnaround Times Computes the average turnaround time (time between sample arrival and report
date)

VS - Compression Ratios Computes the average compression ratio for IMS, VSViewer, VSI, JPEG, and TIFF
output files of all VSlide cases in the selected root directory and presents them as a
table and a bar chart.

VS - File Formats Computes the number of VSlide cases and their output file formats and presents
them as a table, a pie chart and a bar chart.

VS - Light Modes Computes the number of VSlide cases scanned at different light modes and
presents them as a table, a pie chart and a bar chart.

VS - Magnification Computes the number of VSlide cases scanned at a certain magnification and gen-
erates a result table and a bar chart.

VS - Metafer Computes the counts of VSlide cases scanned with different Metafer applications
Application and presents them as a table, a pie chart and a bar chart.

VS- Metafer Version Computes the number of VSlide cases scanned with different Metafer software
versions and presents them as a table, a pie chart and a bar chart.

VS - Scan Users Computes the counts of VSlide cases for all users in the selected VSlide root direct-
ory and and presents them as a table, a pie chart and a bar chart.

VS - Search Times Computes the individual search times for all cases in the selected VSlide root dir-
ectory and generates a result table.

VS - Stich Modes Computes the stitching mode (online/offline) for all cases in the selected VSlide
root directory and present it as a table and a pie chart.

VS - Stich Times Computes the individual stitching times for all cases in the selected VSlide root dir-
ectory and generates a result table.
1
VS - Stitched by Computes the number of VSlide stitching runs by system-ID and presents them as
System table, pie chart and bar chart.

VS - Stitched Runs Computes the number of VSlide stitching runs by week and by month and present
the data as tables and bar charts.

VS - Versions Computes the number of VSlide cases processed with different VSlide software
versions and presents them as table, pie chart and bar chart.

MetaServer & MetaClient 2.1


MetaSystems 112
5.2 Query Editor

The query editor provides a graphical user interface for query definitions. It is a specific mode of the Statistics tab.

a When you load a query on the Statistics tab, the query is locked by default. The locked status is indicated by the
icon next to the selected query. In the state you can only Load a query or Execute the loaded query.

a To unlock a query, g-click the icon : the icon reflects the unlocked state. You can Edit, Rename, and Delete a
query, or create a New... query from scratch:

Command Description

Locked / Unlocked State


Load Choose a query from the Query drop-down list.
Execute Open an existing query (shortcut: [Ctrl] + [O])

Additional Commands, available in the 'Unlocked State' only


Edit Open the Query Editor to edit the selected query. It is now possible to work with multiple
query editors in parallel.
Rename Rename an existing query. In a Rename window, you can assign a new name to the selected
query.
Delete Delete the selected query after confirmation.
New ... Create a new query. In a New window, you can assign a name for the new query. After con-
firmation, the query editor opens to create the new query.
Only Supervisors Controls whether a query is available to all users or only to Supervisors / Administrators.

In the query editor, the available function blocks are organized in groups. You can expand a group by g-clicking the
group header. Only one group can be expanded at any time. The following groups are available (for details, k 202 ):

Groups of Functions available


functions blocks

Input Data (case, image), user input, constant values, file input (tables), environment (date & time,
login user)

Output Table, diagram, file, debug log, meta information

Flow Control Delay, multiplexer, de-multiplexer

Processing Data transform, data access, filter, sort, group, list processing, text processing, data pro-
cessing, number processing

113 Part V Queries


Query Editor
The query editor in Edit mode:

Query Editor Window 1


Legend
1 Menu Bar 2 Command Icon Bar

3 Query Panel 4 Function Block Panel

5 Tool Tips

MetaServer & MetaClient 2.1


MetaSystems 114
The Query Editor Menu Bar

Command Description

File

New Create a new query.

Open Open an existing query (shortcut: [Ctrl] + [O]).

Save Save a query (shortcut: [Ctrl] + [S]).

Save As Save query under another name and in another directory.

Save and Exit Save query and exit query editor.

Exit Exit query editor and return to MetaClient's main window.

Selection

Select All Select all function blocks and data flows (shortcut: [Ctrl] + [A]).

Select None Deselect all selected items (shortcut: [Ctrl] + [N]).

Invert Invert selection (shortcut: [Ctrl] + [I]).

Cut Cut selected items (shortcut: [Ctrl] + [X]).

Copy Copy selected items to Windows clipboard (shortcut: [Ctrl] + [C]).

Paste Paste items from clipboard (shortcut: [Ctrl] + [V]).

Delete Delete selected items (shortcut: [Del]).

Save as Pattern Save all function blocks and data flows as query pattern (shortcut: [Ctrl] +
[D]).

Pattern
Manage Pattern Open the pattern library (shortcut: [F2]).

Save As Pattern Save a particular arrangement of function blocks as a pattern for reuse in
other queries.

Test

Execute Execute a query (shortcut: [F5]). The Query Execution Log provides inform-
ation on the time required to run the query and whether any errors have
occurred.

Help
Show Tips Show Tool Tips below the Query Editor window ( 5 ).

115 Part V Queries


Query Editor
How Can I …?

General Functions

Navigate the Query Editor

You can navigate the Query Editor by any of the following methods:
a Use the horizontal and vertical scroll bars to scroll the editor window.
a Press [<], [>], [y] and [Y] keys to scroll the editor window.
a Use the mouse wheel to scroll the editor window up or down.

Scroll the Query Diagram

You can scroll the query diagram by using one of the following methods:
a Use the scrollbars at the right and at the bottom of the query editor window.
a Use the mouse wheel to scroll vertically.
a Use the arrow keys on your keyboard.

Use the Clipboard

Cut Copy Paste

You can use the clipboard to cut, copy and paste function blocks and their connecting data flows in the query editor.

1
Test a Query

Test a query

To test if a query works as expected, you can execute it within the query editor.
To do this, follow any of the following methods:
a Choose Execute from the Test menu.
a g-click the Test Query icon in the toolbar.
a Press [F5].
You are then asked to provide any user input that is required by the query (if it contains at least one user input function
block).
If the query fails to execute, an error message is displayed. If query execution succeeds, the Query Execution Log is
presented.
You can use debug log function blocks (k 205 ) to write values to the execution log during query execution. This helps to
find errors in queries and to understand how a query works.

MetaServer & MetaClient 2.1


MetaSystems 116
Get Help in the Query Editor

If you move the mouse over a function block icon in the function block panel a hint appears that shows you a quick sum-
mary what the function block does.
The same hint appears if you move the mouse over a function block in the query editor.
If you open the property dialog of a function block, a description of the function block is displayed at the top of the dialog.

Function Blocks

Add a New Function Block

1. To add a new function block to the query diagram, g-click a function block on the function block panel. Notice how
the function block gets highlighted.
2. g-click at the location where you want the new function block to appear. If you selected a function block that has
configurable properties, a matching Properties window is displayed. Adjust the properties and g-click .
3. You can move a function block by g-clicking it, holding the left mouse button down, moving the mouse and finally
releasing the left mouse button. Note, how the grid helps you to position the function block correctly.

Configure the Properties of a Function Block

A function block can have properties that determine how it processes the data. To configure the properties of a function
block you can use any of the following methods:
a G-click the function block.
a j-click the function block and choose Properties from the context menu (k 202 ).

Copy / Paste a Function Block

To duplicate function blocks:


a Select a single function block by a g-click or multiple function blocks as described below.
a j-click the function block and choose Copy from the context menu (k 202 ) or from the Edit menu. Alternatively,
press [Ctrl] + [C].
a Insert the copied function block(s) by either selecting the Paste command from the context menu or the Edit menu.
Alternatively, press [Ctrl] + [V].

Select a Function Block

You can select a function block by g-clicking it. Selected function blocks are indicated by a red rectangle.

117 Part V Queries


Query Editor
1. The Select None command from the Selection menu clears the current selection and the Select All command se-
lects all function blocks. Another possibility to clear the current selection is to L-click an empty spot in the query dia-
gram.

Select Multiple Function Blocks

To select multiple function blocks and/or data flows, you can use one of the following methods:
a Hold the [Ctrl] key down and 8L-click the function block or data flow that you want to add to the selection.
a Move the mouse over an empty spot in the editor, hold the left mouse button down and draw a rectangle around the
function blocks and data flows you want to select.
a Choose Select All from the Selection menu.
a Choose Invert from the Selection menu.
a Press [Ctrl] + [A] to select all function blocks and data flows.
a Press [Ctrl]+ [I] to invert the selection.
a To clear the current selection, you can follow any of the following methods:
s g-click an empty spot in the editor.
s Choose Select None from the Selection menu.
s Press [Ctrl] + [N].

Move a Function Block

To move a function block follow these steps:


1. Move the mouse over the function block and hold the left mouse button down
2. Move the mouse to the desired position.
1
3. Release the left mouse button as soon as the function block is at the desired position.

The grid helps you to position the function blocks in order to visualize the data flow. In fact, the position of function
blocks determines the order of execution. The order of execution follows the rules:
a top before bottom: function blocks closer to the top of the data flow are executed before those closer to the bot-
tom.
a left before right: if function blocks are positioned on the same vertical position, then the sequence of execution is
from left to right.

MetaServer & MetaClient 2.1


MetaSystems 118
Delete Function Blocks

To delete function blocks and/or data flows, you can follow any of the following methods:
a Select the function blocks (and data flows) you want to delete, press [Del]. You are then asked to confirm the deletion.
a Select the function blocks (and data flows) you want to delete and choose Delete from the Edit menu.
a Move the mouse over the function block or data flow you want to delete and press [Backspace]. This deletes the
function block or data flow under the mouse cursor.

Data Flows

Create a Data Flow

You can create a data flow between two function blocks by following these steps:
1. Move the mouse over an output port of the first function block and hold the left mouse button down.
2. Move the mouse over an input port of the second function block.
3. Release the left mouse button.

You should now see a red arrow pointing from the chosen output port to the chosen input port.
When creating data flows you have to make sure that the data types of the connected ports match. For example, if the in-
put port expects values, you should not connect it with an output port that produces a list of cases. In some cases the ed-
itor detects such errors and gives you an error message. In other cases an error message will be displayed during query
execution.
A hint is automatically displayed when you move the mouse pointer while creating a new data flow. This makes it easier to
send data to the correct input port.

Select a Data Flow

You can select a data flow in the same way as you select a function block by g-clicking it (or a spot sufficiently close to it).
Selected data flow are displayed in red.

Select Multiple Data Flows

To select multiple function blocks and/or data flows, you can use one of the following methods:
a Hold the [Ctrl] key down and g-click the function block or data flow that you want to add to the selection.
a Move the mouse over an empty spot in the editor, hold the left mouse button down and draw a rectangle around the
function blocks and data flows you want to select.
a Choose Select All from the Selection menu.
a Choose Invert from the Selection menu.
a Press [Ctrl] + [A] to select all function blocks and data flows.

119 Part V Queries


Query Editor
a Press [Ctrl] + [I] to invert the selection.

To clear the current selection, you can follow any of the following methods:
a g-click an empty spot in the editor.
a Choose Select None from the Selection menu.
a Press [Ctrl] + [N].

Delete Data Flows

To delete data flows, you can follow any of the following methods:
a Select the data flows (and function blocks) you want to delete, press [Del]. You are then asked to confirm the deletion.
a Select the data flows (and function blocks) you want to delete and choose Delete from the Edit menu.
a Move the mouse over the function block or data flow you want to delete and press [Backspace]. This deletes the
function block or data flow under the mouse cursor.

5.3 Patterns

The pattern library allows you to re-use commonly used combinations of function blocks. Combinations of function blocks
(and data flows connecting them) can be stored as a pattern and can be inserted into other queries in a matter of
seconds.

How can I ... ?

Open the Pattern Library 1

Open the pattern library

You can open the pattern library using one of the following methods in the Query Editor:
a g-click the Open Pattern Library icon in the toolbar.
a Choose Manage Patterns in the Patterns menu.
a Press [F2].

The Pattern Library dialog contains a list of available patterns. You can insert the selected pattern into the current query
like a function block or delete the selected pattern from the library.

MetaServer & MetaClient 2.1


MetaSystems 120
Define a Pattern

To define a pattern from a group of function blocks, select the respective function blocks and choose Save as Pattern
from the Edit menu. In the Define Pattern window, enter a Pattern Name for the new pattern. After g-clicking OK the
new pattern is saved and can be used.

Save a Pattern

A group of function blocks can be saved as a pattern:


a First, select function blocks either by including them in a rectangle drawn with the mouse (press left mouse button
and hold it, while drawing the rectangle).
a Then use the Save as Pattern command from the Edit menu of the Query Editor to save the selected group of func-
tion blocks as a new pattern.

Insert a Pattern

You can insert (re-use) a pattern into a query by using one of the following methods:
a g-click a pattern’s name in the Patterns menu.
a Open the Pattern Library, select a pattern and g-click Insert.

Delete a Pattern

To delete a pattern:
a Open the Pattern Library.
a Select a pattern in the Pattern List.
a g-click Delete and confirm.

121 Part V Queries


Patterns
Reporting

VI
NOTE! The reporting functions in MetaClient are only available for Ikaros/Isis data.

MetaClient comes with a powerful reporting framework that makes the whole reporting process more efficient and
straight-forward. A report combines a report template with actual patient, case and/or image data. Data can be directly
extracted from available case or image information, or computed from these values. In addition, reports may also include
direct user input. MetaClient reports can be generated in various formats:
a on paper - select printer or use 'quick print' option (default printer as selected in Configure - Settings ... - General
tab (k 255 ).
a as PDF File - save as PDF, automatically save as PDF file together with case files, or send by email as PDF attachment
(requires external email program).
a as WORD Document - create a Microsoft WORD document (WORD 2003 or later).
a as XML File - as a universal file format for exporting output files into external applications.

The final report is composed of:


1
a a report template - MetaClient comes with a set of pre-made report templates, but you may create your own tem-
plate using the Report Editor (k 125 ).
a report input from cases, cells, or the report buffer - different input sources are available: Report Buffer (see be-
low), All Cases, Selected Cases, All Cells, or Selected Cells.
a optional: computations - results from queries (k 109 ) can be included in reports - data can be presented as table val-
ues, charts or numerical values (text).

The Report Buffer

The report buffer encompasses a list of cases and cells, which can be used as input for printing. Cases and cells can be ad-
ded to or removed from the report buffer. The content of the report buffer (number of cases and images) is displayed in
the status bar. For details, please k 139 .

MetaServer & MetaClient 2.1


MetaSystems 122
Importing Ikaros and Isis Print Formats

MetaClient now includes an import function for Ikaros / Isis reports (= print formats). Imported Ikaros/Isis reports are
saved under their original name in the MetaClient report folder. Depending on the complexity of a (customized) Ikaros/Isis
print format, MetaClient may not be capable of converting all features automatically. A conversion summary lists all lines
in the original print format code that could not be converted. For details, k 236 .

6.1 Printing Reports

1. To print a report in MetaClient you can use any of the following methods:
a Choose Print Report from the Reporting menu.

a Click the Print Report command icon.

2. This opens the Print Report window:


In this dialog you can do the following:
a Select a report from the report list. Report template files are stored
in a (shared) folder (...\MetaSystems\Reports).
a Specify the report Input: you can include the Selected Case, All
Cases, Selected Cells, All Cells, or the content of the Report Buffer
in a report. Printing a report of a selected case creates an entry in
the History record (Tree View - History aspect, k 34 ).

MetaClient - Print Report window

3. g-click OK to start printing the report - the rendered report will be presented in the Report Viewer.

The following command buttons are available in the Report Viewer window:
Previous Page Show the previous page of the report.

Next Page Show the next page of the report.

Zoom In Increase the zoom factor.

Zoom Out Decrease the zoom factor.

Fit Page Adjusts the zoom factor so that the page is completely visible.

Print Print the report - opens the Windows print dialog window.
If a report contains more than 10 printed pages, you are prompted to confirm the print job.
Quick Print Prints the report using the default printer and the default print settings.
If a report contains more than 10 printed pages, you are prompted to confirm the print job.
Save as PDF Save the report as a PDF file (see Note! below on automatic file naming).

123 Part VI Reporting


Save as PDF This option creates the report as a PDF file and adds it as an addition file to the selected case. The
and add to PDF file is saved with the other files of a cases and automatically receives a file name as
case [CaseName].[ReportName].PDF (see Note! below on automatic file naming). The report PDF file
appears in the File List of the selected case (Tree View - File List aspect, k 35 ).
Export to Export the report to Microsoft Word and creates a new Word document. Report tables are conver-
Word ted into Word tables. Please note, that this function requires Word to be installed on the same
computer as MetaClient.
Email Report Send report by email as an attached PDF file (see Note! below on automatic file naming).

Save as XML Save report as XML file.


Close preview Close the Report Viewer window.

Thumbnails Toggle thumbnail view of report page thumbnails on/off. You can click a thumbnail to enlarge it.
The thumbnail of the currently selected page is marked by a red frame.
Search Search report for a text string. The search can be Case sensitive or find Whole words only.

MetaClient - Report Viewer (Report Preview)

MetaServer & MetaClient 2.1


MetaSystems 124
NOTE! The default file name for PDF documents is determined automatically as follows:
a If more than one case is included in a report, then no report file name is assigned automatically and you
have to type a report file name.
a If just one case is included in a report, the case name is suggested as the default report file name.
a If a case with just one cell is featured in the report, then the suggested report file name is built as <Case>—
<Cell>.

6.2 Default Reports

Every installation comes with a set of default reports that can be used without creating custom reports. This section de-
scribes the available default reports and what they can be used for.

MetaClient Standard Reports Resembles Ikaros / Isis Print Formats

CaseList (per root directory) --

EvaluationList Evaluation List

IsisGallery (cells in RGB, Merged Colors and FalseColors --


mode, karyogram in RGB mode)

Karyo2Meta Karyo2Meta

MetaKaryo MetaKaryo

MetKaryoGal KaryoMetaGal

6.3 Report Editor

In the Report Editor you can customize existing print report templates or create new ones.

1. To open the report editor, choose Open Report Editor from the Reporting menu.
The report editor provides a graphical editor for report templates.

125 Part VI Reporting


Printing Reports
Report Editor Window

Legend 1
1 Menu 2 Toolbar

3 Report Area - Page Header 4 Report Area - Page Footer

5 Report Area - Report Content 6 Component Toolbox Icon

7 Property Editor Icon 8 Property Editor Panel

2. The "canvas" of the report form is split into the page header ( 3 ), the page footer ( 4 ) and the main panel ( 5 ). The
content of header and footer is (dynamically) repeated on every page of the report, for example page numbers, head-
lines or logos. Place cell images and specific patient information in the main panel. Reports in MetaClient also support
case or cell summary tables using data from built-in or custom data fields (for the list of existing data fields, k 185 ; for
the data field editor, k 184 ).
3. In brief, to add a component, choose a component from the Component Toolbar, insert it in one of the three panels.
A component can be text, a shape, a static image (logo), an Ikaros/Isis image, an image grid, a table, a chart, or a bar-
code.
4. Then click on the Property Editor to customize the component's appearance (size, color, font size, etc) and other at-
tributes.

MetaServer & MetaClient 2.1


MetaSystems 126
5. Please note, that the reports in MetaClient feature a dynamic page layout. Besides the general attributes like paper
format and page orientation, you can structure pages using different header and footer heights as well as horizontal
or vertical splitters, page breaks and sections.

The Report Editor Menubar

Command Description

Report
New Create a new report (shortcut: [Ctrl] + [N]).
Open Open an existing report (shortcut: [Ctrl] + [O]).
Open Recent Show a list of the five report forms edited last.
Save Save a report (shortcut: [Ctrl] + [S]).
Save As Save report under another name or in another directory.
Create Report Package ... A report package is a ZIP file including a selected report and all its external dependen-
cies (static images and queries).
This function makes it easy to share a customized report with other users. Report pack-
ages can be imported into MetaClient by the Import Report Package menu command
in the Reporting menu.
Print Preview Show a print preview.
Test Print Prints a report based on the current cases. In the Printer window, you can choose an
appropriate printer for the preview, for example a PDF printer (shortcut: [Ctrl] + [P]).
Save and Exit Save report and exit report editor.
Exit Exit report editor and return to MetaClient's main window without saving.

Edit
Undo Undo the last command / step (shortcut: [Ctrl] + [Z]).
Redo Redo the last command / step (shortcut: [Ctrl] + [Y]).
Cut Cut selected items (shortcut: [Ctrl] + [X]).
Copy Copy selected items to Windows clipboard (shortcut: [Ctrl] + [C]).
Paste Paste items from clipboard (shortcut: [Ctrl] + [V]).
Alignment Align selected components (at least one component must be selected).
Alignment with Grid
Center
Align Left
Align Right
Align Top
Align Bottom
Size Adjust the size of selected components (at least one component must be selected).
Same Size
Same Width
Same Height

127 Part VI Reporting


Report Editor
Command Description

Dock Arrange selected components next to each other (at least one component must be selec-
ted).
Dock Horizontally
Dock Vertically
Depth Order Define the stacking order of components.
Pattern Manager Open the Pattern Manager (k 120 ).
Save as Pattern Save a group of function blocks and their connecting data flows as a pattern to be re-
used in another report or query.
Delete Delete selected component(s).

Selection
Select All Open the pattern library (shortcut: [Ctrl] + [A]).
Select None Undo selection.
Invert Selection Inverts the selection of components. That means that all of the components which were
previously not selected become selected, and vice versa (shortcut: [Ctrl] + [I]).

View
Zoom in Increase zoom factor.
Zoom out Decrease zoom factor.
Fit Page Width Adjust zoom factor to view the entire width of a report.
Show Grid Enable and disable displaying the grid. When you enable it, the grid overlays the image
and makes it easier for you to line up selected components (shortcut: [Ctrl] + [G]).
Show Print Margins Enable and disable displaying the grid (shortcut: [Ctrl] + [M]).
Snap to Grid Enable and disable the auto-arranging of component in the grid.
Editor Settings In the Report Editor Settings window, you can adjust the
a Grid Size (in mm)
The default setting is 2.0 mm. 1
a Print Margins: (in mm)
The default settings for the Left, Right, Top, and Bottom margin are 6 mm each. Al-
ternatively, read the margins From Printer... . Please be aware, that printer mar-
gins differ from model to model, and, thus, a report optimized for one printer may
not produce the desired result on another printer model.
Confirm with OK to apply the setting or Cancel to exit without any changes.

Help
Show Tips Show/hide tool tips in the footer of the report editor window.

MetaServer & MetaClient 2.1


MetaSystems 128
General Features

How can I ... ?

Navigate in the Editor Window

You can navigate in the report editor by any of the following methods:
By mouse:
a Use the horizontal and vertical scroll bars to scroll the editor window.
a Use the mouse wheel to scroll the editor window up or down.

By shortcuts:
a Press [<], [>], [y] and [Y] keys to scroll the editor window.
a Press [Home] to reset the zoom factor and jump to the beginning of the report.
a Press [End] to reset the zoom factor and jump to the end of the report.

Zoom

Zoom In Zoom Out Fit Page Width

To change the zoom factor, you can use any of the following methods:
Individual zoom factor:
a g-click the Zoom In and Zoom Out icons in the toolbar to increase or decrease the zoom factor, respectively.
a Hold the [Ctrl] key down and move the mouse wheel to zoom in and out.
a Choose Zoom In or Zoom Out from the View menu.

Fit page width - display whole page:


a g-click the Fit Page Width icon in the toolbar to adjust zoom factor.
a Choose Fit Page Width from the View menu to adjust zoom factor.
a Press [Space] to reset the zoom factor so that the whole page width is visible.

Reset zoom factor:


a Press [Space] to reset the zoom factor so that the whole page width is visible.
a Press [Home] to reset the zoom factor and jump to the beginning of the report.
a Press [End] to reset the zoom factor and jump to the end of the report.

129 Part VI Reporting


Report Editor
Undo and Redo Operations

Undo Redo

All operations in the report editor can be undone and redone (including moving, resizing, changing properties, deleting,
adding). To undo or to redo use the methods described below.
To undo:
a Choose Undo from the Edit menu.
a g-click the Undo icon in the toolbar.
a Press [Ctrl] + [Z].
Note that it is not possible to undo an operation after closing the report editor.

To redo:
a Choose Redo from the Edit menu.
a g-click the Redo icon in the toolbar.
a Press [Ctrl] + [Y].

Look up Report Editor Hotkeys

Report Editor Hotkeys

If you select a property in the property editor (see here), a description of this property is displayed in the area below the
report editor.
a You can view a summary of all available hotkeys by g-clicking the Report Editor Hotkeys icon in the toolbar.

1
Work with Headers and Footers

Property Editor

The report form is split into three editing panels:


a Header Components in the header are printed at the top of each page.
a Footer Components in the footer are printed at the bottom of each page.
a Content This practically infinitely large area contains the content of the report. Components in this area are always
printed below the header and above the footer.

You can change the height of the header and footer. To do that, clear the selection first (k 128 ), switch to the property ed-
itor by g-clicking the Property Editor icon and change the Header Height and/or Footer Height properties of the re-
port. You might want to design a custom title page for your report. In this case you can disable the header for the first
page of your report. To do that, clear the selection first, switch to the property editor by g-clicking the Property Editor
icon and set the Show Header on First Page property to False. If you want to paste components into the header or
footer, make sure you g-click the header or footer before pasting. Otherwise the pasted components might end up in
another report area.

MetaServer & MetaClient 2.1


MetaSystems 130
Components

Add a New Component

Component Toolbox

To add a new report component to a report, follow these steps:


1. g-click the Component Toolbox button in the upper right area of the report editor window to make the toolbox vis-
ible.
2. g-click a report component in the component toolbox. The component is then highlighted in red and the mouse
cursor changes to a '+' symbol.
3. Position the component (its upper left corner) by moving the mouse pointer, press the left mouse button, move the
mouse to adjust the size of the component and then release the left mouse button to insert a component in the de-
sired size.

Report Editor - Add a new component to a report

4. Then switch to the Property Editor to define the properties of each component in detail.
For Text components, you can enter either static text or refer to image or case data fields used in Ikaros or Isis. To read a
detailed description how to add data fields as text components, k 232 .

131 Part VI Reporting


Report Editor
Select a Component

To select a component:
1. g-click the component in the editor. The Property Editor shows the properties of this particular component.
2. A selected component is indicated by a yellow border with blue handles.

3. g-click one of the blue handles to resize the component (k 127 ).

Select Multiple Components

You can select multiple components by using the following methods:

Select several components:


a Press [Ctrl] and g-click a component to add it to the current selection.
a Include all components into a selection rectangle. To do so, position the mouse pointer at a free spot in the editor
panel, press and hold the left mouse button down and move the mouse to draw a red selection rectangle. Release the
left mouse button when all wanted components are enclosed in the selection rectangle.

Select all components:


a Choose Select All from the Selection menu to select all components.
a j-click an empty spot in the report to open a context menu and choose Select All, Select All above here or Select
All below here. These commands will select either all components in report, all components above the current
mouse cursor position, or all components below the current mouse cursor position, respectively.
a Press [Ctrl] + [A] to select all components.
1

Invert selection:
a Choose Invert Selection from the Selection menu to invert the selection.
a Press [Ctrl] + [I] to invert the selection.

Clear Selection

To clear a selection of components in the Report Editor, use any of the following methods:
a Choose Select None from the Selection menu.
a Press [Esc].
a g-click an empty spot in the report editor panel.
If no component is selected, the property editor shows the properties of the report itself.

MetaServer & MetaClient 2.1


MetaSystems 132
Move a Component

To move selected components, you can use any of the following methods:
a Move the mouse over one of the selected components until the cursor changes to the move cursor.
a Hold the left mouse button down and move the mouse to move the components. Then release the left mouse button.
a Press [<], [>], [Y] or [y] to move the components by one 'grid unit' in the indicated direction.
a Press [Ctrl] + [<], [Ctrl] + [>], [Ctrl] + [Y] or [Ctrl] + [y] to move the components by 1/10 mm in the indicated direc-
tion.
a Change the Left or Top properties in the Property Editor.

Resize a component

To resize a component, follow these steps:


1. Select the component. The component is then highlighted by a yellow border with blue boxes on each side and in
each corner.
2. Move the mouse over one of the blue boxes. The mouse cursor changes to a resize cursor.
3. Hold the left mouse button down and move the mouse to resize the component.
4. Release the left mouse button.
You can also edit the Width and Height properties of the component directly in the Property Editor.

Align components

The report editor provides several tools to align components precisely:

Positioning:
a From the Edit menu choose Choose Alignment -> :

Center Center all selected components horizontally on a page.

Align to Grid Align selected components to the grid. Enable Snap to Grid in order to align
automatically (k 128 ).
Align Left, Align Right Align selected components to left, right, top or bottom, respectively.
Align Top, Align Buttom

Sizing:
a From the Edit menu choose Choose Alignment -> :

Same Size Impose the size of the largest component onto all other selected.

Same Width Impose the width of the widest component onto all other selected.

Same Height Impose the height of the tallest component onto all other selected.

133 Part VI Reporting


Report Editor
Docking:
a Choose one of the Dock... commands from the Edit menu:

Dock Horizontally Dock two selected components horizontally.

Dock Vertically Dock two selected components vertically.

All commands are also available in the context menu after j-clicking the Report Editor.

Arrange the Stacking Order of Components

The stacking order is only relevant, if components overlap. Although the latest component is printed on top of older com-
ponents, you can alter the stacking of components at any time.
1. First, select a component by a g-click and then use one of the following methods:
a Choose Depth Order/Stacking Order - Bring to Front or Depth Order/Stacking Order - Send to Back from
the Edit menu.
a Perform a j-click in the editor panel and choose Depth Order/Stacking Order - Bring to Front or Depth
Order/Stacking Order - Send to Back from the context menu.
a Press [Ctrl] + [F] to bring a component to front.
a Press [Ctrl] + [B] to send a component to back.

Edit Component Properties

Property Editor

The properties of components can be edited in the Property Editor:


1
1. g-click the Property Editor icon to activate.
2. Depending on its type, a component has more or less properties. For greater clarity, properties are arranged in
groups. You can expand and collapse property groups by g-clicking the and symbols or by g-clicking the re-
spective group header. Select a property by g-clicking it in the left column of the Property Editor. A description of
this propertyproperty is then highlighted and a is shown in the area below the property editor.
3. To change a simple property:
i. g-click the Property Editor tab.
ii. Select the property, either type the new property value or select a value from a drop-down list.

iii. g-click the to confirm the new value.


4. For more complex properties, like Condition or Text, dedicated editor windows will be displayed.
5. Press [Enter].
6. g-click any other property in the property editor.
7. You can change the properties of multiple components at once. If multiple components are selected, the property ed-
itor shows only properties shared by all selected components. Property values are only displayed if all components
share the same value for that property. If you edit a property, the property is changed for all selected components.

MetaServer & MetaClient 2.1


MetaSystems 134
Delete Components from a Report

You can delete all selected components using any of the following methods:
a Choose Delete from the Edit menu.
a Choose Delete from the context menu (to open, j-click the editor window's background).
a Press [Del].

Use the Clipboard

Cut Copy Paste

You can cut the selected components using any of the following methods:
a Choose Cut from the Edit menu.
a Choose Cut from the context menu (to open, j-click the editor window's background).
a g-click the Cut icon in the toolbar.
a Press [Ctrl] + [X].

You can copy the selected components using any of the following methods:
a Choose Copy from the Edit menu.
a Choose Copy from the context menu (to open, j-click the editor window's background).
a g-click the Copy icon in the toolbar.
a Press [Ctrl] + [C].

You can paste components from the clipboard into the open report using any of the following methods:
a Choose Paste from the Edit menu.
a Choose Paste from the context menu (to open, j-click the editor window's background).
a g-click the Paste icon in the toolbar.
a Press [Ctrl] + [V].

Use External Dependencies - Fonts and Images

The Report Editor also relies on external resources outside MetaServer/MetaClient:


a Fonts - Text may be formatted using any font available on the client computer. Therefore, special fonts should be in-
stalled on all PCs running MetaClient.
a Images - You may wish to include images - for example the logo of your university or laboratory company - in a re-
port. Images used in MetaClient reports should be copied to the (shared) folder ...\MetaSystems\Reports\Res.

135 Part VI Reporting


Report Editor
Report

Create a New Report

New Report

In the Report Editor, create a new, empty report by g-clicking the New command in the Report menu or by pressing
[Ctrl] + [N].

Open a Report / Open a Recent Report

Open

In the Report Editor, load a report by any of the following methods:


a g-click the Open... or Open Recent command in the Report menu. The latter command presents a (short) list of all
recently opened report form.
a Press [Ctrl] + [O].

Save a Report / Save As...

Save

In the Report Editor, save a report by any of the following methods:


a g-click the Save or Save As... command in the Report menu. The latter command opens a standard Save As win-
dow, in which you can save the report at another location or under another name. The standard location is the
(shared) ...\MetaSystems\Reports folder. 1
a Press [Ctrl] + [S].

Create a Report Package

Create Report Package

A report package is a compressed ZIP file with the report templates and all external dependencies (for example logo file).
In the Report Editor, save a report by any of the following methods:
a g-click the Create Report Package icon or the respective command in the Report menu. The command opens a
standard Save As window, in which you can save the report package as a ZIP. The standard location is the (shared) ...
\MetaSystems\Reports folder.

MetaServer & MetaClient 2.1


MetaSystems 136
Test Print

Print Test Report

If you want to test printing the report on a specific printer, you can follow any of the following methods:
a Choose Test Print from the Report menu.
a g-click the Test Print icon in the toolbar.
a Press [Ctrl] + [P]. This opens the printer setup dialog, where you can select a printer and modify the print settings.
g-clicking OK prints the report with example data.

Show Print Preview

Show Print Preview

You can show a quick preview of the report (using example data) using one of the following methods:
a g-click the Print Preview icon in the toolbar.
a Choose the Print Preview... command from the Report menu.
For a detailed description of the Report Viewer, k 137 .

Display Print Margins

You can display print margins in the editor. To enable or disable this use any of the following methods:
a g-click Show Print Margins in the View menu to toggle the display of print margins.
a Press [Ctrl] + [M] to toggle the display of print margins.

Print margins are displayed as thin green lines in the report. To configure the print margins follow these steps:
1. Choose Editor Settings from the View menu.
2. Adjust the print margins.
3. Optionally, you can load the print margins from an available printer. To do that, g-click the From Printer button, se-
lect the printer from the printer list and g-click OK.
4. g-click OK to apply the new print margins.
Note: Print margins are a tool to design a report layout. It is important to consider that the positions of components are
not relative to the print margin but relative to the upper left corner of a paper sheet!

Adjust the Editor Grid Spacing

The editor grid should ease report layout and component positioning. If you want you can disable the grid by g-clicking
Show Grid in the View menu. The Snap to Grid feature aligns components automatically with the grid whenever you
move or resize them. To disable this feature g-click Snap to Grid in the View menu. You can adjust the size of the grid
following these steps:

137 Part VI Reporting


Report Editor
1. Choose Editor Settings from the View menu.
2. Adjust the Grid Size and g-click OK.

Key and Mouse Shortcuts

New report [Ctrl] + [N]

Open a report [Ctrl] + [O]

Save the current report [Ctrl] + [S]

Test print... [Ctrl] + [P]

Cut all selected components [Ctrl] + [X]

Copy all selected components [Ctrl] + [C]

Paste all components from the clipboard to the report [Ctrl] + [V]

Select all components [Ctrl] + [A]

Invert selection [Ctrl] + [I]

Delete selected components [Del]

Undo [Ctrl] + [Z]

Redo [Ctrl] + [Y]

Bring to front [Ctrl] + [F]

Send to back [Ctrl] + [B] 1

Grid on / off [Ctrl] + [G]

Print margins on /off [Ctrl] + [M]

Move selected object(s) by 1 grid position in the respective direc- [<], [>], [Y] or [y]
tion

Move the selected object(s) by 1 pixel in the respective direction [Ctrl] + [<], [>], [Y] or [y]

Adjust zoom - fit to width [Space]

Go to top of report [Home]

Go to end of report [End]

Exit active edit mode [Esc]

MetaServer & MetaClient 2.1


MetaSystems 138
6.3.1 Report Buffer

The report buffer is a flexible and effective way to define input for a report. The report buffer is a transient repository for
cases and/or cells.
1. To add cases or cells to the report buffer use one of the following methods:
a Select cases in the Case List or Tree view. Then choose Add to Report Buffer from the Case menu.
a Select cells in the Tree view. Then choose Add to Report Buffer from the Cell menu.
The content of the report buffer is indicated in the status bar at the bottom of the MetaClient program window
.

2. To clear the report buffer, choose the Clear Report Buffer command from the Reporting menu.

139 Part VI Reporting


Report Editor Report Buffer
Reference
Section
VII
The following topic chapters describe how to install and configure the current version of MetaServer and MetaClient.

If you are already using a previous version of MetaServer and MetaSystems (V1.0, V1.1, or V2.0), please refer to the Updat-
ing MetaServer and MetaClient section (k 270 ).

7.1 Installation and Configuration

7.1.1 Installation Guide - Part 1

NOTE! Carefully read the instructions below before you install MetaServer and MetaClient!

Some Planning Required 1

Before you begin with the installation of MetaServer and MetaClient, some careful planning is required. Please involve
your IT department in the planning process at an early stage already.

Dongle Type

MetaSystems' software is defended against misuse by the presence of software protection devices, also known as
'dongles'. While MetaServer runs without dongle protection, MetaClient V 2.1 requires a matching dongle to load and pro-
cess Ikaros/Isis and Metafer root directories. If MetaClient is handling only VSlide root directories, a dongle is not required
at all.
MetaClient V 2.1 supports three dongle types: CodeMeter (USB), WibuKey (USB), and WibuKey (LPT - legacy compon-
ent). Dongles of the CodeMeter type can be used as local or network devices. In the latter case, MetaClient licenses are
kept on the central network dongle, no local dongles are then required for MetaClient. For details on the different dongle
types, k 274 . During its first start, MetaClient checks for the presence of a local or a network dongle.

MetaServer & MetaClient 2.1


MetaSystems 140
Network Structure

Please observe the following features:


a MetaServer can only run from the C: drive (C:\MetaSystems).
a MetaServer cannot run as a service, but it can run as a scheduled task without a user required to login.
a MetaServer can be started with a command-line argument "/secondinstance". If this parameter is used, MetaServer
skips the check for an existing MetaServer instance on the same computer, so that two MetaServer instances can run
at the same time. This feature should only be used with great care and only in special circumstances (one server com-
puter running two different MetaServer versions or two lab groups sharing one server computer).

In particular you have to decide:


a where you want to store the cytogenetic data: on one of the MetaSystems systems, on a network attached storage
(NAS) device, or on a dedicated file server
a on which computer MetaServer shall be executed.
a MetaServer can only be installed and executed on a computer running Windows (server) operating system (OS), other
OS are not supported.
a One root directory (major folder) should be administered by one MetaServer only! It should be avoided that more
than one MetaServer handles a particular root directory.

In general, MetaServer can run on any computer in the network as long as this computer is reachable from all computers
that use MetaClient. Nevertheless, there are two configurations that are preferable in terms of performance and network
traffic:
a MetaServer runs on a dedicated server computer that also stores the
root directories. In this case, background indexing does not produce any
additional network traffic and should be very fast.

Network setup with dedicated server for MetaServer

a The root directories are stored on a dedicated data server (i.e. a file
server or a NAS storage device) and MetaServer runs on a regular com-
puter in the network. MetaServer cannot be installed on a NAS / run on
NAS.

Network setup without dedicated server-


MetaServer runs on MetaClient PC

141 Part VII Reference Section


Installation and Configuration Installation Guide - Part 1
Hardware Requirements

The following requirements must be met:


a MetaClient requires a MetaSystems dongle in order to be capable of handling Metafer and Ikaros/Isis root directories:
s For Metafer root directories the dongle must have a Metafer or a MetaClient entry.
s For Ikaros / Isis root directories can be used if the dongle contains an Ikaros/Isis or a MetaClient entry.
s Only VSlide root directories can be used without dongle: If no dongle is present, the root directory list shows only
VSlide root directories (if available).
a All computers in the network must have the TCP/IP protocol installed (this should be installed by default on any re-
cent system).
a Firewalls must be configured to allow incoming and outgoing TCP traffic using the port that MetaServer and MetaCli-
ent use.
a Each MetaServer instance is mainly defined by its network port. Thus, the network (firewall) must allow the respective
network port (port numbers '1023' or higher are supported, the default port is '1050').
a The computer running MetaServer should have enough main memory. MetaServer V 2.1 is a 32-bit application. Thus,
the maximum amount of computer memory (RAM) is limited by the Windows operating system used:
Max. Memory Addressed Max. Memory Operating Systems
by MetaServer Installed

2 GB 4 GB on computers running a Windows 32-bit version


3 GB 4 GB on computers running a Windows 32-bit version with 3GB
switch enabled
4 GB 8 GB on computers running a Windows 64-bit version (i, e, Windows
Server® 2003, Windows Server® 2008)

a The amount of main memory required is proportional to the number of images files to be indexed. This number does
not necessarily correlate with the number of cases (experiments), as each case may encompass a variable number of
VSlides or Metafer scan runs or Ikaros/Isis images. The table below should be considered as a rough estimate of
1
memory usage:
Amount of data (sum of all administered root paths) RAM Required

0.1 TB 0.075 GB
0.5 TB 0.375 GB
1.0 TB 0.750 GB
2.0 TB 1.500 GB

Based on the same calculations one can draw the conclusion that the summarized amount of data should not exceed
2 TB on 32-bit systems and 3 TB on 64-bit systems, respectively.

Security Mode
If you are running running Metafer and/or Ikaros/Isis in encrypted 'security mode', must use MetaClient in security mode
as well! Please note, that MetaClient can only handle one type of root directories: either normal or security mode. The
mode is determined by a configuration switch in the copy-protection device (dongle). A 'normal' MetaClient is only com-
patible with non-encrypted root directories, while a MetaClient in security mode can only open encrypted root directories.
However, a MetaClient in security mode can display all Metafer passes (normal/secure). Root directories in MetaServer

MetaServer & MetaClient 2.1


MetaSystems 142
can be specified as "secure" indicating that the data in the root directory are encrypted.

Before You Begin


Update Ikaros / Isis to the latest version supported by your dongle's 'update expiry' code (at least to V5.4) before installing
MetaClient / MetaServer V 2.1. We recommend to update Ikaros / Isis to version V5.7 in order to benefit most of the ad-
vanced interaction between MetaServer/MetaClient V 2.1 and Ikaros/Isis V5.7.
MetaServer and MetaClient communicate via TCP/IP protocol (must be installed on all systems). A dedicated network port
must be allowed by network administration on all computers. Otherwise, MetaClient cannot connect to MetaServer. The
default port is '1050'. Port used for TCP communication between MetaServer and MSDataServer can now be configured
in ...Cfg\MetaServer.ini, section [DataServer], entry Port (for MetaServer) and in ...\MetaServer\ImageServer\Bin
\MSDataServer.ini, section [ConnSettings], entry Port (for MSDataServer). For new installations, the default port is
39999 (to prevent potential conflicts with anti virus software).

7.1.2 Installation Guide - Part 2

New MetaServer Installation


On the PC that should run the MetaServer application, G-click the MetaServer-2.1.x.exe and follow the instructions given
by the installer. This installs MetaServer in C:\MetaSystems. Do not change this location, unless absolutely necessary.

MetaServer Setup Wizard


Once the installation procedure is completed, start MetaServer by a G-click on the MetaServer icon. A Setup Wizard will
guide you through the basic installation steps. The wizard is engaged automatically when MetaServer is started for the
first time. The wizard ensures that important settings are configured correctly. Various settings, for example root paths,
can be imported from an existing Ikaros or Isis installation.
The wizard contains the following steps:

1. Welcome

MetaServer Installlation Wizard - 1. Welcome

143 Part VII Reference Section


Installation and Configuration Installation Guide - Part 1
a g-click to continue, or g-click to leave the Setup Wizard without commencing any changes.

2. Global Configuration Path

MetaServer Installation Wizard - 2. Global Configuration

a On the Global Configuration page you can specify the folder, which contains the shared configuration files (IksG-
lobal.ini / IssGlobal.ini). If they are not located in the default folder (C:\MetaSystems\Cfg), but in a shared folder on
the network, use the folders icon to navigate to the respective folder or type the correct path.
a Then g-click Check Path to confirm that the selected path is correct and available.

a g-click to continue, or g-click to go one step back. g-click to leave the Setup Wiz-
ard without commencing any changes.

3. Date Format
1

MetaServer Installation Wizard - 3. Date Format

MetaServer & MetaClient 2.1


MetaSystems 144
a It is important to define the Date Format. The date format is a global parameter shared by MetaServer and all
MetaClient stations. The date format setting is independent of the Windows regional / date and time settings.

a After you selected date format, g-click to continue, or g-click to go one step back. g-click
to leave the Setup Wizard without commencing any changes.

4. Import Root Paths

MetaServer Installation Wizard - 4. Import Root Paths

a The Setup Wizard reads the root path information from the IksRootPathList.ini / IssRootPathList.ini.
a By default, all registered root paths are marked. Exclude root paths on removable media, for example Archive, as they
cannot be indexed by MetaServer. You may also exclude other root paths. g-click the respective list entry to
deselect a root path. Please observe the notes on secure root paths (k 142 ).

a g-click to continue, or g-click to go one step back. g-click to leave the Setup Wiz-
ard without commencing any changes.

5. Optimize Settings

145 Part VII Reference Section


Installation and Configuration Installation Guide - Part 2
MetaServer Installation Wizard - 5. Optimize Settings

a The Optimize Settings page allows to configure a number of parameters with just two mouse clicks. Select an In-
stallation Size that resembles the number of all computers running MetaSystems software, including Metafer, VSlide
and/or Ikaros/Isis Review licenses. Choose the type of computer on which MetaServer is executed: a dedicated
server or an Ikaros/Isis or Metafer workstation (a 'normal' PC). Depending on your choice, MetaServer will set the
parameters on the Maintenance tab accordingly (k 153 ).

a g-click to continue, or g-click to go one step back. g-click to leave the Setup Wiz-
ard without commencing any changes.

6. Summary

MetaServer Installation Wizard - 6. Summary

a g-click to continue, or g-click to go one step back. g-click to leave the Setup Wiz-
ard without commencing any changes.
1
After completion of the wizard, a self-check is executed to probe for any remaining problems. If necessary, it is possible to
re-run the Setup Wizard. To do so, g-click the Setup Wizard command in the Program menu. Please note, that the wiz-
ard will overwrite any existing configuration!

7.1.3 Installation Guide - Part 3

After completion of the Setup Wizard (see previous chapter (k 143 )), MetaServer offers a number of configuration options
arranged on different tabs:

Self Check
The self check runs a number of tests to ensure proper basic operation of MetaServer:
a Configuration Path - (Global) Configuration files accessible - yes/no?
a Checked firewall - Firewall do not block MetaServer - yes/no?
a Checked network communication - Selected network port open for MetaServer sending and receiving messages -
yes/no?

MetaServer & MetaClient 2.1


MetaSystems 146
a Checked root directory availability - All selected root paths can be found at the specified locations - yes/no?
a Checked root directory write access - Root paths are shared and allow for read and write access - yes/no?
a Image server running - Image server is running properly and can read/write image information - yes/no?
a Checked disk space - Sufficient disk space available for MetaServer temporary log files - yes/no?
Tests passed successfully are marked by a 'checked' symbol ( ), while problems are highlighted by a 'warning' sym-
bol ( ) accompanied by a detailed description of the problem.

a g-click the Refresh-button to re-run the self check, if necessary.

Log
a The log file displayed on the Log tab lists all of MetaServer's major activities - start, check installation, index, notify,
load data fields, settings,... . Every logged activity receives a detailed time stamp (ddmmyyyy hh:mm:ss) in order to re-
view MetaServer's action in detail. If you check the Scroll automatically option, the most recent (the end of the log)
activities are automatically displayed.

Root Directories
a The Root Directories tab presents the list of accessible root paths, imported by the Setup Wizard. The root path
table lists the Alias names, the network Path descriptions (to the respective folders), and the respective Type of data
(Iks/Iss, Metafer or VSlide).
a You can use the command buttons on the tab to manage root paths:

Add another root directory manually.


In the Edit Root Directory window choose an informative Alias. Then type the whole (network)
Path or click the folders icon to navigate to the respective folder. It is important to select the
right Type of data source: Ikaros/Isis, Metafer, or VSlide.

MetaServer - Root Directories tab - Add / edit a root path

For each VSlide root directory you can also specify a Webserver. This option is required for VSlide
output files in VSViewer format.
Tick the Secure option, if you run Ikaros/Isis or Metafer in 'security mode'.
Edit a registered root path - either change the Alias for a given folder or change the physical loca-
tion of a folder for a given Alias in the Edit Root Directory window.
Delete a root path from the list after confirmation. The folder and all of its content is not deleted,
but its registration within MetaServer and all associated index files.
Scan the selected root path for problems.
MetaServer creates a summary report:

147 Part VII Reference Section


Installation and Configuration Installation Guide - Part 3
a If the file structure of the scanned root path is consistent, MetaServer will come back with a
No problems found message.
a However, if problems occur another tab is displayed on which the problems are listed in detail
and solutions to solve the problems are offered.
Import new root paths from existing Ikaros/Isis configuration files - IksRootPathList.ini/
IssRootPathList.ini. You can navigate to any local or network folder in order to select the wanted
configuration file(s).

MetaServer Supports 'Security Mode'

Root directories in MetaServer can be specified as "secure" indicating that the data in the root directory is encrypted. In
order to handle both types of root directories - normal and secure - two global configuration paths must be specified in
MetaServer:
a one for security clients and
a one for non-security clients.
This allows mixed installations, where Metafer runs in security mode and Ikaros / Isis in normal mode or vice versa.

Handling of Duplicate Cases

When adding a root directory in MetaServer, the new root directory should be scanned for problems and problems
should be solved straight away.
MetaServer display details on duplicate cases (in different subdirectories) and duplicate images (more than one of MCI,
MSI or MMI) and offers solutions how to solve data inconsistencies:
a Delete one of the two duplicates.
a Rename one of the two duplicates.
a Missing case information files (CIF) are created automatically. The case creation date is then set to the creation date
of the oldest image. 1
a Empty files should be deleted.

Mirrors
A 'mirror' represents an exact copy of a root directory for backup purposes in order to increase data safety. All changes in
a root directory - adding new file, deleting or renaming existing files - will be transferred to the mirror.

To ensure that Mirrors include all files in their latest versions, original and mirror root paths must be synchronized in a
regular manner. This can be done either manually or automatically as scheduled task by MetaServer.

MetaServer & MetaClient 2.1


MetaSystems 148
MetaServer - Mirror tab - Add mirror site / Review mirror activities

a To setup a new mirror, g-click .


a In the New Mirror window, select the Root Directory that should be mirrored. Then assign an Alias name to the mir-
ror root directory (it is advisable to keep the Alias in order to avoid name confusion ) and define the Mirror Path
either by navigating to to the respective folder using the button or by entering the entire path. If the specified
folder does not exist, MetaServer asks, whether the target folder should be created. An error message is displayed, if
folder creation fails.

149 Part VII Reference Section


Installation and Configuration Installation Guide - Part 3
IMPORTANT! Choose an empty folder with full network access at this stage, as all existing files will be over-
written prior to first synchronization run.
MetaServer also performs a validation check,when a mirror is created:
a Same Alias cannot be used twice.
a Same target path cannot be used twice.
a Target path must be valid.

a Choose the Synchronization mode - Manually or Scheduled:


s In the manual mode, you have to take care of the synchronization of root and mirror directories yourself.
s In the scheduled mode, synchronization can be executed daily or on selected days at a given start hour.

MetaServer - Mirror tab - Set synchronization mode

a g-click to confirm the selection or g-click to leave the configuration without commencing any
changes.
1
a Then g-click to engage the initial synchronization. This make take some time, depending on the amount
of data represented by the synchronized root directory.
a In a case of emergency, you can repair damaged root directories from a mirror site. g-click to retrieve
data from the selected mirror.
a You can also existing mirrors, or mirrors altogether.

MetaServer & MetaClient 2.1


MetaSystems 150
Settings

MetaServer - Settings tab

Server Settings
a Server Port
The network port is set to 1050 as a standard. Any port If your IT policies require to use another port, you may choose
port 1023 or higher instead. Changing the server port requires a MetaServer restart!
a Log Level
There are three levels of logging MetaServer's activities: Verbose (Everything), Normal (Errors and Warnings), Silent
(Nothing). The standard setting is Verbose.
a Exception Reporting
Exception reports are very helpful tools to bundle all relevant information, if there is a problem with MetaServer. Here
you can define how they are send to MetaSystems: Save to Disk (and send them manually), Send by eMail, Send by
FTP (default), or Send by HTTP. In the Advanced... mode, you can customize the transfer protocols in details. This op-
tion should be chosen, if any other pre-configured method fails. g-click the button to send a dummy ex-
ception report by the selected mode in order to verify that the transfer is effective.
a Background Scanning
The default 50 % setting is a reasonable compromise between performance and resource usage: lowering the per-
centage will reduce the indexing speed of MetaServer, while increasing it may impair with other application and ser-
vices on the computer running MetaServer.
a Swap Path
MetaServer creates several temporary files which are held in a 'swap' directory. Here you define the Swap Path. If the
standard folder - C:\MetaSystems\Tmp\ - should not be used, either edit the path or g-click the icon to navig-
ate to the alternate folder. Changing the default paths requires a MetaServer restart!

151 Part VII Reference Section


Installation and Configuration Installation Guide - Part 3
a Start minimized?
This option is active by default, causing MetaServer to minimize the program window to a icon in the system tray of
the Windows task bar. g-clicking the tray icon enlarges the MetaServer program window to full size.

Installation Settings
MetaServer runs a self-check to verify that it has write access to the paths listed below. If the write permissions are not set
correctly, a warning message will be prompting you to assign the required rights.
a Global Configuration Path
The global configuration path should point to the same folder as for the Ikaros/Isis shared configuration folder (IksG-
lobal.ini/IssGlobal.ini): either edit the path or g-click the icon to navigate to the alternate folder.
a Secure Global Config Path
This parameter is only relevant, if your Metafer and/or Ikaros/Isis installation is in 'security mode' with encrypted data
and configuration files. Usually the path is identical to the global configuration path and can be adjusted as described
above.
a Update / Backup Path
As of V 2.1 MetaServer and MetaClient provide a MetaServer-controlled update mechanism:
a Copy the entire MetaClient folder of the new software version to a central network resource, accessible from all sys-
tems running MetaClient. It is recommended, to copy the MetaClient folder to the shared MetaSetup folder on the
configuration server computer.
a Change the Update / Backup Path accordingly, either be editing the paths or by g-clicking the icon to navigate
to the respective folder.
a Upon program start, MetaClient automatically scans the defined folder in the Update / Backup Path for most recent
software updates (if no other MetaSystems software is active on the same PC). If a version newer then the active one
is available, an update routine is executed and, after confirmation, MetaClient is updated and automatically restarted.
As this procedure is strictly station-dependent, every MetaClient has to be set up in the same way in order to be able
to utilize the automatic update procedure.
a Similar to the MetaSetup backup routine for Ikaros and Isis, the update / backup routine uses distinct folders for
every MetaClient station, each folder named according to the System-ID. The backups can be found as sub-folders in
the specified Update / Backup Path.
a The update routine creates a temporary backup in a local folder (C:\Temp), before updating MetaClient. Once the up- 1
date has been successfully completed, the new software configuration is copied to the backup folder and the tempor-
ary backup is deleted. Otherwise, if the update fails, the previous configuration is restored.
a Date Format
If you have used the Setup Wizard to run through a basic configuration of MetaServer, the date format should already
be set (k 144 ). The standard date format is dd.mm.yyyy. Changing the date format to take effect requires a
MetaServer restart!
a Auto-restart MetaServer every day at ....
Please be advised to activate this option, in particular on server computers: MetaServer is shut down in a controlled
manner, some swap files are cleared and MetaServer is restarted. In combination with proper Maintenance settings
(see below) you can ensure long-term unattended operation of MetaServer.

MetaServer & MetaClient 2.1


MetaSystems 152
Maintenance

NOTE! The Maintenance procedures are just optional. Deactivated cases are NOT deleted, their cells are just ex-
empted from the gallery. And all data management functions are not available for deactivated cells. Because in-
active cells are not accounted for during indexing, MetaServer's performance is improved. Inactive cases are
displayed with a gray font color in the list and tree view in order to distinguish them from active cases.
A cell receive the 'unused' state, if:
a no karyogram exists.
a the Karyotype field in Ikaros/Isis is blank.
a the Count function has not not used in Ikaros/Isis.
a the Classify function has not not used in Ikaros/Isis.
The 'inactive' cell status can be reverted at any time for selected cells (k 93 on how to reactivate cells).

MetaServer - Maintenance tab

Automatic Maintenance
a Automatically run maintenance at .... hours each day
Schedules the maintenance service, click g to activate / deactivate.

153 Part VII Reference Section


Installation and Configuration Installation Guide - Part 3
Case Inactivation
a Deactivate unused cells in case after .... month(s)
If this option is active, unused cells are deactivated after the given period (in months after the cell capture/creation
date). The default setting is 3 month.
a Deactivate all cells in case after ..... month(s)
If this option is active, all cells in a case (= the entire case) is deactivated after the given period (in months after the
case creation date). The default setting is twelve months.

Trash Management
a Remove deleted files from trash after ... day(s)
This option prevents that the data volume in the trash is increasing with every deleted file until the capacity limit of
the hard disk is reached. Once enabled, file are removed (i .e. permanently deleted) from the trash in an automatic
time-triggered manner. The default setting is 30 days. Files can only be recovered from trash with the given period.
a Optional: g-click the button to execute the maintenance procedure immediately.

Run MetaServer as a Scheduled Task

When MetaServer is installed on a server computer, it should be run without user interaction, i. e. no user must be logged
on. As servers need to be shut down and rebooted for maintenance reasons, it is mandatory to ensure that MetaServer
automatically restarts when the server is booting up again.
MetaServer cannot run as a 'service', however, it can be executed as a ' scheduled task'.
The following steps are for Windows Server 2003, but should be similar for other Windows Server versions:
i. On the Windows Server Desktop, open Start -> Settings -> Control Panel.
ii. In the Control Panel, choose Scheduled Tasks.
iii. G-click the option Add scheduled task to open the wizard.
iv. Select MetaServer.exe (from C:\MetaSystems\Bin by default). Add the command line parameter /noui. This is man- 1
datory to suppress a confirmation dialog during shutdown.
v. In the next step, select the parameter When my computer starts.
vi. Enter a user account that has sufficient rights (read/write access to installation folder and to data folders).
vii. Finish the wizard.
After the next restart, MetaServer will run in the background. Please note, that the procedure described above bears a dis-
advantage: program executed as scheduled task are running in the background without user interface. Because it is not
possible to access any user-controlled function or parameter, the MetaServer configuration should be completed at this
point!.

IMPORTANT!
a You do not have access to the MetaServer user interface, when MetaServer is running as a scheduled task.
a Therefore, please make sure that MetaServer has been set up correctly and tested, before you run it as a
scheduled task.
a The port communication between MetaServer and MSDataServer is 39999 by default. If prompted by net-
work policies, the port can be altered manually in the section ConnSettings of MSDataServer.ini (in ...
\MetaSystems\MetaServer\ImageServer\Bin\MSDataServer.ini).

MetaServer & MetaClient 2.1


MetaSystems 154
7.1.4 Installation Guide - Part 4

Installing MetaClient

Install MetaClient on all Ikaros / Isis systems! To install MetaClient, follow these steps:
1. Download the MetaClient installer from MetaSystems' FTP server (metasystems-ftp.de/Public/Software/MetaServer/
MSMC-2.1.x/MetaClient-2.1.x.exe).
2. Copy the installer to all Ikaros / Isis systems. Please note, that a Wibu device driver must be installed and the copy
protection device ("dongle") must be present on the respective computer.
3. G-click the MetaClient-2.1.x.exe to start the installer.
4. The installer will create new subfolders in C:\MetaSystems and add files to the existing subfolders.
5. Create a shortcut to MetaClient.exe on the desktop and rename it to 'MetaClient'.

NOTE! MetaClient requires a MetaSystems dongle in order to be capable of handling Metafer and Ikaros/
Isis root directories:
a For Metafer root directories the dongle must have a Metafer or a MetaClient entry.
a For Ikaros / Isis root directories can be used if the dongle contains an Ikaros/Isis or a MetaClient entry.
a Only VSlide root directories can be used without dongle: If no dongle is present, the root directory list
shows only VSlide root directories (if available).
Usually dongles can be found on the backside of a PC. The USB versions have the size and shape of a USB
Flash memory stick, while the old LPT version is sitting on the printer port and has the size of a matchbox
(k 274 ). A CodeMeter network dongle is a centralized dongle on the computer running MetaServer that
holds the network licenses of MetaSystems' programs.

Starting MetaClient for the First Time


a G-click the MetaClient icon to start MetaClient.
a MetaClient checks the presence of a copy protection device (dongle). If MetaClient finds an active dongle, it will start
normally.

Only if MetaClient cannot connect to any of the supported options, the following configuration dialog is displayed.
Verify that a dongle is present and connected to the computer (except CodeMeter Network Dongle) and tick the ap-
propriate option:.

155 Part VII Reference Section


Installation and Configuration Installation Guide - Part 4
Starting MetaClient for the first time - Dongle check

MetaClient now supports both WibuKey and CodeMeter:


s Wibu USB Dongle.
s Wibu LPT Dongle.
s Local CodeMeter Dongle.
s Network CodeMeter Dongle (on the computer running .
s None - a (No Dongle) hint in the title bar of the MetaClient program window indicates this (VSlide) mode.

In order to reset a wrong dongle mode, reset the entry DongleMode in section [Dongle] in MetaClient.ini to 0.

a In order to establish the connection MetaClient and MetaServer, fill in the Alias and Computer Name in the New
Server window. The entries should be the same as they were specified during MetaServer setup (k 146 ). Confirm by
g-clicking OK.

MetaClient - Add new server

For stand-alone systems (or for testing purposes) you may use the Local option. g-click the respective command
button to use a Local Host as server.

a In the next step, you can resolve some problems, that usually pop up during the first start of MetaClient. In order to
ensure a seamless co-operation between MetaClient and Ikaros/Isis the programs exchange change notifications on
new and modified cells and cases.

MetaServer & MetaClient 2.1


MetaSystems 156
MetaClient - Problems tab

MetaClient lists the missing configuration settings. You can either follow the suggestion for Automatic Solutions and
just g-click the Resolve button (repeat for every listed problem) or edit the respective root path configuration
manually (k 183 ) and then g-click the Mark as Resolved button. When all problems are solved, the Problems tab
disappears automatically.

NOTE! Read-only users have no rights to apply automatic problem solutions and to mark problems as re-
solved.

157 Part VII Reference Section


Installation and Configuration Installation Guide - Part 4
7.1.5 Installation Guide - Part 5

MetaClient Settings

NOTE! Automatic detection of password-protected user login


MetaClient reads the local IksStation.ini to obtain the path to the shared IksGlobal.ini file. If MetaClient is in-
stalled on an Isis station, the IssStation.ini is read instead in order to locate the IssGlobal.ini. The settings in the
IksGlobal.ini or IssGlobal.ini determine, whether or not a password-protected user login is used for Ikaros or
Isis, respectively. The settings for Ikaros/Isis are used for MetaClient as well. If neither IksStation.ini nor IssSta-
tion.ini exist, MetaClient tries to read the local Station.ini. If this fails, the password-protected login is disabled.

a G-click the MetaClient icon to start MetaClient. Log on as a user with administrator rights.
a g-click the menu command Configure - Settings... to open the MetaClient Settings window.
Parameters are grouped by functional relationship on several tab sheets: General, User Interface, Paths, Hier-
archy, Case List, Cell List, Gallery, Cell Categories, User Rights, File Associations, Gray Levels, and Analysis
Sheet.
There are different types of parameters marked by icons:

Global Apply to all MetaClient stations and to all users.


User-specific Apply to all users
Station-specific Apply only to a particular computer running MetaClient.

a While many parameter settings are applied irrespective of the loaded root path type (k 140 ), some parameters are
only available for Ikaros/Isis root paths (k 143 ), Metafer root paths (k 146 ), or VSlide root paths (k 155 ), some paramet-
ers may not by available.

Save User Preferences as Default 1

a It is possible to use the settings for the administrator user as a template of all other users:
1. Log on to MetaClient as administrator user (Adm). Only the administrator user has the rights to change
the MetaClient configuration!
2. Go to Configure and change the default settings wherever necessary.
3. Choose the command Save User Preferences as Default to save the customized configuration to the file
MetaClient-Default.ini in the shared ...\MetaSystems\Cfg folder.
4. For every user, who logs on to MetaClient for the first time, a new user configuration file MetaClient-<USER>.ini
will be created based on the MetaClient-Default.ini.

Common Settings

This chapter describes the common parameters that are applied irrespective of the loaded root path type.
Parameters only available for Ikaros/Isis root paths (k 143 ), Metafer root paths (k 146 ), or VSlide root paths (k 155 ) can be
found in the following chapters.

MetaServer & MetaClient 2.1


MetaSystems 158
General

Settings - General tab

a Exception Reporting
Exception reports are very helpful tools to bundle all relevant information, if there is a problem with MetaServer or
MetaClient (k 269 ). Here you can define how they are send to MetaSystems. Choose a Send Mode from the drop-
down list: Save to Disk (and send them manually), Send by eMail, Send by FTP (default), or Send by HTTP. In the Ad-
vanced... mode, you can customize the transfer protocols in details. This option is only required, if any pre-configured
method fails. g-click the Test button to send a dummy exception in order to verify that the transmission is working.

a Interaction with Ikaros / Isis


By default, Synchronize Selection is active and Ikaros is selected as the Default Viewer: when you G-click an
Ikaros image in the gallery view, it is opened in Ikaros.

NOTE! This parameter is only available for Ikaros/Isis root directories, but not for Metafer or VSlide root dir-
ectories.

a Fixed Filter Condition


A fixed filter condition can be used, to present cases always in a specific way. For example, if a lab has one big root
path encompassing prenatal, postnatal, and tumor cases, but a given user works only with cases of one of the areas,
then a fixed filter condition for the specimen type would be an effective way to select only the cases of interest. To
setup a Fixed Filter Condition, g-click the Enable tick-box. Then choose the Filter Field from the drop-down list
and, finally, define a Filter Value.
a Printer
Select the Default Printer for MetaClient. The selected printer will be used for all print jobs, unless you choose an-
other printer among all installed printers.
a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

159 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
User Interface

Settings - User Interface tab

a Available Views
The five 'Views' of MetaClient - Overview, Case List, Tree, Statistics, Problems - can be hidden individually. By de-
fault, all views are selected. The Problems view is only displayed, if at least one problem has been detected, even if it
is selected here.
a Miscellaneous
s Show filter value suggestions? - This option enables the presentation of possible filter results sorted by relev-
ance and prevalence. When you type a filter value, the list of possible results is narrowed down accordingly: 1

Example: the effect of 'Show filter value suggestion?' on filtering data for a particular karyotype.

s Refresh on activate ? - If the option is enabled, MetaClient is refreshing all views automatically every time
MetaClient is activated, for example when switching from Ikaros or Isis to MetaClient. This option is disabled by
default.

MetaServer & MetaClient 2.1


MetaSystems 160
a Localization
MetaClient's user interface can be localized. Language files for different languages are available. Choose your pre-
ferred Language from the drop-down list. While we recommend Calibri as the standard font for Western languages,
you might want to pick another Font Name from the list in order to ensure proper display of your local language. For
optimal readability, you may adjust the size of the display font using the Font Scaling settings.
a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

Paths

Settings - Paths tab

a Paths
Here you can define the paths for:
s query definitions - Query Path: ...\MetaSystems\QryDef\
s report templates - Report Path: ...\MetaSystems\Reports\
s file export - Export Path: ...\MetaSystems\Tmp\

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

161 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
Hierarchy

Settings - Hierarchy tab

a Data Hierarchy
MetaClient V 2.1 allows to display much more Data Hierarchy levels compared to previous versions. The available
hierarchy levels are listed below. The Case and Cell (previously Image) levels are fixed (F) and cannot be hidden. Some
levels are visible by default (D), but may be hidden, while others are hidden by default O), but can become visible.
Infopanels are available for Ikaros/Isis root directories only and display the contents of case and/or image data fields
(see here 29 ). Depending on the selected hierarchy level, infopanels may display different kinds of information. To
customize the default pre-configured infopanels, select a hierarchy level by a g-click and then g-click the corres- 1
ponding Edit Infopanel button on the right hand side of the tab sheet to open the Info Panel Editor (k 174 ).
In contrast to earlier versions of MetaClient, the size of infopanels is now based on a vibrant layout, and hence, it is
not possible to adjust the height and width manually:
s The height is automatically adapted to the number of visible data fields (or the height of the workflow bar, if en-
abled). It is no longer possible to change the height interactively (only be choosing less values to be displayed).
s The width of data entries is also handled dynamically. Long entries are wrapped into another line, if necessary to
display the entire field entry.

MetaServer & MetaClient 2.1


MetaSystems 162
Data Hierarchy Levels Visibility by default* Icon Comments

IKS MF VS
Study Combines several cases (experiments)
in one study, for example for biological
dosimetry .

Case Case (or experiment) level - this level


is visible and cannot be hidden.

Test This level can be used to distinguish


between different stainings or FISH
probes, for example.

Culture For each cell culture condition another


culture can be defined (in Ikaros/Isis or
Metafer).

Slide Shows all slides prepared from differ-


ent cultures.

Pass Slides could be scanned in Metafer with


different parameters (classifiers), each
stored scan run is a 'pass'.

Region Region of interest or cell clone on a


slide (as defined in Metafer of VSlide
Viewer).

Cell Cell (or image) level - this level is vis-


ible and cannot be hidden.

Field Capture fields that belong to one cell


(Ikaros/Isis - Add. Capture or Metafer -
AutoCapt).

Run VSlide virtual slide stitching procedures


with different parameter sets.

VSlide VSlide virtual slide images.

* Visibility Status: IKS: Ikaros/Isis root directories, MF: Metafer root directories, VS: VSlide root directories, : Visible
(fixed), : Visible by default, : Not visible by default

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

163 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
User Rights

Settings - User Rights tab

MetaClient supports the same four user roles for Ikaros/Isis, Metafer and VSlide: read-only, read/write (standard user),
supervisor, and administrator. Several restrictions are imposed on read-only users for MetaClient-specific functions.
They are not allowed to:
a Delete, rename, or move cells and cases.
a Add events to the case history.
a Add files and graphics to a case. 1
a Modify the case karyotype in the combined karyogram.
a Annotate in review mode or combined karyogram.
a Change clone assignments in combined karyogram.
a Allow deleting only for supervisors ? - Standard users are usually allowed to delete files. With this parameter it is
possible to restrict the deleting of files to supervisors and administrators only. g-click the tick-box to activate/deac-
tivate the parameter.
a Disable all data management functionality ? - This parameter affects all case and cell data management functions:
create a case, delete a case or a cell, rename a case or a cell, move a case or a cell, and delete unsused cells. Please
note, that this parameter is a global parameter!

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

MetaServer & MetaClient 2.1


MetaSystems 164
File Associations

Settings - File Associations tab - Add/edit file association

Settings - File Associations tab - Example: File extensions linked to respective program executables

165 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
a File Associations
It is possible to associate cases with files in non-MetaSystems file formats, for example *.DOC, *.BMP, *.TXT, or *.PDF.
Use the functions in Tree View - File List to associate a file with a case (k 35 ). Associated files are then listed in the
File List view and can be opened by a G-click on the file icon , if the file format is associated with a matching pro-
gram. MetaClient uses Windows standards, unless you prefer another file format - software association for MetaCli-
ent.
To add a new file association, g-click the button. In the Edit File Association window, you can type the file Ex-
tension. Then add the path to the executable Application or g-click the icon to navigate to the respective *.EXE
file. If you want to delete a file association, select the respective row in the list and then g-click the button. In or-
der to associate a file extension with another program, you can open the Edit File Association window by g-click-
ing the button.

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

Settings for Ikaros / Isis Root Directories

Case List

NOTE! These parameters are only available for Ikaros/Isis root directories, but not for Metafer or VSlide root dir-
ectories.

Settings - Case List for Ikaros/Isis Root Directories

MetaServer & MetaClient 2.1


MetaSystems 166
a Case List Columns
This tab sheet configures the table for the Case List view. The configuration table has two columns: the left Field
column lists the data field in the sequence as they appear in the Cast List view table. The right Name column exhibits
the captions for the fields. g-click the button to open the Add Column window, in which you can select addi-
tional data fields to be included. If you want to delete a column, select the Field entry in the list and then g-click the
button. In order to change the Name for a Field open the Edit Column window by g-clicking the button.

Add Column Window in Case List Settings

To find the desired field name, either type the first characters of the field name in the smart filter box ( ) or scroll
down the list of data field to the right entry. g-click OK to confirm, or g-click Cancel to leave the Add Column
window without commencing any changes.

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

167 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
Cell List

NOTE! These parameters are only available for Ikaros/Isis root directories, but not for Metafer or VSlide root dir-
ectories.

Settings - Cell List for Ikaros/Isis Root Directories

a Cell List Columns


This tab sheet configures the table for the Cell List view. The configuration table has two columns: the left Field
column lists the data field in the sequence as they appear in the Cell List view table. The right Name column exhibits
the captions for the fields. g-click the button to open the Add Column window, in which you can select addi- 1
tional data fields to be included. If you want to delete a column, select the Field entry in the list and then g-click the
button. In order to change the Name for a Field open the Edit Column window by g-clicking the button.

Add Column Window in Cell List Settings

MetaServer & MetaClient 2.1


MetaSystems 168
To find the desired field name, either type the first characters of the field name in the smart filter box ( ) or scroll
down the list of data field to the right entry. g-click OK to confirm, or g-click Cancel to leave the Add Column
window without commencing any changes.

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

Gallery

NOTE! These parameters are only available for Ikaros/Isis root directories, but not for Metafer or VSlide root dir-
ectories.

Settings - Gallery for Ikaros/Isis Root Directories

a Gallery Info
The Gallery Info settings determine, which data fields are being displayed in the four corners of the info panel below
the image in the Tree View - Cell Gallery. While the entry for the upper left corner is fixed to Image Name, the in-
formation tags for the other three corners can be chosen freely. By default, the creation date (Created), the user, who
made the last image modification (Last Modif. User) and the karyotype (Karyotype) are shown. To edit these entries,
g-click on one of the underlined field names. This will open a Select Cell Fields window, in which you can edit the
visible information.

169 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
Add Column Window in Gallery Settings

If you want to add a field, select the respective entry in the left panel and then g-click the arrow to move the field
identifier to the right panel. To remove an entry, select it in the right panel and g-click the button. If two or more
field identifiers are present, you can use the and arrow buttons to adjust their sequence. The information is
separated by 'bullet points'.

a Gallery Hints
When you move the mouse pointer over an gallery image, MetaClient displays an informative hint window. Although
Gallery Hints are enabled by default, it is possible to disable them by g-clicking off the option Show Gallery Hints
on the Gallery tab (see above). It is possible to configure the information presented in the Gallery Hints. To add an-
other field, g-click the button to open the Select Field window, in which you can select additional data fields to
be included:

Add Column Window in Gallery Settings Add Hint Window in Gallery Settings

1. g-click an entry and then OK to include a data field in the hint window. Use the and arrow buttons to ad-
just the sequence of data fields for display.
2. To remove a data field from the hint window, g-click the respective field identifier first and then the button.

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

MetaServer & MetaClient 2.1


MetaSystems 170
Cell Categories

It is now possible to group cells into individual categories. It is possible to define ten different categories. These categories
are defined in the global configuration settings and edited in the settings dialog. Additionally to the category number each
category as a color and a description. If no description is chosen the default description “(unnamed)” is displayed instead.
Each category can be disabled selectively.

Settings - Cell Categories for Ikaros/Isis Root Directories

a Cell Categories
Global Cell Categories flags can be assigned to cells in the Cell Gallery. By default, three categories marked in green,
orange and red are active. The colored marks can be introduced in the cell gallery images by g-clicking the upper
right corner of a gallery image:

Cell Categories Marks in the Cell Gallery

Cell Categories can be used to mark the processing status of a particular cell (in contrast to the Workflow Bar, which
visualizes the status of a case). The two examples below demonstrate the potential use of Cell Categories marks:

171 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
Examples for the Use of Cell Categories

1. g-click the square in front of the categories number to activate ( ) or deactivate ( ) a category.
2. g-click a colored square to open a Windows color palette from which you can choose color for the selected cat-
egory.
3. Add a descriptive text for the category in the text field. The text will appear in the gallery hint.

NOTE! A categorized cell is set back to the 'undefined' state, when a cell is moved to another case.
However, a category state is preserved upon renaming a cell within the same case. 1

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

MetaServer & MetaClient 2.1


MetaSystems 172
Gray Levels

NOTE! These parameters are only available for Ikaros/Isis root directories, but not for Metafer or VSlide root dir-
ectories.

Settings - Gray Levels

a Screen Gray Levels / Printer Gray Levels


MetaClient provide detailed settings to optimize the presentation of gray levels ("intensities") and colors on different
monitor and printer models. You can adjust the shadows, midtones and highlights gray levels separately for transmit-
ted light and fluorescence image. The parameter values are expressed as ‘percentage color intensity’.
The default values given are just suggestions. If you are not using the monitor and printer models certified by
MetaSystems, alternate settings may be required to produce good results.
a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

173 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
Analysis Sheet

NOTE! These parameters are only available for Ikaros/Isis root directories, but not for Metafer or VSlide root dir-
ectories.

Settings - Analysis Sheet

a Analysis Sheet - Marker Chromosomes


Here you can customize the number of marker chromosomes and their class annotations. The configuration is based
on a simple text file: one line per marker chromosome class, just add the desired descriptive text in each line as
demonstrated above. You can add a line (= a class) using the [Enter] key and delete a line with [Del]. Or g-click the 1
button to undo all modification. The standard setting is one additional marker class 'mar'.

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

Edit Info Panels

NOTE! The Edit Infopanel command buttons are only available for Ikaros/Isis root directories, but not for
Metafer or VSlide root directories.

The Case Information and Image Information Panels available in V1.0/V1.1 of MetaClient were replaced by fully cus-
tomizable Infopanels for all hierarchy levels.

This section describes how to customize the Infopanels for each hierarchy level independently.
1. To edit an Infopanel, g-click the menu command Configure - Settings... .
2. Then select the Hierarchy tab.

MetaServer & MetaClient 2.1


MetaSystems 174
Settings - Hierarchy

3. You can create customized infopanels for every hierarchy level. g-click the respective Edit Infopanel command but-
ton to open the Info Panel Editor.
Depending on the hierarchy level, more or less fields are available. For example, there is only the Name field avail-
able for Study (left), but a long list of options for the Case level (right):

Info Panel Editor - for Study level

175 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
Info Panel Editor - for Case level

The left top panel of the editor displays the list of available Fields for the respective Level, while the right panel en-
compasses all selected visible fields for the particular level. In the pre-configured state, only data fields from the cur-
rent hierarchy level are chosen.

4. You can also include data fields from higher hierarchy levels.
i. g-click on the drop-down list for Level, select a level above the current one.
For example, if you on the Cell level and want to include the Case Name in the info panel, select Case from the
drop-down list:

Selecting a data field for a particular hierarchy level

ii. Select Case Name in the Fields list and g-click the blue arrow icon ( ) to move the Case Name field to the right
panel.

MetaServer & MetaClient 2.1


MetaSystems 176
Activating a data field

5. You can change the position of a field in the infopanel with the blue up ( ) and down ( ) icons .

6. To delete a field from an info panel, click the icon.


7. Tick the option Workflow Bar visible to display or hide the workflow bar. How to customize the Workflow Bar, see k
177 .

8. g-click the command button, to restore the pre-configured state of the infopanels. g-click
to confirm, or g-click to leave the Settings window without commencing any changes.

Edit Workflow Settings

NOTE! These parameters are only available for Ikaros/Isis root directories, but not for Metafer or VSlide root dir-
ectories.

The Edit Workflow settings are only available, if an Ikaros/Isis root directory is loaded.

The Workflow Bar can provide an 'at-a-glance' information on the current processing status of the selected Ikaros/Isis
case. By default, the workflow bar is visible at the case level and at all hierarchy levels below. You can hide the Workflow
Bar in the Info Panel Settings (k 174 ).

1. To customize the Workflow Bar, go to Configure - Workflow Settings ... . In the Workflow Settings window, you can
set the Permissions to alter the workflow progression, and you can edit the visible Workflow Stages.
2. g-click to confirm, or g-click to leave the Workflow Settings window without commencing any
changes.

177 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
Workflow Settings window.

Permissions
With the parameters User level required to set workflow state and User level required to reset workflow state you
can define the minimum user levels required to change the stage level in the Workflow Bar. For both parameters you can
choose among: Read Only - Read/Write - Supervisor - Administrator users.

Workflow Stages
The pre-configured Workflow Bar includes five stages: Created - Captured - In Analysis - Analyzed - Checked. Here you
can add, change or delete workflow stages.

a g-click an existing workflow stage after which you want to insert a new stage and then g-click the button to
open the Add Stage window, in which you can assign a Stage Name. The Workflow Bar grows horizontally with every
new stage. The longest stage name in the sequence determines the breadth of every stage.
Confirm the name by g-clicking or g-click to leave the window without commencing any
changes. 1
a If you want to delete a stage, select the respective entry in the list and then g-click the button. When you delete
an existing workflow stage, a warning message is displayed indicating that all corresponding information will be lost.
Please note, that the Created and Checked stages cannot be edited or deleted, which is indicated by small 'lock'
icons.

a In order to change the caption of a stage, open the Edit Stage window by g-clicking the button.

MetaServer & MetaClient 2.1


MetaSystems 178
Settings for Metafer Root Directories

NOTE! MetaServer / MetaClient supports *.MSD files of Metafer V3.12 and earlier.

Pass List

NOTE! These parameters are only available for Metafer root directories, but not for Ikaros/Isis or VSlide root dir-
ectories.

Settings - Pass List for Metafer root directories

a Pass List Columns


This tab sheet configures the table for the Case List view. The configuration table has two columns: the left Field
column lists the data field in the sequence as they appear in the Cast List view table. The right Name column exhibits
the captions for the fields. g-click the button to open the Add Column window, in which you can select addi-
tional data fields to be included. If you want to delete a column, select the Field entry in the list and then g-click the
button. In order to change the Name for a Field, open the Edit Column window by g-clicking the button.
a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

179 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
Cell Gallery

NOTE! These parameters are only available for Metafer root directories, but not for Ikaros/Isis or VSlide root dir-
ectories.

Settings - Cell Gallery for Metafer root directories

a Coordinates Display
As of V 2.1 it is possible to display transformed coordinates below gallery images in MetaClient's cell gallery. The Dis-
play Transformed Coordinates option is active by default. To disable the display of transformed coordinates g-
click the respective check box. 1
In order to establish a correct coordinate transformation, specify the path to the Stage Transformation file
(StageTra.DAT), which is usually stored either in the ...\MetaSystems\MSCfg folder on your Metafer system or in ...
\MetaSystems\Cfg folder on the configuration server.
Then select the appropriate Coordinate System, for example microscope MIC 1. Coordinates are transformed from
Metafer relative coordinate system to the specified target coordinate system.
The option Apply automatic stage calibration offsets is mandatory for Metafer system with SlideFeeder SFx80, but
optional for Metafer scanning systems without slide feeder.
a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

MetaServer & MetaClient 2.1


MetaSystems 180
Settings for VSlide Root Directories

Run List

NOTE! These parameters are only available for VSlide root directories, but not for Metafer or Ikaros/Isis root
directories.

Settings - Run List for VSlide root directories

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

181 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
VSlide List

NOTE! These parameters are only available for VSlide root directories, but not for Metafer or Ikaros/Isis root
directories.

Settings - VSlide List for VSlide root directories

a Restore Defaults
g-click the command button to restore the standard settings for this tab.
g-click to confirm, or g-click to leave the Settings window without commencing any changes.

MetaServer & MetaClient 2.1


MetaSystems 182
VMD

NOTE! These parameters are only available for VSlide root directories, but not for Metafer or Ikaros/Isis root
directories.

Settings - VMD for VSlide root directories

The VMD tab is blank by default. Detailed VMD Settings are only required, if you are using a Virtual Microscope Database
(VMD) by Lightfields to upload and share virtual slide images.
Please refer to your VMD installation details in order to copy the Hostname, the Default Institute (your institute) and
your VMD user credentials (User and Password), which might differ from the MetaClient credentials. If you are using a
Proxy-Server, please tick the respective option and detail its Address and network Port.

7.1.6 Installation Guide - Part 6

In order for the communication between MetaClient and Ikaros / Isis to work properly, some steps need to be performed
on every computer running MetaClient.

Adjusting the Root Path Lists Manually

If you are not using the automatic problem solver, you must edit the (shared) configuration files IksRootPath.ini (for
Ikaros) and IssRootPath.ini (for Isis) on the server (....\MetaSystems\Cfg) to ensure proper notification between Ikaros/Isis
and MetaServer. The files IksRootPath.ini and IssRootPath.ini contain a section for each root directory configured in
MetaServer. Each section must look like this:

183 Part VII Reference Section


Installation and Configuration Installation Guide - Part 5
[Rootpath Alias]
MetaSrvName=Server
MetaSrvPort=1050
where the rootpath alias, the computer name and the port number should be substituted with the actual values. Notifica-
tions are send in both directions. All data management operations are synchronized for MetaServer/MetaClient and
Ikaros/Isis.

Macro Command "GoToMetaClient"

When you use MetaClient 2.0 in combination with Ikaros / Isis 5.4 or higher, it is recommended to utilize the macro com-
mand GoToMetaClient in an OnKey macro (see also Ikaros & Isis Reference Manual, Reference Section, Print Forms and
Macros). The macro switches from Ikaros / Isis to MetaClient and synchronizes case and cell selection:

Macro Remarks

OnKeyM* DoCmd GoToMetaClient

*'M' is just a suggestion, of course, you may use other keys for this macro. You can also relay this macro command to a
custom command button. Please see the Ikaros & Isis Help for more information.

7.2 Data Field References

Data Field Editor


Although MetaClient already comes with a long list of available data fields, it is possible to define new data fields. New
fields may be required, if you have created new data fields in the Ikaros/Isis data sheet, and want to utilize the same type
of fields in MetaServer/MetaClient for:
a customize displayed data fields in the Info Panel in MetaClient.
a reporting.
1
a queries.

Create and Edit Custom Data Fields

MetaClient allows you to define their own computed fields. Once a new computed fields has been defined, you can use it
just like any other pre-configured data field.
1. To create or edit data fields, go to the Datafield Editor (menu Configure - Datafield Editor ...). You can create new
datafields for all hierarchy levels:
Study - Case - Test - Culture - Slide - Pass - Region - Cell - Field - XFile - VSlide Run - VSlide.
2. Select the respective hierarchy level on the left side of the editor window.

3. Then g-click the icon to open a Edit Datafield window in order to create a new data field. Add a Name, a Short
Name, and a Default Value (if applicable). Then choose the Data Type - the following data types are supported:
Text, Boolean, Optional Boolean, Date, Number, Real Number, Mutliline Text, and Time.
For new data fields the Type is always set to Computed. g-click on the Computation... button to open the Query
Editor (k 113 ), in which you can define the query that shall be used for the computation.
If you want to include the new data field in the indexing regime, tick the Quick Search option.

MetaServer & MetaClient 2.1


MetaSystems 184
4. Finalize the configuration of the new data field by g-clicking OK ( or Cancel to exit the editor without saving).
MetaClient will create the new field and will assign a field-ID to the new field.

Import Custom Data Fields from MetaClient V1.0

Customized data fields defined in MetaClient V1.0 can be imported into V2.1:
1. To import customized data fields, go to the Datafield Editor (menu Configure - Datafield Editor ...) and select the
Case hierarchy level.

2. g-click the icon on the right hand side of the editor window.
3. Choose the option UserFields.lst... to integrate custom data fields defined in MetaServer/MetaClient V 1.0.
4. Navigate to the respective UserFields.lst file (on the server), g-click the file and then OK.

Import Custom Data Fields from Ikaros / Isis

While all default case data fields from Ikaros / Isis are available in MetaClient, too, customized Ikaros / Isis case data fields
shall be imported manually into MetaClient:
1. To import Ikaros / Isis data fields, go to the Datafield EditorXConfigure - Datafield Editor ...) and select the Case hier-
archy level.

2. g-click the icon on the right hand side of the editor window.
3. Choose Import DataSheet.ini ... to import customized fields TEXT01...TEXT12, SWITCH01...SWITCH12 or any user-
defined new data field.
4. Navigate to the respective DataSheet.ini file (on the server), g-click the file and then OK.
Like in Ikaros / Isis, for a custom data field without caption, the field identifier is used as caption.

Data Fields - By Category

NOTE!
a The tables below with more than two rows are sortable by Field ID, Name, Short Name and File Identi-
fier.
a g-click the table headers to sort rows in ascending or descending order, respectively.

Study Field IDs

Field ID Name Short Name Default Value Data Type Iks/Iss Identifier Field Type Quick
Search

0 Name Name — Text — Default TRUE

185 Part VII Reference Section


Data Field References
Case Field IDs

Quick
Field ID Name Short Name Default Value Data Type Iks/Iss Identifier Field Type
Search

0 Case Name Case Name — Text CASE TRUE

1 Archive Media A Media A — Number — FALSE

2 Archive Media B Media B — Number — FALSE

3 Last Modification Date Last Modif. Date — Date — FALSE

7 Check User Check User — Text REVIEWED_BY, FALSE


CONTROLLEDBY,
USR_LOCK

8 Check Date Check Date — Date LOCK_DATE FALSE

9 Creation Date Creation Date — Date n/a FALSE

10 Filing Number Filing No — Text FILING_NBR, TRUE


FILINGNUMBER

11 Patient Number Patient No — Text PAT_NBR, TRUE


PATIENTNUMBER

12 Patient First Name First Name — Text PAT_FST_NAME, TRUE


PATIENTFIRSTNAME

13 Patient Middle Name Middle Name — Text PAT_MDL_NAME TRUE

14 Patient Last Name Last Name — Text PAT_LST_NAME, TRUE


PATIENTSECONDNA
ME

15 Patient Birthdate Birthdate — Date PAT_BIRTHDATE, TRUE


PATIENTBIRTHDATE 1

16 Patient Group Group — Text PAT_GRP, False


PATIENTGROUP

17 Patient Title Title — Text PAT_TITLE, FALSE


PATIENTTITELE

18 Patient Notification of Sex Sex Notif. — Boolean PAT_NOTIFICATION_ FALSE


OF_SEX

19 Patient Address Address — Text PAT_ADDR, TRUE


PATIENTADDRESS

20 Patient Street Street — Text PAT:STREET, TRUE


PATIENTSTREET

21 Patient ZIP Code ZIP Code — Text PAT_POSTCODE, FALSE


PATIENTZIPCODE

22 Patient City City — Text PAT_CITY, FALSE


PATIENTCITY

MetaServer & MetaClient 2.1


MetaSystems 186
Quick
Field ID Name Short Name Default Value Data Type Iks/Iss Identifier Field Type
Search

23 Patient Country Country — Text PAT_COUNTRY, FALSE


PATIENTCOUNTRY

24 Patient Salutation Salut. — Text PAT_SALUTATION, FALSE


PATIENTSALUTATIO
N

25 Patient Phone Number Phone — Text PAT_PHONE, FALSE


PATIENTPHONE

26 Patient Gestation Age Gest. Age — Number PAT_GESTATIONAGE, FALSE

GESTATIONAGE

27 Patient Last Period Last Period — Date PAT_FIRST_DAY_OF_L FALSE


AST_PERIOD,
FIRSTDAYOFLASTPER
IOD

28 Patient Remarks Pat. Remarks — Text PAT_REMARKS, TRUE


PATIENTREMARKS

29 Indication Indication — Text INDICATION TRUE

30 Specimen Type Specimen — Text SPECIMEN_TYPE, TRUE


EXAMINATION

31 Sample Taking Date Sample Taken — Date SAMPLE, FALSE


SAMPLETAKINGDATE

32 Sample Arrival Date Sample Arrived — Date ARRIVAL, FALSE


SAMPLEARRIVALDAT
E

33 Reporting Date Report Date — Date REPORT, FALSE


DIAGNOSISDATE

34 Result Result — Text RESULT, TRUE


DIAGNOSIS

36 Other Techniques Oth. Techn. — Text OTH_TECHNIQUES, FALSE


OTHERTECHNIQUES

37 Karyotype Karyotype — Text KARYO, TRUE


KARYOTYPE

38 Band Count Bands — Text BND_CNT, FALSE


BANDCOUNT

39 Sending Physician Physician — Text PHYSICIAN01, TRUE


SENDINGPHYSICIAN

40 Second Physician 2. Physician — Text PHYSICIAN02, TRUE


SCNDPHYSICIAN

187 Part VII Reference Section


Data Field References
Quick
Field ID Name Short Name Default Value Data Type Iks/Iss Identifier Field Type
Search

41 Third Physician 3. Physician — Text PHYSICIAN03, TRUE


THRDPHYSICIAN

42 Culture Begin Cult. Begin — Date CULTURE_BEGIN, FALSE


CULTUREBEGINDATE

43 Culture End Cult. End — Date CULTURE_END, FALSE


CULTUREENDDATE

44 Culture Remarks Cult. Remarks — Text CULTURE_REMARKS, TRUE


CULTUREREMARK

45 Microcounted Images Microc. Imgs 0 Number MICRO_COUNTED_M FALSE


ETA,
MICROSCOPECOUNT
EDMETACNT

46 Molecular Cytogenetics Mol. Cytogen. — Text MOLECULAR_CYTO, FALSE


MOLECULARCYTOGE
NETICS

47 Male Male — Boolean MALE, ISMALE FALSE

48 G-Banding Gband — Boolean — FALSE

49 Q-Banding QBand — Boolean — FALSE

50 C-Banding CBand — Boolean — FALSE

51 R-Banding RBand — Boolean — FALSE

52 DAPI Counterstain DAPI — Boolean — FALSE

53 Probe ID Probe ID — Text PROBE_ID, FALSE


1
PROBEID

54 Technician Technician — Text TECHNICIAN FALSE

56 Barr Body Barr Body False Boolean BARR_BODY, FALSE


BARRBODY

57 Y Chromatin Y Chrom. False Boolean Y_CHROMATIN, FALSE


YCHROMATIN

58 Noticeable Noticeable False Boolean NOTICABLE, FALSE


NOTICEABLE,
ISNOTICEABLE

59 Export Date Export Date — Date EXPORT_DATE FALSE

63 Associated Files Files 0 Number — FALSE

65 Subdirectory Subdir — Text — FALSE

66 Analysis State Analysis State Not analyzed Text — FALSE

67 Patient Age Pat. Age — Number — FALSE

MetaServer & MetaClient 2.1


MetaSystems 188
Quick
Field ID Name Short Name Default Value Data Type Iks/Iss Identifier Field Type
Search

68 Reporting Time in Days Report Time — Number — FALSE

69 Active Active True Boolean — FALSE

70 Last Reactivation Date Last Reactivation — Date — FALSE

71 Workflow State Workflow State Created Text — FALSE

72 Slides Slides 0 Number — FALSE

73 Cultures Cultures 0 Number — FALSE

74 Passes Passes 0 Number — FALSE

75 VSlide Runs Runs 0 Number — TRUE

76 VSlides VSlides 0 Number — TRUE

100 Metaphases Metas 0 Number — FALSE

101 Karyograms Karyos 0 Number — FALSE

102 Counted Metaphases Counted 0 Number — FALSE

103 Analyzed Metaphases Analyzed 0 Number — FALSE

Test Field IDs (sorted by field ID):

Field ID Name Short Name Default Value Data Type Iks/Iss Iden- Field Type Quick Search
tifier

0 Name Name — Text TRUE

Culture Field IDs (sorted by field ID):

Field ID Name Short Name Default Value Data Type Iks/Iss Identi- Field Type Quick Search
fier

0 Name Name — Text TRUE

Slide Field IDs (sorted by field ID):

Field ID Name Short Name Default Value Data Type Iks/Iss Identi- Field Type Quick Search
fier

0 Name Name — Text TRUE

189 Part VII Reference Section


Data Field References
Pass Field IDs (sorted by field ID):

Field ID Name Short Name Default Data Type Iks/Iss Identi- Field Type Quick Search
Value fier

0 Name Name — Text FALSE

1 File Name File Name — Text TRUE

2 Program Version Version — Text FALSE

3 Original Program Version Orig. Version — Text FALSE

4 Application Application — Text FALSE

5 Classifier Classifier Text TRUE

6 Computer Name Computer Text FALSE

7 Scoring Sheet Scoring Sheet Text TRUE

8 Slide Comment Comment Text TRUE

9 Cell Count Cells Number FALSE

10 Original Cell Count Orig. Cells Number FALSE

11 Undefined Cell Count Undef. Cells Number FALSE

12 Marked Cell Count Marked Cells Number FALSE

13 Rejected Cell Count Rejected Cells Number FALSE

14 Highlighted Cell Count Highlighted Cells Number FALSE

15 Microscope Magnification Magnification Text FALSE

16 CCD Camera Pixel Size CCD Pixel Size Text FALSEO

17 Search Window Search Window Text FALSE 1

18 Capture Image Size X Capt. Img. Size X Number FALSE

19 Capture Image Size Y Capt. Img. Size Y Number FALSE

20 Search Duration Search Duration Text FALSE

21 Fluorescence Mode FL Boolean FALSE

22 Has Label Image Label Image Boolean FALSE

23 Has Internal Overview Int. Overview Img. Boolean FALSE


Image

24 Has External Overview Ext. Overview Img. Boolean FALSE


Image

25 Has Comet Information Comet Info Boolean FALSE

26 Position List Scan PL Scan Boolean FALSE

27 RGB Color Camera Color Camera Boolean FALSE

MetaServer & MetaClient 2.1


MetaSystems 190
Field ID Name Short Name Default Data Type Iks/Iss Identi- Field Type Quick Search
Value fier

28 Raw Bayer Mode Raw Bayer Mode Boolean FALSE

29 Analysis Image Size X Analysis Image Size X Number FALSE

30 Analysis Image Size Y Analysis Image Size Y Number FALSE

31 Gallery Image Size Gallery Img Size Number FALSE

32 Gallery Image Colors Gallery Colors Text FALSE

33 Counterstain Channel CS Channel Number FALSE

34 Scanned Fields Scanned Fields Number FALSE

35 Rejected Fields Rejected Fields Number FALSE

36 Nucleus Count Nucleus Count Number FALSE

37 Manual Mitotic Index Manual Mitotic Index Number FALSE

38 Search User Search User Text FALSE

39 First Evaluation User First Eval. User Text FALSE

40 First Evaluation Date First Eval. Date Date FALSE

41 Last Evaluation User Last Eval. User Text FALSE

42 Last Evaluation Date Last Eval. Date Date FALSE

43 Lock User Lock User Text FALSE

44 Lock Date Lock Date Date FALSE

45 Search End Time Search End Time Text FALSE

46 File Size (MB) File Size Number FALSE

47 Last Saved Date Last Saved Date FALSEO

48 Case Case Text FALSEO

49 Culture Culture Text FALSE

50 Slide Slide Text FALSE

51 Not Highlighted Cell Count Not Highlighted Cells Number FALSE

52 Selected Cell Count Selected Cells Number FALSE

53 Unselected Cell Count Unselected Cells Number FALSE

54 Cells with Aberration Cells with Aberration Number FALSE

55 Cells without Aberration Cells w/o Aberration Number FALSE

56 Cells Pos. Diagram 1 Cells Pos. Diagram 1 Number FALSE

57 Cells Pos. Diagram 2 Cells Pos. Diagram 2 Number FALSE

58 Cells Pos. Region Cells Pos. Region Number FALSE

191 Part VII Reference Section


Data Field References
Field ID Name Short Name Default Data Type Iks/Iss Identi- Field Type Quick Search
Value fier

59 Gallery Count Gallery Count 0 Number FALSE

60 Full Filename Full Filename Text FALSE

61 Original Mitotic Index Orig. MI Real Num- FALSE


ber

62 Current Mitotic Index Curr. MI Real Num- FALSE


ber

Region Field IDs (sorted by field ID):

Field ID Name Short Name Default Data Type Iks/Iss Identi- Field Type Quick Search
Value fier

0 Name Name Text TRUE

Cell Field IDs

Field ID Name Short Name Default Data Type Iks/Iss Iden- Field Type Quick Search
Value tifier

0 Name Name Text Default TRUE

1 Experiment Type Exp. Type Text Default TRUE

2 Culture Culture Text Default FALSE

3 Slide Slide Text Default FALSE


1
4 Coordinates Coord. Text Default FALSE

5 Karyotype Karyotype Text Default TRUE

6 Metaphase Remarks Meta Remarks Text Default TRUE

7 Karyogram Remarks Karyo Remarks Text Default TRUE

8 Creation User Creation User Text Default FALSE

9 Last Image Modification Last Modif. User Text Default FALSE


User

10 Check User Check User Text Default FALSE

11 Capture DLL Version Capt.Vers. Text Default FALSE

12 Computer Name Computer Text Default FALSE

13 Camera Model Camera Text Default False

14 Framegrabber Model Grabber Text Default FALSE

15 Camera Number Camera No Text Default FALSE

MetaServer & MetaClient 2.1


MetaSystems 192
Field ID Name Short Name Default Data Type Iks/Iss Iden- Field Type Quick Search
Value tifier

16 Image Fields Fields 0 Number Default FALSE

17 Creation Date Created Date Default FALSE

18 Has Karyogram Karyo False Boolean Default FALSE

19 Has Black Background Black Bg. False Boolean Default FALSE

20 Check Date Check Date Date Default FALSE

21 Last Image Modification Last Modif. Date Date Default FALSE


Date

22 Scanning User Scan User Text Default FALSE

23 Scanning Date Scan Date Date Default FALSE

24 Auto Capture User AutoCapt User Text Default FALSE

25 Auto Capture Date AutoCapt Date Date Default FALSE

26 Capture User Capture User Text Default FALSE

27 Capture Date Capture Date Date Default FALSE

28 Count User Count User Text Default FALSE

29 Count Date Count Date Date Default FALSE

30 Classify User Cls User Text Default FALSE

31 Classify Date Cls Date Date Default FALSE

32 Karyotyping User Karyo User Text Default FALSE

33 Karyotyping Date Karyo Date Date Default FALSE

34 Karyotype Edit User Karyo Edit User Text Default FALSE

35 Karyotype Edit Date Karyo Edit Date Date Default FALSE

36 Image Type Type 0 Number Default FALSE

38 Case Name Case Text Default FALSE

39 Initial Filename Initial Filename Text Default FALSE

40 Category Category 2147483647 Number Default FALSE

41 Last Display Mode Last Display Mode 0 Number Default FALSE

42 Region Number (more info) Region Number Number Default FALSE

43 Cell ID CID Number CID Default False

193 Part VII Reference Section


Data Field References
Field Field IDs (sorted by field ID):

Field ID Name Short Name Default Data Type Iks/Iss Iden- Field Type Quick Search
Value tifier

0 Name Name Text Default FALSE

1 Is Karyo Karyo Boolean Default FALSE

XFile Field IDs (sorted by field ID):

Field ID Name Short Name Default Data Type Iks/Iss Iden- Field Type Quick Search
Value tifier

0 Name Name Text Default TRUE

1 Filename Filename Text Default FALSE

VSlide Run Field IDs (sorted by field ID):

Field ID Long Name Short Name Default Data Type Iks/Iss Iden- Field Type Quick Search
Value tifier

0 Name Name Text FALSE

1 Full Name Full Name Text TRUE

2 Culture Culture Text FALSE

3 Slide Slide Text FALSE

4 Pass Pass Text FALSE 1


5 VSlide Version VSlide Vers. Text FALSE

6 Metafer Version MF Vers. Text FALSE

7 Metafer Application MF Appl. Text FALSE

8 Metafer Classifier MF Classif. Text TRUE

9 Stitch End Time Stitch End Time FALSE

10 Case Case Text FALSE

17 Slide Comment Slide Comment Text TRUE

18 Magnification Magn. Text FALSE

20 Is Fluorescence FL Boolean FALSE

28 Resolution (µm/Pixel) Resolution Real Number FALSE

29 CCD Camera Pixel Size Camera Pixel Size Real Number FALSE

30 Original TRN Name Original TRN Text FALSE

MetaServer & MetaClient 2.1


MetaSystems 194
Field ID Long Name Short Name Default Data Type Iks/Iss Iden- Field Type Quick Search
Value tifier

31 Parameter Set Parameter Set Text TRUE

32 Offset X Offset X Number FALSE

33 Offset Y Offset Y Number FALSE

34 Area (mm²) Area Number FALSE

41 Scan User Scan User Text FALSE

42 Scan System ID Scan SysID Text FALSE

43 Scan System Name Scan SysName Text FALSE

44 Scan System User Scan SysUser Text FALSE

45 Pixels per Unit Pixels/Unit Real Number FALSE

46 Microscope Config Microscope Conf. Text FALSE

47 Camera Model Camera Model Text FALSE

48 Color Camera Color Cam. Boolean FALSE

49 Raw Bayer Mode Raw Bayer Mode Boolean FALSE

50 Image Flip Mode Img Flip Mode Number FALSE

51 Mirrored Horizontally MirroredH Boolean FALSE

52 Mirrored Vertically MirroredV Boolean FALSE

53 Position List Scan PL Scan Boolean FALSE

54 Irregular Position List Irreg. PL Boolean FALSE

55 Spiral Position List Spiral PL Boolean FALSE

56 Fields per Position X Fields/Pos X Number FALSE

57 Fields per Position Y Fields/Pos Y Number FALSE

58 Scanned Back to Front Back to Front Boolean FALSE

59 Search Window Search Window Text FALSE

60 Search Grid Search Grid Text FALSE

61 Camera Gain Cam. Gain Real Number FALSE

62 MetaCyte Raw IP MCyte Raw IP Boolean FALSE

63 Corrected Inhomogeneous Il- Corr. Inh. Ill. Boolean FALSE


lumination

64 Compressed TRN Compressed TRN Boolean FALSE

65 Backlash Compensation Backlash Comp. Boolean FALSE

66 Unidirectional Positioning XY Unidir. Pos. XY Boolean FALSE

67 Unidirectional Positioning Z Unidir. Pos. Z Boolean FALSE

195 Part VII Reference Section


Data Field References
Field ID Long Name Short Name Default Data Type Iks/Iss Iden- Field Type Quick Search
Value tifier

68 Counterstain Channel CS Channel Number FALSE

69 Search Start Time Search Start Time FALSE

70 Search End Time Search End Time FALSE

71 FOV Pixel Width FOV Width Number FALSE

72 FOV Pixel Height FOV Height Number FALSE

73 1:1 Scaling in Ext. Foc. Img. 1:1 Ext. Foc. Scale Boolean FALSE

74 Channel Info Channel Info Text FALSE

75 Stitch Start Time Stitch Start Time FALSE

76 Stitch Mode Mode Text FALSE

77 Stitch System ID Stitch SysID Text FALSE

78 Stitch System Name Stitch SysName Text FALSE

79 Stitch System User Stitch SysUser Text FALSE

80 Max Angle Error Max Angle Error Real Number FALSE

81 Maxx Magnification Error Max Magn. Error Real Number FALSE

82 Allow Suffixing Suffixing Boolean FALSE

84 Delete Input Files Del. Input Files Boolean FALSE

85 Delete Previous Input Files Del. Prev. Input Files Boolean FALSE

86 Irregular PL Mode Irreg. PL Mode Number FALSE

87 Allow Overwrite Overwrite Boolean FALSE


1
89 Metafer Resolution MF Res. Text FALSE

90 Captured FOVs Capt. FOVs Number FALSE

91 Slide Position Slide Pos. Number FALSE

92 Frame Position Frame Pos. Number FALSE

93 Frame ID Frame ID Number FALSE

94 Matching Quality Match. Qual. Number FALSE

95 Correlated Correlated Boolean FALSE

96 Blending Applied Blending Boolean FALSE

MetaServer & MetaClient 2.1


MetaSystems 196
VSlide Field IDs:

Default Iks/Iss Iden-


Field ID Long Name Short Name Data Type Field Type Quick Search
Value tifier

0 Name Name Text FALSE

1 Full Name Full Name Text FALSE

2 Culture Culture Text FALSE

3 Slide Slide Text FALSE

4 Pass Pass Text FALSE

5 VSlide Version VSlide Vers. Text FALSE

6 Metafer Version MF Vers. Text FALSE

7 Metafer Application MF Appl. Text FALSE

8 Metafer Classifier MF Classif. Text FALSE

9 Stitch End Time Stitch End Text FALSE

10 Case Case Text FALSE

11 Is Stack Stack Boolean FALSE

12 File Size (KB) File Size Number FALSE

13 File Format Format Text FALSE

14 Filename Filename Text FALSE

15 Height (µm) Height Number FALSE

16 Width (µm) Width Number FALSE

17 Slide Comment Slide Comment Text FALSE

18 Magnification Magn. Text FALSE

19 Is Thumbnail Thumb Boolean FALSE

20 Is Fluorescence FL Boolean FALSE

21 Focus Planes Focus Planes Number FALSE

22 Last Change Date Last Changed Date FALSE

23 Is Spot Spot Boolean FALSE

24 Spot ID Spot ID Text FALSE

25 Spot Number Spot Number Number FALSE

26 Tissue ID Tissue ID Text FALSE

27 Output Type Output Type Text FALSE

Real Num-
28 Resolution (µm/Pixel) Resolution FALSE
ber

197 Part VII Reference Section


Data Field References
Default Iks/Iss Iden-
Field ID Long Name Short Name Data Type Field Type Quick Search
Value tifier

Real Num-
29 CCD Camera Pixel Size Camera Pixel Size FALSE
ber

30 Original TRN Name Original TRN Text FALSE

31 Parameter Set Parameter Set Text FALSE

32 Offset X Offset X Number FALSE

33 Offset Y Offset Y Number FALSE

34 Area (mm²) Area Number FALSE

35 Formatted File Size File Size Text FALSE

36 Channels Channels Number FALSE

37 Is Multi-Resolution Multi-Res. Boolean FALSE

Real Num-
38 Compression Ratio Compress. Ratio FALSE
ber

39 Pixel Width Pixel Width Number FALSE

40 Pixel Height Pixel Height Number FALSE

41 Scan User Scan User Text FALSE

42 Scan System ID Scan SysID Text FALSE

43 Scan System Name Scan SysName Text FALSE

44 Scan System User Scan SysUser Text FALSE

Real Num-
45 Pixels per Unit Pixels/Unit FALSE
ber
1
46 Microscope Config Microscope Conf. Text FALSE

47 Camera Model Camera Model Text FALSE

48 Color Camera Color Cam. Boolean FALSE

49 Raw Bayer Mode Raw Bayer Mode Boolean FALSE

50 Image Flip Mode Img Flip Mode Number FALSE

51 Mirrored Horizontally MirroredH Boolean FALSE

52 Mirrored Vertically MirroredV Boolean FALSE

53 Position List Scan PL Scan Boolean FALSE

54 Irregular Position List Irreg. PL Boolean FALSE

55 Spiral Position List Spiral PL Boolean FALSE

56 Fields per Position X Fields/Pos X Number FALSE

57 Fields per Position Y Fields/Pos Y Number FALSE

MetaServer & MetaClient 2.1


MetaSystems 198
Default Iks/Iss Iden-
Field ID Long Name Short Name Data Type Field Type Quick Search
Value tifier

58 Scanned Back to Front Back to Front Boolean FALSE

59 Search Window Search Window Text FALSE

60 Search Grid Search Grid Text FALSE

Real Num-
61 Camera Gain Cam. Gain FALSE
ber

62 MetaCyte Raw IP MCyte Raw IP Boolean FALSE

Corrected Inhomogeneous Il-


63 Corr. Inh. Ill. Boolean FALSE
lumination

64 Compressed TRN Compressed TRN Boolean FALSE

65 Backlash Compensation Backlash Comp. Boolean FALSE

66 Unidirectional Positioning XY Unidir. Pos. XY Boolean FALSE

67 Unidirectional Positioning Z Unidir. Pos. Z Boolean FALSE

68 Counterstain Channel CS Channel Number FALSE

69 Search Start Time Search Start Time FALSE

70 Search End Time Search End Time FALSE

71 FOV Pixel Width FOV Width Number FALSE

72 FOV Pixel Height FOV Height Number FALSE

73 1:1 Scaling in Ext. Foc. Img. 1:1 Ext. Foc. Scale Boolean FALSE

74 Channel Info Channel Info Text FALSE

75 Stitch Start Time Stitch Start Text FALSE

76 Stitch Mode Mode Text FALSE

77 Stitch System ID Stitch SysID Text FALSE

78 Stitch System Name Stitch SysName Text FALSE

79 Stitch System User Stitch SysUser Text FALSE

Real Num-
80 Max Angle Error Max Angle Error FALSE
ber

Real Num-
81 Max Magnification Error Max Magn. Error FALSE
ber

82 Allow Suffixing Suffixing Boolean FALSE

83 Image Size Optimization Image Size Opt. Boolean FALSE

84 Delete Input Files Del. Input Files Boolean FALSE

85 Delete Previous Input Files Del. Prev. Input Files Boolean FALSE

86 Irregular PL Mode Irreg. PL Mode Number FALSE

199 Part VII Reference Section


Data Field References
Default Iks/Iss Iden-
Field ID Long Name Short Name Data Type Field Type Quick Search
Value tifier

87 Allow Overwrite Overwrite Boolean FALSE

88 VSlideRun Run Text TRUE

Metafer Resolution (New for


89 MF Res. Text FALSE
V2.1)

Captured FOVs (New for


90 Capt. FOVs Number FALSE
V2.1)

Slide Position (New for


91 Frame Pos. Number FALSE
V2.1)

Captured FOVs (New for


92 Capt. FOVs Number FALSE
V2.1)

93 Frame ID (New for V2.1) Frame ID Number FALSE

Matching Quality (New for


94 Match. Qual. Number FALSE
V2.1)

95 Correlated (New for V2.1) Correlated Boolean FALSE

Blending Applied (New for


96 Blending Boolean FALSE
V2.1)

Compression Quality (New


97 Compress. Qual.Run Number FALSE
for V2.1)

100 Pixel Area Pixel Area Number FALSE

7.3 Custom Filter 2

Besides the default filtering options, MetaClient enables you to create your own case and image filters.

If you want to utilize an existing filter condition more complex then the pre-made filters available in MetaClient, choose
the Custom entry from the filter field list. In the Custom Filter definition dialog you can create, load and save complex filter
conditions.

To create a new custom filter, g-click the button next to the Filter by field. This opens a new Custom Filter window,
in which you can create your own filter. In contrast to previous versions of MetaClient, you do not have to select logical
(Boolean) operators and conditions anymore, but create a filter condition using natural (English) language phrases.

MetaServer & MetaClient 2.1


MetaSystems 200
For example, create a custom filter for Ikaros cases:

1.

Then add filter conditions like building a sentence:


2.

3.

4.

5.

6.

This filter will extract all cases with more than five karyograms and aberrant case karyotypes (deviant from 46,XX and
46,XY).
7. You can:

201 Part VII Reference Section


Custom Filter
Load a previously saved custom filter
Save a custom filter for reuse
Clear the currently displayed filter condition(s) and create a new custom filter.
8. When the filter definition is complete, g-click to apply it.

7.4 Query Function Block Reference

This section provides a complete reference of the available function blocks. Query function blocks can be divided into four
categories:

Input Data Source, User Input, Constant, File Input, Environment (k 202 )
Output Table, Diagram, File Output, Debug Log, Meta Information (k 204 )
Flow Control Delay, Multiplexer, Demultiplexer, Storage (k 205 )
Processing Data Transform, Data Access, Filter, Sort, Group, List Processing, Text Processing, Date Pro-
cessing, Number Processing (k 206 )

Input

Data Source

Data Source

The data source function block emits data that has been provided as input for the query.
1. G-click a Data Source block to select its data Source. You can choose between Studies, Cases, Tests, Cultures,
Slides, Passes, Regions, Cells, VSlide Runs, or VSlides: 2
a If you select Cases, a list of cases is emitted, which can be used directly in subsequent operations.
a For all other hierarchy levels, a Data Transform block is needed to extract and emit list of cases or cells (k 206 ).

User Input

User input

This function block queries the user for user input at query runtime and emits the value entered by the user.
1. Depending on the User Input Properties, the value entered by the user is emitted for further processing. G-click a
User Input block to select its properties.

MetaServer & MetaClient 2.1


MetaSystems 202
2. In the User Input Properties window you can set the:
a Input Prompt.
a Input Value (see table).
a Default Value.

3. The Input Prompt is displayed at query runtime.


The following input types are supported:

Input Description

Text Add free text or use a defined Default Value instead.

Numeric Add a number or use a defined Default Value instead.

Date Add a specific date or use a defined Default Value instead.

Lookup Choose from a list of predefined values, which are read from file. The File Name of
the list file must be defined.

Constant

Constant

The constant function block emits a constant value.


1. G-click a Constant block to enter the constant value.
If the Triggered option is disabled, the constant is emitted exactly once. Otherwise the constant is emitted whenever
data is available at the trigger port.

File Input

File Input

The File input function block reads a list of values from a text file and emits this list of values.
1. G-click a File Input block to specify the Filename.
2. The standard file input folder is the Query folder (...\MetaSystems\QryDef), unless otherwise specified. To look up a
file from another location, enter the complete path and file name in the Filename field.

203 Part VII Reference Section


Query Function Block Reference
Environment

Environment

The Environment function block provides access to certain values of the execution environment.
1. G-click an Environment block to enter a value.
The following values are supported:

Value Description

Date Emits the query execution date.

Time Emits the query execution time.

Computer Name Emits the name of the computer executing the query.

User Name of the user executing the query.

Output

Table

Table

The Table function block displays query results in a table. One input port corresponds to one column of the table. Each
value sent to one of the input ports is appended to the corresponding column.
1. G-click a Table block to configure the table format.
2. In the Table Properties window. you can customize the table Title, Column Count and Column Names (as a
comma-separated string). 2

Boolean values are represented by symbols in the output tables: True = , False = ).

Diagram

Diagram

The Diagram function block displays query results as a diagram. The left input port takes a list of names and the right in-
put port takes a list of corresponding values. Both lists must have the same size. It is possible to combine multiple data
series in one query diagram.
1. G-click a Diagram block to customize the table.
2. In the Diagram Properties window. you can specify the number of data Series (default: 1), the Series Name(s)
(comma separated values), the Diagram Type, the Diagram Title. and whether a diagram legend should be dis-
played (Show Legend). The following diagram types are available: Bar Diagram, Horizontal Bar Diagram, Pie Dia-
gram, Line Diagram, and Point Diagram.

MetaServer & MetaClient 2.1


MetaSystems 204
File Output

File Output

The File Output function block exports data to a CSV (comma separated values) file. One input port corresponds to one
column in the file. Each value sent to one of the input ports is appended to the corresponding column.
1. G-click a File Output block to customize the table.
2. In the File Output Properties window. you can specify the full Filename and the Number of Columns in the CSV
output file.
3. The standard file output folder is the Query folder (...\MetaSystems\QryDef). To save the output file in another folder,
enter the complete path and file name in the Filename field.

Debug Log

Debug Log

The Debug Log function block has no direct influence on the query results. It is used for debugging queries. The function
block writes all data that travels through it to the Query Execution Log and then passes the data to its output port. It
does not modify the data. The query execution log is displayed after executing a query in the Query Editor.

Meta Information

Meta Information

The Meta Information function block can be used to specify meta information about the query. Currently, the only in-
formation available is the query result title (using the first input port).

Flow Control

Delay

Delay

The Delay function block sends the input received at its input port to its output port as soon as data is available at its Trig-
ger Port. This function block can be used to synchronize the execution order in a query.

Multiplexer

Multiplexer

The Multiplexer function block combines multiple inputs of the same type into one list and emits this list.

205 Part VII Reference Section


Query Function Block Reference
1. G-click a Multiplexer block to configure the multiplexer's action.
2. In the Multiplexer Properties window. you can specify the number of Input Ports. If the Wait until no more data is
available option is enabled, data are received and added to the list until no more data arrive at the input port.

Demultiplexer

Demultiplexer

The Demultiplexer function block splits an input emits the list items one-by-one.
Example: For each case in a list of cases the average capture count (number of image fields) for all cells of that case
should be computed. This can be achieved by combining a demultiplexer block and a number processing block.

Storage

Storage

A Storage function block stores intermediate results for later re-use. This is especially required for extended and complic-
ated types of queries. The block supports namespaces and default values.
The Storage function block supports four operational modes:
a Store: Reads a key and its corresponding value and stores the pair of key and value in the configured namespace.
a Retrieve: Reads a key and emits the corresponding stored value (from the configured namespace). A default value can
be specified that is emitted if no matching 'key - value' pair is stored.
a Retrieve Keys: Retrieve all keys stored in the storage, if no namespace is specified, or all keys in the given namespace. A
trigger port defines when the keys are emitted.
a Retrieve Values: Retrieve all values stored in the storage, if no namespace is specified, or all values in the given
namespace. A trigger port defines when the values are emitted.
2

Processing

Data Transform

Data Transform

The Data Transform function block transforms data of one hierarchy level to data of another hierarchy level.
1. G-click a Data Transform block to configure the way of mode of transformation.
2. The Source and Dest options determine the type of transformation, for example:

Source Dest Description

Cases Cells Takes a list of cases and emits a list of all images belonging to these cases.

Cells Cases Takes a list of images and emits a list of all corresponding cases.

MetaServer & MetaClient 2.1


MetaSystems 206
As of V 2.1, all hierarchy levels are accessible: Studies, Cases, Tests, Cultures, Slides, Passes, Region, Cells, VSlide
Runs, and VSlides.

Data Access

Data Access

The Data Access function block provides access to the values of specific case or image data fields. It takes any input data
and emits a list of values of the specified Field (see also here 184 for detailed field references):

Studies

Studies - Fields

Name

Cases

Cases - Fields

Active Analysis State Analyzed Metaphases

Archive Media A Archive Media B Associated Files

Band Count Barr Body Case Name

C-Banding Check Date Check User

Counted Metaphases Creation Date Culture Begin

Culture End Culture Remarks Cultures

DAPI Counterstain Export Date Filing Number

G-Banding Indication Karyograms

Karyotype Last Modification Date Last Reactivation Date

Male Metaphases Microcounted Images

Molecular Cytogenetics Noticable Other Techniques

Passes Patient Address Patient Age

Patient Birthdate Patient City Patient Country

Patient First Name Patient Gestation Age Patient Group

Patient Last Name Patient Last Period Patient Middle Name

Patient Notification of Sex Patient Number Patient Phone Number

Patient Remarks Patient Salutation Patient Street

207 Part VII Reference Section


Query Function Block Reference
Cases - Fields

Patient Title Patient ZIP Code Probe ID

Q-Banding R-Banding Reporting Date

Reporting Time in Days Result Sample Arrival Data

Sample Taking Date Second Physician Sending Physician

Slides Specimen Type Sub Directory

Technician Third Physician VSlide Runs

VSlides Workflow State Y-Chromatin

Tests

Tests - Fields

Name

Cultures

Cultures - Fields

Name

Slides
2
Slides - Fields

Name

Passes

Passes - Fields

Analysis Image Size X Analysis Image Size Y Application

Capture Image Size X Capture Image Size Y Case

CCD Camera Pixel Size Cell Count Cells Pos. Diagram 1

Cells Pos. Diagram 2 Cells Pos. Region Cells with Aberration

Cells without Aberration Classifier Computer Name

Counterstain Channels Culture File Name

MetaServer & MetaClient 2.1


MetaSystems 208
Passes - Fields

File Size (MB) First Evaluation Date First Evaluation User

Fluorescence Mode Gallery Image Color Gallery Image Size

Has Comet Information Has External Overview Image Has Internal Overview Image

Has Label Image Highlighted Cell Count Last Evaluation Date

Last Evaluation User Last Saved Date Lock Date

Lock User Manual Mitotic Index Marked Cell Count

Microscope Magnification Name Not Highlighted Cell Count

Nucleus Count Original Cell Count Original Program Version

Position List Scan Program Version Raw Bayer Mode

Rejected Cell Count Rejected Fields RGB Color Camera

Scanned Fields Scoring Sheet Search Duration

Search End Time Search User Search Window

Selected Cell Count Slide Slide Comment

Undefined Cell Count Unselected Cell Count

Regions

Regions - Fields

Name

Cells

Cells - Fields

Auto Capture Date Auto Capture USer Camera Model

Camera Number Capture Date Camera DLL Version

Capture User Case Name Check Date

Check User Classify Date Classify User

Computer Name Coordinates Count Date

Count User Creation User Culture

Experiment Type Framegrabber Model Has Black Background

Has Karyogram Image Fields Image Type

209 Part VII Reference Section


Query Function Block Reference
Cells - Fields

Initial Filename Karyogram Remarks Karyotype

Karyotype Edit Date Karyotype Edit User Karyotyping Date

Karyotyping User Last Image Modification Date Last Image Modification User

Metaphase Remarks Name Scanning Date

Scanning User Slide

VSlide Runs

VSlide Runs - Fields

1:1 Scaling in Ext. Foc. Img. Allow Overwrite Allow Suffixing

Area (mm²) Backlash Compensation Camera Gain

Camera Model Case CCD Camera Pixel Size

Channel Info Color Camera Compressed TRN

Corrected Inhomogeneous Illumination Counterstain Channel Culture

Delete Input Files Delete Previous Input Files Fields per Position X

Fields per Position Y FOV Pixel Height FOV Pixel Width

Full Name Image Flip Mode Image Size Optimization

Irregular PL Mode Irregular Position List Is Fluorescence

Magnification Max Angle Error Maxx Magnification Error

MetaCyte Raw IP Metafer Application Metafer Classifier 2

Metafer Version Microscope Config Mirrored Horizontally

Mirrored Vertically Name Offset X

Offset Y Original TRN Name Parameter Set

Pass Pixels per Unit Position List Scan

Raw Bayer Mode Resolution (µm/Pixel) Scan System ID

Scan System Name Scan System User Scan User

Scanned Back to Front Search End Time Search Grid

Search Start Time Search Window Slide

Slide Comment Spiral Position List Stitch End Time

Stitch Mode Stitch Start Time Stitch System ID

Stitch System Name Stitch System User Unidirectional Positioning XY

MetaServer & MetaClient 2.1


MetaSystems 210
VSlide Runs - Fields

Unidirectional Positioning Z VSlide Version

VSlides

VSlides - Fields

1:1 Scaling in Ext. Foc. Img. Allow Overwrite Allow Suffixing

Area (mm²) Backlash Compensation Camera Gain

Camera Model Case CCD Camera Pixel Size

Channel Info Channels Color Camera

Compressed TRN Compression Ratio Corrected Inhomogeneous Illumination

Counterstain Channel Culture Delete Input Files

Delete Previous Input Files Fields per Position X Fields per Position Y

File Format File Size (KB) Filename

Focus Planes Formatted File Size FOV Pixel Height

FOV Pixel Width Full Name Height (µm)

Image Flip Mode Image Size Optimization Irregular PL Mode

Irregular Position List Is Fluorescence Is Multi-Resolution

Is Spot Is Stack Is Thumbnail

Last Change Date Magnification Max Angle Error

Maxx Magnification Error MetaCyte Raw IP Metafer Application

Metafer Classifier Metafer Version Microscope Config

Mirrored Horizontally Mirrored Vertically Name

Offset X Offset Y Original TRN Name

Output Type Parameter Set Pass

Pixel Height Pixel Width Pixels per Unit

Position List Scan Raw Bayer Mode Resolution (µm/Pixel)

Scan System ID Scan System Name Scan System User

Scan User Scanned Back to Front Search End Time

Search Grid Search Start Time Search Window

Slide Slide Comment Spiral Position List

Stitch End Time Stitch Mode Stitch Start Time

211 Part VII Reference Section


Query Function Block Reference
VSlides - Fields

Stitch System ID Stitch System Name Stitch System User

Tissue ID Unidirectional Positioning XY Unidirectional Positioning Z

VSlide Run VSlide Version Width [µm)

Filter

Filter

The Filter function block filters an input list applying specific filter operations and emits a filtered result list.
G-click a Filter block to configure the filtering mode. Choose between Simple and Custom mode:

Mode Filter Characteristics Options

Simple Source All hierarchy levels


Filter Field see Field list for Data Access (see here).
Filter Operation String Match or Less Than or Greater Than (see table be-
low)
Filter Value
Enter a valid field value.

Custom Filter Operation String Match or Less Than or Greater Than (see table be-
low)

The following table describes the Filter Operation in detail:

Operation Action / Product


2
String Match Input data matches the filter criterion only if the value of the filter field matches the given filter
value. You can use wildcards * and ? as (part of) filter value.

Less Than Input data matches the filter criterion only if the value of the filter field is less than the provided
filter value. The meaning of the comparison operations is based on the data type of the filter
field.

Greater Than Input data matches the filter criterion only if the value of the filter field is greater than the
provided filter value. The meaning of the comparison operations is based on the data type of the
filter field.

In Custom Mode, custom filter values and a Compare Value can be provided. All filter values are then compared to the
compare value using the specified Filter Operation. As of V 2.1 can run multiple comparisons with numerous values in-
stead of just comparisons with individual values. All items that match at least once are then sent to the output port.
If the Also Output Rejected List option is enabled, the input items not matching the filter criterion are emitted on a
second output port.

MetaServer & MetaClient 2.1


MetaSystems 212
Sort

Sort

The sort function block takes a list, sorts the input list and emits a sorted list.
Sorting can be:
a In Simple Mode, a case or cell list is sorted using two case or image fields as primary and secondary sort criterion.
The Sort Direction can be ascending (Inverted option disabled) or descending (Inverted option enabled).
a In Custom Mode, a value list must be provided on a second input port. This value lists must have the same size as the
input list. The input list is then sorted according to the values in the provided sort value lists. Sort Direction can be
specified as in simple mode.

Group

Group

The group function block combines items with the same group value into a group. Group values can be either values of a
case or cell field (Simple Mode) or a configurable number of custom values (Custom Mode). Groups are sent to the out-
put ports one-by-one. The shared group value of a group is emitted on the left output port, the list of group members is
emitted on the right output port.

List Processing

List Processing

The list processing function block provides several operations on lists. Use one of the listed operations to compute an out-
put list from one or two input list.
Single Input List

Operation Action / Product

Count Takes a list and emits the number of items in the input list.

Sublist Takes a list, a start index (1 would be the first item in the list) and an end in-
dex. Emits a 'sublist' of the input list based on the two indices.

Remove Duplicates Takes an input list and removes all duplicate items from the list. Emits a
“cleaned up” index.

Element at Copies the item at the specified position of the input list to the output list.

213 Part VII Reference Section


Query Function Block Reference
Two input lists

Operation Action / Product

Union Merges two input lists into one output list. Duplicates are automatically re-
moved.

Intersection Calculate the intersecting set of two input lists.

Difference Compute the differences between two input list and writes them to an output
list.

Text Processing

Text Processing

The text processing function block provides several operations on text:

Operation Action / Product

Length Takes a list of values and emits a list of the lengths (number of characters) of
these values.

Substring Takes a list of values, a start index, and an end index. Emits a list of sub-
strings.

Abbreviate Takes a list of values and abbreviates each value to the specified Abbreviation
Length. Emits the list of abbreviated values.

Concatenate Takes two lists of values (same size) and concatenates each item from the
first list with the corresponding item from the second list. The Separator
string is inserted between each two values. Emits the list of concatenated val-
ues.
2
Concatenate List Takes a list of values and concatenates all values in the list. The Separator
string is inserted between each two values. Emits the concatenated value.

Split Takes a list of values and splits each value using the Separator string. Emits a
list of left values and a list of right values.

Match Takes two lists of values and matches each value in the first list with the cor-
responding value in the second list. The values in the second list can contain
wildcards * and ?. A list of Boolean values (TRUE or FALSE) is emitted.

Check Similarity Takes a list of values and a list of compare values. Checks each value in the
first lest for similarity with the corresponding value in the second list. Leven-
shtein distance is used as a similarity measure. The Similarity Tolerance
(number of characters allowed to be different) can be configured.

MetaServer & MetaClient 2.1


MetaSystems 214
Date Processing

Date Processing

The date processing function block provides operations on date values:

Operation Action / Product

Format Formats a date value according to the given Format string. See the following
table for a description of the available format specifiers.

Quarter Takes a list of dates and emits the quarter (format Q1/2009) for each date in
the list.

Week of Year Takes a list of dates and emits the week of the year for each date in the list.

Min Takes a list of dates and emits the earliest date.

Max Takes a list of dates and emits the latest data.

Date Difference Takes two lists of date values and computes the difference in days between
each two dates. Emits a list of numbers.

Time Difference Computes the difference between two time values in the format hh*mm*ss
(where * is the respective local time separator).

Number Processing

Number Processing

The number processing function block provides operations on numeric values:

Operation Action / Product

Add Takes two lists of values and adds each value in the first list to the corres-
ponding value in the second list. Emits a list of sums.

Subtract Takes two lists of values and subtracts each value in the second list from the
corresponding value in the first list. Emits a list of results.

Multiply Takes two lists of values and multiplies each value in the first list with the cor-
responding value in the second list. Emits a list of products.

Divide Takes two lists of values and divides each value in the first list by the corres-
ponding value in the second list. Emits a list of results.

Percentage Takes two lists of values and calculates the ratio of the left value and the right
value. Emits a list of percentages.

Round Takes a list of numeric values and rounds each number to the given Number
of Digits after the decimal separator. Emits a list of rounded values.

Mean Takes a list of values and calculates the mean value. Emits the mean value.

215 Part VII Reference Section


Query Function Block Reference
Operation Action / Product

Standard Deviation Takes a list of values and calculates the standard deviation. Emits the stand-
ard deviation.

Sum Takes a list of values and adds all values in the list. Emits the sum.

Min Takes a list of values and emits the minimum value in the list.

Max Takes a list of values and emits the maximum value in the list.

Index of Min. Value Takes a list of values and emits the position of the minimum value in the list.

Index of Max. Value Takes a list of values and emits the position of the maximum value in the list.

Coordinates Transformation

Coordinates Transformation

As of V 2.1 it is possible to transform coordinates by a query (pattern). This can be quite helpful for coordinate list reports,
for example.
The function block Coordinate Transformation has
a four inputs ports: X Coordinates, Y Coordinates, Source Microscope Name, and Target Microscope Name
a two output ports: Transformed X Coordinates and Transformed Y Coordinates:

Coordinate Transformation function block

Like in Metafer and Ikaros/Isis, the coordinate transformation is based on the configuration file StageTra.DAT, usually loc-
ated in ...\MetaSystems\MSCfg. When you insert the Coordinates Transformation function block, you can enter the Cfg
Path pointing to the folder holding the StageTra.DAT and specify, whether automatic stage calibration offsets should be
applied (see Metafer Help for details on stage offsets).
The Coordinates Transformation function block is available as a query Coordinate Transformation and as a functional
Pattern, which can be easily inserted into queries:

MetaServer & MetaClient 2.1


MetaSystems 216
Coordinate Transformation functional Pattern

This pattern is listed in the Patterns menu of the Query Editor.

NOTE! It is recommended to insert a Coordinates Transformation pattern for every source microscope / target
microscope pair, for which you wish to transform coordinates automatically.

7.5 Report Component Reference

This section provides a complete reference of all available report components and a description of what they can be used
for.

Component Toolbox
Text - Text can be user-defined fixed text (e. g. headline, lab address) or dynamic data (general field com-
mands like date or time, computation values, input parameters, case data fields, or image data fields. How to
edit the 'Text' properties, k 219 .
Static Image - external images, e. g. a logo. How to edit the 'Static Image' properties, k 220 .
Image - Ikaros or Isis image including annotation text, lines, arrows, and frames. How to edit the 'Image'
properties, k 221 .

217 Part VII Reference Section


Query Function Block Reference
Image Grid - arrange images in a grid pattern, e. g. image fields, a image gallery, a karyogram gallery. How to
edit the 'Image Grid' properties, k 222 .
Table - combine and arrange image and/or case data in a table format. How to edit the 'Table' properties, k
224 .

Shape - insert static shapes: rectangles, ellipses (circles), horizontal or vertical lines. How to edit the 'Shape'
properties, k 226 .
Chart - present case or image data as charts: as vertical or horizontal bars, as pie chart, as line charts, or as
point chart. How to edit the 'Chart' properties, k 227 .
Barcode - reports can include barcodes based on the ASCII character set ('Code 128'). How to edit the 'Bar-
code' properties, k 229 .
Computation - allows you to compute new values from existing data. How to edit the 'Computation' proper-
ties, k 229 .
Horizontal Splitter - links any element below of the horizontal splitter with dynamic elements above the
splitter: if a dynamic element changes its height, the element below the splitter are proportionally moved
down in the report. The distances between the splitter and elements below remain constant. How to edit the
'Horizontal Splitter' properties, k 230 .
Vertical Splitter - links any element right of the vertical splitter with dynamic elements left of the splitter: if a
dynamic element changes its width, the element right of the splitter are proportionally moved to the right.
The distances between the splitter and elements to the right remain constant.How to edit the 'Vertical Split-
ter' properties, k 230 .
Section - allows grouping of elements in a report, for example date and signature field. How to edit the 'Sec-
tion' properties, k 230 .
Page Break - insert a dynamic page break at a fixed position. How to edit the 'Page Break' properties, k 231 .
Input Parameter - add free text to the print form prior to printing. How to edit the 'Input Parameter' proper-
ties, k 231 .

Property Editor
2

NOTE! Any change in a property value must be confirmed individually by g-clicking the mark. The values
for Left, Top, Height and Width are given as 1/10 mm. The reference point for Left and Top values is the top
left corner of the sheet of paper (and not the top left corner of the printable area as in Ikaros / Isis)! Thus, these
values are printer independent.

MetaServer & MetaClient 2.1


MetaSystems 218
Report

Property Default Value Comment

General

Description Add a descriptive title.

Paper Format A4 Portrait Defines the paper format and print orientation. Supported
formats: A4 Portrait, A4 Landscape, Letter Portrait, Letter
Landscape, Photo 10x15 Portrait, Photo 10x15 Landscape,
Photo 13x18 Portrait, and Photo 13x18 Landscape.

Expected Cases 1 Increasing the number allows to combine data from different
cases.

Expected Images 1 Increasing the number allows to combine several images from
a case.

Header Height 200 Defines the height of the report header, given in 1/10 mm.

Footer Height 200 Defines the height of the report footer, given in 1/10 mm.

Show Header on First Page True Show header on first page and consecutive pages (True) or on
consecutive pages only (False).

Text

Property Default Value Comment

General

Name Add a descriptive description for text field.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Width Enter width of text field (in 1/10 mm).

Height Enter width of text field (in 1/10 mm).

Show Border False Show (True) or hide (False) border around text field.

Border Color Define color for text field border. G-click to edit.

Border Width 1 Set line thickness for text field border (mm).

Transparent False Make text field background transparent (True) or filled (False).

Condition (...) Define the condition(s) for conditional printout.

Text

Text Text Add text. G-click to edit. In the Text Editor you can select
among various text sources (see here).

Alignment Left Align text Left, Center, or Right.

219 Part VII Reference Section


Report Component Reference
Property Default Value Comment

AutoSizeMode Disabled Use fixed Width and Height for text field (Disabled) or auto
size text field to accommodate text:
a choose Grow Horizontally for a fixed height and dynamic
width of the text component.
a choose Grow Vertically for a fixed width and dynamic
height of the text component.

Split within Words False Activate (True) of deactivate (False) automatic word wrapping
in text components. Also available for table columns (k).

Bg Color Define background color for text field. G-click to edit.

Hide Sex Chromosomes False Print (False) normal sex chromosomes - XX or XY - in karyo-
types. If enabled (True) , the text XN is printed instead.

Font

Font Name Calibri Choose font for text field.

Font Size 12 Define font size for text field.

Color Define text font color. G-click to edit.

Bold False Choose font property: Bold (True) or normal (False).

Italic False Choose font property: Italic (True) or normal (False).

Underlined False Choose font property: Underlined (True) or normal (False).

Strike Out False Choose font property: Strike out (True) or normal (False).

Static Image
2
Property Default Value Comment

General

Name Optional: Add a descriptive text.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Width Enter width of static image (in 1/10 mm).

Height Enter width of static image (in 1/10 mm).

Show Border False Show border (True) / hide border (False) around static image.

Border Color Define color for static image border. G-click to edit.

Border Width 1 Set line thickness for static image border (mm).

Transparent False Make static image background transparent (True) or filled


(False).

Condition (...) Define the condition(s) for conditional printout.

MetaServer & MetaClient 2.1


MetaSystems 220
Property Default Value Comment

Image

Filename Text G-click to load a static image.

Stretch False Use original image aspect ratio (False) or stretch image to fit
the size of the image component frame (True).

Image

Property Default Value Comment

General

Name Optional: Add a descriptive text.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Width Enter width of image (in 1/10 mm).

Height Enter height of image (in 1/10 mm).

Show Border False Show border (True) / hide border (False) around image.

Border Color Define border color for image. G-click to edit.

Border Width 1 Set line thickness for image border (mm).

Transparent False Make image background transparent (True) or filled (False).

Condition (...) Define the condition(s) for conditional printout.

Layout

Center True Center image.

White Background False Set image background to white (True) or black (False).

Show Annotations False Show (True) / hide (False) annotations for image.

Data

Input Image Index 1 Refer to the image number in the case, i. e. 1 = 1st image, 2 =
2nd image, ... .

Stage Original Choose image processing stage: None, Original, Pre-Pro-


cessed, Processed, or Karyogram.

Isis Display Mode RGB Display All color display modes except 'Individual colors' are suppor-
ted. Color definitions are read from the Isis image file. This op-
tion is not available for Ikaros images.

Hide Sex Chromosomes False Print (False) or suppress (True) chromosome classifications/
annotations for sex chromosome classes X and Y.

221 Part VII Reference Section


Report Component Reference
Property Default Value Comment

Maximize Metaphase False By enabling this property (True) you can increase the size of a
metaphase or cell on a printout. After adjusting object
threshold and masking metaphase/cell in Ikaros/Isis, the
metaphase/cell is automatically enlarged to fill the given area
(while preserving the aspect ratio of the original image).

Metaphase

Field Number 1 Refer to the image field letter, i. e. 1 = image field A, 2 = image
field B, ... .

Karyogram

Show Classes True Print (True) / hide (False) karyogram class numbers below
chromosomes.

Show Class Underlines True Print (True) / hide (False) karyogram class brackets below chro-
mosomes.

Image Grid

Property Default Value Comment

General

Name Optional: Add a descriptive text.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Width Enter width of image grid (in 1/10 mm).

Height Enter height of image grid (in 1/10 mm). 2

Show Border False Show (True) / hide (False) border around grid.

Border Color Define color for grid border. 8LL-click to edit.

Border Width 1 Set line thickness for grid border (mm).

Transparent False Make grid background transparent or filled.

Condition (...) Define the condition(s) for conditional printout.

Data

Filter (...) Apply a custom filter to input data that an image must fulfill to
appear in the grid.

Sort Field Name Sort image data by a cell data field (see here).

Sort Inverted False Use ascending (False) or descending (True) sort orientation.

Layout

Columns 4 Decrease/increase the number of columns in the grid to see


less (larger) or more (smaller) images, respectively.

MetaServer & MetaClient 2.1


MetaSystems 222
Property Default Value Comment

Center Images True Center (True) / left align (False) images in the grid.

Show Grid Lines True Print (True) / hide (False) grid lines.

Grid Line Width 1 Set line thickness for grid lines (mm).

Grid Line Color Define color for grid lines. G-click to edit.

White Background False Print grid with white (True) or black (False) background.

Allow Empty Cells False Print grid cells only if the filled with an image.
When this option is set to True, it it generates a fixed layout,
even if some content, for example a karyogram is missing.
For example, a four-column grid can be used to display the ori-
ginal, the preprocessed, the processed metaphase and the ka-
ryogram for each image. Or Isis images can be displayed using
several display modes.

Annotations True Print annotations when visible in Ikaros (True) or not (False).

Show Karyo Classes True Prints karyogram class number (True) or not (False).

Show Class Underlines True Prints karyogram class underlines (True) or not (False).

Hide Sex Chromosomes False Print (False) normal sex chromosomes - XX or XY - in karyo-
grams. If enabled (True), the text XN is printed instead.

Maximize Metaphase False By enabling this property (True) you can increase the size of a
metaphase or cell on a printout. After adjusting object
threshold and masking metaphase/cell in Ikaros/Isis, the
metaphase/cell is automatically enlarged to fill a grid cell.

Channels

Stage 1 Processed Choose image processing stage: None, Original, Pre-Pro-


cessed, Processed, or Karyogram.

Isis Display Mode 1 RGB Display All color display modes except 'Individual colors' are suppor-
ted. Color definitions are read from the Isis image file. This op-
tion is not available for Ikaros images.

Stage 2 Karyogram See Stage 1

Isis Display Mode 2 RGB Display See Isis Display Mode 1

Stage 3 None See Stage 1

Isis Display Mode 3 RGB Display See Isis Display Mode 1

Stage 4 None See Stage 1

Isis Display Mode 4 RGB Display See Isis Display Mode 1

Image Text

Show Image Text True Display (True) / hide (False) as defined under Text.

Number of Text Rows 1 By default, one row is used to display Text. Increase, if more
space is needed to display all image information.

223 Part VII Reference Section


Report Component Reference
Property Default Value Comment

Text @img1:0@ By default, the image name is used as text; G-click to select
another data field (or several fields) in the Text Editor window.

Alignment Left Align text Left, Center, or Right.

Font Name Calibri Choose font for image text.

Font Size 12 Define font size for image text.

Bold False Choose font property: Bold (True) or normal (False).

Italic False Choose font property: Italic (True) or normal (False).

Color Select font color for image text. G-click to edit.

Bg Color Select font color for image text background. G-click to edit.

Table

Property Default Value Comment

General

Name Optional: Enter a table name.

Left Enter distance from left margin (in 1/10 mm).

Top Enter distance from top margin (in 1/10 mm).

Width Enter width of table (in 1/10 mm).

Height Enter height of table (in 1/10 mm).

Show Border False Show (True) / hide (False) border around table.
2
Border Color Define border color. G-click to edit.

Border Width 1 Set line thickness for table border (1/10 mm).

Transparent False Make table background transparent (True) or filled (False).

Condition (...) Define table data condition.

Data Source Cases Other choices: Images, Query File, Custom Query.

Query Data

Query Filename Enter the name of a standard pre-made query.

Custom Query (...) Enter the name of a custom query (alternative).

Query Table Index 1 Queries can produce different output tables. Choose the re-
spective table (1=1st, 2=2nd,...).

Data

Columns (...) Open a Column Editor, in which you can edit the properties
for new and existing columns:

MetaServer & MetaClient 2.1


MetaSystems 224
Property Default Value Comment

Data Source - The data source can either be a Data Field


(from the list of case data fields - see here for reference) or
a Computation (outlined in the Query Editor chapter, k 113 ).
Name - Add the column header.
Width - Define the width of the selected column (in 1/10
mm).
Right-Aligned - Columns are left-aligned by default. To en-
able right-alignment, tick the check-box.
Highlight - Highlighted columns will be printed in bold.
Word-wrap - If enabled, line breaks are automatically intro-
duced into text running wider than the column width. Line
breaks are preferentially inserted at a comma or, if there
are just spaces, at the adjacent space between two words.

Filter (...) Open a Condition Editor, in which you can modify the table
filter condition.

Sort Column Index 1 Queries can produce different indexes. Choose the respective
index (1=1st, 2=2nd,...).

Sort Inverted False Sort table rows in ascending or descending order.

Hide Sex Chromosomes False Print (False) normal sex chromosomes - XX or XY - in karyo-
grams. If enabled (True) , the text XN is printed instead.

Layout

Min Row Count 1 Set the minimum number of rows in the table.

Auto Size Cols True Adjust table column width automatically.

Bg Color 1 Rows with alternating background color: choose 1st and 2nd
color; if both colors are identical -> uniform background. G-
Bg Color 2
click to edit.

Header Bg Color Set color for header background.

Show Row Numbers False When enabled (True), row numbers are automatically inserted
on the left side of a table in front of the first column. Other-
wise (False), row numbers are omitted.

225 Part VII Reference Section


Report Component Reference
Property Default Value Comment

Lines

Line Width Set line thickness for table grid lines (in 1/10 mm).

Line color black Choose grid line color.

Show Vert Lines False Show / hide vertical grid lines.

Show Horiz. Lines False Show / hide horizontal grid lines.

Show Header Lines False Show / hide line below header row.

Font

Font Name Calibri Choose font for table.

Font Size 12 Define font size for table.

Color Select font color for table. G-click to edit.

Bold False Choose font property: Bold (True) or normal (False).

Italic False Choose font property: Italic (True) or normal (False).

Header Font

Header Font Name Calibri Choose font for table header.

Header Font Size 12 Define font size for table header.

Header Color Select font color for table header. G-click to edit.

Header Font Bold True Choose font property: bold or normal.

Header Italic False Choose font property: italic or normal.

Shape 2

Property Default Value Comment

General

Name Optional: Enter a shape name.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Width Enter width of table (in 1/10 mm).

Height Enter height of table (in 1/10 mm).

Transparent False Make shape transparent (True) or filled (Filled).

Condition (...) Define the condition(s) for conditional printout.

Shape

Shape Rectangle Shapes available: Rectangle, Horizontal Line, Vertical Line, El-
lipse, Left Arrow, Right Arrow, Up Arrow, and Down Arrow .

MetaServer & MetaClient 2.1


MetaSystems 226
Property Default Value Comment

Pen Width 2 Set line thickness for shape frame (in 1/10 mm). This setting
automatically determines the length of an arrow tip: it is calcu-
lated as 5x Pen Width.

Pen Color Define shape frame color. G-click to edit.

Brush Color Define fill color. G-click to edit.

Fill False Make chart background transparent (False) or filled (True).

Chart

Property Default Value Comment

General

Name Optional: Enter a chart name.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Width Enter width of table (in 1/10 mm).

Height Enter height of table (in 1/10 mm).

Transparent False Make chart background transparent (True) or filled (False).

Condition (...) Define the condition(s) for conditional printout.

Data

Query Source Query File Data can be produced by using either a pre-made Query File or
a Custom Query.

Query Filename 8LL-click to choose a pre-made query.

Custom Query (...) 8LL-click to build a custom query.

Diagram Index 1 Queries can produce different output diagrams. Choose the re-
spective diagram (1=1st, 2=2nd,...)

Chart

Chart Type Bars Supported chart types: Vertical Bars, Horizontal Bars, Pie, Line,
and Points.

Show Legend False Print (True) / hide (False) chart legend.

View 3D True Print chart in 3D (True) or 2D (False) style.

Show Data Labels False Print (True) / hide (False) data labels.

Chart Title Chart Print (True) / hide (False) chart title.

Color Mode Fixed Colors Select color mode: Fixed Colors (system palette), Greyscales or
Custom Coloring.

227 Part VII Reference Section


Report Component Reference
Property Default Value Comment

Custom Coloring

Base color If Custom Coloring is selected as Color Mode, choose a base


color (reference color).

Color Range 20 Set the color range on the chromatic circle in % (of 360°). The
Base Color defines the center of the sector.

Alternate Colors True For improved distinction of colors, you can use alternate colors
(True) instead of neighboring colors (False). The number of gen-
erated color shades relates to the number of chart elements
and the Color Range.

Title Font

Title Font Name Calibri Choose font for chart title.

Title Font Size 12 Set font size for chart title.

Title Color Set font color for chart title. G-click to edit.

Title Bold False Choose font property for chart title: Bold (True) or normal
(False).

Title Italic False Choose font property for chart title: Italic (True) or normal
(False).

Title Underlined False Choose font property for chart title: Underlined (True) or nor-
mal (False).

Axis Font

Axis Font Name Calibri Choose font for axis description.

Axis Font Size 12 Set font size for axis description.

Axis Color Set font color for axis description. G-click to edit. 2
Axis Bold True Choose font property for axis description: Italic (True) or nor-
mal (False).

Axis Italic False Choose font property axis description: Italic (True) or normal
(False).

Axis Underlined False Choose font property axis description: Italic (True) or normal
(False).

MetaServer & MetaClient 2.1


MetaSystems 228
Barcode

Property Default Value Comment

General

Name Optional: Enter a barcode name.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Width Enter width of table (in 1/10 mm).

Height Enter height of table (in 1/10 mm).

Transparent False Make chart background transparent (True) or filled (False).

Condition (...) Define the condition(s) for conditional printout.

Text

Text Text Enter the text that should be encoded in the barcode (only
ASCII characters). Only 'Code128' is supported here.

Computation

Property Default Value Comment

General

Name Computation Optional: Add a descriptive text.

Left Enter distance from left margin (in 1/10 mm).

Top Enter distance from left margin (in 1/10 mm).

Computation

Computation (...) Edit computation in Query Editor (k 113 ). Computations create


temporary files in C:\MetaSystems\Tmp.

229 Part VII Reference Section


Report Component Reference
Dynamic Vertical Splitter

Property Default Value Comment

General

Name Optional: Add a descriptive text.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Width Enter width of table (in 1/10 mm).

Condition (...) Optional: Define a condition for the insertion of a dynamic ver-
tical splitter.

Dynamic Horizontal Splitter

Property Default Value Comment

General

Name Optional: Add a descriptive text.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Width Enter width of table (in 1/10 mm).

Condition (...) Optional: Define a condition for the insertion of a dynamic hori-
zontal splitter.

2
Section

Property Default Value Comment

General

Name Optional: Add a descriptive text.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Condition (...) Optional: Define a condition for the insertion of a section.

Section

Split Allowed False Keep section together (no page break in section) (False) or allow
page break within section (True).

MetaServer & MetaClient 2.1


MetaSystems 230
Page Break

Property Default Value Comment

General

Top Enter distance from top margin (in 1/10 mm).

Condition (...) Define the condition for the insertion of a dynamic page break.

Input Parameter

Property Default Value Comment

General

Name Input Parameter Optional: Add a descriptive text.

Left Enter distance from left paper margin (in 1/10 mm).

Top Enter distance from top paper margin (in 1/10 mm).

Parameter

Data Type String Valid options: String, Number, Date, Boolean, and Selection.

Default Value Add the default value for the input parameter.

Lookup Values Add a list of values as 'comma separated values'.

231 Part VII Reference Section


Report Component Reference
7.5.1 Text Editor

In the Text Editor you can define the content of a Text component in a MetaClient report.
When you insert a Text component and open the Text Editor, The word 'Text' is displayed as the content.

The Text Editor for MetaClient reports.

You can simply replace 'Text' with a desired text phrase and confirm by g-clicking OK.
2
Besides static text you can also use dynamic data as a source for automatically generated text inserted on publishing
time. The Data Explorer provides access to five different categories of dynamic content:
General Choose among general dynamic field entries: Date, Time, Page Number, Total Pages
(total number of pages), Root Directory, Input Case Count, Input Image Count, Current
User.
Computations Choose among Computations associated with the report (k 131 ). For example, if you
have created a computation HasKaryogram in the Query Editor (k 113 ), which detects
the presence of at least one karyogram in a case, you insert it as @comp:HasKaryo-
gram@.
Input Parameters Choose among Input Parameters associated with the report (k 231 ). For example, if
you created a lookup list of cytogeneticists, who are authorized to sign a report, as an
input parameter Signature, then you can insert it as @input:Signature@.
Case 1 Choose a case data field from the list of pre-made and custom case data fields (k 186 ).
As an improvement over previous versions, a data field entry consist not only of the
field ID, but also includes the field description, for example: old entry style:
@case1:34@ > new entry style: @case1:Metaphase Comment(34)@.

MetaServer & MetaClient 2.1


MetaSystems 232
Image 1 Choose an image data field from the list of pre-made and custom image data fields (k
192 ).

As an improvement over previous versions, a data field entry consist not only of the
field ID, but also includes the field description, for example: old entry style: @img1:4@
> new entry style: @img1:Coordinates(4)@.

In the first example, a combination of Page Number and Total Pages is inserted in the footer of a report:

Text Editor example: adding page numbers and total number of pages to report footer

In the second example, several case data fields are combined to list the number of metaphases, counted metaphases,
analyzed metaphase, and karyograms. Please note, that the number of karyograms is printed in a separate line:

233 Part VII Reference Section


Report Component Reference Text Editor
Text Editor example: combination of metaphase counts and karyogram count.

7.5.2 Condition Editor

The report components have different characteristics:


a printed elements: Text, Static Image, Image, Image Grid, Table, Shape, Chart, Barcode.
a determinants: Dynamic Vertical Splitter, Dynamic Horizontal Splitter, Report Section, Page Break, or Input 2
Parameter.
1. By g-clicking the Condition Value (...) you open a Condition Editor window, in which you can define single or
multiple conditions for the selected report component:

The blank Condition Editor window.

MetaServer & MetaClient 2.1


MetaSystems 234
2. g-click the icon to open an Edit Condition window to set the first condition:

Add a condition in the Condition Editor.

3. G-click the icon to select the Left Operand in a Data Explorer window:

Define the Left Operand for an example condition in a Data Explorer window.

4. Then choose an Operator from the drop-down list:

Select a condition for the example from the list of available options.

5. Depending on the Left Operand and the Operator, the Right Operand can either be are fixed value (as in the
example below) or another data field.

Define a Right Operand for the example condition in a Data Explorer window.

6. In the latter instance, repeat step 3 for the Right Operand.

235 Part VII Reference Section


Report Component Reference Condition Editor
The example below illustrates a combination of two conditions for an example Text component: Case completed: @Re-
porting Date@:

This text is only printed, if BOTH criteria are met, i. e. if a case contains at least 15 analyzed metaphases AND at least 5 ka-
ryograms.

Completed condition combining two criteria.

7.5.3 Converting Ikaros/Isis Print Formats

The Report Editor includes an Import... command to import existing Ikaros / Isis print formats and to convert them auto-
matically to MetaClient reports. Imported reports are saved under the same name in selected (shared) Report folder. 2
Most commands of the Ikaros / Isis print format script language can be converted automatically, however, a conversion
summary highlights those command that could not be converted and, thus, require some manual adaptations. This sec-
tion gives hints on how to convert Ikaros / Isis print formats into MetaClient reports. The following table states how sev-
eral script language constructs from Ikaros / Isis reporting can be realized with the new reporting framework.

NOTE! The values for Left, Top, Height and Width are given as 1/10 mm. The reference point for Left and Top
values is the top left corner of the sheet of paper (and not the top left corner of the printable area as in Ikaros /
Isis)! Thus, these values are printer independent.

MetaServer & MetaClient 2.1


MetaSystems 236
General Print Commands

Ikaros / Isis Command MetaClient Component Property

PrintLandscape Set Orientation property of the report to Landscape.

PrintPortrait Set Orientation property of the report to Portrait.

StartPrint —

EndPrint —

SendToQueue —

SelectPrinter S —

Adjusting the Print Position on a Sheet of Paper

Ikaros / Isis Command MetaClient Component Property

NextPage/ PrintNextPage Page breaks are inserted automatically and administered dynamically. If you want
to force a page break, insert a fixed Page Break component.

SetPrintLeft Set the Left property for each component.

SetPrintTop Set the Top property for each component.

Adjusting the Print Position in a Grid

Ikaros / Isis Command MetaClient Component Property

SetPrnCellWidth Use an Image Grid component, adjust its Width and set the Columns property.

SetPrnCellHeight Use an Image Grid component, adjust its Width and set the Columns property. The
cell height is then automatically determined from the aspect ratio of the images
printed.

CenterPrnGrid Set the Center property of the Image Grid component to True.

SetPrnGridLeft Set the Left property of the Image Grid component.

SetPrnGridTop Set the Top property of the Image Grid component .

PrintNextCell —

PrintNextRow —

237 Part VII Reference Section


Report Component Reference Converting Ikaros/Isis Print Formats
Image Print commands

Ikaros / Isis Command MetaClient Component Property

MaximizeChromosomes/ Un- —
doScaleChromosomes

PrintBitmap F,W Use a Static Image component, choose the File Name property and adjust its
Width and Height.

PrintCapture X Use an Image component and adjust its Width and Height.
PrintCapture X, H

PrintKaryotype X Use an Image component, set its Stage property to Karyogram and adjust its
Width and Height.
PrintKaryotype X, H

PrintMetaphaseInRect This is the default behaviour when using an Image component. You can also use
the Maximize Metaphase property to increase the size of metaphase by removing
background around metaphase or cell (k 221 ).

SetPrintAnnotations —

SetPrintBuffer —

SetPrintCentromerlines Set Image component property Show Centromer Lines to True.

SetPrintClassUnderlines Set Image component property Show Karyo Classes to False.

SetPrintImageFrames For an Image component: Set property Show Border to False.


For an Image Grid component: Set properties Show Border and Show Grid Lines
to False.

SetPrintLowerThreshold —

SetPrintOriginalCaptures To print original images/metaphases, set the Data - Stage property for the Image
component to Original. 2
SetPrintPreProcessedImage To print original images/metaphases, set the Data - Stage property for the Image
component to Preprocessed.

SetPrnColAnnotations Annotations are printed in their display color by default (if printer allows color prin-
touts).

SetPrnWhiteBackground To print images or karyograms with white background, set the Layout - White
Background property for the Image component to True.

MetaServer & MetaClient 2.1


MetaSystems 238
Text Print commands

Ikaros / Isis Command MetaClient Component Property

PrintChar — (not required: MetaClient supports Unicode)

PrintCharMoveCursor Set the Text - AutoSizeMode property for the Text component to Grow Horizont-
ally.

PrintLeftJustify Set the Text - Alignment property for the Text component to Left.

PrintMemo Set the Text - AutoSizeMode property for the Text component to Grow Vertically.

PrintRightJustify Set the Text - Alignment property for the Text component to Right.

PrintText Text - Text - add text.

PrintTextInRect L, T, R, B, S Set the General - Left, Top, Width, and Height properties for the Text component.

PrintTextMoveCursor Not implemented: arrange text components (text frames) accordingly.

PrintMultiChar — (not required: MetaClient supports Unicode)

SetFontName Set the Font - Font Name property for the Text component - choose font from the
drop-down list.

SetFontSize Set the Font - Font Size property for the Text component - choose font size (in pt)
from the drop-down list.

SetTextBold Set the Font - Bold property for the Text component to True.

SetTextItalic Set the Font - Italic property for the Text component to True.

SetTextOrientation — (not implemented, yet).

SetTextUnderline Set the Font - Underline property for the Text component to True.

SetPrnColAnnotations Annotations are printed in their display color by default (if printer allows colored
printouts).

Graphics Print Commands

Ikaros / Isis Command MetaClient Component Property

PrintRectangle L, T, R, B Insert a Shape - Shape:Rectangle or Shape:Horizontal Line or Shape:Vertical


Line.

FrameCell Set the Pen Color for the respective Shape - Shape object.

SetPenWidth Set the Pen Width for the respective Shape - Shape object.

239 Part VII Reference Section


Report Component Reference Converting Ikaros/Isis Print Formats
7.6 Overview: Shortcut Keys and Icons

7.6.1 Key and Mouse Shortcut Commands

In addition to command buttons and menu commands, many functions in MetaClient can be called by shortcuts. This al-
lows for a direct and quick program control. In order to assist you, hotkey hint tables are available in the Case List, Tree -
File List, and Tree - Cell Gallery views and aspects.

1. g-click the icon at the lower right corner of the program window to display the hotkeys table.

General Shortcut Keys

Alternate [Alt]

Backspace [Backspace]

Control [Ctrl]

Delete [Del]

Display / hide 'Tree' [F8]

Enter/Return [Enter]

Escape [Esc]

Function keys F1, F2, F3, ... [F1], [F2], [F3], ...

Insert [Ins]

Page Down [PgDn] 2


Page Up [PgUp]

Space [Space]

Shift [Shift]

Switch to 'Case List' view [F6]

Switch to 'Tree' view [F7]

Tabulator [Tab]

Arrow keys: Up, Down, Left, Right [y], [Y], [<], [>]

Please also observe the Mouse Clicks and Typographical Conventions - k 2 .

MetaServer & MetaClient 2.1


MetaSystems 240
Logout and Exit from MetaClient

You can logout and exit from MetaClient by any of the following methods:

Logout [Esc]
G-click / j-click user field in the status bar

Exit g-click the (in Title Bar)


g-click Cancel button (in User Login window)
[Alt] + [F4]

Main Window - Overview

Unlock Dashboard g-click icon

Refresh Widget g-click

Main Window - Case List

Navigation
Scroll one page up [PgUp]
Scroll one page down [PgDn]
Center selected case [Space]

Selection
Select case g
Select previous case [<]
Select next case [>]
Select first case [Home]
Select last case [End]
Select all cases [Ctrl] +[A]
Select several cases Hold [Ctrl] + g-click cases
st
Select contiguous group of cases g-click 1 case, then hold [Shift] + g-click last case,
or hold [Shift] and use [Y] or [>] keys to mark more cases
Invert selection of cases [Ctrl] + [I]

Action
Delete selected case(s) [Del]
Open selected case in Ikaros / Isis G, [Enter]
Add selected case(s) to report buffer / Remove from buffer [B]
Print report [P]

241 Part VII Reference Section


Overview: Shortcut Keys and Icons Key and Mouse Shortcut Comman
Main Window - 'Tree' View - Ikaros/Isis 'File List'

Display
Increase preview size [+]
Decrease preview size [-]

Action
Open selected file [Enter]
Delete selected file [Del]

Main Window - 'Tree' View - Ikaros/Isis 'Cell List'

Print report [P]

Delete selected cell [Del]

Main Window - 'Tree' View - Ikaros/Isis 'Cell Gallery'

Navigation
Scroll one gallery row up [y]
Scroll one page up [PgUp]
Scroll one gallery row down [Y]
Go to the beginning of the gallery [PgDn]
Go to the end of the gallery [Home]
Scroll one page down [End]
2
Center selected cell [Space]

Selection
Select cell g
Select previous cell [<]
Select next cell [>]
Select all cells [Ctrl] +[A]
Select several cells Hold [Ctrl] + g-click cells
Select contiguous group of cells g-click first cell,
then hold [Shift] + g-click last case
Invert selection of cases [Ctrl] + [I]

Display
Toggle display of metaphases on / off [M]
Toggle display of karyograms on / off [K]
Increase image size [+]
Decrease image size [-]

MetaServer & MetaClient 2.1


MetaSystems 242
Action
Zoom current image [Z]
Switch between gallery and review mode [G]
Add selected case(s) to report buffer / Remove from buffer [B]
Print report [P]
Delete selected case(s) [Del]
Open selected case in Ikaros / Isis G, [Enter]

Main Window - 'Tree' View - Ikaros/Isis 'Cell Review'

Navigation
Scroll one gallery row up [y]
Scroll one page up [PgUp]
Scroll one gallery row down [Y]
Scroll one page down [PgDn]
Center selected case [Space]

Selection
Select cell g
Select previous cell [<]
Select next cell [>]
Select first cell [Home]
Select last cell [End]
Select all cells [Ctrl] + [A]
Select several cells Hold [Ctrl] + g-click cases
st
Select contiguous group of cells g-click 1 case, then hold [Shift] + g-click last case,
or hold [Shift] and use [<] / [>] keys to mark more cases
Invert selection of cases [Ctrl] + [I]

Display
Toggle display of metaphases on / off [M]
Toggle display of karyograms on / off [K]
Increase image size [+]
Decrease image size [-]

Action
Zoom current image [Z]
Switch between gallery and review mode [G]
Add selected case(s) to report buffer [B]
Print report [P]
Delete selected case(s) [Del]

243 Part VII Reference Section


Overview: Shortcut Keys and Icons Key and Mouse Shortcut Comman
Open selected case in Ikaros / Isis G, [Enter]

Main Window - 'Tree' View - Ikaros/Isis 'Comb. Karyo'

Show / hide chromosomes [C]

Show / hide aberrations [G]

Swap between detailed and compact aberrations [M]

Print combined karyogram [P]

Main Window - 'Tree' View - Metafer 'Cell Gallery'

Navigation
Scroll one gallery row up [y]
Scroll one page up [PgUp]
Scroll one gallery row down [Y]
Scroll one page down [PgDn]
Go to the beginning of the gallery [Home]
Go to the end of the gallery [End]
Center selected cell [Space]

Selection
Select cell g
Select previous cell [<] 2
Select next cell [>]
Select all cells [Ctrl] + [A]
Select several cells Hold [Ctrl] + g-click cells
Select contiguous group of cells g-click first cell,
then hold [Shift] + g-click last case
Invert selection of cases [Ctrl] + [I]
Clear selection [Ctrl] + [N]

Display
Increase image size [+]
Decrease image size [-]

Action
Open current Metafer pass G, [Enter]

MetaServer & MetaClient 2.1


MetaSystems 244
Main Window - 'Tree' View - VSlide 'Gallery'

Toggle on / off filter conditions: [F]


a If a filter is active, pressing [F] disables the filter condition.
a If a filter is disabled, pressing [F] restores the last filter con-
dition.

Report Editor

Report
Create a new report [Ctrl] + [N]
Open a report [Ctrl] + [O]
Save the current report [Ctrl] + [S]

Clipboard
Cut all selected components [Ctrl] + [X]
Copy all selected components [Ctrl] + [C]
Paste all components from the clipboard to the report [Ctrl] + [V]

Selection
Select all components [Ctrl] + [A]
Invert Selection [Ctrl] + [I]

Display
Grid on / off [Ctrl] + [G]
Print Margins on /off [Ctrl] + [M]
Adjust zoom - fit to width [Space]
Go to top of report [Home]
Go to end of report [End]

Actions
Bring selected components to front [Ctrl] + [F]
Send selected components to back [Ctrl] + [B]
Move selected object(s) by 1 grid position in the respective direction [<], [>], [Y] or [y]
Move the selected object(s) by 1/10 mm in the respective direction [Ctrl] + [<], [>], [Y] or [y]
Delete selected components [Del]

245 Part VII Reference Section


Overview: Shortcut Keys and Icons Key and Mouse Shortcut Comman
Query Editor

Open a query [Ctrl] + [O]

Save a query [Ctrl] + [S]

Undo [Ctrl] + [Z]

Redo [Ctrl] + [Y]

Cut function block [Ctrl] + [X]

Copy function block [Ctrl] + [C]

Paste function block [Ctrl] + [V]

Delete function block [Del]

Select all function blocks [Ctrl] +[A]

Select none [Ctrl] + [N]

Invert selection of function blocks [Ctrl] + [I]

Manage patterns, open Pattern Library [F2]

Test query and run execution log [F5]

7.6.2 Icons

General Icons

Main Window 2

Icon Description

Refresh all views (= [F5]).

Quick search (= [F3]).

Fullscreen mode (= [F11]).

Overview' Tab

Icon Description

Lock / unlock dashboard.

Refresh widget.

MetaServer & MetaClient 2.1


MetaSystems 246
Statistics' Tab

Icon Description

Display Options

Query result presented as a table.

Query result presented as a bar chart.

Query result presented as a line chart.

Layout Options

Auto-arrange query results automatically.

Single query display.

Dual query display (split vertically, show two queries).

Dual query display (split horizontally, show two queries).

Triple query display (show three queries).

Quadruple query display (show all four queries).

Actions

Print query results.

Export query results.

Report Editor

Toolbar

Icon Description

New Report - Create a new empty report.

Open Report - Open an existing query.

Save Report - Save all changes made to the current query.

Test print.

Print preview.

Cut components.

Copy components.

247 Part VII Reference Section


Overview: Shortcut Keys and Icons Icons
Icon Description

Paste components from the clipboard.

Show Pattern Manager - in which pattern can be deleted, renamed or inserted into the report.

Undo - Undo the last component.

Redo the last component.

Zoom In - Increase the zoom factor.

Zoom Out - Decrease the zoom factor.

Fit page width - Centers the page and adjusts the zoom factor so that the page with fits into the displayed
window.

Show hotkeys - show a list of all available report editor hotkeys.

Component Toolbox

Icon Description

Text.

Static image.

Image.

Image grid.

Table. 2

Shape.

Chart.

Computation.

Dynamic vertical splitter.

Dynamic horizontal splitter.

Report section.

Page break.

Input parameter.

MetaServer & MetaClient 2.1


MetaSystems 248
Query Editor

Toolbar

Icon Description

New query.

Open query.

Save query.

Execute query - Execute current query and display execution log.

Cut and move selected function blocks and data flows to the clipboard.

Copy selected function blocks and data flows to the clipboard.

Paste all function blocks and data flows from the clipboard into the current query.

Pattern Library - Opens the Pattern Library, which allows to insert and manage query patterns.

Undo last step.

Redo last step.

Full function block reference (k 202 ).

Icons specific for Ikaros/Isis Root Directories

'Case List' Tab

Icon Description

Open in Ikaros (V5.4 or higher required).

Open in Isis (V5.4 or higher required).

Print report.

Export case list in Microsoft Excel or CSV file format.

Create case.

Delete case(s).

Rename case.

Move case.

249 Part VII Reference Section


Overview: Shortcut Keys and Icons Icons
'Tree' Tab

Icon Description

All Aspects

Show / Hide tree.

Show / Hide information area.

History

Add event to history.

Print history.

File List

Add to file list. Add existing files to the selected case.

Add graphic (opens the Graphics Module).

Delete from file list.

Cell List

Print cell list.

Selected list items

Navigate to ... .

Open in Ikaros (V5.4 or higher required).

Open in Isis (V5.4 or higher required).


2
Print report.

Delete all selected items.

Rename cell.

Move cell

Cell Gallery

Open in Ikaros (V5.4 or higher required).

Open in Isis (V5.4 or higher required).

Print report.

Delete all selected items.

Rename cell.

MetaServer & MetaClient 2.1


MetaSystems 250
Icon Description

Move cell.

Delete unused cell(s).

Show / Hide analysis sheet.

Cell Review

Open in Ikaros (V5.4 or higher required).

Open in Isis (V5.4 or higher required).

Print report.

Delete all selected items.

Show / Hide analysis sheet.

Go to first Image.

Go to previous image.

Go to next image.

Go to last image.

Comb. Karyo

Print combined karyogram.

Export combined karyogram to Microsoft Excel. Requires that Microscoft Excel is installed on the same
computer.

Open in Ikaros (V5.4 or higher required).

Open in Isis (V5.4 or higher required).

Composite karyotype.

Clonal karyotype.

Clear case karyotype.

Save changes to the case karyotype.

Show / Hide analysis sheet.

251 Part VII Reference Section


Overview: Shortcut Keys and Icons Icons
Icons specific for Metafer Root Directories

'Case List' Tab

Icon Description

Open in Metafer (V3.10 or higher required).

Delete all selected items.

Move Pass(es). Move selected pass(es) to another root directory.

Copy Pass(es). Copy selected pass(es) to another root directory.

'Tree' Tab

Icon Description

Pass List (for Case, Test, Culture, and Slide hierarchy levels)

Navigate to ... (jump to selected pass).

Open in Metafer (V3.10 or higher required).

Delete Pass.

Move Pass(es). Move selected pass(es) to another root directory.

Copy Pass(es). Copy selected pass(es) to another root directory.

2
Data (for Pass hierarchy levels)

Open in Metafer (V3.10 or higher required).

Delete Pass.

Move Pass(es). Move selected pass(es) to another root directory.

Copy Pass(es). Copy selected pass(es) to another root directory.

Show / Hide tree.

MetaServer & MetaClient 2.1


MetaSystems 252
Icons specific for VSlide Root Directories

'Case List' Tab

Icon Description

Open VSlide (in VSViewer V2.0 or higher).

Delete all selected items.

Move VSlide(s).

Copy VSlide(s).

Show / Hide tree.

'Tree' Tab

Icon Description

Run List, VSlide List, VSlide Gallery

Navigate to ... (jump to selected VSlide(s)).

Open VSlide (in VSViewer V2.0 or higher).

Delete VSlide(s).

Move VSlide(s).

Copy VSlide(s) - Copy selected VSlide(s) to another root directory.

Upload VSlides - Upload selected VSlide(s) to VMD (Virtual Microscopy Database). Requires valid VMD li-
cense, for details contact MetaSystems (see here).

Show / Hide tree.

253 Part VII Reference Section


Overview: Shortcut Keys and Icons Icons
7.7 Overview: Menus and Context Menus

7.7.1 MetaClient Menu Bar

Root Directory
Shows all registered root paths. How to add, edit, and delete root paths, see here 80 .

Command Description

Iks/Iss Root Directory 1 List of all registered Ikaros/Isis root directories (alias names) (k 147 ).
Iks/Iss Root Directory 2
:::

Metafer Root Directory 1 List of all registered Metafer root directories (alias names) (k 147 ).
Metafer Root Directory 2
:::

VSlide Root Directory 1 List of all registered VSlide root directories (alias names) (k 147 ).
VSlide Root Directory 2
:::

Manage
Reload Root Directory List Update the root directory list, for example when new root directories have
been added in MetaSever (k 80 ).
Add Root Directory ...
Add a new root directory directly in MetaClient (k 81 ).

NOTE! It is no longer possible to add root directories with local 2


paths from MetaClient, only UNC network paths and mapped net-
work drives are allowed.

NOTE! The following two menus in the menu bar are not static, but adapt themselves to the selected:
a view - Overview, Case List, Tree, or Statistics.
a data - Ikaros/Isis, Metafer, or VSlide root directories.
a hierarchy level - from Study down to VSlide or Cell (Gallery) (hierarchy settings in Configure - Settings - Hi-
erarchy tab, k).

MetaServer & MetaClient 2.1


MetaSystems 254
Reporting

Command Description

Print Report ... Select report template and print report (k 123 )

Clear Report Buffer Remove all items currently held in the report buffer prior to printing a re-
port (k 139 ).

Import Report Package ... Select and import a report package ZIP file. This will copy the file into
their correct subfolders of the installation (queries in ...\MetaSystems
\QryDef, images in ...\MetaSystems\Reports\Res, reports in ...\MetaSys-
tems\Reports) (k 236 ).

Open Report Editor ...

Configure

Command Description

Settings ... Open the settings configuration window (k 158 ).

Workflow Settings ... Open the configuration window for the workflow bar (only available, if an
Ikaros/Isis root directory is loaded)(k 178 ).

Datafield Editor ... Open the configuration window, in which you can customize the
datafields (k 184 ).

Save User Preferences as Default Create a user configuration template from the user preferences of the
current user (k 158 ).

Trash

NOTE! The Trash menu is only available for Ikaros/Isis and Metafer root directories.

Command Description

Manage ... Open the Manage Trash window, in which you can selectively restore
cases and files or delete them irrevocably to increase free disk space.
There is one Trash folder for each root path, storing all recently deleted
cases and files (k 108 ).

Empty Erase the content of a trash folder completely (k 108 ).

255 Part VII Reference Section


Overview: Menus and Context Menus MetaClient Menu Bar
Tools

NOTE! There are additional commands in the Trash menu available for Ikaros/Isis (k 259 ) and VSlide (k 262 )
root directories.

Command Description

Show Active Users ... View a list of all currently logged in users.

Send Message ... Send a message to all currently logged in MetaClient users.

Diagnostics

Command Description

Show Log All MetaClient sessions are logged: while the (problem) log records hints
and errors, the event log lists all user driven activities. View the corres-
Show Event Log
ponding file for problem analysis. Logs and events are stored with a time
stamp (yyyy-mm-dd hh:mm:ss) for greater transparency. You can g-click
the Refresh button to update the current view. g-click the Clear button
for the event log to create a fresh event log by removing the entire history.

Check Cases for Modification This command is only available for Ikaros/Isis root directories. Although all
file modifications are synchronized between MetaClient and Ikaros/Isis on
a regular basis, it may be necessary to trigger the synchronization step
with any delay.

Re-Index Root Directory After changing the data structure, for example, by adding new data fields
in the data field editor (k 184 ), it is necessary to re-index the current root
directory, in order to apply the changes and to retrieve the respective in-
formation.
2
Performance Analysis ... Starts several tools measuring the local and network setup to generate
performance indicators.

Clear Cache Remove all temporary files from the MetaClient cache.

Profiler ... The Profiler function counts the number of threads, measures the
memory usage and log important events. This information may be useful
in identifying problems with MetaClient's performance.

Scripting Console ... The Server Console can be used for servicing purposes.

Screen Capture The screen capture tool allows to document problems with MetaClient
and/or for educational purposes alike. You can start recording a screen
Start Capture
capture movie with Start Capture and stop the recording with End Cap-
End Capture ture. The screencasts videos can be replayed (Replay), saved (Save) and
Replay reloaded (Load). The Replay Speed supports three options: Half, Ori-
ginal, or Double .
Save ...
Load ...
Replay Speed

MetaServer & MetaClient 2.1


MetaSystems 256
Command Description

Send Exception Report Create and exception report, which can then be send to MetaSystems for
analysis (k 166 ).

Windows

Command Description

Report Editor This menu lists any active non-modal window in MetaClient, i. e. the Re-
port Editor and/or Query Editor, in order to prevent that modifications in
Query Editor
the editors are lost when exiting MetaClient.

Help

Command Description

Show Help Show help file (i. e. this file).

Show Hotkeys Show the hotkey short reference.

System Info Display a summary of the systems basic software and hardware setup.

Info View version information about the installed MetaClient software.

Menu Items specific for Ikaros/Isis Root Directories

On 'Study' Level

Command Description

Create Case ... In the Create New Case window you can enter the new Case Name and
Select Subdirectory (in the current root directory) for the new case (k 86 ).

257 Part VII Reference Section


Overview: Menus and Context Menus MetaClient Menu Bar
On 'Case' Level

Command Description

Open In Ikaros Open the selected case in Ikaros (k 85 ).

Open in Isis Open the selected case in Isis (k 85 ).

Add to Report Buffer / Add the selected case to the report buffer / Remove case from the report
Remove from Report Buffer buffer (k 139 ).

Delete Delete the current case (k 87 ).

Rename Case ... Rename the current case (k 87 ).

Move Case(s)... Move current case to a specific sub directory of another root directory (k
88 ).

Create Case ... In the Create New Case window you can enter the new Case Name and
Select Subdirectory (in the current root directory) for the new case (k 86 ).

On 'Test', 'Culture', 'Slide', and 'Region' Levels

Command Description

Open In Ikaros Open the selected case in Ikaros (k 85 ).

Open in Isis Open the selected case in Isis (k 85 ).

Create Case ... In the Create New Case window you can enter the new Case Name and
Select Subdirectory (in the current root directory) for the new case (k 86 ).

On 'Pass' Level 2

Command Description

Open In Ikaros Open the selected case in Ikaros (k 85 ).

Open in Isis Open the selected case in Isis (k 85 ).

Delete Delete the current pass (k 87 ).

Create Case ... In the Create New Case window you can enter the new Case Name and
Select Subdirectory (in the current root directory) for the new case (k 86 ).

MetaServer & MetaClient 2.1


MetaSystems 258
On 'Cell' Level

Command Description

Open In Ikaros Open the selected case in Ikaros (k 85 ).

Open in Isis Open the selected case in Isis (k 85 ).

Add to Report Buffer / Add the selected cell to the report buffer / Remove cell from the report buf-
Remove from Report Buffer fer (k 139 ).

Delete Delete the current cell (k 87 ).

Rename Cell ... Rename the current cell. Renaming a cell does not alter its Cell Category
state (k 91 ).

Move Cell(s)... Move selected cell(s) to a specific sub directory of another root directory (k
92 ).

NOTE! Cell categories are now reset to 'undefined', when you


move a cell to another case.

Create Case ... In the Create New Case window you can enter the new Case Name and
Select Subdirectory (in the current root directory) for the new case (k 86 ).

Tools

Command Description

CV Viewer
Open... Launch the external viewer software for Cytovision images.
Import Images into Current Case ... Open CV Viewer case with the same name as the current MetaClient case
and imports all images of the CV Viewer case.

PG Viewer
Open... Launch the external viewer software for PowerGene images.
Import Images into Current Case ... Open PG Viewer case with the same name as the current MetaClient case
and import all images of the PG Viewer case.

Show Active Users ... View a list of all currently logged in users.

Send Message ... Send a message to all currently logged in MetaClient users.

259 Part VII Reference Section


Overview: Menus and Context Menus MetaClient Menu Bar
Reporting

Command Description

Print Report .. Print a report for the selected items (image(s), case(s) or content of the re-
port buffer (k 123 ).

Clear Report Buffer Delete the contents of the report buffer (k 139 ).

Import Report Package ... Select and import a report package ZIP file. This will copy the file into their
correct subfolders of the installation (queries in ...\MetaSystems\QryDef,
images in ...\MetaSystems\Reports\Res, reports in ...\MetaSystems\Re-
ports) (k 236 ).

Open Report Editor ... Open the report editor to create or customize a report buffer (k 125 ).

MetaServer & MetaClient 2.1


MetaSystems 260
Menu Items specific for Metafer Root Directories

On 'Case' and 'Pass' Levels

Command Description

Open in Metafer Open the selected case in Metafer (k 100 ).

Delete Delete the current case (k 101 ).

Move Pass(es) ... Move current pass to another Metafer Root Directory or to an Export Path
(k 101 ).

Copy Pass(es) ... Copy current pass to another Metafer Root Directory or to an Export Path
(k 102 ).

On 'Test' and 'Culture' Levels

Command Description

Open in Metafer Open the slides included in the selected test in Metafer (k 100 ).

On 'Slide' Level

Command Description

Open in Metafer Open the selected slide in Metafer (k 100 ).

Move Pass(es) ... Move current pass to another Metafer Root Directory or to an Export Path
(k 101 ).

Copy Pass(es) ... Copy current pass to another Metafer Root Directory or to an Export Path
(k 102 ).

Tools

Command Description

Show Active Users ... View a list of all currently logged in users.

Send Message ... Send a message to all currently logged in MetaClient users.

261 Part VII Reference Section


Overview: Menus and Context Menus MetaClient Menu Bar
Menu Items specific for VSlide Root Directories

On 'Case', 'Pass', 'VSlide Run', and 'VSlide' Levels

Command Description

Open VSlide Open the selected VSlide in VSViewer (k 103 ).

Delete Delete the current VSlide.

Move VSlide(s) ... Move current pass to another Metafer Root Directory or to an Export Path
(k 104 ).

Copy VSlide(s) ... Copy current pass to another Metafer Root Directory or to an Export Path
(k 104 ).

On 'Test', 'Culture', and 'Slide' Levels

Command Description

Open VSlide Open the selected VSlide in VSViewer (k 103 ).

Move VSlide(s) ... Move current VSlide to another VSlide Root Directory or to an Export Path
(k 104 ).

Copy VSlide(s) ... Copy current VSlide to another VSlide Root Directory or to an Export Path
(k 104 ).

Tools 2

Command Description

Show Active Users ... View a list of all currently logged in users.

Send Message ... Send a message to all currently logged in MetaClient users.

Show VMD Uploads ... View a list of all VSlide uploads to VMD server. Requires a valid VMD installa-
tion (k 105 ).

*VMD (Virtual Microsocpe Database is manufactured by Lightfields GmbH, for contact de-
tails, k 105 .)

MetaServer & MetaClient 2.1


MetaSystems 262
7.7.2 MetaClient Context Menues

For Ikaros/Isis Root Directories

Context Menu in Case List View

Command Description

Open In Ikaros Open the selected case in Ikaros (k 85 ).

Open in Isis Open the selected case in Isis (k 85 ).

Print Report ... Print a case report (k 85 ).

Add to Report Buffer / Add the selected case to the report buffer / Remove case from the report
Remove from Report Buffer buffer (k 139 ).

Delete Delete the current case (k 87 ).

Rename Case ... Rename the current case (k 87 ).

Move Case(s) ... Move selected case(s) to a specific sub directory of another root directory (k
88 ).

Context Menus in Tree View

Context Menu in Tree

Command Description

Open In Ikaros Open the selected case in Ikaros (k 85 ).

Open in Isis Open the selected case in Isis (k 85 ).

Add to Report Buffer / Add the selected case to the report buffer / Remove case from the report
Remove from Report Buffer buffer (k 139 ).

Delete Delete the current case (k 87 ).

Rename Case ... Rename the current case (k 87 ).

Move Case(s) ... Move selected case(s) to a specific sub directory of another root directory (k
88 ).

263 Part VII Reference Section


Overview: Menus and Context Menus MetaClient Context Menues
Context Menu in Cell List

Command Description

Navigate to Open Cell Review (k 89 ).

Open In Ikaros Open the selected case in Ikaros (k 90 ).

Open in Isis Open the selected case in Isis (k 90 ).

Print Report ... Print a case report (k 90 ).

Add to Report Buffer / Add the selected case to the report buffer / Remove case from the report
Remove from Report Buffer buffer (k 139 ).

Delete Delete the current case (k 91 ).

Rename the current case. Renaming a cell does not alter its Cell Category
Rename Cell
state (k 91 ).

Move Cell(s) Move selected case(s) to a specific sub directory of another root directory (k
92 ).

NOTE! Cell categories are now reset to 'undefined', when you


move a cell to another case.

Assign Category Assign a (processing) Category to a the selected cell in the Cell List (k 92 ).

Context Menu in Cell Gallery

Command Description

Open In Ikaros Open the selected case in Ikaros (k 90 ).

Open in Isis Open the selected case in Isis (k 90 ). 2


Print Report ... Print a case report (k 90 ).

Add to Report Buffer / Add the selected case to the report buffer / Remove case from the report
Remove from Report Buffer buffer (k 139 ).

Delete Delete the current cell - metaphase and karyogram (k 91 ).

Rename Cell Rename the current cell. Renaming a cell does not alter its Cell Category
state (k 91 ).

Move Cell(s) Move selected case(s) to a specific sub directory of another root direct-
ory (k 92 ).
NOTE! Cell categories are now reset to 'undefined', when you
move a cell to another case.

Assign Category Assign a (processing) Category to a the selected cell in the Cell List (k 92 ).

MetaServer & MetaClient 2.1


MetaSystems 264
Context Menu in Comb. Karyo

j-click on background in Combined Karyogram


Command Description

Open Cell ### Open Cell Review aspect for cell / image ###.
Edit Aberration Edit Case Karyotype (k 56 ).

j-click on chromosomes in Combined Karyogram


Command Description

Cleared Chromosome reveals no abnormalities upon visual inspection.


p Cleared p-arm of chromosome reveals no abnormalities upon visual inspection.
q Cleared q-arm of chromosome reveals no abnormalities upon visual inspection.
Not cleared Presentation of chromosome is too poor and does not allow for a clearance.
Undefined Chromosome is (still) in undefined state (default state, prior to inspection.
Comment ... Open the Chromosome Comment window, in which you can describe struc-
tural aberrations according to ISCN nomenclature.
Open Cell [Number] Open Cell [Number] with the default viewer (Ikaros or Isis).

265 Part VII Reference Section


Overview: Menus and Context Menus MetaClient Context Menues
For Metafer Root Directories

Tree

Command Description

Open in Metafer Open the selected pass in Metafer (k 100 ).

Delete Delete the selected Metafer pass (k 101 ).

Move the selected Metafer pass(es) to another Root Directory or to an Ex-


Move Pass(es) ...
port Path (k 101 ).

Copy Pass(es)... Copy the selected Metafer pass(ds) to another Root Directory or to a Ex-
port Path (k 102 ).

Pass List

Command Description

Navigate to

Delete Delete the selected Metafer pass (k 101 ).

Move the selected Metafer pass(es) to another Root Directory or to an Ex-


Move Pass(es) ...
port Path (k 101 ).

Copy Pass(es)... Copy the selected Metafer pass(es) to another Root Directory or to an Ex-
port Path (k 102 ).

MetaServer & MetaClient 2.1


MetaSystems 266
For VSlide Root Directories

NOTE! 'MetaViewer' was renamed to 'VSViewer' and the old 'VSViewer' file format to 'ZViewer'.

Tree

Command Description

Open VSlide Open the selected VSlide in VSViewer (k 103 ).

Delete Delete the selected VSlide (k 103 ).

Move the selected VSlide(s) to another Root Directory or to an Export Path


Move VSlide(s) ...
(k 104 ).

Copy VSlide(s)... Copy the selected VSlide(s) to another Root Directory or to an Export Path
(k 104 ).

VSlide List and VSlide Gallery

Command Description

Navigate to

Open VSlide Open the selected VSlide in VSViewer (k 103 ).

Open the selected VSlide in another instance of VSViewer (separate pro-


Open VSlide (New Instance)
gram window) (k 103 ).

Delete Delete the selected VSlide (k 103 ).

Move the selected VSlide(s) to another Root Directory or to an Export Path


Move VSlide(s) ...
(k 104 ).

Copy VSlide(s)... Copy the selected VSlide(s) to another Root Directory or to an Export Path
(k 104 ).

Upload VSlides Connects to VMD* server and uploads the selected VSlide(s) to VMD. Re-
quires a valid VMD installation (k 105 ).

*VMD (Virtual Microsocpe Database is manufactured by Lightfields GmbH,


for contact details, k 105 )

267 Part VII Reference Section


Overview: Menus and Context Menus MetaClient Context Menues
7.7.3 MetaServer Menu Bar

Program

Command Description

Setup Wizard ... Start the Setup Wizard (k 143 ).

Shutdown MetaServer in a controlled manner, saving most recent index


Shutdown
files. Any active MetaClient will loose connection to MetaServer (k 17 )!

Diagnostics

Command Description

Client Summary Display a Client Summary table, listing the Client computers network-IDs,
the Type of client, the amount of InTraffic and OutTraffic (in KB), the num-
ber of Notifies, the User Config Dir, and the path to the Configuration
File.

Profiler Display a Profiler Summary presenting graphs for internal Measurements


results (number of Threads, Memory usage, and the number of Connec-
tions (= number of MetaClients connected to MetaServer) and Events.

Send Exception Report ... Trigger the generation of an exception report (k 269 ).

Help

Command Description 2

Info Display the actual software version, copyright information, and MetaSys-
tems' contact address

MetaServer & MetaClient 2.1


MetaSystems 268
7.8 Troubleshooting

If MetaServer and MetaClient do not function properly, please try one of the following:
a depending on the nature of the problem, the Problems tab may be present in MetaClient: check the message on the
tab and either use the Resolve command button or follow the instructions provided.
a Look up the log files for errors:
s MetaServer Log - Log tab in MetaServer
s MetaClient Log - Show Log commands in the MetaClient Diagnostics menu.
s MetaClient Event Log - Show Event Log command in the MetaClient Diagnostics menu.

a Try to reload the respective root directory.


a Update the loaded root directory - Check Cases for Modifications command in the MetaClient Diagnostics menu.
a Re-Index the current root directory - Re-Index Root Directory command in the MetaClient Diagnostics menu.
a If the problem might be related to network performance , run the Performance analysis in the Diagnostics menu.
You can choose between a Standard Analysis or a Long-run Analysis (for rare events). g-click Start and then
Save, when the analysis is completed. The performance indicators can be stored as text or as a bitmap. Please send
the results to MetaSystems (for contact details, see backcover).
a Create an exception reports can be created by pressing the [ ] + [Esc] key combination, save the report and forward
it to MetaSystems by email (for contact details, see backcover k). For more information on exception reports, see the
chapter below (k 269 ).

7.8.1 Filing Exception Reports

Exception reports provide an extensive 'snapshot' of a program situation, if a program error occurs. They are generated
automatically on program errors or can be created manually by pressing the [W] + [Esc] key combination or by g-click-
ing the Send Exception Report... command in the Diagnostics menu.
In both instances an Error occurred window like this should appear:

269 Part VII Reference Section


Troubleshooting
Please enter a short description. The description should answer the following questions:
a What were you doing when the problem happened?
a What exactly was the problem?
a What behavior did you expect instead?
If you wish to receive some feedback, you should also enter your email address.

Depending on the exception reporting mode (as defined in Configure - General , k 159 ) the filed exception report is then :
a Saved on your local hard disk (in C:\Tmp by default). In this case you should send the created ZIP file to XRe-
[email protected]. If your institution's network policies do not allow to create an XReport in the C:
\Tmp folder, the XReport is written to C:\MetaSystems\XRep folder instead.
a Automatically sent to us by email.
a Automatically uploaded to our FTP server.
a Automatically uploaded to our HTTP server.
a or treated differently based on the settings in the XReports.ini file which is located in your MetaSystems\Bin folder.

NOTE! Forwarding exception reports to MetaSystems is greatly appreciated, because they are the basis to im-
prove the software and correct any errors. However, sending exception reports automatically via email, FTP or
HTTP may require a consent from your IT department.

7.9 Updating MetaServer and MetaClient

Updating a V2.1 Installation with Service Releases


Version 2.1 introduces a MetaServer-controlled update mechanism for MetaClient installations. If MetaClient with an older
version connects and there is a newer version available at the server, the client version gets automatically updated.
In MetaServer a backup / update path can be specified. In the specified folder (accessible from all MetaClient stations) the
whole MetaClient folder for Installation should be copied (not the Installer). If MetaSetup is installed the backup / update 2
path should be the MetaSetup folder. Equivalent to MetaSetup a backup of the new configuration is saved in a folder
named after the station which was updated. The backup folder is created next to the MetaClient folder in the backup / up-
date path. For each system a sub-folder is created in the backup folder. The name of the sub-folder is identical to the Sys-
tem-ID.

Option 1: With a dedicated Server

The procedures below describe how to update MetaServer and MetaClient in an installation, in which MetaServer is in-
stalled on a dedicated server computer and MetaClient is installed on separate computers, but not on the server itself. If
the server computer also runs MetaClient, please refer to option 2 below. Otherwise, an error message will be displayed.

Update MetaServer

a Close all MetaClient instances on client PCs.


a Log on to the server computer with administrator rights and shut down MetaServer.

MetaServer & MetaClient 2.1


MetaSystems 270
a Copy the latest version of the self-extracting updater for MetaServer to the server computer and G-click the
MetaServer-2.1.XXX.EXE (where XXX substitutes the version number of the service release).
The update routine will replace all outdated files automatically by their latest versions.
a When the update process is completed, restart MetaServer by G-clicking the MetaServer icon on the desktop or the
MetaServer.EXE (usually) located in C:\MetaSystems\Bin.

Update MetaClient

a Copy the content of the MetaClient for the latest service release update folder to the backup/update folder on the
computer running MetaServer. You might need administrator rights to do complete the task.
a To start the update process, MetaClient has to be closed and restarted on each station. When MetaClient connects to
a MetaServer, it scans the designated folder for updates. If a newer version of MetaClient is found, an update routine
is initiated and prompting the user to confirm the update. After confirmation, MetaClient continues with creating a
temporary local backup of the current configuration, which is deleted after successful completion of the update pro-
cess. In the next step, the current configuration is updated. Finally, the updated configuration is saved to the backup/
update folder (on the server).

NOTE! The update routine is only executed, if no other MetaSystems software is running (Ikaros, Isis, Metafer,
MetaArchive, MetaSetup).

Option 2: Without a Dedicated Server

The procedures below describe how to update MetaServer and MetaClient in an installation, in which MetaServer is not
running on a dedicated server, but on a computer running MetaClient. If MetaServer is installed on a dedicated server,
please refer to option 1 above.

Update MetaServer and MetaClient on Server PC

a Close all MetaClient instances on client PCs and on the server PC.
a Shut down MetaServer.
a Copy the latest versions of the self-extracting update files for MetaServer and MetaClient to the server computer and
1. G-click the MetaServer-2.1.XXX.EXE (where XXX substitutes the version number of the service release).
2. G-click the MetaClient-2.1.XXX.EXE (where XXX substitutes the version number of the service release).

The update routine will replace all outdated files automatically by their newer versions.

a When the update process is complete, restart MetaServer by G-clicking the MetaServer icon on the Windows
desktop.

NOTE! The update routine is only executed, if no other MetaSystems software is running (Ikaros, Isis, Metafer,
MetaArchive, MetaSetup).

271 Part VII Reference Section


Updating MetaServer and MetaClient
Update MetaClient on all other Clients

a Copy the content of the MetaClient for the latest service release update folder to the backup/update folder on the
computer running MetaServer. You might need administrator rights to do complete the task.
a To start the update process, MetaClient has to be closed and restarted on each station. When MetaClient connects to
a MetaServer, it scans the designated folder for updates. If a newer version of MetaClient is found, an update routine
is initiated and prompting the user to confirm the update. After confirmation, MetaClient continues with creating a
temporary local backup of the current configuration, which is deleted after successful completion of the update pro-
cess. In the next step, the current configuration is updated. Finally, the updated configuration is saved to the backup/
update folder (on the server).

NOTE! The update routine is only executed, if no other MetaSystems software is running (Ikaros, Isis, Metafer,
MetaArchive, MetaSetup).

Update from V2.0

Update MetaServer on Server PC

a Close all MetaClient instances on client PCs.


a Shut down MetaServer on the computer acting as server.
a Copy the latest version of the self-extracting updater for MetaServer to the server computer and G-click the
MetaServer-2.1.XXX.EXE (where XXX substitutes the version number of the service release).
The update routine will replace all outdated files automatically.
a When the updating process is complete, restart MetaServer by G-clicking the MetaServer icon on the Windows
desktop.

2
Update MetaClient

a Close all MetaClient instances on client PCs and on the server PC.
a Copy the latest version of the self-extracting updater for MetaClient to every MetaClient computer. Then start the
update process on every computer individually by G-click the MetaClient-2.1.XXX.EXE (where XXX substitutes
the version number of the service release).
The update routine will replace all outdated files automatically.
a When the updating process is complete, restart MetaClient by G-clicking the MetaServer icon on the Windows
desktop.

MetaServer & MetaClient 2.1


MetaSystems 272
Update from V1.0 or V1.1

Update MetaServer

a Updating from V1.0 : When you update from MetaServer / MetaClient V1.0 please observe that
s As queries created in V1.0 are not compatible with V2.1, please delete all existing queries (in ...\MetaSystems
\QryDef) before updating MetaClient! Customized queries must be created anew.
s Please also delete all files in ...\MetaSystems\Tmp and ...\MetaServer\ComputedFields prior to updating.

a Updating from V1.1: Queries created in MetaServer / MetaClient V1.1 are compatible with V2.1.
a Proceed as described above for the Update from V2.0.

Update MetaClient

a Follow the description for the Update from V2.0.


Old Setting files are automatically converted. A message is displayed after conversion and a backup of the original file
is created before conversion.

NOTE! When you update from MetaServer / MetaClient V1.0, please delete the contents of these folders prior to
updating: ...\MetaSystems\QryDef (queries), ...\MetaSystems\Tmp (temporary files), and ...\MetaServer
\ComputedFields.

273 Part VII Reference Section


Updating MetaServer and MetaClient
Software
Protection
VIII Devices - Dongles
MetaSystems' software is defended against misuse by the presence of software protection devices, also known as
'dongles'.
While MetaServer runs without dongle protection, MetaClient V 2.1 requires a matching dongle to load and process
Ikaros/Isis and Metafer root directories. If MetaClient is handling only VSlide root directories, a dongle is not required at
all.

MetaClient V 2.1 supports three dongle types:

Dongle Type /
Remarks
Interface

WibuKey (LPT)/ a Software support: up to Ikaros/Isis V5.7, MetaSetup V5.7, and


LPT printer port Metafer 3.10.
a Requires proprietary Wibu software
a Workplace license.
a Legacy component - requires PC with LPT printer port, not sup-
ported any longer by most current PC models.
2
WibuKey (USB) / a Software support: up to MetaClient V2.1, Ikaros/Isis V5.7,
USB 2.0 (USB 3.0) MetaSetup V5.7, and Metafer 3.12.
a Requires proprietary Wibu software / Wibu USB driver.
a Workplace license.

CodeMeter / a New dongle supported as of MetaClient V5.7, Ikaros/Isis V5.7,


USB 2.0 (USB 3.0) MetaSetup V5.7, and Metafer 3.12.
a Not compatible with Ikaros/Isis V5.5, MetaSetup V5.5, Metafer 3.10
or earlier.
a Behaves like a standard USB 2.0 device, no proprietary driver
needed.
a Workplace or network license(s).
a Supports modern software encryption algorithms.

For details, please see also the Wibu-Systems homepage: www.wibu.com.

MetaServer & MetaClient 2.1


MetaSystems 274
If you run Ikaros/Isis systems with V5.5 or higher and still a LPT dongle, please contact MetaSystems for a quotation on a
replacement dongle (k). MetaClient V 2.1 supports WibuKey (USB) and CodeMeter dongles. When you start MetaClient for
the first time, you have decide, whether a local dongle (WibuKey), a network dongle (CodeMeter), or no dongle (VSlide files
only) shall be used. A corresponding message will ask you for the required input.
The presence of a dongle is verified on each refresh and when changing root directories.

CodeMeter and Network Licenses

MetaClient V 2.1 supports both WibuKey and CodeMeter dongles. If Ikaros/Isis or Metafer root directories have been re-
gistered with MetaServer, MetaClient prompts you upon first program start after installation, whether it should refer to a
local or local dongle.
One CodeMeter dongle can host an unlimited number of MetaSystems license files. Thus, users can share any number of
software licenses between multiple workstations:
a The license pool is administered from a central license server with one CodeMeter dongle.
a The license server controls the number of program instances that are allowed to run concurrently.
a When a user closes Ikaros/Isis (or Metafer), the particular license is released back into the central pool so it can be as-
signed to another user.
a Local and network licenses (dongle) can be mixed in a network, however, all dongles must be of the CodeMeter type.

The advantages of network licenses are:


a Centralized license management (LAN, Intranet, Internet).
a The possibility to keep the network dongle in a secluded server room.
a Licenses not tightly linked to certain computer - they can be used on all computer in a network irrespective of the
physical location.
a Maximize utilization of each license.
a Comfortably accessible combinations of licenses possible.

Network licenses have a few limitations though:


a Functionality requiring specific hardware can only be used on properly equipped stations - this includes cameras, mi-
croscopes, scanning stages.
a Hardware configuration must be local.
a Network licenses are only recommended for connections with stable and good performance:
s If MetaClient cannot find the network dongle on program start,there will be 6 retries with 10s intervals. After-
wards, a message will prompt you to verify the dongle type. If the next attempt to connect to the dongle fails,
then MetaClient will stop working after just over a minute.
s If MetaClient cannot communicate with the dongle during a program session, there will be 3 retries with 1-
minute checking intervals. Like above, MetaClient will stop working after 4 minutes.

275 Part VIII Software Protection Devices - Dongles


Security Package
for Ikaros / Isis
IX and Metafer
The Security Package is an optional upgrade for Ikaros / Isis and Metafer to protect your system against unauthorized
use and your data from unauthorized access. The security package was developed to meet the relevant rules of GLP /
ISO / FDA and should fulfill the requirements of most national accreditation / supervising authorities for cytogenetic
laboratories.

Features

File Access see below

Data Encryption see below

Event List

User Login k 14

User Administration see below and Ikaros/Isis Help or Metafer Help

If your lab has to meet other requirements not covered by the security package, please contact MetaSystems directly for
consultation (see back cover for addresses).

2
File Access

All main menu functions check for the required access level of the user currently logged on. One of these four access
levels have been assigned to every user:
Access Level Description

Read Only 1 Display images and case data. Only review functions are enabled. Saving images and cases is
disabled.
Read / Write 2 Includes Read Only right; plus access to all functions, which may alter data - images and case /
patient data -, like capturing new images, modifying images, moving images, renaming im-
ages, copying images, deleting images, saving images, importing images, saving banding clas-
sifier training data, editing case data, moving cases, delete cases and saving combined karyo-
types.
Supervisor 3 Includes both lower access levels. Supervisor rights also allow for changing systems configura-
tions except the user dependent parameters, locking/unlocking of images/cases, editing print
formats, macros, filter definitions, and karyotype templates, altering root paths, case data-
sheet and data exchange settings, false color definitions, comment templates, annotation
templates, and annotation template color definitions.

MetaServer & MetaClient 2.1


MetaSystems 276
Access Level Description

Administrator 4 All Supervisor rights plus the rights to create and modify user accounts, view the event log, un-
lock images/cases locked by any user. Because one administrator is needed at least, you can-
not change the access level of the default Administrator (ID 0).

Data Encryption

The essential component of the Security Package is the hardware based data encryption.
All user-related information, like user names and passwords, text entries in the case datasheet and image data fields, and
the event list are stored in an encrypted file format. The encryption key is based on unique data read from the Wibu
dongle (copy protection device). So even another Ikaros / Isis system with Security Package cannot decrypt, read or
modify the data encrypted on your system(s).

User Administration

MetaClient uses the same user configuration files as Ikaros / Isis and Metafer, including the common features like pass-
word-protected user login and automatic logoff (after a certain period of inactivity). Login and automatic logoff are func-
tioning across applications: when you are logged in in MetaClient and open an image in Ikaros, you do not have log in sep-
arately in Ikaros. Likewise, the automatic logoff in one program will also log you off in the other.

277 Part IX Security Package for Ikaros / Isis and Metafer


Document No. H-1050-043-EN
2015 MetaSystems

MetaSystems Germany

You might also like