Clinical Collaboration Platform

Vue PACS and Vue Archive 12.2 Administration

Guide

Confidential

Part # AG3110
2019-05-07
 Trademark and Copyright Information
CARESTREAM is a trademark of Carestream Health.
This document is copyrighted with all rights reserved.
Under the copyright laws, this document may not be copied, in whole or in part, without the written consent
of Carestream Health, Inc. Under the law, copying includes translating into another language or format.
All names or identities used in this document are fictitious.

Caution: Federal law restricts this device to sale to, by, or on order of a physician.

The information contained herein is based on the experience and knowledge relating to the subject matter
gained by Carestream Health, Inc. prior to publication. No patent license is granted by this information.
Carestream Health, Inc. reserves the right to change this information without notice and makes no
warranty, express or implied, with respect to this information.
Carestream Health, Inc. shall not be liable for any loss or damage, including consequential or special
damages, resulting from the use of this information, even if loss or damage is caused by Carestream
Health, Inc.'s negligence or other fault.

Note: Users should refer to the relevant documentation for any third-party hardware for safety and
hazard information.

Indications for Use

Note: Features of the Vue PACS Web Client are described in this documentation. Depending on your
licensing, some features may be unavailable. Contact your sales specialist for details about license
upgrades. 

Vue PACS is an image management system whose intended use is to provide completely scalable local
and wide area PACS solutions for hospitals and related institutions/sites, which will archive, distribute,
retrieve and display images and data from all hospital modalities and information systems. The system is
to be used by trained professionals including, but not limited to, physicians and medical technicians.
The system contains interactive tools in order to ease the process of analyzing and comparing three
dimensional (3D) images. It is a single system that integrates review, dictation and reporting tools to create
a productive work environment for the radiologists and physicians.
The system contains a Perfusion module with interactive tools to analyze and compare Computed
Tomography Perfusion (CTP) and MR Perfusion (MRP) images of adult patients. Blood perfusion
parameters are automatically calculated and displayed as a set of perfusion maps and perfusion tables.
The perfusion tables include the calculation of parameters related to tissue flow (perfusion) and tissue
blood volume.
The system contains a Diffusion Module with interactive tools to ease the process of analyzing and
comparing MR Diffusion Weighted images (DWI) and MR Diffusion Tensor Imaging (DTI) of adult patients.
This module is used to visualize local water diffusion properties from the analysis of diffusion- weighted
MRI data.

AG3110 │ 2019-05-07 ii
 The system supports Subtraction with interactive tools to aid with the analysis of Digital Subtraction
Angiography (DSA) images in both interventional radiology and cardiology. Subtraction automatically
subtracts a mask from contrast frames of an X-Ray Angiography study for visualization of vascular
anatomy and pathology of adult patients.
The system contains a Lesion Management module that works with Vue PACS for measurement of lesions
or regions of interest identified by trained users; tabulation of measurements, categorization of tumor
response in accordance with user-selected standards, and follow-up record of findings. The Lesion
Management Application is not to be used for mammography.
Vue Reporting is the radiology reporting module combined with the CARESTREAM Vue PACS client. Vue
Reporting provides radiologists with tools to create, update, or amend reports, using the same application
that they use to read and interpret images. Report editing may be done using speech dictation (speech
recognition) or manually (using the keyboard). Vue Reporting enables the creation of interactive-multimedia
reports by incorporating rich data such as images, tables, graphs, and hyperlinks to specific bookmarks
within the images. It supports all common reporting workflows and environments, such as a teaching
workflow, where a trainee (resident) creates a preliminary report which later final-signed by a specialist
(attending). It provides a variety of tools for streamlining report creation by radiologists and deployment to
end users (clinicians, referring physicians, and patients).

AG3110 │ 2019-05-07 iii

 Contents
Introduction 1
Who Should Use This Document 1
Terms and Definitions 1
Related Documents 2

Overview 3
Server Configurations 4
Multi-Site Solutions 4
Vue Administration Tool 5

User and Group Management 6

Get Started with the User Management Admin Tool 6
User Management Admin Tool Tabs 7
Configure the User Management Repository 9
Filter the Display 11
Sort the Display 11
Refresh the Display 12
Add New Users and Groups 12
Add a Group 12
Add a User 13
Import Users from the LDAP Repository 13
Import Users from a File 13
Define Advanced Settings for Users 14
Define External Applications for Users 15
Edit Settings at the System, Group, and User Levels 15
Delete Users and Groups 21
Define Access Control 21
Assign Restrictions Based on DICOM Tags 21
Assign Restrictions Based on General System Information 24
Modify Permissions 26
Permissions 27
Configure Change and Forgot Password URLs 39

System Configuration 40
Get Started with the System Configuration Tool 40
Image Storage Wizard 40
Save Your Changes 41
Configure Devices 41
Configure Modalities 42
Configure a DICOM Printer 43
Configure a DICOM Archive 44
Configure a Workstation 45
Configure Reporting 45

AG3110 │ 2019-05-07 iv
 Configure a Remote Web Portal 46
Verify the DICOM Connection 46
Add New Device Window Elements 47
Update the Workflow Manager Node Configuration 50
View the AE Configuration 50
Specify Allowed and Forbidden Hosts 51
View the Communication Configuration 51
Update the Loader Configuration 51
Update the Default Transfer Syntax Policy 52
DICOM Tab Elements 53
Configure the Workflow Manager 57
Configure DICOM Parsing Rules 58
Configure Study Grouping Rules 63
Configure Pre-Fetch Rules 65
Configure Push to Client Rules 69
Configure Icons Settings 70
Configure Compression Settings 70
Configure Initial Values 73
Configure IS Link 75
Configure the Listener Process 76
Configure the Converter Process 77
Configure the IS Link Database 80
Edit Report and Order Templates 81
Enable Report Parsing 81
Configure Queues and Notifications 83
Enable Filtering of Cancelled Orders 84
Troubleshoot Upgrade Issues 84
Configure HL7-PACS Field Mapping 84
Modify the HL7-PACS Field Mappings 85
Use Dictionary Tables 86
Configure Logging of HL7 Messages in the Audit Trail Viewer 90
Configure the Info Router 91
Configure Info Router Rules 92
Configure Info Router Aliases 95
Configure General Parameters 96
Configure RIS Synchronization 97
Configure Fields for RIS Synchronization 97
Enable RIS Synchronization 97
Configure Life Cycle Management 98
Configure Image Life Cycle Rules 99
Configure the Archive Settings 101
Configure Auto Delete Rules 102
Configure Auto-Delete Rules for Database Objects 103
Configure Patient Matching Rules 103
Add a Patient Matching Rule 104
Edit a Patient Matching Rule 104
Delete a Patient Matching Rule 105
Configure a Disk Folder on a Local PACS Server 105
Set Up the Disk Folder 105
Configure the Disk Auto Delete Process 106

AG3110 │ 2019-05-07 v
 System Monitoring 108
Perform System Checks 108
View System Information 108
Check the License Status 108
Run System Checks 109
Monitor Server Processes 110
Monitor MVS Services 111
View the Info Router Status 112
Monitor the Bandwidth 112
Use the Info Router 114
Get Started with the Info Router Client 114
Audit 116
Get Started with the Audit Trail Viewer 117
Define Auditing Settings 120
View Event Details 120
Define Display Settings 120
Archive Audit Data 121
View Archived Audit Data 122
Export Logs to MICROSOFT EXCEL 123
Use the Synchronization Monitor 123
Get Started with the Synchronization Monitor 123
View Synchronization Details 124
View Synchronization Errors in the Workflow Manager Administration Tool 125

Database Configuration and Management 126

Back up the Database 126
Restore the Database 127
Verify the Database Backup 127
Change the Scheduled Time for the Database Backup 128
Back up the Central Configuration 128
Check the ORACLE Alert File 128
Perform an ORACLE Server General Fitness Check 129
Run Other Scheduled Database Maintenance Tasks 129

System Administration 130

Workflow Manager Administration Tool 131
Get Started with the Workflow Manager Administration Tool 131
Manage Patient IDs 134
Update Patient Details 135
Update Study Details 135
Perform Merge and Split Operations 136
Update Series Information 138
View Study Information 138
Locate Studies 139
View Backup Media for Studies 139
Perform Manual RIS Synchronization 139
Protect and Unprotect Studies 140
Resolve Patient Matching Conflicts 140

AG3110 │ 2019-05-07 vi
 IS Link 141
Get Started with IS Link 141
Push Scripts 143
Delete Redundant Observations 143
Certificate Portal 143
Get Started with the Certificate Portal 144
Manage Keys 145
Manage Certificates 145
View Certificates 147
Test the Client and Server Configuration 147
Example: Create a Valid Certificate and Configuring TLS in a Grid Environment 148
Central Configuration Editor 149
Get Started with the Central Configuration Editor 149
Work with Keys 149
Modify Parameter Values 150
Log Files 151
Use the Log Update Utility 151
Use the Log Viewer Utility 153
Dictionary Tool 154
Get Started with the Dictionary Tool 155
Update Synonym Groups 155
Search for Specific Terms 156
Scan the Database 156
Configure Dictionary Parameters 156

Maintenance Checklists 158

Daily Maintenance Tasks 158
Weekly Maintenance Tasks 164
Monthly Maintenance Tasks 166
Situational Maintenance Tasks 166

Publication History 169

AG3110 │ 2019-05-07 vii

 Introduction
This document describes system administration tasks for Vue PACS and Vue Archive. The administration
tasks include:

l User and Group Management on page 6

l System Configuration on page 40

l System Monitoring on page 108

l Database Configuration and Management on page 126

l System Administration on page 130

Who Should Use This Document

This document is intended for use by Carestream customers.

Terms and Definitions

The following table defines the terms and acronyms used in this document:

Term Definition

DICOM Digital imaging and communications in medicine

EMR Electronic medical record

HIE Health information exchange

HIS Hospital information systems

HL7 Health Level Seven International—a set of standards, formats and definitions for exchanging
and developing electronic medical records.

LDAP Lightweight directory access protocol

PACS Picture archiving and communication system

PDQ Patient demographics query

PHI Protected health information—any information about health status, provision of healthcare, or
payment for healthcare for a specific individual.

RIS Radiology information system

AG3110 │ 2019-05-07 1
Related Documents

Term Definition

SSL Secure sockets layer

URL Uniform resource locator 

VNA Vendor neutral archive

XDS Cross enterprise document sharing

Related Documents
For more information, the following documents can be downloaded from the Service Portal:

l AG1177 - Vue PACS 12.2 HL7 Interface Specifications

l AF7489 - Vue Reporting 12.2 Administration Guide

AG3110 │ 2019-05-07 2
 Overview
Vue PACS and Vue Archive form a multi-site, standards-based data and workflow sharing and reporting
platform, which include the following components:

Vue PACS Client

The Vue PACS Client is a PACS and Reporting workstation that displays DICOM and non-DICOM clinical
data through a single interface. It is the main viewing application for reading image data and is available for
different types of users, based on their profile.

Vue PACS Server

On the server side, the Vue PACS Server is a multi-tier, multimedia repository for diagnostic images and
related clinical data. The Vue PACS Server includes the following modules:

l Workflow Manager

The Workflow Manager is the main workflow engine of the Vue PACS Server. It provides distributed
storage and workflow management capabilities, automating workflow and data management, and
creating a convenient and efficient working environment for users and administrators. The Workflow
Manager performs the following main activities:

l Manages and processes the workflow

l Captures and stores data sent from modalities and other ologies

l Manages and controls the database

l Manages physical access to the data in the archive

l Manages and handles communication (including DICOM, non-DICOM, XDS, and HL7)

l Manages and controls storage and life cycle management

l Manages access control, permissions, login, and security

l Manages integration with RIS, VNA, and other third-party systems

l Info Router

The Info Router provides flexible and rule-driven data management and auto-forwarding capabilities.

l IS Link

IS Link is a configurable HL7 interface engine that provides seamless integration between Vue PACS
and hospital information systems (HIS), radiology information systems (RIS), and other healthcare
information systems.

AG3110 │ 2019-05-07 3
Server Configurations

Specifically, IS Link provides Vue PACS with patient demographic, visit, and order information, and
enables the retrieval of clinical reports.

Server Configurations
The Workflow Manager can be installed in the following server configurations:

l Single Server—The Workflow Manager is installed on a single server, where both the application and
the database run on the same server.

l Cluster Server—The Workflow Manager is installed in a cluster configuration, which provides increased
availability as the application and database run on different servers. If a server failure occurs, the
remaining server automatically takes over the role of the failed server.

l Standalone Workstation—The Workflow Manager and a single workstation are installed on a single
PC.

In addition to these server configurations, the following options are also available for storage management,
backup, and synchronization purposes:

l Archive Agent—The Archive Agent is installed on a separate server from the Workflow Manager. It
automatically and transparently manages the repository of near-line and offline images stored on tape
libraries, providing cost-effective storage management and archival and retrieval services.

l Cold Spare—In this configuration, an additional server is installed on a separate server from the
Workflow Manager. The cold spare server is not active until a server failure occurs, when it is activated
manually, allowing business continuity.

l Synchronized Workflow Managers—Vue PACS allows synchronization of the Worklist and sharing
patient history between two or more remote PACS sites.

Multi-Site Solutions
Vue Connect can be used to manage patient information regardless of location. It does this by virtualizing
the multi-site or grid environment, where an endless number of sites are treated as one radiology entity for
reading and reporting purposes. In many scenarios these capabilities are achieved regardless of which
third-party RIS, PACS or dictation systems are installed at each of the sites.
Global worklists consisting of studies from any of the participating sites are available to the radiologists
from any location inside or outside the network allowing them to focus on reading and reporting without
knowing or caring about the origin of the data.

AG3110 │ 2019-05-07 4
Vue Administration Tool

Vue Administration Tool

The Vue Administration Tool is the gateway to the user management, system monitoring, system
administration, and system configuration applications.

To log in to the Vue Administration tool

1. In your browser, type the address of the server and press Enter.

2. In the window that opens, click Administration.

The Administration Tool menu appears. From here, you can access the user management, system
monitoring, system administration, and system configuration applications.

The log in procedure is the same for all applications.

3. Click one of the application buttons. The Login window opens.

Note: When you log in for the first time, you are prompted to change your password.

4. In the User box, type your assigned login name.

5. In the Password box, type your password.

6. Click OK to log in.

AG3110 │ 2019-05-07 5
 User and Group Management
If you are an authorized administrator, you can use the User Management Admin tool to define logical
groups of users and define basic group and user details, such as central login criteria. You can also edit the
default system settings (if you have permission to do so) to change the settings for all groups and users.

Note: During installation, one default administrator user is defined to start using the system with the
default settings. Except for the default administrator, account users and groups initially have no
privileges. The system administrator must set these before the system can be used.

You can use the User Management Admin tool for the following activities:

l Add New Users and Groups on page 12

l Define Advanced Settings for Users on page 14

l Define External Applications for Users on page 15

l Edit Settings at the System, Group, and User Levels on page 15

l Delete Users and Groups on page 21

l Define Access Control on page 21

l Modify Permissions on page 26

l Configure Change and Forgot Password URLs on page 39

Get Started with the User Management Admin

Tool
To open the User Management Admin tool, select User Management from the Administration Tool menu.
For more information about the elements in each of the tabs in the User Management Admin tool, see User
Management Admin Tool Tabs on the next page.

Note: The User Management Admin window appears differently depending on whether your system
is using a central MICROSOFT Active Directory server as the user repository (LDAP repository).
When using an LDAP repository, only the Groups tab appears initially, as the user management is
performed outside of the User Management Admin tool. For more information, see Configure the User
Management Repository on page 9.

AG3110 │ 2019-05-07 6
User Management Admin Tool Tabs

User Management Admin Tool Tabs

The User Management Admin tool includes a Users tab, a Groups tab, and a Profiles tab.

Users Tab
In the Users tab you can add, edit, and delete users and define user settings.

Element Description

Login Name The user’s assigned login name.

First Name The user’s first name.

Last Name The user’s last name.

Group Name The group to which the user is assigned by the administrator.

E-Mail The user’s email address.

Last Login Date The date on which the user last logged in to the system.

Password Age The age of the user’s password, in days. This lets you know when it is time for
users to change their passwords (and remind them if necessary).

Status The user’s current status. Possible values are:

l Active – The user is currently active and has access to the system.

l Suspend – The user has attempted to log in several times using incorrect log
in information and is currently blocked from accessing the system. The user
remains locked out until the administrator unlocks the user account.

l Timeout – The user has attempted to log in several times using incorrect log
in information and is currently blocked from accessing the system for the
preconfigured timeout period. The user can either wait for the timeout period
to pass or request to be unlocked by the administrator.

l Expired – The user can no longer access the system. This often indicates
that the user was assigned a temporary role, which allowed access to the
system for a limited time. It is recommended to delete any expired user
accounts from the system.

Note: The Audit Trail uses the user's login ID when recording actions
performed by this user. When a user account is removed from the system,
the system administrator should keep a record (for at least six years) of the
personal identity of the user, so that historical data in the Audit Trail can be
related to that individual.

AG3110 │ 2019-05-07 7
User Management Admin Tool Tabs

Groups Tab
In the Groups tab you can add, edit, and delete groups and define group settings.

Element Description

Group Name The name of the group.

Profile Name The name of the profile associated with the group.
Each profile defines the features a user can use after logging in to the Vue
PACS Client.

Profiles Tab
A profile defines the features a user can use in the Vue PACS Client, where each feature is a licensed
permission.
Each group of users has a profile associated with it, and each group has its own set of permissions.
In the Profiles tab, you can view the licenses and their associated features.

Element Description

Name The name of the profile (license).

Conc. Users The number of users that can use the license.

Current Users The number of users currently using the license.

Expiration Date The expiration date of the license

Version The version number of the license.

Profile Content

Features The features included in the profile.

Feature Properties Tab

Feature Name The name of the feature.

Feature number of The number of licenses associated with this feature. This is set for a particular
licenses feature and overrides the Concurrent Users setting at the profile level.

Dependent Permissions Tab

Dependent Indicates whether this feature is dependent on permissions set at the system
Permissions level.

AG3110 │ 2019-05-07 8
Configure the User Management Repository

Configure the User Management Repository

Before you can start using the User Management Admin tool, you need to perform some initial configuration
activities to set the user management repository where the user information is stored.
The following options are available:

l PACS repository—A local PACS repository. This is the default.

l LDAP repository—A central user management repository, such as MICROSOFT Active Directory
server.

If you are using a central user management repository, you can configure the User Management Admin tool
to look up user information using LDAP (Lightweight Directory Access Protocol).
You can set the LDAP configuration to provide the option to create and manage remote PACS users, such
as technicians and referring physicians that require limited access to the system, as well as using a central
user management repository. These remote PACS users are maintained in a separate domain, without
being added to the Active Directory server.

1. In the User Management Admin tool, do one of the following:

l Click LDAP Settings in the toolbar.

l From the Tools menu, select Edit LDAP Settings.

The LDAP Settings window opens.

2. In the Server Settings section, select LDAP Repository as the authentication repository.

3. If you want to configure the ability to create and manage remote PACS users, select the Allow
authentication (login) of users not in PACS repository check box.

4. In the General tab, do the following:

a. Click Add to add the server name to the User Directory Hosts list. You can add several hosts to
the list and change the order of the host names using the Move Up and Move Down buttons. If
failure occurs when connecting to the first host, a second attempt is made to the next host in
order, and so on until a connection is made.

b. In the User Directory Port box, enter the port. There usually are different ports for secured and
non-secured connections.

c. If the LDAP connection is to be secured (SSL), select the Secured LDAP Connection check
box.

d. In the User Directory Base box, enter the Base DN of the LDAP Server user account.

e. In the Change Password URL box, enter the URL for changing the user password.

f. In the Forgot Password URL box, enter the URL for changing the password when the user
forgets the password.

AG3110 │ 2019-05-07 9
Configure the User Management Repository

5. In the Credentials tab, do the following:

a. Select the Default option button.

b. Set the user bind ID and password to be used for the LDAP pre-authentication stage. This setting
is used for initial authentication to transform the user login name into an LDAP distinguished
name (DN).

OR

If an anonymous bind is to be performed, select the Anonymous Bind check box.

6. In the Users tab, select the following check boxes:

l Auto import of LDAP users after successful first login

l Auto update of LDAP users after successful login

7. In the Groups tab, do the following:

a. Select the Read Security Group from LDAP check box.

b. In the Enter Group Attribute Name box, enter a name for the group attribute.

c. If required, in the Group Prefixes section, click Add to add a group prefix to the group name. Any
group with a group prefix found in the LDAP server should appear without a prefix in the User
Management group list. It should also exist in the User Management application.

8. In the Advanced Settings tab, do the following:

a. From the Search user DN on drop-down list, select Whole subtree starting with Base DN.

b. In the Where objectclass box, type objectclass=*.

c. In the And attribute box, type the unique user identifier attribute name. For Active Directory, this
is sAMAccountName.

d. Select the Build user DN dynamically check box.

9. In the Authentication Result tab, do the following:

a. In the Query page size limit box, enter the page size limit for the LDAP query, for example,
1000 .

b. From the Select LDAP query type drop-down list, select Paged Query or No Paging,
depending on your requirements.

c. From the Select LDAP error code type drop-down list, select Active Directory Error Codes
Only.

10. In the Test LDAP tab, enter your user name and password and click Authenticate to LDAP.

11. If authentication is successful, a success message appears.

If authentication fails, an error message appears. You must then reconfigure the LDAP settings until
the authentication process is successful.

12. Click OK to save your changes and close the window.

AG3110 │ 2019-05-07 10
Filter the Display

13. Restart the system by stopping and then restarting all daemon processes.

Filter the Display

You can filter the results shown in the User Management Admin tool according to criteria that you specify.
The criteria are different and depend on which tab you are in when you click the Filter icon: the Users tab or
the Groups tab.

Filter the Display in the Users Tab

You can filter the results shown in the Users tab according to a number of different criteria.

1. In the User Management Admin tool, from the Users tab, click Filter in the toolbar.

2. In the Set Filters window, enter the desired filter criteria.

3. For more information about each of these filter criteria, see User Management Admin Tool Tabs on
page 7.

4. Click OK. The list of users is updated automatically according to the filter criteria specified. In
addition, the criteria that the list is currently filtered by appear above the relevant column names.

OR

Click Clear to clear existing filter criteria. You can then reset the filter criteria or click OK to close the
window.

Filter the Display in the Groups Tab

You can filter the results shown in the Groups tab according the group name, the profile name, or both.

1. In the Set Filters window, enter the desired filter criteria in the Group Name box, the Profile Name
box, or both.

2. Click OK. The list of groups is updated automatically according to the filter criteria specified. In
addition, the criteria that the list is currently filtered by appear above the relevant column names.

OR

Click Clear to clear existing filter criteria. You can then reset the filter criteria or click OK to close the
window.

Sort the Display

You can sort the results shown in the User Management Admin tool by clicking a column heading. The
results are shown in ascending order. Click the same column heading again to sort the results in
descending order.

AG3110 │ 2019-05-07 11
Refresh the Display

Refresh the Display

Click Refresh to refresh the results shown in the User Management Admin tool. The results in both
the Users tab and the Groups tab are updated with the latest information.
In addition, the results are sorted in ascending order by Group Name (in the Groups tab) and by Login
Name (in the Users tab).

Add New Users and Groups

You add new groups to the system and then add users to these groups. In addition, you can also import
users from the LDAP repository or from a CSV file.

Add a Group
When you add a new group to the system, you need to define the group name, as well as the advanced
settings that are inherited by each user in the group.
All group details are automatically inherited from the system settings unless you modify them at the group
level. Any settings that are modified at the group level override the settings inherited from the system level.

1. In the User Management Admin tool, in the Groups tab, do one of the following:

l Click Add New .

l Select Add New from the Tools menu.

l Right-click in the list and select Add new group.

2. In the Add Group window, fill in the following group details:

l In the Group Name box, type a logical name for the group, for example, radiologists.

l From the Profile Name list, select the relevant profile for this group. If you select NONE, some
features will not be available in the client.

3. In the Add Group window, you can do the following:

l Change the advanced settings that will be inherited by each user in the group. Click Add to add the
group and close the window. For a description of these advanced settings, see Advanced Settings
Window Elements on page 17.

l Click Restore Group Defaults to restore any modified files to the default set for the group.

l Click Cancel to close the window without making changes.

Note: The color of the fields in the Add Group window changes according to their status, as
follows:

AG3110 │ 2019-05-07 12
Add a User

l Yellow indicates that the setting is inherited from the system-level settings.

l White indicates that the value has been modified and is defined at the group level.

Add a User
When you add a new user to the system, you need to define general and login details, such as the user’s
name, the name of the group the user is assigned to, and the user’s login name and password.

1. In the User Management Admin tool, in the Users tab, do one of the following:

l Click Add New .

l Select Add New from the Tools menu.

l Right-click in the list and select Add new user.

2. In the Add User window, fill in the details for the user. Field names in red indicate that the information
is mandatory.

For more information about each of the elements in the Add User window, see Add User and Edit
User Settings Window Elements on page 19.

3. When you have completed the relevant details for a user, click Add to close the window. The new
user appears in the list of users in the User Management Admin tool.

Import Users from the LDAP Repository

If you are using a central user management repository, and you want to change the configuration settings
for a user, you need to import that user into the User Management Admin tool.

1. In the User Management Admin tool, do one of the following:

l On the toolbar, click Import in the toolbar.

l Click Tools > Import.

2. In the Import User From LDAP window, enter the LDAP login name and domain name, and click
Search.

3. Select the user that you want to import and click Import. The selected user appears in the list of users
in the User Management Admin tool.

Import Users from a File

You can import users from a CSV file using the importFromCsv.pl script, located in:
C:\Program Files\Carestream\System5\scripts\
The script contains the following flags:
AddUsersFromCsv -inputfile=<csv users filename> [-outputdir=<directory
name>] [-header]

AG3110 │ 2019-05-07 13
Define Advanced Settings for Users

where:
AddUsersFromCsv – Indicates that the CSV file contains a list of users to import
-inputfile – The name of the file that contains the user information
-outputdir – The location of the log file (optional)
-header – Indicates that the first line contains a comma-separated header
If the input file contains a header, use the -header option to notify the program. The default header contains
the following fields:
last_name,first_name,login,new_password,preferencegroup,domain,
email,user_description,question,answer,group_domain_name,
middle_name,signature_text,title,user_status,is_expired

Note: You can omit columns or leave empty fields, if required.

The password field should be an unencrypted password. If left empty, 12345678 is used.
The user_status and is_expired fields are internal and should be left empty.
If the first character in the line is #, the line is skipped.

Define Advanced Settings for Users

Advanced settings are inherited from the group level, but you can modify them at the user level. Any
settings modified at the user level override the settings inherited from the group level.
You define advanced settings for a user when you add the user to the system, or later on by editing the
user's settings.

1. In the Add User window or Edit User Settings window, click Advanced Options.

2. In the User Advanced Settings window, you can do the following:

l Change the settings and click OK.

For a description of these advanced settings, see Advanced Settings Window Elements on
page 17.

l Click Restore Group Defaults to restore any modified files to the default set for the group, and
click OK.

l Click Cancel to close the window without making changes.

Note: The color of the fields in the User Advanced Settings window changes according to their
status, as follows:

l Yellow indicates that the setting is inherited from the group-level settings.

l White indicates that the value has been modified and is defined at the user level.

AG3110 │ 2019-05-07 14
Define External Applications for Users

Define External Applications for Users

You can define a user’s access to external applications, such as RIS or a voice dictation system, so that
the user can access the system with a user name and password that is different from that used for the
central log in.
This option applies only to Vue PACS Client users. It allows them to access the external system without
logging in again, because the login information is automatically refreshed from the User Management
Admin Tool.
You define a user’s access to external applications when you add the user to the system, or later on by
editing the user's settings.

Note: It is not necessary to complete the RIS field when using IS Link as the RIS interface.

1. In the Add User window or Edit User Settings window, click External Applications.

2. In the External Applications Settings window, fill in the required user name and password in each of
the relevant fields. Re-enter the password to confirm it.

Possible options are:

l Report—The user name and password of the user in dictation applications, such as
POWERSCRIBE.

l RIS—The user name and password of the user in desktop integration with RIS.

l RIS ID—The user name field contains the identification of the user (for example – NPI). This is not
the user name of the user.

l Speech Magic—The user name and password of the user in the SPEECHMAGIC application
(used for voice recognition).

3. Click OK to close the window.

Edit Settings at the System, Group, and User

Levels
The User Management Admin Tool uses a hierarchical structure of settings at the system, group, and user
levels. Each group automatically inherits the default system settings and each user automatically inherits
the relevant group settings.
You can override the inherited settings by modifying the values defined for a specific group or user. Any
unmodified values remain as is, according to the inherited default system settings.

Modify the System Settings

You can modify the default system settings that were defined during installation.
The system settings are automatically inherited by the groups and users that you add to the system. You
can override the inherited system-level settings at the group level or the user level.

AG3110 │ 2019-05-07 15
Edit Settings at the System, Group, and User Levels

1. In the User Management Admin tool, do one of the following:

l In the toolbar, click Edit System Settings .

l Click Tools > Edit System Settings.

2. In the Edit System Settings window, you can do the following:

l Change the settings and click OK.

For a description of these advanced settings, see Advanced Settings Window Elements on the
next page.

l Click Cancel to close the window without making changes.

Note: The Edit System Settings window appears differently depending on whether your system
is using LDAP. The options in the Edit System Settings window (with LDAP) are the same as
those in the Add Group window except for the Allowed Applications options, which are not
relevant at the system level.

Edit Group Settings

You can modify the advanced settings that are inherited by each user in the group.

1. In the User Management Admin tool, in the Groups tab, do one of the following:

l Click Edit selected .

l Double-click a group in the list.

l Click Tools > Edit selected.

l Right-click in the list and select Group properties.

2. In the Edit Group Settings window, click Group Permissions.

Note: The Edit Group Settings window appears differently depending on whether your system
is using LDAP.

In addition, the color of the fields changes according to their status, as follows:

l Yellow indicates that the setting is inherited from the system-level settings.

l White indicates that the value has been modified and is defined at the group level.

AG3110 │ 2019-05-07 16
Edit Settings at the System, Group, and User Levels

Edit User Settings

You can edit a user’s settings, including the general details, login details, and any other advanced settings.

1. In the User Management Admin tool, in the Groups tab, do one of the following:

l Click Edit selected .

l Double-click a group in the list.

l Click Tools > Edit selected.

l Right-click in the list and select User properties.

2. In the Edit User Settings window, fill in the details for the user. Field names in red indicate that the
information is mandatory.

For more information about each of the elements in the Edit User Settings window, see Add User
and Edit User Settings Window Elements on page 19.

3. Click OK to close the window.

Advanced Settings Window Elements

The following settings windows include a number of common elements that are described in the table
below:

l Add Group

l User Advanced Settings

l Edit System Settings

l Edit Group Settings

Element Description

Password Syntax Settings

Minimum password The minimum number of characters required for each user’s password.
length

Maximum password The maximum number of characters allowed for each user’s password.
length

Minimum numeric The minimum number of numeric characters required for each user’s password.
chars

Maximum consecutive The maximum number of identical characters allowed in each user’s password.
chars

Minimum upper case The minimum number of upper case characters required for each user’s
chars password.

AG3110 │ 2019-05-07 17
Edit Settings at the System, Group, and User Levels

Element Description

Maximum special The maximum number of special characters allowed in each user’s password.
chars

General Settings

Identical password The number of passwords that cannot be identical. This prevents the user from
check using a password that is identical to the previous [x] number of passwords
used. For example, if you enter 3, then the user can only use a password if it
was not used as one of the last three passwords.

Password never Select if the password never needs to be changed.

expires

Password expires Select if the password needs to be changed after a set number of days. When
after (days) the limit is reached, users receive a message that their password has expired
and must be changed. You can set the number of days in the adjacent text box.

Password Failures Settings

Allowed number of The number of times a user can enter an incorrect password before being
password failures locked out or suspended.

Lock user Select to lock the user and prevent access to the system when the limit for
entering the incorrect password is exceeded.

Suspend user Select to suspend the user for a defined number of minutes when the limit for
entering the incorrect password is exceeded.

Duration in minutes The amount of time in minutes that the user is suspended when the limit for
entering the incorrect password is exceeded.

Application Settings

CD-Direct Click to open the User Default Burner window, in which you can select the
default burner for that user or group.

Access Control Click to open the Access Control window, in which you can assign restrictions
at the user, group, or node level. For more information, see Assign Restrictions
Based on DICOM Tags on page 21.
Appears in the Add Group, User Advanced Settings, and Edit Group
Settings windows.

Permission Settings

System Permissions Click to open the System Permission Settings window. For more information,
see Modify Permissions on page 26.
Appears in the Edit System Settings window.

AG3110 │ 2019-05-07 18
Edit Settings at the System, Group, and User Levels

Element Description

Group Permissions Click to open the Group Permission Settings window. For more information,
see Modify Permissions on page 26.
Appears in the Add Group and Edit Group Settings windows.

Add User and Edit User Settings Window Elements

The Add User and Edit User Settings windows include a number of common elements that are described in
the table below:
The following table lists the elements that appear in the Add User window and the Edit User Settings
window.

Element Description

User General Details

Last Name The user’s last name. Mandatory field.

First Name The user’s first name. Mandatory field.

Description A textual description relating to the user.

Group The group the user is assigned to. Mandatory field.

E-Mail The user’s email address.

Profile The profile assigned to the user. This is assigned automatically when the user
is assigned to a group. Mandatory field.

Middle Name The user’s middle name.

Title The user’s title.

Signature Text The signature text that is used to sign reports.

Site ID The site where the user is located.

User Login Details

Login Name The user’s assigned log in name.

Domain The domain that the user is assigned to.

Password A temporary password assigned to the user for the first log in.

Confirm Password Confirmation of the password assigned to the user for the first log in.

AG3110 │ 2019-05-07 19
Edit Settings at the System, Group, and User Levels

Element Description

Recovery Question A question that is asked if the user forgets the assigned password. This
information must be obtained from the user.

Note: If a user forgets his or her password and the recovery question is not
defined, the user must request a new password from the administrator.

Recovery Answer The answer to the recovery question. This information must be obtained from
the user.

User must change Select the first time you enter a user’s details when you assign a temporary
password with next password to the user. The user must then change the password at the first log
login in.
This option is selected  by default.

Other Options

Advanced Options Click to open the User Advanced Settings window. For more information,
see Define Advanced Settings for Users on page 14.

External Applications Click to open the External Applications Settings window. For more
information, see Define External Applications for Users on page 15.

Additional Properties Click to open the User Additional Properties window in which you can
allocate a physician ID to the user.

Permission Settings

User Permissions Click to open the User Permission Settings window. For more information,
see Modify Permissions on page 26.

User Cards Click to open the User Cards Settings window in which you can enter the
smart card ID for a user.

User Status

User Active Select to indicate that the user is active and has permission to access and use
the system.

User Locked Select to indicate that the user is not active and does not have permission to
access and use the system.

Note: This is the manual method for locking or unlocking a user. A locked
user is only allowed back into the system after intervention by a
system/group administrator or group operator.

Buttons

AG3110 │ 2019-05-07 20
Delete Users and Groups

Element Description

Add (Add User Click to add the user and close the window.
window)

OK (Edit User Settings Click to save the changes and close the window.
window)

Cancel Click to close the window without saving changes.

Delete Users and Groups

You can delete users and groups from the system if your assigned role gives you permission to do so. It is
recommended to delete users who no longer need to be in the system, for example, users that were
assigned a temporary role and now have Expired status.
Note: The Audit Trail uses the user's login ID when recording actions performed by this user. When a user
account is removed from the system, you should keep a record (for at least 6 years) of the personal identity
of the user, so that historical data in the Audit Trail can be related to that individual.
The following steps describe how to delete a user from the Users tab. You can use the same steps to
delete a group from the Groups tab.

1. In the User Management Admin tool, in the Users tab, do one of the following:

l Select the user and click Delete .

l Click Tools > Delete Selected.

l Right-click the user and select Delete Selected Users.

2. In the Delete Selected User window, click OK. The user is removed from the system and is no
longer displayed.

Define Access Control

You can use access control to define the exact access users have to various types of data, and to prevent
them from accessing restricted data. There are two ways to define access control:

l Using DICOM tags, such as the modality and body part—see Assign Restrictions Based on DICOM
Tags below

l Using general system information, such as user's site and department – see Assign Restrictions Based
on General System Information on page 24

Assign Restrictions Based on DICOM Tags

You can restrict user access to Workflow Manager data by assigning restrictions at the user, group, or
node level. Then, when a user logs in and requests data, the system automatically checks for restrictions.

AG3110 │ 2019-05-07 21
Assign Restrictions Based on DICOM Tags

A restriction is a combination of the following items:

l Tag—The type of DICOM data that is limited, for example, modality type or body part.

l Value—The value for the specific DICOM tag.

For user-level restrictions, each user must be assigned to a group.

Group-level restrictions are applicable to all users in the group. For example, you can define a CT group and
an MRI group and assign a restriction for each group. This limits the groups to view only CT images or only
MRI images. You can then assign a specific user to the required group without having to configure specific
restrictions for each individual user.
You can use OR and AND operators to add more than one restriction at a time.

Assign a Restriction
You assign restrictions in the Access Control window, either when adding a new user or group, or by
editing an existing user or group. To open the Access Control window, click the Access Control button in
the User Advanced Settings window or the Edit Group Settings window.
The following steps show how to assign a restriction at the user level. You can use the same procedure to
assign a restriction at the group level from the Edit Group Settings window.

1. In the User Management Admin tool, in the Users tab, select the user to assign the restriction to, and
then do one of the following:

l Click Edit selected .

l Double-click a user in the list.

l Click Tools > Edit selected.

l Right-click in the list and select User properties.

2. In the Edit User Settings window, click Access Control.

3. In the Access Control window, do one of the following:

l From the Access Control toolbar, click Add Restriction .

l From the Edit menu, select Add Restriction.

l Right-click in the Tag/Value pane and select Add Restriction.

4. In the Add Tag Restriction window, do the following:

l From the Tag drop-down list, select the DICOM tag for the Workflow Manager data that you want
to restrict.

l In the Value field, enter the value for the selected tag.

Note: You can add more than one restriction by inserting a backslash (\) between each value. For
example, 1\2 allows the user to access studies from site 1 or 2 only.

AG3110 │ 2019-05-07 22
Assign Restrictions Based on DICOM Tags

5. Click OK. The new access control settings appear in the Tag/Value pane.

6. Repeat steps 3-5 to add additional restrictions to the same user, if required.

7. Click Save .

Update a Restriction
You can update existing restrictions in the Access Control window. For example, you can change the type
of data that is limited or you can add additional values to an existing restriction tag. To open the Access
Control window, click the Access Control button in the User Advanced Settings window or the Edit
Group Settings window.
The following steps show how to update a restriction at the group level. You can use the same procedure to
update a restriction at the user level from the User Advanced Settings window.

1. In the User Management Admin tool, in the Groups tab, select the group to update the restriction for,
and then do one of the following:

l Click Edit selected .

l Double-click a group in the list.

l Click Tools > Edit selected.

l Right-click in the list and select Group properties.

2. In the Edit User Settings window, click Access Control. The Access Control window opens for the
selected group, showing any restrictions that have been defined.

3. Select the restriction to update and then do one of the following:

l From the Access Control toolbar, click Update Restriction .

l Click Edit > Update Restriction.

l Right-click the restriction and select Update Restriction.

4. In the Update Tag Restriction window, do either or both of the following:

l From the Tag drop-down list, select a different tag for the Workflow Manager data that you want to
restrict.

l In the Value field, enter the value for the new tag or a different value for the existing tag.

5. Click OK. The updated restriction is displayed in the Tag/Value pane.

6. Click Save .

Remove a Restriction
You can remove a restriction from a user or group in the Access Control window. To open the Access
Control window, click the Access Control button in the User Advanced Settings window or the Edit
Group Settings window.

AG3110 │ 2019-05-07 23
Assign Restrictions Based on General System Information

The following steps show how to update a restriction at the group level. You can use the same procedure to
update a restriction at the user level from the User Advanced Settings window.

1. In the User Management Admin tool, in the Groups tab, select the group to remove the restriction
from, and then do one of the following:

l Click Edit selected .

l Double-click a group in the list.

l Click Tools > Edit selected.

l Right-click in the list and select Group properties.

2. In the Edit Group Settings window, click Access Control. The Access Control window opens for
the selected group, showing any restrictions that have been defined.

3. Select the restriction to remove and then do one of the following:

l From the Access Control toolbar, click Remove Restriction .

l Click Edit > Remove Restriction.

l Right-click the restriction and select Remove Restriction/Node.

The selected restriction is removed from the Tag/Value pane.

4. Click Save .

Assign Restrictions Based on General System Information

You can restrict user access to various types of data, including:

l Worklist items

l Documents

l Orders

l Patients

l Studies

l Security groups

Depending on the type of data you want to restrict access to, you can define view and manage access
control according to the following criteria:

l Site

l Subspecialty

l Modality

l Group

AG3110 │ 2019-05-07 24
Assign Restrictions Based on General System Information

l Department

l Stakeholder

l Data type

l Confidentiality

View access rights mean that users can search for and view items; manage access rights mean that
users can perform other actions, such as create, edit, and delete items.
For example, you can use access control to restrict user access to only those worklist items that are from a
specific site, subspecialty, or modality. In this case, you define Manage access control for Worklist
Items.
You can also define break glass access control so that users can gain temporary access to any data in the
following categories (not just their own patients' data):

l Documents

l Orders

l Patients

l Studies

To define access control:

The following steps show how to define access control at the user level. In this example, manage access
control for orders is defined. This means that users will only be able to perform actions on orders from their
own site.
You can use the same procedure to define access control at the group level and system levels. User-level
access control overrides that of group and system levels.

1. In the User Management Admin tool, on the Users tab, double-click the relevant user.

2. In the Edit User Settings window, click User Permissions. The User Permission Settings window
opens.

3. In the tree on the left, scroll down to Access Control. Select Orders.

4. Select the Manage check box and click Custom.

5. In the Access Control: Documents - Manage window, in the Site section, select One of and click
Add.

6. Select a site from the drop-down list. In this example, My site is selected.

7. Click Add.

8. Click OK twice to close the windows.

AG3110 │ 2019-05-07 25
Modify Permissions

Modify Permissions
A profile defines the features a user can use in Vue PACS , where each feature is a licensed permission.
Permissions can be configured at the system, group, or user level, where each level overrides the
preceding level.

Modify System Permissions

System permissions are automatically inherited by any groups and users that you add to the system. You
can modify the default system permissions that were defined during installation, or override them at the
group level or user level.

1. In the User Management Admin tool, do one of the following:

l Click Edit System Settings in the toolbar.

l Click Tools > Edit System Settings.

2. In the Edit System Settings window, click System Permissions.

3. In the System Permission Settings window, select the relevant permission and then select the
relevant feature check boxes in the right pane. Repeat this action for all relevant permissions.

4. Click OK to close the window.

See Permissions on the next page for more information about each of the permissions.

Modify Group Permissions

1. In the User Management Admin tool, in the Groups tab, do one of the following:

l Click Edit selected .

l Double-click a group in the list.

l Click Tools > Edit selected.

l Right-click in the list and select Group properties.

2. In the Edit Group Settings window, click Group Permissions.

3. In the Group Permission Settings window, select the relevant permission, and then select the
relevant feature check boxes in the right pane. Repeat this action for all relevant permissions.

4. Click OK to close the window.

See Permissions on the next page for more information about each of the permissions.

Modifying User Permissions

1. In the User Management Admin tool, in the Users tab, do one of the following:

AG3110 │ 2019-05-07 26
Permissions

l Click Edit selected .

l Double-click a user in the list.

l Click Tools > Edit selected.

l Right-click in the list and select Group properties.

2. In the Edit Group Settings window, click User Permissions.

3. In the User Permission Settings window, select the relevant permission and then select the relevant
feature check boxes in the right pane. Repeat this action for all relevant permissions.

4. Click OK to close the window.

See Permissions below for more information about each of the permissions.

Permissions

Image Manipulation
Permission Description

Export Data

Copy Images Allows users to copy images from the local archive to a foreign archive.

Burn Images Allows users to burn images to a CD.

Print Images Allows users to print images. Options are:

l DICOM Printer - Users can print images to a DICOM printer.

l Network Printer - Users can print images to a network printer.

l Auto Printing - Marks if the PACS is a standalone printing station (it is

defined during installation and cannot be enabled otherwise).

Save Images Allows users to save images. Options are:

l Save to Local - Users can save data to a local disk.

l Save to Server - Users can save data to a server.

Update Data

Allow editing patient & Allows users to edit patient and study details. Applies to any update of patient
study details and study details, both in the Archive Explorer (editable fields) and in the
Administrator tool (such as update, merge/split, and RIS Sync).
Select Custom fields only or Custom and System fields.

Allow deletion of Allows users to delete images and reports. Applies to deletions from the Vue
images & reports PACS Client or from the Administration tool.

AG3110 │ 2019-05-07 27
Permissions

Permission Description

Web Admin Tool Permissions

Update study details Allows users to update exam details in the Web Administration tool.

Allow study Move & Allows users move, split, and duplicate exams in the Web Administration tool.
Duplicate

Allow Study UID Allows users to change an exam's unique identifier in the Web Administration
Generation tool.

Allow Creation and Allows users to create and update patients in the Web Administration tool.
Updating of Patients

Allow Merging Allows users to merge patients in the Web Administration tool. Only relevant if
Patients the Allow Creation and Updating of Patients check box is selected.

Allow Manual Linking Allows users to link patients manually in the Web Administration tool.
Patients

Allow eMPI Patients Allows users to link patients using eMPI suggestions.
Linking

Workflow
Permission Description

Reading Flow

Allow Viewing Reports Allows users to view reports. If selected, the R and O icons in the Patient Mini-
Archive are enabled and the Reports button is enabled in the Archive Explorer
and the Viewer.
By default, this permission applies to all users in the Radiologists group.

Allow Reading Allows users to read exams. Options are:

Permissions
l Allow Study Status Changes—Allows users to move studies from one status
to another when clicking Done, and to lock a study. If permission is not
granted, the user returns to the Archive Explorer when clicking Done.

l Allow Dictation Permission—Allows users to dictate a report.

l Allow Saving Reports—Allows users to save reports automatically

generated in Vue PACS applications, such as Calcium Scoring and Vessel
Analysis.

l Allow Creating Critical Result Notification—Allows users to create a critical

result notification.

By default, these permissions apply to all users in the Radiologists group.

AG3110 │ 2019-05-07 28
Permissions

Permission Description

Allow Marking Key Allows users to mark images as key images. Only users with reading
Images permissions can be assigned this permission.
By default, this permission applies to all users in the Radiologists group.

Note: The permission to mark key images does not necessarily mean that
the user has Save permissions. Users who do not have Save to Server
permission can still mark key images.

Allow Marking Allows users to mark images as a significant series. Only users with reading
Significant Series permissions can be assigned this permission.
By default, this permission applies to all users in the Radiologists group.

Allow Unmarking Allows users to unmark images that were previously marked as a significant
Significant Series series. Only users with reading permissions can be assigned this permission.
By default, this permission applies to all users in the Radiologists group.

Allow Updating Allows users to update the critical result status of a study. Only users with
Critical Result Status reading permissions can be assigned this permission.
By default, this permission applies to all users in the Radiologists group.

Sticky Notes Allows users to use sticky notes. Permission levels are:
l None

l View Only

l View, Add

l View, Add, Edit, Delete user’s own

l View, Add, Edit, Delete (no restriction)

Teaching Files The levels of permission for teaching files:

l None

l View Only

l View, Add, Edit, Delete user’s own

l View, Add, Edit, Delete (no restriction)

Allow Modifying Allows users to modify a teaching file form.

Teaching File Forms

Bookmarks Allows users to use bookmarks. Permission levels are:

l View Only

l View, Add, Edit, Delete (no restriction)

AG3110 │ 2019-05-07 29
Permissions

Permission Description

Folder Creation/Deletion

Regular Folders Allows users to create and delete regular folders. Select the Private or Public
option button.

Worklist Folders Allows users to create and delete Worklist folders. Select the Private or Public
option button.

Teaching Folders Allows users to create and delete Teaching folders. Select the Private or
Public option button.

Allow Saving of Allows users to save the default folder settings.

Default Folder
Settings

DP and Save Presentation

DP Creation Allows users to create, edit, and delete user, group, and system display
Permissions protocols (DPs) by using Save As and the DP Editor. Also allows use of the DP
repair tool. Can be applied only to users who have permission to create, edit,
and delete system display protocols using the DP Editor.
By default, this permission is applied to any user defined in the System
Administrators group.

Save Presentation Allows users to create, edit, and delete presentations for a study.
Permissions
By default, this permission is applied to any user defined in the Radiologists
group.

URL and Action Buttons

Allow viewing Allows users to change a study after the URL activation is invoked (launch
additional studies after Archive Explorer and select a different study).
URL activation
Note: The permission to allow URL activation is included under
Application Access permissions.

Default Action Button Allows users to activate a specific action button that is configured on site (for
Permissions example, the ORTHOVIEW action button triggering the integration with the
ORTHOVIEW application). Possible values are Allow or Not Allow.

Other Permissions

Allow login as another Allows users to log in to the client as another user.
user to CS Client

Allow Clearing Studies Allows users to clear studies from the local drive.
from Local Drive

AG3110 │ 2019-05-07 30
Permissions

Permission Description

Allow Pushing Studies Allows users to push studies to other users.

to Other Users than
Myself

Allow modifying My Allows users to modify My Tab, right-click menu and shortcuts.
Tab, right-click menu
and shortcuts

Allow Manual Allows users to manually change the radiologist assigned to read an exam.
Assignments

Allow Quality Allows users to manually assign a radiologist to peer review an exam. This is
Assignments relevant only when the Orchestrator’s Quality module is activated.

Non-DICOM

Allow Access to the Allows users to allow access to the following cases for non-DICOM images:
following sites
l User’s site cases

l Specific cases—Select the site where the user can access specific cases

l All cases

Multi-node/Site
Permission Description

Access to Foreign Archives

<remote server> Allows users to read, write and delete images to/from the configured remote
servers.

Default Device Allows users to read, write and delete images to/from the default device.
Permissions

Allow Global Access Allows users for global access to patient history.
For Patient History

Global Delete

Allow Synchronization Allows users to synchronize images and reports deleted from the configured
of Images/Reports sites.
deletions with the
following site-ids

AG3110 │ 2019-05-07 31
Permissions

Reporting Permissions
Element Description

Reporting Workflow

Allow update and Allows users to update and redistribute reports.

redistribute report

Allow Integrated Allows users to perform integrated reporting. Options are:

Reporting
l For radiologists:

l Speech Recognition

l Dictation Only

l Typing Only

l For transcriptionists:

l Transcription

Allow Signing Without Allows users to sign a report without a password.

Password

Allow Addendum Allows users to create addendums. You can also allow a user to create an
Creation addendum for another user’s report.

Allow Signing Other Allows users to sign another user’s draft report.
User’s Draft Reports

Allow Report Creation Allows users to create a report without an associated study.
Without Study

Allow Batch Signing Allows users to batch sign a number of reports. You can also allow a user to
batch sign for another user’s reports.

Allow Digital Signature Allows users to sign another user’s report.

for Other User’s
Report

Allow Loading Images Allows users to load images to a report.

Allow Web Reporting Allows users to perform reporting from Vue Motion. You can also allow a user
to approve reports from Vue Motion.

Template Editing

Allow Templates/Auto- Allows users to create templates and auto-texts. Select the User, Group, or
Texts Creation System option.

AG3110 │ 2019-05-07 32
Permissions

Element Description

Allow Changing The Allows users to change the default template.

System Default
Template

Allow Changing The Allows users to change the addendum template.

System Addendum
Template

Allow Changing The Allows users to change the master template.

System Master
Template

Speech Recognition

Allow adding and Allows users to add and remove words for all users.
removing words for all
users

Application Access
Permission Description

<application> Allows users to access the following applications:

l Vue PACS Client

l Vue PACS Client via URL activation

l Vue PACS Client via COM interface

l Vue Motion

l MyVue

l Vue Explorer

l Worklist Orchestrator

l CD-Direct

l Data Import Tool

l System Configuration

l System Administration

l System Monitoring

l User Management Admin

l Central Configuration

AG3110 │ 2019-05-07 33
Permissions

Application Settings
Permission Description

Allow UI & Viewing Allows users to access the user interface and viewing settings. Select the
Settings User, Group, or System option.

Allow True Size Allows users to perform true size calibration.

Calibration

Allow Printing Allows users to perform printing calibration.

Calibration

Allow Reports & 3rd Allows users to generate reports and access third-party settings.
Party Settings

CD Monitoring
Permission Description

Allow updating user’s Allows users to update a user’s queued burn requests.
burn requests in queue

Allow updating CD- Allows users to update the CD-Direct settings.

Direct settings

User/Patient Account Management

Permission Description

General User Management

Allow add/edit/delete Allows users to add, edit, and delete users. Select the Group or System
users option.

Allow resetting user’s Allows users to reset user passwords. Select the Group or System option.
passwords

Web User Management

Allowed Actions Defines the allowed actions for Web users. Options are:
l None

l Create, Edit Only

l Create, Edit, Delete

Share exams with Allows users to share exams with other Web users.
‘Other’ Web Users

Other UM Permissions

AG3110 │ 2019-05-07 34
Permissions

Permission Description

Allow create new Allows users to create new groups.Permission to share exams with other Web
groups users.

Allow edit Allows users to edit user and group permissions.

Users\Groups
permissions

Allow edit the LDAP Allows users to LDAP and system settings.
and system settings

Vue Motion
Permission Description

Save to Local Allows users to save studies to a local directory.

Send Study Allows users to send a study.

Allow Viewing Reports Allows users to view reports.

Print Reports Allows users to print reports. Only relevant if the Allow Viewing Reports check
box is selected.

Free Search Allows users to perform a free search on studies.

Advanced Viewer Allows users to use the Advanced Viewer.

Allow viewing Allows users to view additional studies after URL activation.
additional studies after
URL activation

Vue Motion 3D Allows users to perform 3D renditions in Vue Motion.

renditions

Sticky Notes Allows users to use sticky notes in Vue Motion. Permission levels are:
l None

l View Only

l View, Add

l View, Add, Edit, Delete user’s own

l View, Add, Edit, Delete (no restriction)

Allow viewing DICOM Allows users to view the DICOM tags of images in View Motion.
tags

AG3110 │ 2019-05-07 35
Permissions

MyVue
You can set permissions for users, patients, and guest users, as follows:

l For individual users—select a user on the Users tab. Only radiologists (or non-guest doctors) are granted
permissions via the Users tab.

l For patient users—select Web_patients on the Groups tab

l For guest users—select Web_others on the Groups tab Permissions

Permission Description

MyVue Allows users or groups to use MyVue.

Share Data Allows users to share data from MyVue.

Save to Local Allows users to save an exam. If not selected, the Save icon does not appear.

Allow Viewing Reports Allows users to view reports. If not selected, the Patient Report pane displays
a notification: "No authorization to view reports."

Print Reports Allows users to print locally. Only relevant if the Allow Viewing Reports check
box is selected.

Explorer Portal
Permission Description

Acquisition Portal

Allow Non-DICOM Allows users to upload still images, videos, documents and other non-DICOM
import via Acquisition files originating from a medical device. Must be selected to enable the Acquire
Portal Non-DICOM menu option in the Acquire menu bar.

Allow DICOM import Allows users to upload DICOM files. Must be selected to enable the Acquire
via Acquisition Portal DICOM menu option in the Acquire menu bar.

Allow study de- Allows users to remove a patient's identifying information when copying and
identification via burning exams, series, and images. Only available if you select the Allow
Acquisition Portal DICOM import option,

Data Share

Share exams with Allows users to share exams with other users. These users can be guest users
'Other' web users or users that are already registered in the system.

Allow permanent Allows users to use an access code to view exams that have been shared with
access to exams by them using a public code. This is known as sharing using a public code.
code

Order Management Portal

AG3110 │ 2019-05-07 36
Permissions

Permission Description

Allow creation and Allows users to create an order.

updating of orders

Allow changing of Allows users to change the status of an order.

order status

Allow management of Allows users to create and update the list of referring physicians in the
referring physicians Referring Physicians lookup table.
lookup table

Spooler

View Spooler Allows users to view progress of only their own operations or of operations
performed by all users.

Analytics
Permission Description

Allow Report Analytics Allows users to perform concept searches using the Report Analytics tool. If
selected, the Research folder appears in the folder pane. The administrator can
also restrict the reports visible in Vue Archive by site ID and confidentiality
code. This requires Manage access control for Orders.

Communications
Permission Description

Allow alert creation Allows users to create alerts.

Allow chat Allows users to use chat.

Allow link sharing Allows users to share links.

Worklist Orchestrator
Permission Description

Reading

Allow to mark a case Allows users to mark a case as high priority.

as hotline

Shifts Select the reading shifts from which radiologists can read exams. The first shift
that you add is automatically set as the default shift. To select a different shift
as default, select it in the Selected Shifts list and click Set Default.

AG3110 │ 2019-05-07 37
Permissions

Permission Description

Site affiliation Select the site affiliations of the radiologist. The first site that you add is
automatically set as the default site. To select a different site as default, select
it in the Selected Site Affiliation list and click Set Default.

Subspecialties Select the subspecialties of the radiologist. The first subspecialty that you add
is automatically set as the default subspecialty. To select a different
subspecialty as default, select it in the Selected Subspecialties list and click
Set Default.

Medical roles Select the medical roles of the radiologist. The first medical role that you add is
automatically set as the default medical role. To select a different medical role
as default, select it in the Selected Medical Roles list and click Set Default.

Quality

Allow rejecting peer Allows users to reject assigned peer review items.
review Worklist items

Allow Quality Allows users to act as moderators for quality review.

Arbitration

Shifts Select the quality shifts from which radiologists can perform quality reviews.
The first shift that you add is automatically set as the default shift. To select a
different shift as default, select it in the Selected Shifts list and click Set
Default.

Administration

Allow worklist item Allows administrator users to manually explore worklist items that are related
exploring to a specific study. If selected, the Explore Worklist Items button appears in
the Archive Explorer.

Allow manual worklist Allows administrator users to create, delete, relocate, and recalculate worklist
item management items. If selected, the following options appear in the Archive Explorer:
l Show in Worklist

l Hide from Worklist

l Move to Worklist

l Set as Handled

Allow worklist item Allows administrator users to manually unlock worklist items. If selected, the
lock change Unlock option appears in the Archive Explorer.

Shifts Select the Administration shifts from which administrator users can perform
administrative tasks. The first shift that you add is automatically set as the
default shift. To select a different shift as default, select it in the Selected
Shifts list and click Set Default.

AG3110 │ 2019-05-07 38
Configure Change and Forgot Password URLs

Configure Change and Forgot Password URLs

You configure the change and forgot password URLs in the Central Configuration Editor.
The URLs contain the following configurable elements:

l The protocol—Can be HTTPS or HTTP. The default is HTTPS. If set to HTTP, the protocol depends on
that of the user. If the user enters using HTTPS, it remains secured.

l The IP—Can be $IP$, where the IP value is taken from the URL entered by the user, or a specific IP
value. If the IP is static, the server name used is irrelevant because the change password URL opens
with the predefined IP address.

To set the change and forgot password URLs

1. In the Central Configuration Editor, go to:

imaginet/system/applications/securitymanager/preferences

2. Set the following attributes:

Attribute Value

change_password_url The change password URL. The default value is:

https://$IP$/um/ChangePassword.jsp

forgot_password_url The forgot password URL. The default value is:

https://$IP$/um/ForgotPassword.jsp

3. Save your changes.

AG3110 │ 2019-05-07 39
 System Configuration
You can use the System Configuration tool to configure and tune the system according to your site’s
requirements. Proper configuration enhances system performance and saves time and resources.
You can use the System Configuration tool for the following activities:

l Get Started with the System Configuration Tool below

l Configure Devices on the next page

l Update the Workflow Manager Node Configuration on page 50

l Configure the Workflow Manager on page 57

l Configure IS Link on page 75

l Configure HL7-PACS Field Mapping on page 84

l Configure Logging of HL7 Messages in the Audit Trail Viewer on page 90

l Configure the Info Router on page 91

l Configure RIS Synchronization on page 97

l Configure Life Cycle Management on page 98

l Configure Patient Matching Rules on page 103

l Configure a Disk Folder on a Local PACS Server on page 105

Get Started with the System Configuration Tool

To open the System Configuration tool, select System Configuration from the Administration Tool menu.
The System Configuration tool opens, showing the configuration options in the left pane.

Image Storage Wizard

You can use the Image Storage Wizard to guide you through some of the Workflow Manager configuration
activities. The wizard includes steps for each of the following activities:

l Configure DICOM Parsing Rules on page 58

l Configure Initial Values on page 73

l Enable RIS Synchronization on page 97

l Configure Study Grouping Rules on page 63

AG3110 │ 2019-05-07 40
Save Your Changes

l Configure Patient Matching Rules on page 103

l Configure Compression Settings on page 70

l Configure Icons Settings on page 70

To access the wizard, in the System Configuration tool, select Configuration Options > Workflow
Configuration > Image Storage Wizard.
Each of the steps that appears in the wizard can be accessed separately from Configuration Options >
Application Configuration. The steps can be navigated using the Next and Back buttons. Refer to the
relevant section for more information.

Save Your Changes

When you have made changes in the System Configuration tool, you need to save the changes and restart
the affected services.
When you finish setting configuration parameters, the Save Operation window opens, showing the
changes made and the restart options. Both services and processes can be restarted. You can choose to
restart immediately or on exit.

Configure Devices
Medical imaging applications and devices connected to a hospital network usually exchange information
using the DICOM protocol. Each of these devices is known as an application entity (AE) and each
application entity has its own unique name, known as an AE title.
Devices that communicate using the DICOM protocol are also known as DICOM nodes or DICOM peers.
When you configure devices in your network, you must define their static IP address and port, so that the
devices can communicate. You can also define additional optional settings depending on the type of
device.
The following figure illustrates a typical hospital network, where modalities, a workstation and a DICOM
archive are connected to the Workflow Manager.

AG3110 │ 2019-05-07 41
Configure Modalities

In the System Configuration tool, you use the Nodes Configuration option to configure the following
devices:

l Modality

l DICOM printer

l DICOM archive

l Workstation

l Reporting

l Remote Web portal

Configure Modalities
You can configure modalities in one of two ways:

l When you have a large number of modalities to configure, for example, when you set up a new hospital
network with 500 modalities, you can set the allowed net addresses that the Workflow Manager can
receive.For example, all modalities with an IP that starts with 192.168 can send DICOM images to the
Workflow Manager.

l When you have a single or small number of modalities to configure, for example, when an
already-configured modality is not working properly and you would like to configure it manually, or when
you add a new modality to the network with a network that you do not wish to allow.

Configure a Large Number of Modalities

When you have a large number of modalities to configure, use the Allowed Net option to set the allowed net
addresses from which the Workflow Manager can receive DICOM images.
For more information, see Specify Allowed and Forbidden Hosts on page 51.

Configure a Single Modality

1. In the left pane of the System Configuration tool, go to Nodes Configuration.

2. Do one of the following:

l In the right pane, select Modality and click Create Device.

l Right-click Nodes Configuration and select Add.

3. In the Add New Device window, enter values for the following mandatory fields:

l Node Name

l IP

l Issuer

4. Click Add.The new modality appears in the left pane under the Modalities node.

5. In the AE Titles section, type the AE Title name.This is the unique name that identifies the device to

AG3110 │ 2019-05-07 42
Configure a DICOM Printer

other DICOM entities on the network.

Note: The AE title is case sensitive and has a maximum of 16 characters.

6. Leave the other elements in the Add New Device window with their default values, or change them
according to your requirements.

For more information about each of the elements in the Add New Device window, see Add New
Device Window Elements on page 47.

7. Click Save , then restart the affected services.

You now need to verify the connection to the modality.For more information, see Verify the DICOM
Connection on page 46.

Configure a DICOM Printer

You can configure a DICOM printer to print DICOM images on X-ray film and paper.

1. In the left pane of the System Configuration tool, go to Nodes Configuration.

2. Do one of the following:

l In the right pane, select DICOM Printer and click Create Device.

l Right-click Nodes Configuration and select Add.

The Add New Device window opens.

Note: The AE titles section appears partiality populated with default values.

3. Click anywhere in AE titles section.The Add New Device window expands to include the Select
printer drop-down list and Printer configuration box.

4. Enter values for the following mandatory fields:

l Node Name

l IP

5. In the AE Titles section, type the AE Title name.This is the unique name that identifies the device to
other DICOM entities on the network.

Note: The AE title is case sensitive and has a maximum of 16 characters.

6. From the Select printer kind drop-down list, click the printer type to be added.

7. To set this printer as the default printer, select the Set as Default Printer check box.

8. If the printer uses implementation-specific print parameters, type the values in the Printer
configuration box.

9. Click Add.The new printer appears in the left pane under the DICOM Printers node.

AG3110 │ 2019-05-07 43
Configure a DICOM Archive

10. Leave the other elements in the Add New Device window with their default values, or change them
according to your requirements.

For more information about each of the elements in the Add New Device window, see Add New
Device Window Elements on page 47.

11. Click Save , then restart the affected services.

You now need to verify the connection to the printer. For more information, see Verify the DICOM
Connection on page 46.
You also need to configure the DICOM printer in the client workstation.

Configure a DICOM Archive

You can configure a DICOM archive as a DICOM node.

1. In the left pane of the System Configuration tool, go to Nodes Configuration.

2. Do one of the following:

l In the right pane, select DICOM Archive and click Create Device.

l Right-click Nodes Configuration and select Add.

The Add New Device window opens.

Note: The AE titles section appears partiality populated with default values.

3. Enter values for the following mandatory fields:

l Node Name

l IP

l Issuer

Note: The Name and AE title in the AE titles section are automatically populated with the node
name.

4. Click Add.The new archive appears in the left pane under the DICOM Archives node.

5. Leave the other elements in the Add New Device window with their default values, or change them
according to your requirements.

For more information about each of the elements in the Add New Device window, see Add New
Device Window Elements on page 47.

6. Click Save , then restart the affected services.

You now need to verify the connection to the archive.For more information, see Verify the DICOM
Connection on page 46.

AG3110 │ 2019-05-07 44
Configure a Workstation

Configure a Workstation
You can configure a diagnostic workstation as a DICOM node.

1. In the left pane of the System Configuration tool, go to Nodes Configuration.

2. Do one of the following:

l In the right pane, select Workstation and click Create Device.

l Right-click Nodes Configuration and select Add.

The Add New Device window opens.

Note: The AE titles section appears partiality populated with default values.

3. Enter values for the following mandatory fields:

l Node Name

l IP

l Issuer

4. In the AE Titles section, type the AE Title name.This is the unique name that identifies the device to
other DICOM entities on the network.

Note: The AE title is case sensitive and has a maximum of 16 characters.

5. Click Add.The new workstation appears in the left pane under the Workstation node.

6. Leave the other elements in the Add New Device window with their default values, or change them
according to your requirements.

For more information about each of the elements in the Add New Device window, see Add New
Device Window Elements on page 47.

7. Click Save , then restart the affected services.

You now need to verify the connection to the archive. For more information, see Verify the DICOM
Connection on the next page.

Configure Reporting
You can configure the Speech Server as a Reporting node.

1. In the left pane of the System Configuration tool, go to Nodes Configuration.

2. Do one of the following:

l In the right pane, select Reporting and click Create Device.

l Right-click Nodes Configuration and select Add.

AG3110 │ 2019-05-07 45
Configure a Remote Web Portal

3. In the Add New Device window, enter values for the following mandatory fields:

l Node Name

l IP

4. If the Speech Server is part of a grid network, select the Supports Grid check box.Then complete the
relevant grid details in the Grid tab that appears.

For more information about each of the elements in the Add New Device window, see Add New
Device Window Elements on the next page.

5. Click Add.The Speech Server appears in the left pane under the Reporting node.

6. Click Save , then restart the affected services.

You now need to verify the connection to the Speech Server. For more information, see Verify the DICOM
Connection below.

Configure a Remote Web Portal

You can configure a remote Web portal for Vue Motion.

1. In the left pane of the System Configuration tool, go to Nodes Configuration.

2. Do one of the following:

l In the right pane, select Remote Web Portal and click Create Device.

l Right-click Nodes Configuration and select Add.

3. In the Add New Device window, enter values for the following mandatory fields:

l Node Name

l IP

4. If the Web application is part of a grid network, select the Supports Grid check box.Then complete
the relevant grid details in the Grid tab that appears.

For more information, see Add New Device Window Elements on the next page.

5. Click Add.The application appears in the left pane under the Remote Web Portals node.

6. Click Save , then restart the affected services.

You now need to verify the connection to the remote Web portal.For more information, see \Verify the
DICOM Connection below.

Verify the DICOM Connection

When you have finished configuring a device, you need to verify the connection to it.

AG3110 │ 2019-05-07 46
Add New Device Window Elements

1. In the left pane of the System Configuration tool, go to Nodes Configuration.

2. Select the device for which you want to verify the DICOM connection.

3. In the right pane, if there is more than one entry in the AE Titles section, select the relevant AE title.

4. Click DICOM Verify. The Server DICOM Verify window opens, confirming whether the connection
is working.

5. Click OK to close the window.

Add New Device Window Elements

The following table lists the elements that appear in the New Device window. The elements that are
common to a number of devices are listed first.

Element Description

Common Elements

Node Name The name of the device. This is the name that appears in the navigation tree in
the left pane of the System Configuration tool.

IP The IP address of the device.

Site ID The site ID that is used to identify studies from this device. Relevant only when
there is more than one site within the network.

Issuer The issuer assigning the patient ID from this device.

Node Info Click to view information about the node, such as the IP address and port.
In the Device Information window that appears, you can view information about
the current node, or you can scroll through the window to view information on all
nodes configured in the network.

Access Control Click to assign or remove restrictions for accessing data from this device. For
example, when there is more than one site in a network, you can restrict data
access according to the site ID, so that only individual sites will see data
relating to that site.
For more information on using data restrictions, see Assign Restrictions Based
on DICOM Tags on page 21.

Name The name of the device.

AE The unique name, which identifies the application entity instance to other
DICOM entities on the network.
The AE title is case sensitive and has a maximum of 16 characters.

Port The port used by the application entity instance for DICOM communication.

Queryable Indicates whether DICOM queries can be sent to the device.

AG3110 │ 2019-05-07 47
Add New Device Window Elements

Element Description

Storable Indicates whether DICOM images can be stored on the device.

For example, a previous mammography exam for a patient can be sent to the
modality so the technician can view it before performing the current exam.

Device Type The device type. This value is populated automatically.

Add Click to add the AE title, port and other details for the device.

Delete Click to delete the device.

DICOM Verify Click to verify DICOM connectivity to the device.

The AE Titles For future use. Indicates whether the AE title instances are virtual. That is, they
configured above are are additional AE titles that can be used to connect to this device.
Virtual AEs

Outgoing DICOM AE The AE-title used when sending outgoing DICOM messages to this device.
Possible values are:
l Source AE (default)

l Default mask – This is the virtual AE.

Storage Commitment Specifies how the storage commitment response is sent. Possible values are:
Policy
l Same association (default)

l New association

l Not allowed

AG3110 │ 2019-05-07 48
Add New Device Window Elements

Element Description

Transfer Syntax Policy Specifies the DICOM transfer syntax that is offered and accepted by the
device. Possible values are:
l Standard DICOM (default) – Includes Explicit Big, Explicit Little, and Implicit
Little syntax

l Implicit Little – Recommended when troubleshooting DICOM connectivity

problems

l Private – Recommended for communication between PACS components

l Custom – Transfer syntaxes are manually configured in the Central

Configuration

l Adaptive – Use custom transfer syntaxes for SOP classes that need to be
transferred. Recommended when image compression should not be
affected.

In addition, if pixel data is compressed, you can select the compression

algorithm used:
l JPEG Lossless

l JPEG Lossy

l JPEG Lossy/ Lossless 2000

l JPEG Lossless 2000

l JPEG Lossy Baseline

l JPEG Lossy Extended

l JPEG Lossless 1st Order Predictions

l JPEG Lossless PR14

l RLE Lossless

Advanced SOP Click to open the Advanced SOP Classes Settings window in which you define
Classes Settings the known storage SOP classes that are excluded from the negotiation phase
of an association and the SOP classes that are added to an association.
For more information, see Update the Default Transfer Syntax Policy on
page 52.

Printer Elements

Select printer kind Specifies the manufacturer and model of the printer to be added.

Set as Default Printer Indicates whether the printer is the default printer.

AG3110 │ 2019-05-07 49
Update the Workflow Manager Node Configuration

Element Description

Printer configuration Optional printer configuration parameters set in the DICOM print request (tag
2010,0150 – Configuration Information). Used when the printer vendor supports
implementation-specific print parameters or one or more configuration data
values encoded as characters.

Reporting and Remote Web Portal Elements

Supports Grid Indicates whether the Speech Server is part of a grid network.

Update the Workflow Manager Node

Configuration
The Workflow Manager is highly configurable and can be expanded to accommodate growing storage and
archiving needs. To view the current configuration, select the Workflow Manager node in the left pane of
the System Configuration tool.
From here, you can do the following:

l View the AE Configuration below

l Specify Allowed and Forbidden Hosts on the next page

l View the Communication Configuration on the next page

l Update the Loader Configuration on the next page

l Update the Default Transfer Syntax Policy on page 52

View the AE Configuration

1. In the left pane of the System Configuration tool, go to Nodes Configuration and select the
Workflow Manager. The DICOM tab appears in the right pane, open at the Servers Options tab.

2. You can view the list of processes configured for the Workflow Manager and you can verify the
connection to the server, if required. For more information, see Verify the DICOM Connection on
page 46.

Note: When you select a process, the Server Options tab expands to include additional
elements.

For more information about each of the elements in the Servers Options tab, see DICOM Tab
Elements on page 53.

Note: Consult with Carestream Professional Services personnel before making any changes to
the Workflow Manager server configuration.

AG3110 │ 2019-05-07 50
Specify Allowed and Forbidden Hosts

Specify Allowed and Forbidden Hosts

You can restrict access to the Workflow Manager based on the host address of the source machine.

1. In the left pane of the System Configuration tool, go to Nodes Configuration and select the
Workflow Manager. The DICOM tab appears in the right pane.

2. Select the Node Options tab.

3. Use the following tabs to enter the allowed or forbidden host addresses from which the Workflow
Manager can receive DICOM images:

Allowed Hosts
] Type the exact IP address.
Forbidden Hosts

Allowed Net Type the net address (for example, type 192.168) to allow or restrict
]
Forbidden Net devices with an IP address that belongs to the 192.168 net.

4. Click

5. Repeat steps 3–4 for additional host addresses, as required.

For more information about each of the elements in the Node Options tab, see DICOM Tab Elements
on page 53.

View the Communication Configuration

Important: The communication configuration parameters are set by Carestream Professional
Services personnel and are for Carestream use only.

1. In the left pane of the System Configuration tool, go to Nodes Configuration and select the
Workflow Manager. The DICOM tab appears in the right pane.

2. Select the Communication Configuration tab, which shows the mapped file size and allocated
buffers.

For more information about each of the elements in the Communication Configuration tab, see DICOM Tab
Elements on page 53.

Update the Loader Configuration

1. In the left pane of the System Configuration tool, go to Nodes Configuration and select the
Workflow Manager. The DICOM tab appears in the right pane.

2. Select the Loader Configuration tab.

3. In the text box at the bottom, type the AE title from which to load and click .

The Loader Configuration tab expands to include the DICOM Pool Settings.

AG3110 │ 2019-05-07 51
Update the Default Transfer Syntax Policy

4. Enter the appropriate values in the DICOM Pool Settings boxes.

For more information about each of the elements in the Loader Configuration tab, see DICOM Tab
Elements on the next page.

Update the Default Transfer Syntax Policy

The transfer syntax policy specifies the DICOM transfer syntax that is offered and accepted by a device.
You can update the Workflow Manager’s default transfer syntax policy for non-customized SOP classes.
In addition, you can customize the SOP classes, or exclude or add SOP classes from the association.

Select the Transfer Syntax

1. In the left pane of the System Configuration tool, go to Nodes Configuration and select the
Workflow Manager. The DICOM tab appears in the right pane.

2. Select the Default TX Policy tab.

3. From the All Transfer Syntaxes list, select the required transfer syntaxes, and click Add. The
selected transfer syntax appears in the Selected Transfer Syntaxes list.

4. Use the and buttons to change the order of the selected transfer syntaxes.

For more information about each of the elements in the Default TX Policy tab, see DICOM Tab Elements
on the next page.

Customize an SOP Class

1. In the Default TX Policy tab, click Add.

2. In the Add Custom SOP Class window, select the SOP class that you want to customize from the
Custom SOP Class drop-down list.

3. Select the Inherit from Default Transfer Syntaxes List check box to use the default transfer
syntaxes defined in the Default TX Policy tab for this SOP class. This is useful if you want to
configure multiple presentation contexts.

4. If you do not select the Inherit from Default Transfer Syntaxes List check box, then you need to
select the transfer syntaxes that are relevant for this SOP class and click the Add button to move
them to the Selected Transfer Syntaxes list.

5. Use the and buttons to change the order of the selected transfer syntaxes.

6. Select the Requested as Multiple Presentation Contexts check box to use multiple presentation
contexts when requesting the specific SOP class. This option is relevant only when acting as the
client side.

7. Click OK to close the window.

Configure Advanced SOP Classes Settings

You can configure known storage SOP classes that are excluded from the negotiation phase of an

AG3110 │ 2019-05-07 52
DICOM Tab Elements

association and the SOP classes that are added to an association. These settings apply to all DICOM
peers that are not configured as a device in the system configuration.

1. Click the Advanced SOP Classes button to open the Advanced SOP Classes Settings window.

2. In the SOP Classes Excluded from Association list, select any non-relevant SOP classes that can
be excluded from the association.

3. To add additional SOP classes to an association, click the Add button.

4. In the Add SOP Class to Association window, enter the SOP Class Description and SOP Class
UID in the relevant fields and click OK.

5. In the Advanced SOP Classes Settings window, click OK to close the window.

DICOM Tab Elements

The following table lists the elements that appear in the DICOM tab.

Element Description

Common Elements

Node Name The name of the device. This is the name that appears in the navigation tree in
the left pane of the System Configuration tool.

IP The IP address of the device.

Site ID The site ID that is used to identify studies from this device. Relevant only when
there is more than one site within the network.

Issuer The issuer assigning the patient ID from this device.

Users Domain The domain name assigned to users defined locally on this server (not via
LDAP) that is used to differentiate between these users and users from other
servers in the grid.

Supports Grid Indicates whether the Workflow Manager is part of a grid network.

Node Info Click to view information about the node, such as the IP address and port.
In the Device Information window that appears, you can view information about
the current node, or you can scroll through the window to view information on all
nodes configured in the network.

Access Control Click to assign or remove restrictions for accessing data from this device. For
example, when there is more than one site in a network, you can restrict data
access according to the site ID, so that only individual sites will see data
relating to that site.
For more information on using data restrictions, see Assign Restrictions Based
on DICOM Tags on page 21.

Servers Options Tab

AG3110 │ 2019-05-07 53
DICOM Tab Elements

Element Description

Display Name When the DX check box is selected, this is the name that appears in the Vue
PACS client Archive Explorer.

AE The unique name, which identifies the application entity instance to other
DICOM entities on the network.
The AE title is case sensitive and has a maximum of 16 characters.

Device Type The role of the AE on the server.

Virtual AE Indicates whether the AE instance is a virtual AE.

This are additional AE titles that are associated with this application.

Add Click to add an optional service to the Workflow Manager.

Delete Click to delete the service.

DICOM Verify Click to verify DICOM connectivity to the service.

Activate Backup Rule Relevant for services where the device type is DISK. Indicates whether
studies are backed up by the Info Router.

Automatically mark Relevant for services where the device type is DISK. Indicates whether the
studies as “backed up” Info Router marks the copied studies as backed up after a configurable amount
of time.

Port The port used by the application entity instance for DICOM communication.

Parallel Associations The number of associations to open when storing images to this application
entity. Possible values are from 1 to 4.

Database Path Relevant for services where the device type is FOLDER or DISK. This is the
directory where the images are saved.

Timeout (Minutes) The maximum time to wait for a socket event.

Enable Dicom to conn Relevant for services where the device type is DTC. Enables the DICOM to
interface Conn service.

Global Worklist AE The AE title of the remote grid node that the DTC service works with.
Title

Supports Store Indicates whether the Vue PACS client can store images to this application
entity.

Supports Delete Indicates whether the Vue PACS client can delete images from this application
entity.

Supports Query Indicates whether the Vue PACS client can retrieve images from this
application entity.

AG3110 │ 2019-05-07 54
DICOM Tab Elements

Element Description

Supports DX Store Indicates whether the Vue PACS client can store the presentation state to this
Presentation State application entity.

Invoke Filter Indicates whether the filter is invoked automatically in the Vue PACS client.

Classified Indicates whether the patient name in stored studies is changed to initials.

Uncompressed Indicates whether newly-stored DICOM images are not compressed.

Read only Indicates whether the folder is read-only.

Presentation State C- Determines what is done with presentation states when they are copied to this
Move Policy application entity.
Possible values are:
l Standard (as is)

l Move with referenced images

l Apply presentation state

l Ignore presentation state

Multiple Reports C- Determines what is done with studies when they are copied to this application
Move Policy entity.
Possible values are:
l Move only requested study

l Include referenced study (images)

l Include all SRs and referenced study

Key Object Selection Determines what is done with key object selections when they are copied to
C-Move Policy this application entity.
Possible values are:
l Standard (as is)

l Move with referenced images

l Apply KOS

l Ignore KOS

Create Folders in DX Indicates whether a folder for the DICOM folder is created in the Vue PACS
client.

Search The name of the Search folder as it appears in the Vue PACS client.

All Studies The name of the All Studies folder as it appears in the Vue PACS client.

All Patients The name of the All Patients folder as it appears in the Vue PACS client.

AG3110 │ 2019-05-07 55
DICOM Tab Elements

Element Description

Auto Delete Indicates whether to automatically delete studies from the DICOM folder when
the studies pass the threshold number of days allowed or when the folder size
exceeds the allowed amount.

Days to keep The maximum number of days to keep studies in the DICOM folder.

Delete up to (MB) The maximum size of the DICOM folder.

Node Options Tab

Daemon Port The port used by the application entity instance for DICOM communication.

Allowed Hosts The IP addresses from which the Workflow Manager can receive DICOM
images.

Forbidden Hosts The IP addresses that are restricted for the Workflow Manager and from which
no DICOM images are received.

Allowed Net The allowed net addresses from which the Workflow Manager can receive
DICOM images.

Forbidden Net The net addresses that are restricted for the Workflow Manager and from which
no DICOM images are received.

Plus Click to add allowed or forbidden host addresses.

Minus Click to remove allowed or forbidden host addresses.

Communication Configuration Tab

Mapped File Size For Carestream use only.

Allocated buffer – For Carestream use only.

Client Cmd

Allocated buffer – For Carestream use only.

Client Data

Allocated buffer – For Carestream use only.

Server Cmd

Allocated buffer – For Carestream use only.

Server Data

Loader Configuration Tab

AE to load from For Carestream use only.

Plus Click to add AE titles to load from.

Minus Click to remove AE titles to load from.

AG3110 │ 2019-05-07 56
Configure the Workflow Manager

Element Description

Default TX Policy

All Transfer Syntaxes The available transfer syntaxes.

Selected Transfer The selected transfer syntaxes. You set the order of priority using the up and
Syntaxes down arrows.

Add Click to move the selected transfer syntax to the Selected Transfer Syntaxes
list.

Remove Click to remove the selected transfer syntax from the Selected Transfer
Syntaxes list.

Move up Click to move the selected transfer syntax up the list. The list order defines the
priority of the transfer syntax.

Move down Click to move the selected transfer syntax down the list. The list order defines
the priority of the transfer syntax.

SOP Class The SOP class that is customized.

Custom Transfer The supported transfer syntaxes of the customized SOP class. The order
Syntaxes defines the priority of the transfer syntax.

Requested as Multiple Not applicable for the default DICOM configuration.

Presentation Context

Add Click to open the Add Custom SOP Class window, in which you select the
SOP class to customize and the supported transfer syntaxes.
For more information, see Update the Default Transfer Syntax Policy on
page 52.

Edit Click to edit a customized SOP class.

Delete Click to remove a customized SOP class.

Advanced SOP Click to open the Advanced SOP Classes Settings window, in which you can
Classes Settings exclude irrelevant SOP classes from the association or add new SOP Classes
that are currently not supported:
For more information, see Update the Default Transfer Syntax Policy on
page 52.

Configure the Workflow Manager

The Workflow Manager provides workflow management, distribution and archive capabilities that automate
workflow and data management. These features create a convenient and efficient working environment for
users and administrators.
The Workflow Manager maintains the single site or global enterprise database, manages the DICOM and
non-DICOM online storage, manages multi-tier storage, coordinates near-line and offline storage, controls

AG3110 │ 2019-05-07 57
Configure DICOM Parsing Rules

RIS connectivity and synchronization, reconciles patient information, initiates pre-fetches, and
automatically routes images and information quickly and efficiently to any location throughout the
enterprise.
You can use the System Configuration tool to do the following:

l Configure DICOM Parsing Rules below

l Configure Study Grouping Rules on page 63

l Configure Pre-Fetch Rules on page 65

l Configure Push to Client Rules on page 69

l Configure Icons Settings on page 70

l Configure Compression Settings on page 70

l Configure Initial Values on page 73

Configure DICOM Parsing Rules

You use DICOM parsing rules to set an initial value for a tag or to map specific DICOM tags to different or
multiple tags. For example, if a modality uses a single field for two values, the DICOM parsing rules can be
configured to break down this information into two distinct DICOM tags.
You can configure the following types of parsing rules:

l Pre-Defined—Use to set an initial value for a tag. You can do this in one of the following ways:

l Set the value in a tag to a fixed value. For example, add the site ID to all incoming studies.

l Remove a tag completely.

l Clear the value of a tag.

l Basic—Use to copy values from one tag to another or to split the value in a tag into separate target tags.

For example, for cardiac CT images, you can define a parsing rule to copy the last two characters
(number) from the SERIES_DESCRIPTION tag to TAMAR_IMAGE_PHASE.

l Advanced—Use to copy values from one tag to another using an advanced pattern.

For example, if the patient ID in the source tag includes leading zeros, which are not required in the
target tag, you can define a parsing rule to remove the leading zeros.

l Conversion Table—Use to convert specific values in a source tag to another value based on value
mappings in a table.

For example, in a multi-site environment, you can set the issuer target tag according to the site ID
source tag.

Note: Carestream recommends that you consult with Carestream Professional Services personnel
before adding or modifying DICOM parsing rules.

AG3110 │ 2019-05-07 58
Configure DICOM Parsing Rules

Add a DICOM Parsing Rule

1. In the left pane of the System Configuration tool, go to Application Configuration > Workflow
Manager Configuration  > DICOM Parsing. The rule display area appears in the right pane
containing two sections:

l The DICOM Parsing Table section lists the DICOM parsing rules.

l The Filter Rules section lists the filter rules that apply to each of the DICOM parsing rules above.

2. Click Add Rule. The DICOM Parsing Rule Addition Panel window opens.

3. In the Parsing Parameters section, select the parsing method to use.

l Pre-Defined Parsing—Use to set an initial value for a tag. In this case, the From DICOM Tag is
not required.

l Basic Parsing—Use to copy values from one tag to another.

l Advanced Parsing—Use to copy values from one tag to another using an advanced pattern.

l Conversion Table—Use to convert specific values in the FROM DICOM Tag section to another
value based on value mappings in a table.

4. Do one of the following:

l In the From DICOM Tag section, select the tag that you want to map from in the Select from list
drop-down list (not required for pre-defined parsing).

l Enter the values in the Group, Element, Implementer, and VR text boxes.

5. Do one of the following:

l In the To DICOM Tag section, select the tag that you want to map to in the Select from list drop-
down list.

l Enter the values in the Group, Element, Implementer, and VR text boxes.

6. To define a parsing rule for a specific AE, in the Basic Parameters section, type the AE title in the
Apply Rule for AE text box. Otherwise, type ALL for all AEs.

Note: The AE title is case sensitive and has a maximum of 16 characters.

7. In the Parsing Rule order number text box, type a number that defines the order of the parsing rule
in relation to other parsing rules.

8. Define the parsing parameters that are relevant for the parsing method that you chose in step 3.

a. If you selected pre-defined parsing, in the Pre-Defined Parsing section, select one of the
following options:

l To DICOM Tag value – Select this option to set the value in the To DICOM Tag to a fixed
value. Type the value in the text box.

AG3110 │ 2019-05-07 59
Configure DICOM Parsing Rules

l Remove To DICOM Tag – Select this option to remove the To DICOM Tag.

l Clear To DICOM Tag – Select this option to clear the value of the To DICOM Tag.

b. If you selected basic parsing, in the Basic Parsing section:

i. Type the syntax that specifies the part of the source tag to copy to the target tag. The
syntax uses regular expressions, such as * and /.*. Click Help for a detailed explanation
and examples.

ii. Select the Remove what was copied to the 'To Tag' from the 'From Tag' check box, if
required.

For example, if the BODY_PART_EXAMINED tag contains the body part and the patient
ID, select this tag in the From DICOM Tag section.

Then select the PATIENT_ID tag in the To DICOM Tag section.

In the Syntax text box, type /.* and select the Remove what was copied to the 'To Tag'
from the 'From Tag' check box.

This results in two tags: the BODY_PART_EXAMINED tag and the PATIENT_ID tag.

c. If you selected advanced parsing, in the Advanced Parsing section:

i. Type the syntax for the pattern to search for in the source tag. The pattern uses regular
expressions with special characters, such as *, ^ and $. Click Help for a detailed
explanation and examples.

ii. Select one of the following options:

l Copy Pattern – Select this option to copy the pattern to the target tag.

l Replace Pattern with – Select this option to replace the pattern in the target tag with the
replacement text (or no text).

iii. Select one of the following options:

l First occurrence—Select this option to copy only the first occurrence of the pattern to
the target tag.

l All occurrences—Select this option to replace all occurrences of the pattern in the target
tag with the replacement text (or no text).

iv. Select the Remove what was copied to the To Tag from the From Tag check box, if
required.

For example, if the patient ID in the source tag includes leading zeros, which are not
required in the target tag, select PATIENT_ID in both the From DICOM Tag and To
DICOM Tag sections.

In the Pattern text box, type ^0* and select the Replace Pattern with option, but leave it

AG3110 │ 2019-05-07 60
Configure DICOM Parsing Rules

empty.

The leading zeros will be removed from the target tag.

d. If you selected to convert specific values, click Edit Conversion Table. In the window that
opens, click the Add Data button to add the values that you want to replace and the values that
you want to replace them with.

For example, if you have a multi-site environment, if the site ID in the source tag is 1 then you can
set the Issuer target tag to x; if the site ID is 2 then you can set the Issuer target tag to y.

For more information on using conversion tables, see Use DICOM Parsing Conversion Tables
below.

9. To add a prefix or suffix to the target tag, in the Prefix - Suffix section, enter the value to be added in
the relevant text box.

10. To concatenate the parsing results (not relevant for pre-defined parsing), in the Parsing result
concatenation section, select one of the following values:

l No concatenation (Overwrite To Tag)

l Add before existing value in To Tag

l Add after existing value in To Tag

Add a separation string, if required

11. Click OK to return to the rule display area.

Use DICOM Parsing Conversion Tables

You can create a conversion table to convert specific values in DICOM parsing rules, or you can import a
file that contains values separated by a delimiter.

To create a conversion table

1. In the DICOM Parsing Rule Addition Panel window, in the Parsing Method section, select
Conversion Table.

2. Click Edit Conversion Table. The View DICOM_PARSE_RULE window opens.

3. Click the Add Data button. The Insert DICOM_PARSE_RULE Data window opens.

4. Type the value you want to replace and the converted value and click OK.

5. Repeat steps 3 and 4 to add more values.

6. Click the Exit button to close the View DICOM_PARSE_RULE window and return to the DICOM
Parsing Rule Addition Panel window.

To import a conversion file

1. In the DICOM Parsing Rule Addition Panel window, in the Parsing Method section, select
Conversion Table.

2. Click Edit Conversion Table. The View DICOM_PARSE_RULE window opens.

AG3110 │ 2019-05-07 61
Configure DICOM Parsing Rules

3. Click the Import DICOM_PARSE_RULE Data button. The Insert DICOM_PARSE_RULE Data
window opens.

4. Type the location of the conversion file in the File Path box or click Browse to find the location.

5. In the Column Delimiter box, type the delimiter used to separate the columns in the conversion file.

6. In the Import Type section, select whether to import new rows or overwrite data in the DICOM_
PARSE_RULE table.

7. Click Import to import the conversion table.

8. When the conversion table is imported successfully, click OK in the message that appears to return
to the View DICOM_PARSE_RULE window.

9. Click the Exit button to close the View DICOM_PARSE_RULE window and return to the DICOM
Parsing Rule Addition Panel window.

Edit a DICOM Parsing Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > DICOM
Parsing.

2. In the rule display area in the right pane, select the rule and click Edit Rule. The DICOM Parsing
Rule Addition Panel window opens.

3. Edit the rule. For details, see Add a DICOM Parsing Rule on page 59.

Remove a DICOM Parsing Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > DICOM
Parsing.

2. In the rule display area in the right pane, select the rule and click Remove Rule.

3. In the confirmation message that appears, click Yes.

The rule is removed from the rule display area.

Add a Filter for a DICOM Parsing Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > DICOM
Parsing. The rule display area appears in the right pane. It contains two sections:

l The DICOM Parsing Table section lists the DICOM parsing rules.

l The Filter Rules section lists the filter rules that apply to each of the DICOM parsing rules above.

2. Click Add Filter. The DICOM Parsing Rule Filter Addition Panel window opens.

3. In the Filter Scenarios section, select one of the following options:

l Incoming scenarios (default)—Use this option to parse incoming data.

Then select the Store or Update Tags check box, or both.

AG3110 │ 2019-05-07 62
Configure Study Grouping Rules

l Outgoing scenarios—Use this option to parse outgoing data. Then select the Query or Query
and Move options. This scenario is less common but can be used, for example, to remove tags
that are not handled by the target system.

Edit a Filter for a DICOM Parsing Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > DICOM
Parsing.

2. In the rule display area in the right pane, select the rule and click Edit Rule. The DICOM Parsing
Rule Addition Panel window opens.

3. Edit the rule. For details, see Add a Study Grouping Rule below.

Remove a Filter for a DICOM Parsing Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > DICOM
Parsing.

2. In the rule display area in the right pane, select the rule and click Remove Rule.

3. In the confirmation message that appears, click Yes.

The rule is removed from the rule display area.

Configure Study Grouping Rules

You use study grouping rules to group studies together. For example, if an incoming study has the same
accession number and patient ID as an existing study, you can group them together into one study with a
single study instance ID.
The study grouping mechanism uses compare rules to compare one study with another. These compare
rules can be applied to all incoming studies, or to specific studies only, in which case filter rules are used to
decide which of the studies are compared.
When you configure study grouping rules, the information is reflected in the Central Configuration in the
following location:
imaginet\system\applications\medistore\didb\study_matching_system_rules

Add a Study Grouping Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > Study
Grouping. The rule display area appears in the right pane containing two sections: the upper section
is for rules that apply to all incoming studies; the lower section is for rules that apply to specific
studies only.

2. To define rules that apply to all incoming studies, click Add rule in the upper section.

3. In the Enter Rule Name window, type the rule name and click OK. The Grouping Rule Details
window opens.

AG3110 │ 2019-05-07 63
Configure Study Grouping Rules

4. By default, the accession number (which identifies the order for the study) and the patient ID are used
to compare studies. To add criteria, select the Edit default compare rules check box. The additional
criteria are enabled for selection.

5. Select the additional criteria operator from the relevant drop-down list. For example, to compare
studies from the same modality, from the Modality drop-down list, select Equal.

Note: For the Contains operator, you can use a regular expression. For example, if Modality
contains *SR*, the mechanism will match CT-SR and MR-SR modalities.

6. To use a fixed value for the additional criteria, select the Static checkbox and type a value in the text
box. For example, to compare only CR studies, type CR in the text box.

7. Select one of the following grouping policies:

l Normal study grouping—If a match is found, the existing study determines the study instance ID.

l Reverse study grouping—If a match is found, the incoming study determines the study instance
ID. This is used, for example, if a report is created before the relevant images arrive from the
modality.

l Reverse study grouping with back merge candidates only—Searches for a match from studies
that are marked explicitly as back merge candidates. If a match is found, the incoming study
determines the study instance ID.

8. Click OK to return to the rule display area.

9. Repeat steps 2-8 to add additional rules that apply to all incoming studies.

10. Use the and buttons to change the order of the selected rules.

11. To define rules that apply to specific studies only, click Add rule in the lower section.

12. In the Enter Rule Name window, type the rule name and click OK. The Grouping Rule Details
window opens. It now includes the Set Filter Criteria section.

13. Click Add.

14. In the Study Grouping Enable Rule Pattern window, select the relevant rule pattern and click OK.

15. In the Fill In Values window, type the value and click OK to return to the Grouping Rule Details
window.

16. Now you add the compare rules that are checked when the filter criteria are matched. See steps 2-8
for instructions on how to do this.

17. Use the and buttons to change the order of the selected rules in the rule display
area.

The study grouping mechanism runs the rules according to their priority, using the following logic:

AG3110 │ 2019-05-07 64
Configure Pre-Fetch Rules

l Run the first rule from the upper section (apply to all incoming studies).

l If a match is found, the matching studies are merged and the mechanism stops.

l If no match is found, continue to the remaining rules in the upper section until a match is found.

l If no match is found, continue to the rules in the lower section.

l Run the first rule from the lower section (apply to specific studies only), as follows:

l Run the filter rule on the incoming study.

l If filters match, run the relevant compare rule.

l If a match is found, the matching studies are merged and the mechanism stops.

l If no match is found, the mechanism stops.

l If no filter match is found, continue to the next rule in the lower section.

Edit a Study Grouping Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > Study
Grouping.

2. In the rule display area in the right pane, select the rule and click Edit.

3. In the Grouping Rule Details window, edit the rule. For details, see Add a Study Grouping Rule on
page 63.

Remove a Study Grouping Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > Study
Grouping.

2. In the rule display area in the right pane, select the rule and click Remove.

3. In the confirmation message that appears, click Yes.

The rule is removed from the rule display area.

Rename a Study Grouping Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > Study
Grouping.

2. In the rule display area in the right pane, select the rule and click Rename.

3. In the Enter Rule Name window, type the rule name and click OK to return to the rule display area.

Configure Pre-Fetch Rules

You use pre-fetch rules to configure the study retrieval process so that specific studies can be retrieved in
advance and be ready for the radiologist to read, at times when there is less demand on the server, or when
a new study is stored.

AG3110 │ 2019-05-07 65
Configure Pre-Fetch Rules

The following types of pre-fetch rules can be configured:

l Study Arrives—The Workflow Manager receives images from an AE and queries the server for the
patient’s history.

This type of pre-fetch process is useful when there is no internal information system at the facility or in
case of an emergency when there is no opportunity to retrieve the patient’s history in advance.

l RIS Notification—IS Link informs the Workflow Manager when there is an order for a scan to be
performed or when a patient is admitted to the facility.

The details of the scan (for example, the body part to be scanned) are supplied to the Workflow
Manager, if available. Based on this information, the appropriate studies are brought online before the
new scan is performed.

Add a Pre-Fetch Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > Pre-
Fetch. The rule display area appears in the right pane showing the out-of-the-box Push to Client rule.
For more information, see Configure Push to Client Rules on page 69.

2. From the System Configuration toolbar, do one of the following:

l Click Add .

l Select Add A Rule from the right-click menu.

The New Pre-Fetch Rule window opens.

3. In the Name box, type a name for the rule.

4. In the Pre-Fetch Trigger section, configure the events that trigger the pre-fetch:

a. In the Event section, select from the following options:

l Study Arrives—Pre-fetch is triggered when a study arrives at the Workflow Manager.

l RIS Notification—Pre-fetch is triggered when there is an order for a scan to be performed or

when a patient is admitted to the facility.

Note: The Push To Client check box is used to define Push To Client rules. For more
information, see Configure Push to Client Rules on page 69.

b. In the Conditions section, click Add, or use the predefined buttons, Add Modality or Add Body
Part, and complete the relevant conditions for the rule.

c. Click OK to return to the New Pre-Fetch Rule window.

5. In the Fetch section, you configure groups of conditions that define which studies to retrieve from the
backup device, as follows:

AG3110 │ 2019-05-07 66
Configure Pre-Fetch Rules

a. Click Add Group and define the conditions for the Pre-Fetch function.

For example, to transfer studies that relate to CT scans only, click Add Modality. In the Add
Condition window, enter the value CT.

b. Configure additional conditions for the group, as required.

6. Repeat step 5 to configure additional groups, as required.

7. In the Routing section, you configure the pre-fetch archives used. In most cases, the main FIR is
defined in both the Pre-Fetch From and Pre-Fetch To boxes.

To configure a local pre-fetch archive

a. In the Pre-Fetch From box, click .

b. In the Archives List window, select the archive from which to get the studies, or click Select
None to disable the local pre-fetch mechanism.

c. Click OK to return to the New Pre-Fetch Rule window.

d. In the Pre-Fetch To box, click .

e. In the Archives List window, select the archive to which to forward the studies.

f. Click OK to return to the New Pre-Fetch Rule window.

To configure a remote pre-fetch archive

a. In the And/Or From Remote box, click .

b. In the Archives List window, select one or more archives from which to get the studies, or click
Select None to disable the remote pre-fetch mechanism.

c. Click OK to return to the New Pre-Fetch Rule window.

d. If you selected more than one archive, to change the order from which they are searched, click
Reorder.

e. In the Change Order window, select one of the archives and drag it up or down, as required.

f. Click OK to return to the New Pre-Fetch Rule window.

g. In the And Forward To box, click .

h. In the Archives List window, select the archives to which to forward the studies or click Select
None to disable the forwarding mechanism.

i. Click OK to return to the New Pre-Fetch Rule window.

8. Click OK to return to the rule display area.

9. Repeat steps 2-7 to add additional pre-fetch rules.

AG3110 │ 2019-05-07 67
Configure Pre-Fetch Rules

10. Use the and buttons to change the order of the selected rules.

11. Click Save .

Enable Night Pre-Fetch

The Night Pre-Fetch process runs the night before the scheduled studies are due. You can enable this
process, as follows:

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > Pre-
Fetch. The rule display area appears in the right pane showing the out-of-the-box Push to Client rule.

2. Select the Enable Night Pre-Fetch check box.

3. Click Save .

Activate and Deactivate Pre-Fetch Rules

To activate or deactivate Pre-Fetch rules, select one or more rules and select Activate Rule(s) or
Deactivate Rule(s) from the right-click menu.

Edit a Pre-Fetch Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > Pre-
Fetch. The rule display area appears in the right pane.

2. Select the rule to edit and do one of the following:

l Click Edit .

l From the right-click menu, select Edit Selected Rule.

3. In the Update Pre-Fetch Rule window, change the settings as required. For more information,
see Add a Pre-Fetch Rule on page 66.

4. Click OK to return to the rule display area.

Delete a Pre-Fetch Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > Pre-
Fetch. The rule display area appears in the right pane.

2. Do one of the following:

l Select or more rules and click Delete .

l From the right-click menu, select Remove Rule(s).

3. In the Delete Rule window, click Yes to confirm the deletion and return to the rule display area.

AG3110 │ 2019-05-07 68
Configure Push to Client Rules

Configure Push to Client Rules

Radiologists can use the Push to Client function to transfer studies from the network to a local computer,
such as a home PC, or to another physician. This is useful when the local computer is connected over a
slow line and streaming cannot be used because images need to be loaded at a faster rate and without loss
of quality.
When the radiologist transfers the studies, he or she can choose to transfer prior studies in addition to the
current study.
You configure Push to Client rules to define which prior studies are transferred. You also need to define the
user permissions to authorize which users can push studies. For more information, see Workflow on
page 28.
The out-of-the-box implementation already includes a Push to Client rule. You can modify this rule, or add
additional rules, as follows:

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration > Pre-
Fetch. The rule display area appears in the right pane showing the out-of-the-box Push to Client rule.

2. To add a new rule, from the System Configuration toolbar, click Add .

The New Pre-Fetch Rule window opens.

3. In the Name box, type a name for the rule.

4. In the Pre-Fetch Trigger section, clear the Study Arrives and RIS Notification check boxes and
select the Push To Client check box.

5. In the Fetch section, click Add Group and define the conditions for the Push to Client function.

For example, to transfer studies that relate to a specific body part, click Add Body Part. In the Add
Condition window, enter a value for the body part and click OK.

You can configure additional conditions for the group, as required.

6. Repeat step 5 to configure additional groups, as required.

7. In the Routing section, you configure whether users can push studies located on the data center or
any other satellite connected to the grid. Select from the following options:

l Always—The list of studies is a merged list based on the selected archive and the data center

l Never—The list of studies is only based on the selected archive

l Only if receiver has global permission—The list of studies is a merged list based on the selected
archive and the data center, but only if the user has access permissions.

8. Click OK to return to the rule display area.

9. Repeat steps 2-8 to add additional Push to Client rules.

10. Use the and buttons to change the order of the selected rules.

11. Click Save .

AG3110 │ 2019-05-07 69
Configure Icons Settings

Note: In addition to the Push to Client rules, you can also define parameters for the local computer in
the Central Configuration. For example, you can define the maximum size of the repository and the
number of days to keep pushed studies. For more information on these parameters, contact Customer
Service.

Configure Icons Settings

You configure the image icon creation strategy in the Workflow Manager Configuration > Icons Settings
screen. It is recommended to leave the default values as is, or consult with Carestream Professional
Services personnel before making changes.

Note: Series icons are created automatically, and the configuration is not done in this screen.

Configure Compression Settings

Modalities are generating more and more images of increasing resolution, contributing to the large volume
of digital data that requires storage. Reducing the file size means that more images can be stored in a given
amount of memory space, and images can be transferred and downloaded more quickly.
Compression can be used to reduce image file sizes using the following compression techniques:

l Lossless—all image information originally in the file remains after the file is uncompressed. Lossless
compression reduces file sizes by a factor of 2 or 3.

l Lossy—reduces the file size by permanently removing certain information. You can decide how much
loss to introduce and make a trade-off between file size and image quality. When the file is
uncompressed, only part of the original image remains, however, this is often not noticeable.
Lossy compression often reduces file sizes by a factor of 10 or more.

For more information on the available compression methods, see Compression Methods on page 72.
You use the System Configuration tool to configure compression rules that determine which images are
compressed and the compression method. The compression rules are displayed in a table.
Each row in the table represents a compression rule, containing one or more compression criteria. The
rules are run in order until a match is found. If no match is found, then the default compression is used.
Each column in the table represents a repository. The main storage repository appears first, followed by
additional repositories.
When you configure compression rules, the information is reflected in the Central Configuration in the
following location:
imaginet\system\applications\medistore\fir\compression

Add a Compression Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration >
Compression Settings. The rule display area appears in the right pane.

2. Do one of the following:

AG3110 │ 2019-05-07 70
Configure Compression Settings

l From the System Configuration toolbar, click Add .

l Click the Add rule button.

The Compression rule filters window opens.

3. In the Rule name box, type a name for the rule.

4. In the Rules enabled section, you configure which images are compressed:

a. Click Add.

b. In the Compression Enable Rule window, select the rule type and click OK.

c. In the Fill In Values window, type the value that matches the rule type and click OK to return to
the Compression rule filters window.

In the following example, a rule is defined for selecting CR images of the neck.

5. Click OK. The new rule appears in a new row in the rule display area.

6. In the first cell of the new row, right-click and select the compression method for the new rule for the
first repository:

For an explanation of the possible options, see Compression Methods on the next page.

Note: You can copy and paste cells in the table.

7. Repeat step 6 for each of the repositories.

8. Repeat steps 2-7 to add additional compression rules.

9. Use the and buttons to change the order of the selected rules.

10. Click Save .

Work with Default Compression Rules

When a new repository is installed, a default compression rule is automatically added (usually lossless
RICE compression) and appears in the last row of the table. When the rules are run, if no match is found,
the default compression method is used.
You can remove the compression method in the default rule. To do this, right-click the cell and select
Clear. In this case, when the rules are run, if no match is found, the system default compression method is
used.

Edit a Compression Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration >
Compression Settings. The rule display area appears in the right pane.

2. Select the rule to edit and do one of the following:

AG3110 │ 2019-05-07 71
Configure Compression Settings

l From the System Configuration toolbar, click Edit .

l Cclick the Edit rule button.

3. In the Compression rule filters window, change the rule parameters as required.

4. Click OK.

5. To change the compression method, right-click the cell and select the required compression method.

For an explanation of the possible options, see Compression Methods below.

Note: You can copy and paste cells in the table.

6. Click Save .

Delete a Compression Rule

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration >
Compression Settings. The rule display area appears in the right pane.

2. Select the rule and, from the System Configuration toolbar, click Delete or click the Delete
button.

The rule is removed from the rule display area.

3. Click Save .

Compression Methods
The following table lists the compression methods that that can be used to compress image files.

Compression
Description
Method

Uncompressed Image files are not compressed.

As-Is Image files are left as-is.

AG3110 │ 2019-05-07 72
Configure Initial Values

Compression
Description
Method

Lossless Image files are compressed without reducing image quality. When a file is
uncompressed, all the original information is restored.
The following types of lossless compression are available:
l RICE

l RLE

l JPEG

l JPEG 2000

l JPEG 2000 Optimized

Lossy Image files are compressed and some information is lost. When a file is
uncompressed, only part of the original image remains, however, this is often not
noticeable.
The following types of lossy compression are available:
l JPEG

l JPEG 2000

l JPEG 2000 Optimized

For JPEG and JPEG 2000, you can decide on the degree of compression: high,
medium, default, or low. When the value is high, the file is more compressed. When
the value is low, the file is less compressed.
For JPEG 2000 Optimized, you select the compression ratio.
Lossy compressed images are stored with a new SOP instance UID and comply with
the DICOM standard.

Private Lossy Private lossy compression is used when a storage life cycle is defined.
For example, when images are initially stored using lossless optimized compression.
After 3 years, images are migrated to another repository and are compressed using
lossy compression. After 4 more years, images are compressed further, migrated to
another repository, and deleted from the previous repository.
Lossy compressed images are stored with the same SOP instance UID.
For more information on using this compression method, contact Customer Service.

Configure Initial Values

You can set initial values for incoming studies that do not already have values assigned. The values can be
assigned at the system, node, site, or AE levels. For example, you can set the initial study status for all
incoming studies to be UNREAD, or you can assign all incoming studies for a specific site to a particular
doctor.

AG3110 │ 2019-05-07 73
Configure Initial Values

System-level values are automatically inherited by the levels below, unless they are modified at any of the
node, site, or AE levels.

Configure Initial Values at the System Level

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration >
Init Values > System.

2. In the right pane, complete the following fields, as appropriate:

Field Description

Study Status The status assigned to incoming studies.

Study Locked Indicates whether the incoming study is locked or unlocked.

Study Priority The priority of the study. The highest priority is 1.

Study Assigned to Indicates whether the study is assigned to a particular doctor.

Doctor

Study Practice Setting The department code used in vendor-neutral archiving scenarios. Possible
Code values are:

l 0—Radiology

l 100—Cardiology

l 200—Endoscopy

l 300—Gastroenterology

l 400—Dermatology

l 500—Opthalmology

l 600—Pathology

Study Confidentiality The data sensitivity, which is used when applying access control rules.
Code Possible values are:

l N—Normal

l R—Restricted

l V—Very Restricted

Study Protected Indicates whether the study is protected from auto-deletion.

3. When you have finished configuring the initial values, save your changes and restart the affected
services.

Configure Initial Values at the Node, Site, and AE Levels

1. In the left pane of the System Configuration tool, go to Workflow Manager Configuration >

AG3110 │ 2019-05-07 74
Configure IS Link

Init Values > System and select the relevant node.

2. In the right pane, complete the appropriate fields, as described in Configure Initial Values at the
System Level on the previous page.

Note: The color of the fields changes according to their status, as follows:

l Yellow indicates that the setting is inherited from the system-level settings.

l White indicates that the value has been modified and is defined at the node level.

3. To configure initial values at the site and AE levels, click the Storing AEs / Site IDs button.

4. In the Init Values window, click the Add Site or Add AE button, as appropriate.

5. In the window that opens, enter the site ID or AE title and click OK.

6. In the left pane, select the site or AE that you just added.

7. In the right pane, complete the appropriate fields, as described in Configure Initial Values at the
System Level on the previous page.

Note: The color of the fields changes according to their status, as follows:

l Yellow indicates that the setting is inherited from the node-level settings.

l White indicates that the value has been modified and is defined at the site or AE level.

8. When you have finished configuring the initial values, save your changes and restart the affected
services.

Configure IS Link
IS Link is a configurable HL7 interface engine that provides seamless integration between Vue PACS and
hospital information systems (HIS), radiology information systems (RIS), and other healthcare information
systems. Specifically, IS Link provides Vue PACS with patient demographic, visit, and order information,
and enables the retrieval of clinical reports.
IS Link includes the following main processes:

l Listener—Receives HL7 messages from RIS/HIS and stores them in a table ready for the Converter
process.

l Converter—Fetches HL7 messages from the table, processes the messages, and then uploads the
relevant information to the IS Link database. Parallel Converter processes can be configured for
scalable processing of HL7 messages and improved performance in large sites.

IS Link supports the following HL7 messages:

l ADT—Admission, discharge, transfer messages

l ORM O01—General order message

l ORU R01—Observational results

AG3110 │ 2019-05-07 75
Configure the Listener Process

For more information on the HL7 communication protocol, see AG1177 – Vue PACS 12.2 HL7 Interface
Specifications.
You can use the System Configuration tool to configure the following IS Link features:

l Listener process

l Converter process

l Database

l Reports and orders

l Report parser

l Queues and notifications

In addition, you can use the Central Configuration Editor to configure the following features:

l Parallel converter processes

l Cancelled order filters

l Report display filters

Configure the Listener Process

The Listener process receives HL7 messages from RIS or HIS and places them in the MDB_HL7_
MESSAGES table in the IS Link database.
You use the System Configuration tool to configure parameters, such as the port for TCP/IP connections
from clients.

Edit Listener Configuration Parameters

1. In the left pane of the System Configuration tool, go to IS Link Configuration > Listeners.

2. In the right pane, select the listener process to edit from the Listeners drop-down list.

3. From the System Configuration toolbar, click Edit or select Edit from the right-click menu.

4. In the Edit Listener window, edit the listener parameters as required.

Property Description

Listener Name The name of the listener process.

Port Number The port used by the listener process for TCP/IP connections.

Encoding The character encoding used.

Control Port Number The control port, which is used to check if the listener process is up.
The default is 2114.

AG3110 │ 2019-05-07 76
Configure the Converter Process

Property Description

Control Interval (sec) The frequency for checking whether the control port is in use, in
seconds.

Close Connection The period of time after which the non-active connection is closed.
Interval (sec)

Listener Description A description of the listener process.

5. Click OK.

6. Click Save , then restart the affected services.

Configure the Converter Process

The Converter process fetches HL7 messages from the MDB_HL7_MESSAGES table, separates each
message into segments, and then parses them to the relevant IS Link database tables. When message
processing is complete, the converter sends event notifications to the relevant enabled notification queues.
You can configure parallel Converter processes to provide scalable processing of HL7 messages in large
sites. For details, see Configure Parallel Converter Processes below.
You use the System Configuration tool to configure the converter process, as follows:

1. In the left pane of the System Configuration tool, go to IS Link Configuration > Converter.The
configuration area appears in the right pane.

2. In the right pane, configure the converter properties, as follows:

Property Description

Port Number The port used by the converter process for TCP/IP connections.

Encoding The character encoding used.

Control Port The control port, which is used to check if the converter process is up.The
Number default is 2111.

Control Interval The period of time after which the non-active connection is closed.
(sec)

Do not select the step mode check box, as it is not in use.

3. Click Save , then restart the affected services.

Configure Parallel Converter Processes

From 12.2

AG3110 │ 2019-05-07 77
Configure the Converter Process

To improve scalability and performance, it is possible to configure a number of Converter processes to

work in parallel. The converter processes (known as converter nodes) are managed by the node manager.
All configuration changes require converter service restart.

1. Go to:
imaginet\system\[nodes]\[node]\applications\medilink\config\ converter\

Possible
Attribute Default Comment
Values

nodes 1 1-520 The number of converter processes on the

local machine.

It is recommended to set this to 1 for a

small site and up to 8 for a very busy data
center.

restart_node_sleep 5000 numeric The number of milliseconds to sleep before

a node restart.

start_node_index 0 0-519 The index of the first node on the local

machine. When running the converter on
multiple nodes, each node must have a
unique value.

start_memory numeric The JVM start memory argument for

converter nodes (MB).

max_memory numeric The JVM maximum memory argument for

converter nodes (MB).

Reduce the value to 96 if no large

messages are processed and the server
experiences memory problems. Increase if
large messages (for example, that contain
images) cause memory exceptions.

2. Then go to:
imaginet\system\[nodes]\[node]\applications\medilink\config\converter\
control

Possible
Attribute Default Comment
Values

port 14415 numeric The control port of the node manager. It is

not recommended to change this value.

3. Then go to:

AG3110 │ 2019-05-07 78
Configure the Converter Process

imaginet\system\[nodes]\[node]\applications\medilink\config\converter\
priority_queue

Possible
Attribute Default Comment
Values

lock_timeout 30 numeric The approximate number of seconds a

message can be locked by one
node.Remove to disable timeout
monitoring.Modify or remove before
debugging or using step mode.

miss_sleep 1000 numeric The number of milliseconds to sleep after a

miss at rownum 1.

tries_limit 3 numeric The maximum number of tries allowed on a

problematic message.

4. Then go to:
imaginet\system\applications\medilink\config\listeners\listener

Possible
Attribute Default Comment
Values

buffered_reader false true/false Indicates whether the listener uses a

buffered reader. This is effective only if
read_blocks_from_ris is set to false or is
undefined. Activate only if listener
performance is too slow. Note that this can
be risky as it might not work with all clients
(RIS).

Troubleshoot Converter Process Performance

You can use a number of useful commands to monitor converter processes. These commands are passed
to all nodes, though you can pass a command to a specific node by appending the node index to it.
For example, to view statistics from node 2, go to %imaginet_root%medilink\admin and run:

To see if the converter nodes are running as they should, check the following:

l Locks and commits—is the system working in general?

l Are there a lot of rollbacks? This may mean that there is a configuration issue or bug (sync ping-pong
etc.).

l Are there erroneous messages? This may mean there is a problem in RIS and you should check the log.

AG3110 │ 2019-05-07 79
Configure the IS Link Database

l Are messages handled more or less evenly? If a node has significantly less acquired locks for example,
it probably restarted recently and you should check the medilink_converter.log file. The node could also
be forgotten in a halt/step mode.

l Does the collisions percentage exceed 10% when there is a high message load? Too many collisions
may mean there are too many nodes.

Other useful commands include:

l control help—print help for control interface.

l control converter info—print local runtime summary and status.

l control converter ping:0—print a simple alive message from node 0.

l control converter list—list all active nodes and process IDs.

l control listener list—list all active connections (clients).

l control converter stop:0—stop node 0 permanently.

l control converter start:99—start new node 99.

l control converter halt—pause all message processing.

l control converter step:0—make node 0 process one message.

l control converter continue—exit halt mode.

The control interface (the script or class) also provides a help command and an info command for the
converter, which prints the local runtime summary and status. The interface can serve as a simple
monitoring tool API and is part of System Check input.
System Check of IS Link ports gets the following additional information from the info command:

l Backlog increasing (yellow)

l Erroneous messages (yellow)

l Some default nodes are down (red)

l Errors receiving info (red)

Configure the IS Link Database

IS Link receives and translates HL7 data from RIS or HIS and uploads the translated data in the IS Link
database.
You use the System Configuration tool to configure the IS Link database, as follows:

1. In the left pane of the System Configuration tool, go to IS Link Configuration > Database. The
configuration area appears in the right pane.

AG3110 │ 2019-05-07 80
Edit Report and Order Templates

2. In the right pane, configure the converter properties:

Property Description

Host IP The host IP of the IS Link database.

Port Number The port number. The default is 1521.

3. Click Save , then restart the affected services.

Edit Report and Order Templates

IS Link enables the end user, such as a radiologist, to view clinical reports using the Vue PACS Client. The
report information is stored in the IS Link database and can be retrieved as required.
You use the System Configuration tool to edit the report and order templates, as follows:

1. In the left pane of the System Configuration tool, go to IS Link Configuration > Reports & Orders.
The display area appears in the right pane.

2. In the Report Message Format section, select from the following options:

l Multiple OBXs

l Single OBX with repetitions

l HTML Report Text

3. In the Application Report/Order Templates section, select the application used to view the report
from the drop-down list.

4. In the Templates section, select the report template to edit. The options available depend on the
application selected in step 3.

5. Click Edit.

6. In the Edit Record window, you can change the format of the selected template.

7. When you have finished making your changes, click OK to return to the display area.

8. Click Save , then restart the affected services.

Note: You can use the Preview option to preview the templates after making your changes.

Enable Report Parsing

You use the System Configuration tool to enable report parsing and to define report parsing parameters.

1. In the left pane of the System Configuration tool, go to IS Link Configuration > Report Parser. The
display area appears in the right pane.

2. To enable report parsing, select the Enable Report Parser check box.

AG3110 │ 2019-05-07 81
Enable Report Parsing

3. In the Search Parameters section, select or deselect the Enable check box for each parsing
element.

4. To edit the parsing parameters for a specific parsing element, select the parsing element from the
Search Text list and click Edit Parser.

5. In the Edit Parser window, configure the parsing parameters, as required. Click OK to return to the
display area.

6. Click Save , then restart the affected services.

Add a Parsing Element

You use the System Configuration tool to add new parsing elements, which can be used to modify text
fragments in reports.

1. In the left pane of the System Configuration tool, go to IS Link Configuration > Report Parser. The
display area appears in the right pane.

2. In the Search Parameters section, click Add Parser.

3. In the Add Parser window, configure the parsing element properties:

Property Description

Search Text The text that you want to modify.

Replace Text The replacement text. This option is only available if the Use original text
check box is not selected.

Prefix Text The text to insert before the text fragment. For example, to bold a text
fragment, use the <b> tag as a prefix.

Suffix Text The text to insert after the text fragment. For example, if you used the <b>
tag as a prefix, enter </b> tag as a suffix.

Case sensitive Indicates whether the parser is case-sensitive.

Use original text Indicates whether to use leave the original text as is. If no, use the
Replace Text box to define the replacement text.

Enable Indicates whether the parsing element is enabled.

4. Click OK to return to the display area.

5. Click Save , then restart the affected services.

Delete a Parsing Element

1. In the left pane of the System Configuration tool, go to IS Link Configuration > Report Parser. The
display area appears in the right pane.

2. From the Search Text list, select the parsing element to delete and click Delete Parser.

AG3110 │ 2019-05-07 82
Configure Queues and Notifications

3. In the Delete Parsing Element window, click Yes to confirm the deletion and return to the display
area.

4. Click Save , then restart the affected services.

Configure Queues and Notifications

When message processing is complete, the converter sends the event notifications to the relevant
notification queues.
You use the System Configuration tool to configure the notifications and enable the relevant queues.

Add a Notification
1. In the left pane of the System Configuration tool, go to IS Link Configuration > Queues &
Notifications. The configuration area appears in the right pane.

2. Select a queue from the Queue Name list. The list of notifications appears under the Notification
Name list.

The check box indicates whether the notification is enabled.

3. Click Add Notification. The Add Notification window opens.

4. In the Notification Name box, type the name of the notification.

5. In the Notification Condition box, type the condition for the notification.

6. Select the Enable check box and click OK to return to the display area.

7. Click Save , then restart the affected services.

Edit a Notification
1. In the left pane of the System Configuration tool, go to IS Link Configuration > Queues &
Notifications.

2. In the right pane, select the notification to edit in the Notification Types section and click Edit
Notification. The Edit Notification window opens.

3. In the Notification Condition box, edit the condition for the notification, as required.

4. Click OK.

5. Click Save , then restart the affected services.

Delete a Notification
1. In the left pane of the System Configuration tool, go to IS Link Configuration > Queues &
Notifications.

AG3110 │ 2019-05-07 83
Enable Filtering of Cancelled Orders

2. In the right pane, select the notification to delete in the Notification Types section and click Delete
Notification.

3. In the Delete Notification window, click Yes to confirm the deletion and return to the display area.

4. Click Save , then restart the affected services.

Enable Filtering of Cancelled Orders

Generally, information for cancelled orders is in accordance with HL7 standards and can arrive either
together or individually as an HL7 ORC.1 (Order Control) field or by ORC.5 (Order Status).
To enable filtering of cancelled orders, in the Central Configuration Editor, go to:
imaginet\system\applications\medilink\config\api\filters
and set enable_cancelled_order_filter to true.

Troubleshoot Upgrade Issues

Relevant when upgrading to 12.2

As part of the upgrade to version 12.2, the HL7 interface stops fetching messages from the message queue
and starts working with the MDB_HL7_MESSAGES table. If the message queue is not empty before the
start of the upgrade, for example, if there are some performance issues or other problems, then you need to
manually process the backlog in the queue.
Do the following:

1. Copy the converter.bat file and rename it old_converter.bat.

2. In old_converter.bat, change all instances of .ConverterNodesManager to .Main.

3. Run old_converter.bat.

When the queue is empty, migration is finished. Converter and listener services run in the background
normally, and should not be touched. Make sure last port in range not allocated to a managed converter
node.

Note: If the PACS reboots before the migration is finished, then rerun old_converter.bat.

Configure HL7-PACS Field Mapping

IS Link processes HL7 messages from RIS and HIS and uploads the relevant information to the IS Link
database. This information can then be used by the RIS Synchronization process to update the Workflow
Manager.
In the out-of-the-box implementation, a default mapping set defines which HL7 fields are mapped to which
DICOM fields.

AG3110 │ 2019-05-07 84
Modify the HL7-PACS Field Mappings

You can use the System Configuration tool to view the default mapping set and modify the field mappings,
if required. You can also define whether the HL7 field is modified using a dictionary table and whether the
Workflow Manager should be notified of changes to the HL7 field using the RIS Synchronization process.
For example, for the Exam Start Date field, RIS sends OBR-36 instead of the expected OBR-27.4.1. You
can change the default field mapping of the Exam Start Date field from OBR-27.4.1 to OBR-36.
Each row in the table displays the mapping of an HL7 field to a field in the IS Link database. It includes the
following information:

l Carestream Field—The destination field in the IS Link database. This is the DICOM tag.

l HL7 Field ID—The unique ID of the source HL7 field.

l HL7 Field Name—The name of the source HL7 field.

l Dictionary Table—Indicates whether the HL7 field is converted through a dictionary table. Possible
options are:

l Simple mapping table, which converts one value into another. For example the Priorities table.

l Complex mapping table, in which you define a number of columns. The out-of-the-box
implementation includes the Procedures and Study Status Translations tables.

For more information, see Use Dictionary Tables on the next page.

l RIS-Synced—Indicates whether to notify the Workflow Manager of updates to this field using the RIS
Synchronization process, for example, when the patient details are updated.

l Update Condition—The condition that defines when RIS synchronization takes place.

l Normalized—Indicates whether the RIS value is dicomized during RIS synchronization.

For more information on the HL7 fields and the communication protocol, see AG1177 – Vue PACS 12.2 HL7
Interface Specifications.

Modify the HL7-PACS Field Mappings

1. In the left pane of the System Configuration tool, go to HL7-PACS Field Mapping > Default
Mapping Set. The display area appears in the right pane.

2. Select the row to update and click Update Field Mapping or select Update Row from the right-click
menu. The configuration window opens for the chosen field.

Note: The contents of the configuration window depend on whether a dictionary table can be
used, and whether the RIS Synchronization process is enabled for the chosen field.

3. In the Mapping Source section, you can change the HL7 field that is mapped or, if the HL7 field was
previously changed, you can restore the default mapping.

a. Click Choose HL7 Field.

b. Do one of the following:

AG3110 │ 2019-05-07 85
Use Dictionary Tables

l In the Select HL7 Mapping Field window, select the new HL7 source field to map and click
OK to return to the configuration window.

l Click Restore Default.

4. To convert the HL7 value using a dictionary table, select the Replace HL7 value using Dictionary
Table check box. Then click Edit Table.

In the table that opens, edit the fields as required and click OK to return to the configuration window.

For more information, see Use Dictionary Tables below.

5. If RIS Synchronization is enabled for this field, in the RIS-Sync Configuration section, you can
change the RIS synchronization parameters:

a. To use RIS synchronization, select the Enable RIS-Sync check box.

b. From the Update field if drop-down list, select the condition that defines when RIS
synchronization takes place.

c. Do one of the following:

l To dicomize the RIS value during RIS synchronization, select the Normalize RIS value
check box.

l To disable RIS synchronization, clear the Enable RIS-Sync check box.

6. Click OK to return to the configuration window.

7. Click Save , then restart the affected services.

Use Dictionary Tables

You can use simple or complex dictionary tables to convert HL7 values before they are uploaded to the
IS Link database.

Configure a Simple Mapping Table

1. In the left pane of the System Configuration tool, go to Dictionary > Simple Mapping Tables. The
list of simple mapping tables appears in the right pane.

2. From here, you can do the following:

AG3110 │ 2019-05-07 86
Use Dictionary Tables

To Do this

Add data a. Select the relevant table from the list and click Update.

b. In the window that appears, click Add Data .

c. In the Insert Data window, type the new value and the converted value.

d. To add more values, click Save & Clear and repeat step c.

e. When you have finished adding values, click OK.

f. Click Exit to close the window.

Update values a. Select the relevant table from the list and click Update.

b. In the window that appears, select the values to update and click

Update Data .

c. In the Update Data window, type the relevant values and click OK.

d. Repeat steps b-c to update additional values, as required.

e. When you have finished updating values, click OK.

f. Click Exit to close the window.

Delete a value a. Select the relevant table from the list and click Update.

b. In the window that appears, click Delete Data .

c. In the confirmation message that appears, click Yes.

d. Click Exit to close the window.

AG3110 │ 2019-05-07 87
Use Dictionary Tables

To Do this

Import a conversion a. Select the relevant table from the list and click Update.
file
b. In the window that appears, click Import .

c. In the Import window, type the location of the conversion file in the File
Path box or click Browse to find the location.

d. In the Column Delimiter box, type the delimiter used to separate the
columns in the conversion file.

e. In the Import Type section, select whether to import new rows or

overwrite data in the mapping table.

f. Click Import to import the conversion table.

g. When the conversion table is imported successfully, click OK in the

message that appears.

h. Click Exit to close the window.

Add a new mapping a. Click Add.

table
b. In the Add Simple Mapping Table window, type the name of the new
mapping table and click OK.

The new mapping table appears at the end of the list of mapping tables.

For details on how to add values to the new table, see Add data.

Rename a simple a. Select the relevant table from the list and click Edit.
mapping table
b. In the Update Simple Mapping Table window, type the new name of
the mapping table and click OK.

Delete a simple a. Select the table you want to delete and click Delete.
mapping table
b. In the confirmation message that appears, click Yes.

Configure a Complex Dictionary Table

1. In the left pane of the System Configuration tool, go to Dictionary > Complex Mapping Tables. The
list of complex mapping tables appears in the right pane.

2. From here, you can do the following:

AG3110 │ 2019-05-07 88
Use Dictionary Tables

To Do this

Add data a. Select the relevant table from the list and click Update.

b. In the window that appears, click Add Data .

c. In the Insert Data window, type the new value and the converted value.

d. To add more values, click Save & Clear and repeat step 3.

e. When you have finished adding values, click OK.

f. Click Exit to close the window.

Update values a. Select the relevant table from the list and click Update.

b. In the window that appears, select the values to update and click

Update Data .

c. In the Update Data window, type the relevant values and click OK.

d. Repeat steps b-c to update additional values, as required.

e. When you have finished updating values, click OK.

f. Click Exit to close the window.

Delete a value a. Select the relevant table from the list and click Update.

b. In the window that appears, click Delete Data .

c. In the confirmation message that appears, click Yes.

d. Click Exit to close the window.

AG3110 │ 2019-05-07 89
Configure Logging of HL7 Messages in the Audit Trail Viewer

To Do this

Import a conversion a. Select the relevant table from the list and click Update.
file
b. In the window that appears, click Import .

c. In the Import window, type the location of the conversion file in the File
Path box or click Browse to find the location.

d. In the Column Delimiter box, type the delimiter used to separate the
columns in the conversion file.

e. In the Import Type section, select whether to import new rows or

overwrite data in the mapping table.

f. Click Import to import the conversion table.

g. When the conversion table is imported successfully, click OK in the

message that appears.

h. Click Exit to close the window.

Add a new mapping a. Click Add.

table
b. In the Add Complex Mapping Table window, type the name of the
new mapping table and click OK.

The new mapping table appears at the end of the list of mapping tables.

For details on how to add values to the new table, see Add data.

Rename a complex a. Select the relevant table from the list and click Edit.
mapping table
b. In the Update Complex Mapping Table window, type the new name
of the mapping table and click OK.

Delete a complex a. Select the table you want to delete and click Delete.
mapping table
b. In the confirmation message that appears, click Yes.

Configure Logging of HL7 Messages in the Audit

Trail Viewer
From 12.2

All HL7 messages that are committed or rolled back are logged as events in the Audit Trail Viewer by
default. You can change these default settings as required.

AG3110 │ 2019-05-07 90
Configure the Info Router

1. Go to:
imaginet\system\applications\medilink\config\converter

Possible
Attribute Default Comment
Values

audit_rollback_msgs_enabled true true/false Set to false to stop logging

rolled back messages as
events in the Audit Trail
Viewer.

audit_commit_msgs_enabled true true/false Set to false to stop logging

committed messages as
events in the Audit Trail
Viewer.

audit_no_change_rollback_ false true/false Set to true to start logging

msgs_enabled messages that have not
changed as events in the
Audit Trail Viewer.

long_segments_prune_size 500 numeric The maximum length of a

single segment before it is
split into two events.

Configure the Info Router

The Info Router provides flexible and rule-driven data management and auto-forwarding capabilities.
You can use the System Configuration tool to configure Info Router rules for archiving new data, burning
CDs, pre-fetching data from within or outside Vue PACS, synchronizing Workflow Manager metadata
across sites, and many other data management activities.
An Info Router rule includes:

l An event—Provides the trigger for the Info Router. Examples include the arrival of a new image, study, or
report.

l A command—Defines the actions that the Info Router performs after being triggered by an event. For
example, move DICOM data, send tag updates, and send HL7 messages. Commands can be grouped
and can also have an alias. An alias is an alternative target for a command (such as a person or a
device), with its own set of rules. For example, copy the DICOM study to Dr. Smith, except on
Sundays, when it is copied to Dr. Jones instead.

l A filter—Events can be filtered, for example, so only new CT images trigger the Info Router.

Info Router rules are displayed in a table. The Rule List area, in the upper pane, displays a list of the rules
that are defined for the system, together with general information and the current status of each rule.
When you select a rule, the rule details appear in the Rule Information area, in the lower pane.
You can use the screen splitter arrows between the areas to resize the Rule Information area, or click and
drag it to a new position.

AG3110 │ 2019-05-07 91
Configure Info Router Rules

Configure Info Router Rules

You use the System Configuration tool to configure Info Router rules, as follows:

l Using predefined functions, which are packaged combinations of events, filters, and commands.
Examples include:

l Backup

l Copy images/studies

l Create structured reports

l Burn and copy

l Pre-fetch/Pre-load

l Update tags

l Synchronize tags between Workflow Managers

l Using custom functions that include a combination of events, filters, and commands not provided by the
predefined functions.

Add an Info Router Rule using Predefined Functions

1. In the left pane of the System Configuration tool, go to Info-Router > Rules. The rule display area
appears in the right pane.

2. To add a rule, do one of the following:

l From the System Configuration toolbar, click Add

l Select Add from the right-click menu.

l Right-click the list rule area and select Insert Rule.

The New Rule Creation window opens.

3. In the Description box, type a description of the rule.

4. From the Function drop-down list, select a pre-defined function. The parameters section changes
depending on the function selected.

5. In the parameters section, complete the relevant parameters for the function.

6. To set an event filter, in the Filter section, click Edit.

7. In the Edit Filter window, you compose a filter expression as follows:

a. Select a criterion from the Filter Criteria list. If you do not find a suitable criterion, click Add, and
in the Filter Fields Editor window, select a field and click Add.

The Criterion Details section changes depending on the criterion selected.

b. Select a condition from the Condition drop-down list.

AG3110 │ 2019-05-07 92
Configure Info Router Rules

c. Select the relevant criterion details in the Criterion Details section.

d. Click Apply to Filter Expression. The filter expression appears in the Filter Expression section.

e. Repeat steps a-d to add additional expressions.

f. Click OK to return to the New Rule Creation window.

8. To configure rule scheduling, in the Scheduling section, click Edit.

9. In the Rule Scheduling Dialog window, use the drop-down lists and other controls to define the
default scheduling parameters for the rule.

10. Click OK to return to the New Rule Creation window.

11. Click OK to return to the rule display area window.

Add an Info Router Rule using Custom Functions

Note: It is recommended to consult with Carestream Professional Services personnel before adding or
modifying Info Router rules using custom functions.

1. In the left pane of the System Configuration tool, go to Info-Router > Rules. The rule display area
appears in the right pane.

2. To add a rule, do one of the following:

l From the System Configuration toolbar, click Add

l Select Add from the right-click menu.

l Right-click the list rule area and select Insert Rule.

3. In the New Rule Creation window, you define the rule parameters, as follows:

a. In the Description box, type a description of the rule.

b. From the Function drop-down list, select Custom Function.

c. From the Event Type drop-down list, select the relevant event type.

d. From the Command Type drop-down list, select the relevant command type. To configure a
group command, select Group Command.

The parameters section changes depending on the event type and command type selected.

e. In the parameters section, complete the relevant parameters for the function and add actions to
the group. If required, you can define another set of group commands and specify whether these
commands should be executed sequentially or in parallel.

4. To set an event filter, in the Filter section, click Edit.

5. In the Edit Filter window, you compose a filter expression as follows:

AG3110 │ 2019-05-07 93
Configure Info Router Rules

a. Select a criterion from the Filter Criteria list. If you do not find a suitable criterion, click Add, and
in the Filter Fields Editor window, select a field and click Add.

The Criterion Details section changes depending on the criterion selected.

b. Select a condition from the Condition drop-down list.

c. Select the relevant criterion details in the Criterion Details section.

d. Click Apply to Filter Expression. The filter expression appears in the Filter Expression section.

e. Repeat steps a-d to add additional expressions.

f. Click OK to return to the New Rule Creation window.

6. To configure rule scheduling, in the Scheduling section, click Edit.

7. In the Rule Scheduling Dialog window, use the drop-down lists and other controls to define the
default scheduling parameters for the rule.

8. Click OK to return to the New Rule Creation window.

9. Click OK to return to the rule display area window.

Activate and Deactivate Info Router Rules

To activate or deactivate Info Router rules, select one or more rules and select Activate, Deactivate, or
Suspend from the right-click menu.

Edit an Info Router Rule

1. In the left pane of the System Configuration tool, go to Info-Router > Rules. The rule display area
appears in the right pane.

2. To edit a rule, select the rule and do one of the following:

l From the System Configuration toolbar, click Edit

l Select Update Add from the right-click menu.

l Double-click the rule.

3. In the Edit Rule window, change the settings as required. For more information, see Configure Info
Router Rules on page 92.

4. Click OK to return to the rule display area.

Delete an Info Router Rule

1. In the left pane of the System Configuration tool, go to Info-Router > Rules. The rule display area
appears in the right pane.

2. Select or more rules and click Delete or select Delete from the right-click menu.

3. In the Delete Rule window, click Yes to confirm the deletion and return to the rule display area.

AG3110 │ 2019-05-07 94
Configure Info Router Aliases

Configure Info Router Aliases

An alias is an alternative target for a command (such as a person or a device), with its own set of rules.
For example, you can create an alias called On-Call that consists of the user, Dr. Jones. The conditions for
this alias may be a range of dates: January 1, 2003 16:00 to January 2, 2003 23:00. The system recognizes
Dr. Jones as the on-call physician and routes information and images to Dr. Jones during the specified time
frame (as defined by the rules).
Aliases are displayed in a table with the following information:

Field Description

Alias Name The name of the alias.

Destinations The user or device to which the information is being copied.

Conditions The conditions defined for the alias. Possible options are:
l Always—Information is sent to all the items included in the alias.

l Date—The alias is applied during a defined date range.

l Default—Default conditions apply during dates outside of the specified date range.

You use the System Configurator to add, edit and delete Info Router aliases.

To add an alias

1. In the left pane of the System Configuration tool, go to Info-Router > Alias. The display area appears
in the right pane.

2. From the System Configuration toolbar, click Add or select Add from the right-click menu.

The New Alias Creation window opens.

3. In the Alias Name box, type a name for the new alias, or select an existing alias from the drop-down
list.

4. In the Archives area, select the archives to include in the alias.

5. In the Aliases area, select the existing aliases to include in the alias, if any.

Note: Click Clear Selection at any time to clear the selected items.

6. From the Condition drop-down list, select one of the following conditions to apply to the alias:

l Always

l Date

l Default

7. From the From and To drop-down lists, select the range of dates and times for which the alias is
active.

AG3110 │ 2019-05-07 95
Configure General Parameters

8. To define a recurring alias, click Recurrence and, in the Alias Recurrence window, select the
relevant days and click OK to return to the Edit Alias window.

9. Click OK.

The alias appears in the display area and begins immediate operation.

Note: To modify an existing alias, double-click the alias name in the display area to open the Edit
Alias window.

Configure General Parameters

You use the System Configurator to configure general parameters that apply to all rules, such as the
maximum number of commands that can run simultaneously and the priority of a command compared to
other commands.
In addition, you can also define parameters that apply to specific rules, such as timeout and backup
parameters.

Configure Concurrent Commands

1. In the left pane of the System Configuration tool, go to Info-Router > General Parameters. The
display area appears in the right pane.

2. In the Maximum Concurrent Commands box, enter a number or use the arrows to select the number
of commands that can run simultaneously.

3. For each relevant command, you can define the maximum number of actions of this type that can run
simultaneously and set the priority compared with other commands. The lower the number, the higher
the priority. You can also disable the command, if required.

To set the Maximum and Priority parameters, double-click the field and type the required number.

Configure Timeout Parameters

1. In the left pane of the System Configuration tool, go to Info-Router > General Parameters >
Timeout. The display area appears in the right pane.

2. Complete the relevant response timeout for each of the options, as required.

Configure Backup Parameters

1. In the left pane of the System Configuration tool, go to Info-Router > General Parameters >
Backup. The display area appears in the right pane.

2. Complete the relevant backup parameters, as required.

AG3110 │ 2019-05-07 96
Configure RIS Synchronization

Configure RIS Synchronization

The RIS Synchronization process ensures that patient details in Vue PACS are the same as those in RIS,
and that the patient attributes stored in the Workflow Manager contain the most up-to-date details from the
hospital records. If there are differences, the information from RIS is used to update the information stored
in PACS.
RIS synchronization occurs whenever a study is stored in the Workflow Manager or an event takes place in
RIS. RIS notifies PACS about relevant events via an HL7 interface with IS Link, which forwards the
notification to the Workflow Manager.
The Workflow Manager is notified for the following events:

l A patient is added to RIS or patient details are updated – The Workflow Manager searches its database
for the patient details according to the patient ID. If the patient is found, the attributes are overridden by
the updated attributes in RIS.

l Patient details are merged – When two sets of details for a patient are merged in RIS, the Workflow
Manager is notified. The patient details are then merged in the Workflow Manager.

l A new report is created – When a report is created in RIS, the Workflow Manager is notified. The Has
report column in the DIDB_STUDIES table is updated to Yes. If the Workflow Manager has a related
study, it updates the study status to READ. This removes studies from the UNREAD worklist that were
not read using the Vue PACS Client.

l Order details are changed – When the details of an order are changed, such as the date of a scan, the
Workflow Manager is notified.

When attributes are updated as a result of the RIS Synchronization process, the old values and updated
values are logged in the Audit Trail log and can be viewed using the Audit Trail Viewer.

Configure Fields for RIS Synchronization

You use the HL7-PACS Field Mapping function to indicate which HL7 fields in RIS should be updated in the
Workflow Manager. For more information, see Configure HL7-PACS Field Mapping on page 84.

Enable RIS Synchronization

1. In the left pane of the System Configuration tool, go to Application Configuration > Ris-Sync >
Ris-Sync process.

2. Select the Enable Ris-Sync process check box in the right pane

When the RIS Synchronization process fails for some reason, it is possible to perform manual RIS
synchronization. For more information, see Perform Manual RIS Synchronization on page 139.

AG3110 │ 2019-05-07 97
Configure Life Cycle Management

Configure Life Cycle Management

Life Cycle Management provides support for the automatic transfer of images from one storage tier to
another. You use the System Configuration tool to configure the rules that control the automatic migration
of data across these multiple storage tiers. There is no limit to the number of storage tiers that can be used.
The migration process is a scheduled task that runs at a predefined time every day. This process queries
the database for image information and evaluates the migration rules by tiers, using defined rule groups. It
then uses the Info Router to migrate the actual data.
You can configure that after images are copied to the destination tier they will be deleted from the source
tier. An archive tier (such as the Archive Agent) is the last tier in the life cycle. A backup process writes
data to this tier immediately. The data is not deleted until the data’s life cycle is complete; sometimes the
data is never deleted.
The distinction between migration and backup is important to understand when configuring Life Cycle
Management:

l Migration is used to migrate data from one type of media to another over time, usually as a
cost/performance tradeoff.

l Backup is used to make copies of data as soon as possible after ingestion, so that images are stored on
multiple media, for reliability purposes.

In this example, Life Cycle Management rules are configured as follows:

l Migrate data to Tier B after 1 year

l Migrate data to Tier C after 2 years

l Back up data to tape immediately

AG3110 │ 2019-05-07 98
Configure Image Life Cycle Rules

You can use the System Configuration tool to configure the following Life Cycle Management features:

l Image life cycle rules—Use to configure rules that define when to move images and where to move
them.

l Archive settings—Use to configure server availability and the percentage storage space available for
each server.

l Auto-delete priorities—Use to manage system-wide deletion rules.

l Auto-delete for database objects—Use to set the storage settings for icons.

Configure Image Life Cycle Rules

You use the System Configuration tool to configure the rules that define when to move images and where
to move them.
Each rule uses a rule group as a template, which defines the parameters to use when searching for images
to migrate. For example, the Study Older than [param1] days rule group can be used to search for
images that are more than a year old.
The rule groups are defined in the Central Configuration Editor in the following location:
imaginet\system\applications\medistore\admintool\auto_delete\images\exclude_
templates
For each rule group, you define whether it is a migration (copy to new tier, then delete from old tier) or an
archive (copy to new tier and leave on old tier) and when to copy the images.

Add a Rule Group

1. In the left pane of the System Configuration tool, go to Life Cycle Management > Life Cycle
Configuration. The configuration area appears in the right pane.

2. In the Image Life Cycle section, click Add Group. In the Add Life Cycle Group window, select the
group to add from the list of groups and click OK.

3. If there is a parameter to add, type the relevant value is the Fill In Values window and click OK to
return to the configuration area.

4. Use the and buttons to change the order of the selected rule group.

You can now configure the image life cycle for the rule group. For details, see Configure the Image Life
Cycle on the next page.

Update Rule Group Parameters

1. In the left pane of the System Configuration tool, go to Life Cycle Management > Life Cycle
Configuration. The configuration area appears in the right pane.

2. In the Image Life Cycle section, select the group to edit and click Edit Group.

3. In the Fill In Values window, update the value for the rule and click OK to return to the configuration
area.

AG3110 │ 2019-05-07 99
Configure Image Life Cycle Rules

Remove a Rule Group

1. In the left pane of the System Configuration tool, go to Life Cycle Management > Life Cycle
Configuration. The configuration area appears in the right pane.

2. In the Image Life Cycle section, select the group to remove and click Remove Group.

3. In the Remove group window, click Yes to confirm the removal and return to the configuration area.

Configure the Image Life Cycle

You use the Edit Life Cycle option to add rules to the image life cycle for a rule group and server.

1. In the left pane of the System Configuration tool, go to Life Cycle Management > Life Cycle
Configuration.

2. In the right pane, in the Image Life Cycle section, select the relevant group.

3. In the lower section, select the relevant server and click Edit Life Cycle.

4. In the Life Cycle window, use the drop-down menus to define where to copy images from and to,
when to copy the images, and whether to delete from the source tier for the selected server.

5. Click OK. A schematic diagram of the life cycle rules appears in the lower section.

6. Repeat steps 2-5 to configure rules for additional rule groups and servers.

Update Image Life Cycle Rules

When you have configured the image life cycle for a rule group and server, you use the Edit and Remove
options to change and remove the rules.

To edit a rule

1. In the left pane of the System Configuration tool, go to Life Cycle Management > Life Cycle
Configuration.

2. In the right pane, in the Image Life Cycle section, select the rule group.

3. In the lower section, select the relevant server and click Edit.

4. In the Settings window, use the drop-down menus to define where to copy images from and to, when
to copy the images, and whether to delete from the source tier for the selected server.

5. Click OK to return to the configuration area.

To remove a rule

1. In the left pane of the System Configuration tool, go to Life Cycle Management > Life Cycle
Configuration.

2. In the right pane, in the Image Life Cycle section, select the rule group.

3. In the lower section, select the relevant server and click Remove. The rules for the relevant server
are removed and schematic diagram is updated.

AG3110 │ 2019-05-07 100

Configure the Archive Settings

Note: If you select the main server, then a confirmation message appears. Click Yes to confirm
removal of all the image life cycle rules for that server.

Configure the Archive Settings

You use the System Configuration tool to configure the archive settings, which define the server availability
and percentage storage space available for each server.
Each file-oriented storage tier is configured with a high water mark and a low water mark. In the out-of-the-
box implementation, the default auto delete threshold for the main archive is set to 80%. This is the
standard setting and should not be changed.

1. In the left pane of the System Configuration tool, go to Life Cycle Management >
Archive Configuration. The archive settings display area appears in the right pane.

The archive settings display area shows the storage available for the selected server, as well as other
statistics. The information is displayed in cylindrical format and shows the high and low water mark
levels for storage space.

2. To view the details of different servers, select the server name in the Image Life Cycle section.

3. To configure the image and study availability for the selected server, click the upper Edit button.

4. In the Default Availability window, select the image and study availability from the drop-down list.

You can choose from the following options:

l ONLINE—Images are electronically accessible with high performance, as needed. This generally
applies to various types of spinning storage, such as DASD, RAID, and NAS. At least one tier
must be defined to provide online image availability.

l NEARLINE—Images are electronically accessible, however not with performance that users may
demand. This generally applies to tape library storage (via Archive Agent) and to some DICOM or
HSM storage tiers.

l NEARLINE1— Images are electronically accessible; performance is not as good as online, but it
better than NEARLINE. This generally applies to CENTERA storage.

l AUTO— For the LTSM server, the status is automatically updated between NEARLINE and
OFFLINE depending on whether the tape is in or out of the tape library

l OFFLINE—Images are managed from a tape library and need manual intervention for retrieval.
Access performance is uncertain and can be expected to be very slow.

5. To configure the tier status for each server, click the lower Edit button.

6. In the Status window, select the tier status from the drop-down list.

You can choose from the following options:

AG3110 │ 2019-05-07 101

Configure Auto Delete Rules

Option Description

ACTIVE The normal status of a tier. Data can be migrated to and from active tiers.

READ-ONLY Data can be accessed from a read only tier, however, data cannot be
written to the tier or migrated to another tier. This status prevents a tier
from participating in migration activities from the time the status is set to
read-only.

OBSOLETE New data cannot be stored on the tier, but old data can be migrated to an
active tier. This can be useful for tiers whose storage technology is
obsolete and which can be emptied slowly, over time.

UNAVAILABLE There is a problem with the tier and it cannot be accessed.

Configure Auto Delete Rules

Since there is a finite amount of disk space on the servers, space must be cleared periodically by removing
those studies that are least likely to be required. You use the System Configuration tool to configure rules
for removing studies.
The Auto Delete process is a scheduled task that runs rules to determine the priority for deleting images
from the file system. Then, when the high watermark is reached, the delete queue is processed to delete
the files in this order until the low water mark is reached. Typical rules delete the oldest data first, but only if
the data has been backed up.
The Auto Delete process applies to all caches on all storage tiers, as well as caches within Archive Agent.
If the watermarks are not defined in the Archive Settings window, the default watermark amounts are taken
from the figures configured in the Database Objects Auto Delete window.

Add an Auto Delete Rule

1. In the left pane of the System Configuration tool, go to Life Cycle Management > Auto-
Delete Priorities. The rule display area appears in the right pane.

2. To add a rule, click Add.

3. In the Add Image Deletion Rules window, select the rule to add and click OK.

4. If there is a parameter to add, type the relevant value is the Fill In Values window and click OK to
return to the configuration area.

5. Repeat steps ‎2-4 to configure additional rules.

6. Use the and buttons to change the order of the rules.

Remove an Auto Delete Rule

1. In the left pane of the System Configuration tool, go to Life Cycle Management >
Auto-Delete Priorities. The rule display area appears in the right pane.

AG3110 │ 2019-05-07 102

Configure Auto-Delete Rules for Database Objects

2. Select the rule to remove and click Remove.

3. In the Remove Rule window, click Yes to confirm the removal and return to the configuration area.

Update Auto Delete Rule Parameters

1. In the left pane of the System Configuration tool, go to Life Cycle Management >
Auto-Delete Priorities. The rule display area appears in the right pane.

2. Select the rule to edit and click Edit.

3. In the Fill In Values window, update the value for the rule and click OK to return to the configuration
area.

Configure Auto-Delete Rules for Database Objects

Images saved as icons can be deleted based on storage availability, or after a configurable amount of time.
You use the System Configuration tool to configure rules for removing these icons.

1. In the left pane of the System Configuration tool, go to Life Cycle Management > DB Objects Auto-
Delete. The display area appears in the right pane.

2. In the Icons Storage Settings section, select from the following options:

Option Description

Set storage limit for The screen expands to display the Icons Auto-Delete Settings section.
Icons You can specify whether to allow icon deletion for non-online images only
or for all images.

You can also manually set the storage limit or allow the system to
calculate the storage limit by icon size based on the number of months
entered.

It is recommended to set the storage limit to 2 GB.

No storage limit for You can specify whether to allow icon deletion for non-online images only
Icons or no icon deletion. The storage information for icons tablespace size and
current storage used is displayed in linear format.

Configure Patient Matching Rules

You use patient matching rules to define which patient attributes are matched when incoming studies are
archived. This is useful, for example, to correct errors when the wrong patient ID is entered manually by
technicians.
The out-of-the-box implementation includes the following default patient matching rules:

l Rule 1—based on patient ID, original patient ID, accession number

l Rule 2—based on patient ID, original patient ID, last name

You can modify the default rules or add additional rules, as required.

AG3110 │ 2019-05-07 103

Add a Patient Matching Rule

The patient matching mechanism runs the rules according to their priority, as follows:

1. Run the first rule:

If a match is found, the study is associated with the existing patient and the mechanism stops.

If no match is found, continue to the remaining rules until a match is found.

2. If no match is found:

The study is archived under a new patient ID.

Add a Patient Matching Rule

1. In the left pane of the System Configuration tool, go to PIX Management > Patient Management
and select onstore. The rule display area appears in the right pane.

2. Click Add. The new rule appears in the rule display area.

3. Select the Select first match in case of multiple-match result check box, if required.

4. In the Rule Details section, configure the patient matching criteria for each of the relevant attributes.
Choose from the following options:

l No Compare—the attributes are not compared

l Equal or NULL—the attributes must be equal or empty to match

l Equal—the attributes must be equal to match

l Equal Non Empty—the attributes must be equal and not empty to match

5. Repeat steps 2-4 to add additional patient matching rules.

6. Use the and buttons to change the order of the selected rules.

7. Click Save .

Edit a Patient Matching Rule

1. In the left pane of the System Configuration tool, go to PIX Management > Patient Management
and select onstore. The rule display area appears in the right pane.

2. Select the rule you want to edit.

3. In the Rule Details section, modify the patient matching criteria for the rule. For more information on
possible options, see Add a Patient Matching Rule above.

4. Click Save .

AG3110 │ 2019-05-07 104

Delete a Patient Matching Rule

Delete a Patient Matching Rule

1. In the left pane of the System Configuration tool, go to PIX Management > Patient Management
and select onstore. The rule display area appears in the right pane.

2. Select the relevant rule and click Remove.

3. In the Patient Matching window, click Yes to confirm the deletion and return to the rule display area.

4. Click Save .

Configure a Disk Folder on a Local PACS Server

You can use the System Configuration tool to define a file system directory locally on the PACS server.
This directory, known as a disk folder, can then be used to store and retrieve studies using the Vue PACS
Client or any standard DICOM client.
The disk folder supports the Study Root Query/Retrieve Information Model for querying and retrieving. The
following features are not supported by the disk folder:

l Automatic backup

l Study workflow, sticky notes, and presentations

l Advanced life cycle management (auto delete is available)

l Access control

l DICOM parsing rules

l Compression (except in RICE format)

l Any feature that needs database support

Set Up the Disk Folder

1. On the local PACS server, open the System Configuration tool.

2. In the left pane, go to Nodes Configuration > Workflow Manager and select the local PACS server.
The DICOM tab appears in the right pane, open on the Servers Options tab.

3. Click Add.

4. Select FOLDER and click OK.

5. In the AE column, type an AE title for the new folder, for example <server_name>FLD.

6. Create a new empty folder on the server and type its path in the Database Path box.

AG3110 │ 2019-05-07 105

Configure the Disk Auto Delete Process

7. You can define the following optional parameters:

Parameter Description

Supports Defines the Vue PACS Client behavior regarding the folder.
Store/Delete/Query

Classified Replaces the patient name with initials in stored studies.

Uncompressed Specifies that stored DICOM images are not compressed.

Read only Prevents changes to the folder, such as store and delete.

Create Folders in Creates a folder for the disk folder in the Vue PACS Client.
DX

Auto Delete Enables the Disk Auto Delete scheduled task, which deletes studies stored
in the disk folder for more than the specified number of days, or if the free disk
space in the local drive is less than that specified.

8. Click Save to save your changes.

Configure the Disk Auto Delete Process

Disk folders that have the Auto Delete checkbox selected in the System Configuration tool, are monitored
by the WINDOWS scheduled task, disk_auto_delete. The task’s main purpose is to delete old
studies from the disk folder. It runs daily by running the disk_auto_delete.exe file, located in:
%imaginet_root%mv\exe
You can use the following command line arguments for this utility:
Command Line Arguments
-t database_AE Runs the process on a disk folder with database_
AE AE.

-l Runs the process on all disk folders on the

server.

-z DAY Reports zombie files (files that have no reference

in the metadata, and which might be created if the
folder service is killed unexpectedly). Zombie file
maintenance is only performed if DAY (one of
MON, TUE, WED, THU, FRI, SAT, SUN)
matches the current day of the week.

-r Forces the deletion of all zombie files detected

(use with caution).

–z Generates a CSV report of the files detected in

the file system path of the disk folder. The CSV
file is only created if zombie files are found.

AG3110 │ 2019-05-07 106

Configure the Disk Auto Delete Process

In the out-of-the-box implementation, the following default arguments are used:

-l -z SUN
This means that the process runs through all the disk folders on the server and performs zombie file
detection on Sundays.

AG3110 │ 2019-05-07 107

System Monitoring

System Monitoring
You can use System Monitoring tools to perform the following system monitoring tasks:

l Perform System Checks below

l Use the Info Router on page 114

l Audit on page 116

l Use the Synchronization Monitor on page 123

Perform System Checks

You can use the System Monitoring & Control tool to monitor processes and run system checks. You can
do the following:

l View system information

l Check the status of licenses

l Run system checks

l Monitor server processes

l Monitor MVS processes

l Run bandwidth tests

l View the Info Router status

To open the System Monitoring & Control tool, select System Monitor > System Check from the
Administration Tool menu. The System Monitoring & Control tool opens showing links in the left pane.

Note: The System Monitoring & Control tool is not available in cluster server deployments.

View System Information

In the left pane, click the System Information link to view general system and product information.

Check the License Status

In the left pane, click the License Status link to view the global license report and license status for a
server. The license status shows the number of licenses issued and the number of licenses in use.
When a license violation occurs, a warning notification appears on the Administration Tool home page.
Click the warning notification to display the Licenses Log, which provides details about the license errors.
Each line in the log indicates whether there is a violation (or error in the check). The percentage values
quantify the amount of violation from the licensed amount.

AG3110 │ 2019-05-07 108

Run System Checks

Important: The license violation does not interfere with system operation. You must contact a
Carestream representative to check or renew the license.

Run System Checks

The system automatically performs a number of system checks, including network, server resources, and
database checks. You can view the status of these checks and run specific checks again. You can also
deactivate or reactivate any of the system checks.
In the left pane, click the Run System Check link to view the system checks in table format. Click the
column name to sort the table by that column.

Run System Check Window Elements

Element Description

Check All Click to run all checks immediately.

To view the results, click View All or View Errors after a few minutes.

View All Click to view the check results.

View Errors Click to view errors or warning.

Each column can be sorted by pressing the column header.

Status The status of the check. Possible values are:

l Green – OK

l Red – Error

l Yellow – Warning

l Gray – Inactive

Category The type of check. Possible values are:

l app

l db

l network

l ltsm

l system

Name The name of the check.

Details The details of the check.

Check Time The time the check was made.

Log Click to view the log and history of errors of the specific check.

AG3110 │ 2019-05-07 109

Monitor Server Processes

Element Description

Run Click to run the check again.

The page is automatically refreshed when the check finishes running.

Repair For scripts that have a repair action, click the link to repair errors.
The page is automatically refreshed when the repair finishes running.

Deactivate/Activate Click to disable or enable a specific check.

When you click Deactivate, the link text changes to Activate and the status
changes to inactive.

Monitor Server Processes

You can monitor the server processes that are running and start and stop specific processes.
In the left pane, click the Server Processes link to view the system processes that are running. The
system processes are displayed in table format. Click the column name to sort the table by that column.

Server Processes Window Elements

Element Description

Status The status of the process. Possible values are:

l Green – Running

l Red – Stopped

l Gray – Inactive

Process The name of the check.

PID The process ID number.

# The number of processes currently running.

CPU Time The total CPU time the process used.

Memory (M) The total real memory the process used.

Max Memory (M) The maximum amount of memory the process can use. If the process exceeds
the memory limit, it is automatically restarted.

Stop Click to stop the process.

Start Click to start the process.

Deactivate/Activate Click to disable or enable a specific process.

When you click Deactivate, the link text changes to Activate and the status
changes to deactivated. When the process is deactivated, it is not automatically
restarted.

AG3110 │ 2019-05-07 110

Monitor MVS Services

Monitor MVS Services

You can view the MVS services currently running on a specific host and port. You can also display the
MVS status and the full list of pools.
In the left pane, click the MVS Services link to view the MVS services. The services are displayed in table
format. Click the column name to sort the table by that column.

MVS Monitoring Window Elements

Element Description

Server List Window

Port Select the port type: non-secured or secured.

MVS Ping Click to display the MVS status on the specific host and port. The details
shown include:
l MVS version

l Grid name

l Node name

l Issuer name.

Test Bandwidth See Monitor the Bandwidth on the next page.

Service List Click to display the MVS services currently running.

Pool List Click to display the list of pools that exist in MVS (even if no service of the pool
is currently up).
See Pool List Window on the next page.

Service Name The name of the MVS service.

Pool Name The name of the pool of the service.

PID The process ID number of the service.

Status The status of the service.

User The user associated with the service.

Request Duration The amount of time that the current request is being handled (for busy services
only).

# Requests The number of requests the service has handled since it started.

Pool Status Click to view details of the pool status and queue details in a new window.

Restart Pool Click to restart all service of the specific pool.

The page refreshes immediately after the pool is restarted.

AG3110 │ 2019-05-07 111

View the Info Router Status

Element Description

Analyze Pool Click to view statistics for the pool in a new window. Statistics shown include
the requests rate and the busy services and pending requests.

Pool List Window

# The row number.

Pool Name The name of the MVS pool.

Pool Status The pool status and the time the status was checked.

Pool Queue Details The pool status.

Pool Status Click to view details of the pool status and queue details in a new window.

Restart Pool Click to restart all services of the specific pool.

The page refreshes immediately after the pool is restarted.

Analyze Pool Click to view statistics for the pool in a new window. Statistics shown include
the requests rate and the busy services and pending requests.

View the Info Router Status

You can view the Info Router status, including the Info Router queue size, command status, and failed
commands.
In the left pane, click the Info Router Status link to view the Info Router status.

Monitor the Bandwidth

You can measure the bandwidth, or throughput of the network, by measuring the time required to transfer a
file of known size using the conn protocol. You can do the following:

l Test the bandwidth between your workstation and the local node

l Test the bandwidth between the local node and remote nodes

l Test the bandwidth between server nodes using the command line

Test the Bandwidth from Your Workstation

To test the bandwidth between your workstation and the local node:

1. To run a bandwidth test from the Administration Tool, select System Monitor > Bandwidth Test from
the Administration Tool menu.

2. In the Bandwidth Test window, you can change the data size, expected rate and data scale. Click
Test to run the bandwidth test.

AG3110 │ 2019-05-07 112

Monitor the Bandwidth

The bandwidth test results appear in the window.

3. Click Exit to close the window.

Test the Bandwidth between Server Nodes

You can test the bandwidth between server nodes for the following PACS components:

l Vue PACS and external Vue Motion

l Vue PACS and Vue PACS

l Vue PACS and other grid nodes

The test is bidirectional, from the remote server to the local server and vice versa. The latency is tested
three times.

To test the bandwidth between server nodes

1. To run a bandwidth test from the System Monitoring & Control Tool, select System Monitor >
System Check from the Administration Tool menu. The System Monitoring & Control tool opens
showing menu links in the left pane.

2. In the left pane, click the MVS Services link.

3. Click the Test Bandwidth button. The bandwidth test results are displayed.

4. To change the expected bandwidth and size of data to transfer in the test, select the required value
from the Data Size (Megabits) list.

Use the Command Line

You can measure the bandwidth between server nodes for PACS components by running bandwidth and
latency tests, together or separately, from the command line. You can also run the command line utility
from the Vue PACS client installation folder. Example commands include:

l For a remote server:

tool_ping -i <server_name/ip> -p <port> -b <size> -lt <times>

l For a grid server:

tool_ping -g <grid_name> -b <size> -lt <times>

l For a grid server using a secure connection:

tool_ping -g <grid_name> -b <size> -lt <times> --secure

Command Line Parameters

-g The grid name.

-i The machine name or IP address. The default is localhost.

-p The port number. The default is 2104.

AG3110 │ 2019-05-07 113

Use the Info Router

-r The number of times to repeat the ping.

-s The sleep time between repetitions, in milliseconds.

-b The expected bandwidth and size of data to transfer in the test, in Mbps.

-lt The number of consecutive latency tests to perform.

-o Use to open a connection and hold it open.

-t The timeout. The default is 10 seconds.

--slow Force a slow connection.

--secure Force a secure connection.

--fast Force a fast connection.

--nonsecure Force a nonsecure connection.

-l Print the routing table.

-h Help.

Use the Info Router

You can use the Info Router client to monitor rules that determine how images and other data are routed
within Vue PACS and under what conditions the images are sent.
The Info Router client is accessible even in cases where Info Router server processes are down.
The Info Router client automatically synchronizes with the server, enabling you to create and update rules,
as well as view existing rules and their related data. You can also create aliases for items and groups of
items, and apply conditions to them.

Get Started with the Info Router Client

To open the Info Router client, select System Monitor > Info Router from the Administration Tool menu.
The Info Router client opens, showing the commands execution status, the command list area, and the
command log information area.
The commands execution status panes display the status as shortcuts. To view information about each
status, click the shortcut.
Screen splitter arrows between the areas enable you to resize the Command Log Information area, or click
and drag it to a new position.
The number of commands displayed in the Info Router client can be controlled by applying filters.

Command List Area

The Command List area displays all commands created from all the active rules, together with general
information and the current status of each command. For each command, it includes the following

AG3110 │ 2019-05-07 114

Get Started with the Info Router Client

information:

Command Description

ID The unique identification number for each command, according to the order in
which the commands were created. When a command is deleted, the
remaining commands retain their original identification numbers

Type The type of command.

Patient Name The name of the patient.

Source The name of the source device from which the image or study is copied

Destination The name of the destination device to which the image or study is being copied.

Status The current operational status of the command. Possible values are:
l Running—The command is being executed. If the command previously
failed, the number in brackets indicates the number of retries.

l Waiting—The system is waiting for the next Running session, if the

command previously failed.

l Succeeded—The command was successfully executed.

l Failed—The command failed.

Date Started The date and time when the command initially started to run.

Date Completed The date and time when the command succeeded or failed.

Percent Completed The percentage of completion of the command currently running. The display
resets to 0% each time there is a retry.

Command Log Information Area

The Command Log Information area displays a running log of information for the command currently
selected in the Command List area.

Filter Commands
You can filter the commands that are displayed in the Command List area of the Monitor tab. You can also
view the number of commands that appear in the Command List area when the filters are applied.
You should apply the appropriate command filters to reduce the number of commands that appear in the
Command List area of the Monitor tab. When fewer commands appear, the retrieval time is reduced.

1. Do one of the following:

l From the Info Router toolbar, click Filter .

l From the View menu, select Filter.

AG3110 │ 2019-05-07 115

Audit

The Commands Filter window opens.

2. In the Date section, use the following options to filter commands by date:

l Previous—Shows commands initiated in a predetermined number of days, hours, or minutes.

l Between Dates—Shows commands initiated between the specified dates.

3. In the Status section, select the relevant status check boxes, such as Not Started, Waiting, and
Running.

4. In the General section, complete the relevant parameters:

Parameter Description

Command ID Between The ID of the command from which to start the display. If you leave this
field blank, all commands created up to the selected command in the To
ID field are displayed.

Command Type The type of command, such as DynamicCopy, or Group SR.

Originator Rule ID The rule that generated the command.

Patient Name The name of the patient. Enter a partial name to display all the patient
names that begin with that string of letters.

Source The source of the event.

Destination The destination of the event.

5. The Number of filtered commands box displays the number of commands that are shown if filters
are applied. To update the counter, click Refresh Count. The button is unavailable if there are no
changes.

6. Click OK to apply the selected filters.

The information in the Commands List area is updated and displayed according to the criteria you
defined.

Audit
As Vue PACS handles protected health information (PHI), regulations require that all PHI-related activities,
including warnings and failures, are logged. Each logged event can include: the operation performed, the
user who performed it, the location from which it occurred, and the information affected.
You can use the Audit Trail Viewer to monitor the logged events and identify unusual system activity or
suspicious user behavior. You can exclude events from auditing and define filters to manage information
collected by the system.

AG3110 │ 2019-05-07 116

Get Started with the Audit Trail Viewer

Get Started with the Audit Trail Viewer

1. To open the Audit Trail Viewer, select System Monitor > Audit Trail from the Administration Tool
menu.

2. In the Filter Events window, enter any relevant parameters to filter the events shown. For more
information, see Filter Events below.

3. Click OK. The Audit Trail Viewer window opens, showing a list of events.

Define the Display in the Audit Trail Viewer

In the Audit Trail Viewer tool, a default set of fields is displayed. You can change the default view and
choose which fields to display, the order in which they are displayed, and the width of each column.
You can make the following changes to the display:

To Do this

Move a column Left-click the column header and drag the column to the right or left.

Delete a column Right-click the column to delete and select Remove Column.

Change the column width Left-click the edge between two adjacent column headings and drag to the
position you want.

Add a column Right-click anywhere on the column header, select Field Chooser, and
click Add.

Remove a column Select a field in the right pane, select Field Chooser, and click Remove.

Save changes for future Right-click anywhere in the column header and select Save Settings.
sessions

Reset the filters Right-click any column in the right pane and select Clear All Filters.

Reset the default settings Right-click anywhere in the column header and select Set Default
Settings.

Filter Events
You can filter the events displayed in the Audit Trail Viewer window to display a manageable number of
events and reduce consumption of system resources.
You can apply a single filter or use multiple filter criteria, as required. If filters have been applied, the filter
criteria are displayed in the relevant filter fields (white fields above the column names).

To apply a single filter to the events list

1. In the events list area, click in the filter criteria field above the required column heading.

2. In the filter window that opens, enter the required filter criteria. To remove existing filter data, click
Clear.

AG3110 │ 2019-05-07 117

Get Started with the Audit Trail Viewer

3. Click OK.

The events list is filtered according to the filter you selected. The filter criteria appear in the field above
the relevant column name.

To apply multiple filters to the events list

1. From the Audit Trail Viewer toolbar, click Filter or from the View menu, select Filter Events. The
Filter Events window opens.

2. In the Date Filter section, use the following options to filter events by date:

l Between—Shows events that occurred between the specified dates. Use DD/MM/YYYY format.
To use the current date, click Current date.

l Previous—Shows commands initiated in a predetermined number of days.

3. In the Severity Filter section, select the relevant event types to display, as follows:

l Information—events related to PHI access, such as a data query or login.

l Warning—events that could affect the system, such as major configuration changes or
start/stop operations (for example, stopping the Info Router). Any changes made to the list of
events that are not audited, are also considered warning events.

l Error—events that indicate any type of failure that affects the availability of the system.

l Success Audit—events such as successful logins to the system and other security-related
matters.

l Failure Audit—events that indicate a security violation, such as an authentication failure (bad
login) or an access control restriction violation attempt.

4. In the Event Filters section, complete the relevant parameters, as follows:

l User—the name of the user who performed the action recorded by the event.

l Application—the source of the event, such as the Central Configuration.

l Patient ID—the patient ID of the event:

l Last Name—the patient’s last name.

l First Name—the patient’s first name.

Note: Partial entries and wildcards can be used in these fields.

5. Then select the following items:

AG3110 │ 2019-05-07 118

Get Started with the Audit Trail Viewer

l Category—the event type, such as System Access or Account Management.

l Sub Category—the event subtype, such as User Authentication or Security Alert.

6. Do one of the following:

l Click OK to apply the selected filters. The list of events is updated automatically according to the
filter criteria specified.

l Click Clear to clear existing filter criteria. You can then reset the filter criteria or click OK to close
the window.

Sort the Display

You can sort the information displayed in the Audit Trail Viewer window.
Click a column heading to sort the entire list by that item in ascending order. Click the same column
heading again to sort the list in descending order.
You can sort the events displayed in the Audit Trail Viewer window using up to three columns.

1. Click once on a column heading to perform an ascending sort. Click the same column heading again
to perform a descending sort.

2. Press Shift and click another column heading to select a secondary sort.

3. Press Ctrl and click another column heading to perform a tertiary sort.

If a column is used for a sort, a symbol is displayed next to the column name, as follows:

Symbol Description

First sort ascending

Second sort ascending

Third sort ascending

First sort descending

Second sort descending

Third sort descending

Refresh the Display

The Audit Viewer Tool window is updated with the latest information.
You can manually refresh the events displayed in the Audit Trail Viewer, as follows:

l From the Audit Trail Viewer toolbar, click Refresh .

AG3110 │ 2019-05-07 119

Define Auditing Settings

l From the View menu, select Refresh.

The currently displayed events are updated and displayed according to the latest information in the archive.

Define Auditing Settings

You can enable or disable the auditing function. When the auditing function is disabled, no events that take
place in the system are recorded.

Note: The auditing feature of Vue PACS is a critical last line of defense against misuse of the
information contained in the system. It should never be disabled, except by authorized personnel in
consultation with Carestream.

1. Do one of the following:

l From the Audit Trail Viewer toolbar, click Audit Settings .

l From the Settings menu, select Audit Settings.

The Settings window opens.

2. To enable auditing, in the Audit Status section, select Enable.

3. In the Max Rows To Fetch section, enter a number or use the arrows to select the maximum number
of rows to fetch.

4. Click OK.

Note: Enabling and disabling the auditing function are considered Warning-level events. If you
choose to disable the auditing function, this operation is recorded as the last event before auditing
stops.

View Event Details

You can view the details of an event in a separate pop-up window, as required.

1. Select the required event in the events list.

2. From the View menu, select Event Details, or double-click the required event. The Event Details
window opens, which includes the most important information about the selected event, such as the
event description, the category/subcategory, and the operation.

3. You can click the Prev and Next buttons to view the details of other events in the events list.

Note: The fields displayed in the Event Details window are fixed and do not reflect the selections
made in the Add/Remove Fields window.

Define Display Settings

You can define the automatic refresh interval for the events that display in the Audit Trail Viewer.

AG3110 │ 2019-05-07 120

Archive Audit Data

1. From the Audit Trail Viewer toolbar, click Display Settings or from the Settings menu, select
Display Settings. The Update Settings window opens.

2. To automatically update the events displayed in the Audit Trail Viewer, select the Automatic Refresh
check box.

3. In the Refresh Interval field, enter a number or use the arrows to select refresh interval in seconds.

4. Click OK to save the settings.

Archive Audit Data

You can archive audit data periodically to prevent the Audit Trail Viewer from becoming overloaded. The
archived audit data is exported to external files, which can be restored for viewing, if required.

Note: When audit data is exported to external files, it is no longer backed up as part of the database
backup. It is the responsibility of the site to back up the exported audit files.

To export audit data to an external file

Run the following script from the command line:
%imaginet_root%scripts\TableExporter\TableExporter.pl <arg1> <arg2>
<arg3> <arg4> <arg5> <arg6> <arg7>
where:

l arg1 = Logical database name, for example, mstore

l arg2 = Table owner, for example, auditing

l arg3 = Table name, for example, audit_log

l arg4 = Date column for the filter, for example, event_date

l arg5 = Primary key column, for example, log_dbid

l arg6 = The number of months to keep in the database. The value refers to full months. For example, if
set to 2, the previous two months are kept. In this case, if the script is run in the middle of March, then
audit data from January and February is kept and all audit data up to the end of December is exported to
external files.

l arg7 = Location for exports

For example:
%imaginet_root%scripts\TableExporter\TableExporter.pl mstore auditing
audit_log event_date log_dbid 2 c:\audit
The script creates GZIP files for each month exported, and a corresponding log file that contains the
number of rows exported for each month. For example:
AUDITING-AUDIT_LOG-2015_12.exp.gz
AUDITING-AUDIT_LOG-2015_12.log

AG3110 │ 2019-05-07 121

View Archived Audit Data

To import archived audit files to the database

Run the following script from the command line:
%imaginet_root%scripts\TableExporter\ArchivedDataManager.pl
action=import file=<file> fromuser=<source user name> touser=<target
user name>
where:

l file can be a GZIP file

l touser must include offline

For example:
%imaginet_root%scripts\TableExporter\ArchivedDataManager.pl
action=import file=c:\audit\AUDITING-AUDIT_LOG-2015_12.exp.gz
fromuser=auditing touser=audit_offline
For GZIP files, the script extracts the files to the following temporary location:
%imaginet_root%scripts\TableExporter\temp
It then imports them to the database and deletes them from the temporary location.
If there is not enough space in the temporary location, or if there is need to change the default path, add the
following parameter to the restore script:
temp=<temp_path>
You can restore more than file at the same time. In this case, it is recommended that you change the
default for creating indexes when running the commands, except for the last one running. To change, add
the following parameter to the import script:
indexes=n

View Archived Audit Data

You can view audit data that was archived and restored to the database in the Audit Trail Viewer.

1. From the View menu, choose Select Audit Repository > audit_offline.

2. In the Filter Events window, enter any relevant parameters to filter the events shown. For more
information, see Filter Events on page 117.

3. Click OK. The Audit Trail Viewer window opens, showing a list of events.

Important: When you have finished viewing the restored audit data, it is recommended that you delete
it from the database to save space and time when backing up the database.

To delete the restored audit data

Run the following script from the command line:
%imaginet_root%scripts\TableExporter\ArchivedDataManager.pl
action=delete schema=<schema name> tablename=<table name>

AG3110 │ 2019-05-07 122

Export Logs to MICROSOFT EXCEL

For example:
%imaginet_root%scripts\TableExporter\ArchivedDataManager.scr
action=delete schema=audit_offline tablename=audit_log

Export Logs to MICROSOFT EXCEL

You can export logs in the Audit Trail Viewer and store them on your computer in a CSV (comma separated
value) format.

1. From the Audit Trail Viewer toolbar, click Export .

2. In the Export Audit to File window, select the location to save the file.

3. Click OK.

Use the Synchronization Monitor

In grid and cluster environments, data is synchronized between the server nodes using the
SMARTSYNCH tool. You can use the Synchronization Monitor to view the synchronization status and any
synchronization errors, if they exist.

Get Started with the Synchronization Monitor

You access the Synchronization Monitor from the target side, for example, from the data center or from the
primary archive.
From the target server, select System Monitor > Synchronization Monitor from the Administration Tool
menu.
The Synchronization Monitor opens, showing the current status of each archive being synchronized. Fields
with synchronization errors appear as red or yellow fields.
For each of the archives, you can view the following information:

Field Description

Remote Site The name of the remote site that is being synchronized. Archives that are
configured but do not run are displayed as grayed out.

Grid Role and Type The grid role and type of the archive. Examples of grid roles include archive
data centers, satellites, and synchronized backup servers.
Examples of types include metadata and pixel data, metadata only, and pixel
data only.

Last Sync Time The last time a successful synchronization was performed. This indicates
whether the synchronization mechanism is working well with this archive.
A failure here indicates that there is a general error, such as incorrect
configuration, network failure, or some major application problem on the source
or target archive (for example, sync_main or sysync are not running).

AG3110 │ 2019-05-07 123

View Synchronization Details

Field Description

Min Sync Time The minimum synchronization time. This indicates whether the
synchronization mechanism is working well for all the operations and groups of
this archive.
A failure here indicates that there is an error for one or more groups, though
others may be working properly. This may be due to an application error, a
performance problem, or corrupted data.

Sync Gap Indicates that the synchronization mechanism is working but is running behind.

Sync Groups Rejects Displays the number of synchronization groups that have synchronization
rejects for this archive in the last 24 hours.

Note: Disabled operations and groups are not included when calculating the values.

View Synchronization Details

In the Synchronization Monitor, double-click an archive to display more details of SMARTSYNC operations
and groups for that archive.
For the selected archive, you can view the following information:

Field Description

Operation The operation that is being synchronized. Operations that are configured but do
not run are displayed as grayed out.

Group The group that is being synchronized. Groups that are configured but do not run
are displayed as grayed out.

Last Communication The last time a successful synchronization was performed for this group.
Time

Local Change Number The local change number indicates the last synchronized change.
Remote Change The remote change number indicates the latest change waiting to be
Number synchronized.
These values are compared to get the Sync Gap, which indicates whether the
synchronization mechanism is working but is running behind.

Change Number The time when the displayed data in the Local Change Number and Remote
Update Time Change Number columns was modified. Notice that the displayed data in the
monitor is not modified on every change but on every interval.

Num Limit These configuration values provide a complete view of how often each group is
synchronized and how many records are sent on each iteration. Combining
Interval (sec)
these values with the Last Communication Time and Sync Gap helps to track
down problems.

AG3110 │ 2019-05-07 124

View Synchronization Errors in the Workflow Manager Administration Tool

Field Description

Sync Rejects The number of synchronization errors for this group and archive in the last 24
hours.

View Synchronization Errors in the Workflow Manager

Administration Tool
You can also view synchronization errors from the Workflow Manager Administration tool.

1. Select System Administration > Database Admin from the Administration Tool menu.

2. From the View menu, select Synchronization Errors. The Workflow Grid window opens, displaying
any synchronization errors that have occurred.

From here, you can manually retry SMARTSYNC operations.

AG3110 │ 2019-05-07 125

 Database Configuration and
Management
This section describes the following tasks:

l Back up the Database below

l Restore the Database on the next page

l Verify the Database Backup on the next page

l Change the Scheduled Time for the Database Backup on page 128

l Back up the Central Configuration on page 128

l Check the ORACLE Alert File on page 128

l Perform an ORACLE Server General Fitness Check on page 129

l Run Other Scheduled Database Maintenance Tasks on page 129

Back up the Database

A daily backup of the entire database is performed using a MICROSOFT WINDOWS scheduled task,
usually at night.
The backup method can be a hot backup, where the database is online and users can continue to work, or a
cold backup, where the database is shut down and users are unable to work until the backup is complete.
The backup method is chosen during installation.
The following scheduled tasks are defined:

l run_full_backups – Use to run hot backups

l run_al_backups – Use to run archive logs only backups

l run_cold_backups – Use to run cold backups

In a cluster configuration, these tasks are executed on the database node.

The backup process writes database backup files and log files to a location on a local disk that is chosen
during installation, for example, <Backup_drive>:\oradata\mst1\backup.
Backup log files use the following naming convention:
back_<type>.<status>_date.log

AG3110 │ 2019-05-07 126

Restore the Database

where:
l type =

inc0 for a hot backup

al for an archive logs only backup

cold for a cold backup

l status = ok or err indicating the success or failure of the backup process.

If backup storage allows, a backup should be kept for both the current backup and the previous backup.
The previous backup is saved in <Backup_drive>:\oradata\mst1\backup\COPY.

Important: Backup files must be copied to a tape, network location, or other media, on a daily basis.
Failure to do so might lead to a total site loss.

Restore the Database

Full or partial restoration of a database from a backup should only be done by Customer Service. Any
attempt by unqualified personnel may result in permanent loss of patient data or a general system
malfunction.
The hot backup method uses the ORACLE RMAN utility and requires DBA skills for recovery. The cold
backup method involves OS copy commands and does not require DBA skills for recovery.

Verify the Database Backup

A daily task runs at 6 am to ensure that the previous backup was successful. You can also perform this
backup verification manually when there is a related problem reported by the system check, as follows:

1. In WINDOWS, select Start > Control Panel > System and Maintenance > Administrative Tools >
Task Scheduler.

2. Right-click Open.

3. Select the relevant scheduled task and check that the date in the Last Run Time column is today’s
date. The following scheduled tasks are defined:
l run_full_backups

l run_al_backups

l run_cold_backups

4. Go to <Backup_drive>:\oradata\mst1\backup and check whether the name of the log file

includes the status ok or err.

If the name of the log file includes err, an error exists and you should contact Customer Service.

AG3110 │ 2019-05-07 127

Change the Scheduled Time for the Database Backup

Change the Scheduled Time for the Database

Backup
You can change the scheduled time for the database backup, as follows:

1. In WINDOWS, select Start > Control Panel > System and Maintenance > Administrative Tools >
Task Scheduler.

2. Right-click the relevant scheduled task and select Properties. The following scheduled tasks are
defined:
l run_full_backups

l run_al_backups

l run_cold_backups

3. In the Schedule tab, change the time as required and click OK.

Back up the Central Configuration

Daily backups of the Central Configuration are performed each night using the following scheduled tasks:

l run_cfg_backups – Exports the configuration database schema to an ORACLE export file.

l db_cfg_export – Exports the XML configuration to a GZIP compressed file.

Export files are written to <Backup_drive>:\Backup\cfg_backup.

The backup files can be used to restore the system configuration to an earlier state without restoring the
entire database (which is more complicated and takes longer).
History is kept for 7 days.
This task is executed on the database node in cluster configurations.

Check the ORACLE Alert File

The ORACLE database has a built-in alert file, in which system alerts and important messages are
registered. You should read this file daily to identify potential problems at an early stage, as follows:

1. Go to
<DB_drive>:\imaginet_db\oracle\admin\diag\rdbms\mst1\mst1\trace\alert_
mst1.log

and open the alert file using Notepad or WordPad.

2. Scroll down to the last section of the file.

3. Locate the last week’s dates and review the messages.

Only informative messages are acceptable, such as startup, shutdown, and changing log files.

AG3110 │ 2019-05-07 128

Perform an ORACLE Server General Fitness Check

(Thread 1 advanced to log sequence)

If an error exists, contact Customer Service.

Perform an ORACLE Server General Fitness

Check
When the system is restarted, or after a failure or invoked operation, such as installation, upgrade or
restructuring, you must ensure that all of system components are functioning properly. You should perform
the ORACLE Server general fitness check manually after every reboot.
When the system is up, these services should be running:

l OracleServicemst1 – The Workflow Manager database service

l OracleOraDB12Home1TNSListener – The ORACLE Listener service

Run Other Scheduled Database Maintenance

Tasks
The following table lists other daily tasks that are scheduled for database maintenance purposes.

Task Name Description Notes

DB_Tablespace_ A daily task that handles ORACLE database This task is executed on
freespace tablespace management. the database node in
cluster configurations.
This script enlarges relevant tablespaces by either
enlarging current database files or adding new files.

db_worker A daily task that collects database statistics of This task is executed on
relevant tables and indexes. the application node in
cluster configurations.
Database objects statistics are gathered to allow
ORACLE to access data in the most efficient way.

OracleLogsHandler A daily task that handles database log files, including This task is executed on
ORACLE alert log files, and ORACLE listener log files the database node in
and trace files. cluster configurations.
History is kept for 60 days.

gather_db_info A daily task that collects database performance This task is executed on
statistics for the last 24 hours. the database node in
cluster configurations.
Information collected includes AWR reports, ORACLE
configuration files, ORACLE logs, ORACLE database
settings and host server information.
History is kept for 60 days.

AG3110 │ 2019-05-07 129

 System Administration
You can use System Administration tools to perform system administration tasks, including:

l Workflow Manager Administration Tool on page 131

l IS Link on page 141

l Certificate Portal on page 143

l Central Configuration Editor on page 149

l Log Files on page 151

l Dictionary Tool on page 154

AG3110 │ 2019-05-07 130

 Workflow Manager Administration Tool
You can use the Workflow Manager Administration tool to view patient and study data, update and edit
information, and perform more advanced manipulations, such as merging or splitting studies.
You can use the Workflow Manager Administration tool for the following activities:

l Manage Patient IDs on page 134

l Update Patient Details on page 135

l Update Study Details on page 135

l Perform Merge and Split Operations on page 136

l Update Series Information on page 138

l View Study Information on page 138

l Locate Studies on page 139

l View Backup Media for Studies on page 139

l Perform Manual RIS Synchronization on page 139

l Protect and Unprotect Studies on page 140

Get Started with the Workflow Manager Administration Tool

To open the Workflow Manager Administration tool, select System Administration > Database Admin
from the Administration Tool menu.
In the Enter Filter Values window, enter any relevant parameters to filter the studies shown, and click OK.
The Workflow Manager Administration tool opens, showing a list of patient and study data.

Define the Display in the Workflow Manager Administration Tool

In the Workflow Manager Administration tool, a default set of fields at the study, series, and image level are
displayed. You can change the default view and choose which fields to display, the order in which they are
displayed, and the width of each column.
You can make the following changes to the display:

To Do this

Move a column Left-click the column header and drag the column to the right or left.

AG3110 │ 2019-05-07 131

Get Started with the Workflow Manager Administration Tool

To Do this

Delete a column Right-click the column to delete and select Remove Column.

Change the column width Left-click the edge between two adjacent column headings and drag to the
position you want.

Add a column Right-click anywhere on the column header, select Field Chooser, and
click Add.

Remove a column Select a field in the right pane, select Field Chooser, and click Remove.

Save changes for future Right-click anywhere in the column header and select Save Settings.
sessions

Reset the filters Right-click any column in the right pane and select Clear All Filters.

Reset the default settings Right-click anywhere in the column header and select Set Default
Settings.

Filter the Studies List

You can apply the following types of filters to the studies list:

l String Filter—Applies to columns that display data in string format and can accept any kind of string.
Each string in the column that begins with the entered filter string passes through the filter and appears
in the studies list.

l Date Filter— Applies to columns that display data in date format. There are two ways to enter this type of
filter:

l Between—Filters the studies list by the defined date range. Enter the to and from dates in
DD/MM/YYYY format, or click Current Date to insert the current date for the relevant field.

l Previous—Select or enter the number of previous days (for example, 7 for the previous week). All
studies added to the archive during the previous [x] days appear.

l Numeric Filter—Applies to columns that display numbers. You can use a single number or a numeric
range to filter columns.

You can apply a single filter or use multiple filter criteria, as required. If filters have been applied, the filter
criteria are displayed in the relevant filter fields (white fields above the column names).

Note: The Enter Filter Values window opens automatically when you open the Workflow Manager
Administration tool. This lets you filter the studies included in the studies list before the list is loaded,
reducing the download time required to display the list.

To apply a single filter to the studies list

1. In the studies list area, click in the filter criteria field above the required column heading.

2. In the filter window that opens, enter the required filter criteria. To remove existing filter data, click
Clear.

AG3110 │ 2019-05-07 132

Get Started with the Workflow Manager Administration Tool

3. Click OK.

The studies list is filtered according to the filter you selected. The filter criteria appear in the field
above the relevant column name.

To apply multiple filters to the studies list:

1. From the Workflow Manager Administration toolbar, click Filter or from the View menu, select
Filter Dialog.

2. In the Enter Filter Values window, enter the required values in any combination of fields. To remove
existing filter data, click Clear.

3. Click OK.

The studies list is filtered according to the multiple filter criteria that you selected. The filter criteria
appear in the fields above the relevant column names.

Sort the Studies List

You can sort the studies list using up to three columns.

1. Click once on a column heading to perform an ascending sort. Click the same column heading again
to perform a descending sort.

2. Press Shift and click another column heading to select a secondary sort.

3. Press Ctrl and click another column heading to perform a tertiary sort.

If a column is used for a sort, a symbol is displayed next to the column name, as follows:

Symbol Description

First sort ascending

Second sort ascending

Third sort ascending

First sort descending

Second sort descending

Third sort descending

Configure Display Settings

You can configure the interval at which the data displayed in the Workflow Manager Administration tool is
automatically refreshed, as well as the maximum number of rows of data that are displayed.

AG3110 │ 2019-05-07 133

Manage Patient IDs

1. From the Workflow Manager Administration toolbar, click Display Settings or from the Edit
menu, select Display Settings. The Display Settings window opens.

2. To activate the automatic refresh feature, select the Automatic Refresh check box.

3. In the Refresh Interval field, enter a number or use the arrows to select refresh interval in seconds.

4. In the Limit Fetched Rows to field, enter the maximum number of rows to appear in the studies list.

Note: You can enter a value of 0 to display all studies, but the list may be so large that it is
unworkable.

5. Click OK.

Refresh the Studies List

You can manually refresh the list of studies displayed in the Workflow Manager Administration tool, as
follows:

l From the Workflow Manager Administration toolbar, click Refresh .

l From the File menu, select Refresh.

l Right-click a study from the studies list and select Refresh.

The currently displayed studies in the studies list are updated and displayed according to the latest
information in the archive.

Manage Patient IDs

In the Workflow Manager Administration tool, the patient ID that is connected to the default issuer is shown
in the study list. However, a single patient might have several different patient IDs provided by different
issuers.
You can view, add, or update a patient ID. You can also delete a patient ID, however, this option is disabled
by default. To change the default setting, go to:
imaginet\system\applications\medistore\admintool
and set allow_pid_delete to TRUE.

To view, add, or update a patient ID

1. From the Workflow Manager Administration toolbar, click Manage Patient ID . The Manage
Patient ID window opens.

2. To update a patient ID, select the relevant row and click Update. In the Update Patient ID window,
complete the changes as required and click OK.

3. To insert a new patient ID, click Insert. In the Insert Patient ID window, complete the changes as

AG3110 │ 2019-05-07 134

Update Patient Details

required and click OK.

4. Click Close.

Update Patient Details

You can update patient details, such as the patient’s name, sex or birth date for an individual patient or for
multiple patients at the same time.

1. Select the required study or studies in the studies list area.

2. Do one of the following:

l From the Workflow Manager Administration toolbar, click Update Patient Details .

l From the Edit menu, select Update Patient.

l Right-click the required study and select Update Patient.

3. In the Update Patient Data window, update the patient data, as required.

Note: If more than one study was selected, the Patient ID field is unavailable and cannot be
updated.

4. Click Extended Details to update the phonetic or ideographic patient name details.

5. Click OK.

The relevant patient data is updated in the archive.

Note: When patient data is modified, the change is applied to all the studies for this patient.

Update Study Details

You can update study details, such as the study date, modality, body part, or study status for an individual
patient or for multiple patients at the same time.

1. Select the required study or studies in the studies list area.

2. Do one of the following:

l From the Workflow Manager Administration toolbar, click Update Study Details .

l From the Edit menu, select Update Study.

l Right-click the required study and select Update Study.

The Update Study Data window opens.

3. To edit the modality of the study, click Edit Modalities.

4. In the Update Series Modalities window, select the relevant modality and click OK.

AG3110 │ 2019-05-07 135

Perform Merge and Split Operations

5. Update the study data, as required and click OK.

The relevant study data is updated in the archive.

Perform Merge and Split Operations

You can use the Merge-Split wizard to perform merge and split operations on studies and series.
The Merge operation is generally performed when a study is inserted and attached to an incorrect patient.
The Merge operation lets you remedy this problem by moving the incorrectly attached study to the correct
patient. You can move an individual study or multiple studies at the same time (for example, merge two
studies with a third study).

Merge Studies

1. Select the relevant study or studies in the studies list area and click Merge-Split Wizard . The
Merge-Split Wizard window opens.

2. In the Step 1: Choose Target Patient section, select the Select existing Patient option.

3. Filter the patient list, as required. Then select the required patient and click Finish.

The incorrectly attached study merges with the selected patient information in the archive.

Note: The Merge operation may take longer if you are merging multiple studies. In this case, an
additional confirmation message appears, informing you that it will take some time and asking if
you want to continue with the Merge operation.

Split Studies
Sometimes modalities generate a single study, which contains multiple body parts (Chest/Abd/Pelvis)
although there are separate orders for each body part. These studies can be split into multiple studies—one
for each order.

1. Select the relevant study or studies in the studies list area and click Merge-Split Wizard . The
Merge-Split Wizard window opens.

2. In the Step 1: Choose Target Patient section, select the Create new Patient option and click
Next.

3. In the Step 2: Edit Target Study Details section, complete the new patient data, as required and
click Finish.

The study is attached to the newly-created patient information in the archive.

Note: The Split operation may require a longer time to perform if you are splitting multiple studies
or if the selected study is comprised of numerous images.

AG3110 │ 2019-05-07 136

Perform Merge and Split Operations

Merge a Series from One Study to Another

1. In the Series Details window, select the series to merge and click Merge-Split Wizard . The
Merge-Split Wizard window opens.

2. In the Step 1: Choose Target Patient section, select the Select existing Patient option.

3. Filter the patient list, as required. Then select the required patient.

4. In the Step 2: Choose Target Study section, select the relevant order or study. Then click Finish.

The series is merged with the selected patient information in the archive.

Split a Series

1. In the Series Details window, select the series to split and click Merge-Split Wizard .

2. In the Merge-Split Wizard window, select the Create new Patient option and click Next.

3. In the Step 2: Edit Target Study Details section, complete the new patient data or study, as
required, and click Finish.

The study is attached to the newly-created patient information or study in the archive.

Note: The Split operation may require a longer time to perform if you are splitting multiple studies
or if the selected study is comprised of numerous images.

Merge Images
You can merge an image to an existing patient, study, or series.

1. In the Image Details window, select the images to merge and click Merge-Split Wizard . The
Merge-Split Wizard window opens.

2. In the Step 1: Choose Target Patient section, select the Select existing Patient option.

3. Filter the patient list, as required. Then select the required patient and click Finish.

Note: You can also select the order and study.

The image merges with the selected patient information in the archive.

Split Images

1. In the Image Details window, select the images to merge and click Merge-Split Wizard .

2. In the Merge-Split Wizard window, select the Create new Patient option and click Next.

3. In the Step 2: Edit Target Study Details section, complete the new patient data, study, or series

AG3110 │ 2019-05-07 137

Update Series Information

data, as required, and click Finish.

The image is attached to the newly-created patient information, study, or series in the archive.

Update Series Information

You can update information for a series, in addition to the patient and study information.

1. Select the required study in the studies list area.

2. Do one of the following:

l From the Workflow Manager Administration toolbar, click Explore Study .

l Double-click the study.

l Right-click the required study and select Explore Study.

3. In the Series Details window, select one or more series to update and click Update Series .

4. If you selected more than one series, click Yes in the Confirm Update window that opens.

5. In the Update Series Data window, update the series as required and click OK.

Note: Updating the modality at the series level affects the modality at the study level. If multiple
studies are updated at the same time, the Series Number field is blocked and changes cannot be
made.

View Study Information

You can view images for a selected study. You can also view any report information related to the study
being viewed, if available.

1. Select the required study in the studies list area.

2. Do one of the following:

l Click View Study .

l From the Edit menu, select View Study.

l Right-click a study and select View Study.

3. If the decision of which study to be viewed is not unique (for example, the study does not have an
accession number), a window containing all relevant studies opens. Select a study and click Load or
Cancel.

Note: This operation is limited to a single study. If you do not have URL activation permissions, the
View Study icon is unavailable.

AG3110 │ 2019-05-07 138

Locate Studies

Locate Studies
You can search for the locations of an individual study or multiple studies in the system. Each study can
reside in multiple locations, as there are always at least two copies of a study in the system at all times.

1. Select a study or studies in the studies list area.

2. Do one of the following:

l From the Workflow Manager Administration toolbar, click Study Location .

l From the View menu, select Study Location.

l Right-click the required study and select Location.

The Studies Images Locations window opens, listing the exact location of all copies of the study or
studies in the system.

View Backup Media for Studies

You can view the exact backup media location for near-line studies  and offline studies (outside the library).
The Media operation can be performed for an individual study or for multiple studies at the same time. This
lets you quickly locate the relevant tape or tapes and determine if they need to be inserted into the Jukebox
before you send the Fetch command to the system.

1. Select a study or studies in the studies list area.

2. Do one of the following:

l From the Workflow Manager Administration toolbar, click Study Media .

l From the View menu, select Study Media.

l Right-click the required study and select Study Media.

The Media ID List window opens.

Note: If a study has not yet been backed up on tape, a message appears informing you that the
study does not reside on any media.

Perform Manual RIS Synchronization

If the automatic RIS Synchronization process fails for some reason, you can perform RIS synchronization
manually. For the manual RIS synchronization to work successfully, both the patient ID and the accession
number must be the same.
You can perform manual RIS synchronization on a single study or on a number of studies at the same time.

1. In the Workflow Manager Administration tool, select the study on which to perform the manual RIS
synchronization.

AG3110 │ 2019-05-07 139

Protect and Unprotect Studies

2. From the toolbar, click Manual RIS-Sync . The Manual RIS-Sync window opens, showing
details of the orders that relate to the study to be synchronized. The orders are filtered by patient ID
and accession number, by default.

3. You can filter the data using additional attributes, if required.

4. Select an order and click Manual RIS-Sync .

Protect and Unprotect Studies

You can mark one or more studies as protected or change protected studies to unprotected. Studies that
are protected are not influenced by the auto-delete process or any manual deletion operation.

To protect a study

1. Select the required study or studies in the studies list area.

2. From the Workflow Manager Administration toolbar, click Protect Study.

3. Click Refresh.

The protection status of the study is displayed in the Study Locked column.

To unprotect a study:

1. Select the required study or studies in the studies list area.

2. From the Workflow Manager Administration toolbar, click Unprotect Study.

3. Click Refresh.

The protection status of the study is displayed in the Study Locked column.

Resolve Patient Matching Conflicts

Before a study can be archived, a patient matching check takes place to verify whether the study belongs
to an existing patient. The check is based on the patient ID and other attributes, such as the accession
number, patient name, and date of birth.
The patient matching check can result in a number of scenarios, including:

l The study is matched to an existing patient and is archived

l The study does not match an existing patient and is archived under a new patient ID

l The study matches some but not all of the patient information. The study is archived and $$$n is added
to the patient ID to indicate that there is a patient matching conflict and to flag the study for investigation
(where n is a counter that increments with each additional study).

In the following example, a new study arrives and the patient matching rule checks the patient ID, first and
last name, and date of birth. A match is found and the study is archived.

AG3110 │ 2019-05-07 140

IS Link

In the next example, a new study arrives and the patient matching rule checks the patient ID, first and last
name, and date of birth. The new study data does not match the patient information of the first patient, but
does partially match the patient information of the second patient. The study is saved with a new patient ID
and is flagged for further investigation.

As part of the regular maintenance checks, you need to review the Patient ID column in the Workflow
Manager Administration tool and search for flagged studies. To do this, enter %$$$ in the Set ID filter
window. When a conflict is found, you need to merge the study into the correct patient. For more
information, see Merge Studies on page 136.

IS Link
IS Link provides information on patient demographics, visits, and orders, and can be used to retrieve
clinical reports.

Get Started with IS Link

To open IS Link, select System Administration > IS Link from the Administration Tool menu.
In the Filter window, enter any relevant parameters to filter the studies shown and click OK.
The IS Link Administration Tool opens on the Patients tab.
The IS Link Administration toolbar is page-sensitive; when toolbar functions are not relevant to a particular
page, they are grayed out.

IS Link Admin Tool Window Tabs

The IS Link Admin Tool window includes the following tabs:

l Patients tab

l Visits tab

l Orders tab

l Reports tab

AG3110 │ 2019-05-07 141

Get Started with IS Link

Each tab is related to the previous tab. For example, the Reports tab relates to reports that were written
based on orders, which in turn refer to particular patient visits. You can search each tab individually using
that specific tab, or using the buttons in the View Patient Data window.

View Patient Information

You can view information for a specific patient in the View Patient Data window.

1. In the Patients tab, double-click a patient or select a patient and click View Data in the toolbar.

The View Patient Data window opens.

2. In the Additional Information section, you can choose to display additional information that is not
already displayed.

3. In the Patient Visits, Orders & Reports section, you can click the relevant button to view specific
visits, orders, and reports of the selected patient.

4. Click OK to close the window and return to the Patients tab.

View Visit Information

You can view information for a specific visit in the View Visit Data window.

1. In the Visits tab, double-click a visit or select a visit and click View Data in the toolbar.

The View Visit Data window opens.

2. In the Additional Information section, you can choose to display additional information that is not
already displayed.

3. In the Visit Orders section, you can click Orders Information to view specific orders of the specific
patient.

4. Click OK to close the window and return to the Visits tab.

View Order Information

You can view information for a specific order in the View Order Data window.

1. In the Orders tab, double-click an order or select an order and click View Data in the toolbar.

The View Order Data window opens.

2. In the Additional Information section, you can choose to display additional information that is not
already displayed.

3. In the Orders View section, you can select the relevant application and click Show Order to view
the order as it appears in the application.

4. In the Orders Reports section, you can click Reports Information to view reports of the specific

AG3110 │ 2019-05-07 142

Push Scripts

patient.

5. Click OK to close the window and return to the Orders tab.

View Report Information

You can view information for a specific report in the View Report Data window.

1. In the Reports tab, double-click a report or select a report and click View Data in the toolbar.

The View Report Data window opens.

2. In the Additional Information section, you can choose to display additional information that is not
already displayed.

3. In the Report View section, you can select the relevant application and click Show Report to view
the report as it appears in the application.

4. Click OK to close the window and return to the Reports tab.

Push Scripts
You can use the send_file_loop.pl script to send files containing HL7 messages from the RIS to the
Listener. IS Link then reads these files and saves them to the database. It can be used when the RIS does
not open a connection to IS Link or send HL7 messages through the connection.
The send_file_loop.pl script is located in:
%imaginet_root%medilink\admin
To use the send_file_loop.pl script, you need to define the following directories:

l A new messages directory to save new messages that were not sent yet

l An old messages directory for messages that were sent

Delete Redundant Observations

You can use the delete_redundant_obx.pl script to delete redundant observations from the IS Link
database. The script is operated manually and should be run regularly to prevent a build-up of redundant
observations. It does not affect the IS Link workflow. The data stored in the database is not harmed by
running the script since the responsible observer is the same for all reports.
The delete_redundant_obx.pl script is located in:
%imaginet_root%medilink\admin

Certificate Portal
Vue PACS can use secure sockets layer (SSL) to enable secure HTTPS communications between the
client Web browser and the Workflow Manager server. Digital certificates are mandatory for SSL
connection initialization, and are used to verify that the client workstation is communicating with a trusted
server.

AG3110 │ 2019-05-07 143

Get Started with the Certificate Portal

Digital certificates are often used when working in a grid environment, where the data center
communicates with satellites using secure SSL.
Each site is responsible for obtaining valid certificates from a certified granting authority, or for generating a
self-signed certificate. In addition, each site can act as a certificate authority and sign certificates of other
sites (for example, in a grid environment).
You can use the Certificate Portal to:

l Manage Keys on the next page

l Manage Certificates on the next page

l View Certificates on page 147

l Test the Client and Server Configuration on page 147

To create a valid certificate and configure SSL in a grid environment, see the example presented
in Example: Create a Valid Certificate and Configuring TLS in a Grid Environment on page 148.

Get Started with the Certificate Portal

To open the Certificate Portal, select System Administration > Certificate Manager from the
Administration Tool menu.
The Certificate Portal opens, showing the links to the various certificate files.

Configure Details for Certificate Requests

You can configure the details that are used to identify your organization in certificate requests. This
information only applies to new certificate requests (and will only affect new certificates).

1. In the Certificate Portal, in the left pane, select Options > Certificate fields.

2. In the right pane, enter values for the various fields and click Update fields.

View Certificate File Locations

You can view the locations of various files, such as certificates and trusted lists. The information displayed
is read-only and cannot be modified.
In the Certificate Portal, in the left pane, select Options > Paths. The following read-only information
appears in the right pane.

AG3110 │ 2019-05-07 144

Manage Keys

Manage Keys
A default key and certificate is supplied as part of the Workflow Manager installation. You can create and
upload a new key to override the existing key; however, this will invalidate any existing certificates and you
will need to create a new certificate after this step.

Create a Private Key

1. In the Certificate Portal, in the left pane, select Key Management > Create a private key.

2. In the right pane, enter the number of bits for the key size and click Generate key.

The minimum number of bits is 1024.

3. In the confirmation message, click OK to continue.

Important: This will invalidate any existing certificates. You will need to create a new certificate
after this step.

4. Verify that the key has been generated successfully.

You must now create a new certificate. See Create a Certificate Request on the next page.

Upload a Private Key

1. In the Certificate Portal, in the left pane, select Key Management > Upload a private key.

2. In the right pane, click Browse and select the private key file to upload.

3. Click Upload.

4. In the confirmation message, click OK to continue.

Important: This will invalidate any existing certificates. You will need to create a new certificate,
or upload the matching certificate, after this step.

5. Verify that the key has been uploaded successfully.

Now you must create a new certificate (see Create a Certificate Request on the next page) or upload a
matching certificate (see Upload a Certificate on the next page).

Manage Certificates
A default key and certificate is supplied as part of the Workflow Manager installation. You can create a
request to receive a new certificate from a Certificate Authority, and then upload the new certificate to
override the existing certificate.
In addition, when working in a grid environment, you can act as a certificate authority and sign certificate
requests from satellites in the grid.
Alternatively, you can create a self-signed certificate, which can be used for testing purposes.

AG3110 │ 2019-05-07 145

Manage Certificates

Create a Certificate Request

1. In the Certificate Portal, in the left pane, select Certificates Management > Certificate request.
The certificate request appears in the right pane.

2. Copy the entire text of the certificate request, including the begin and end lines, and save as a text
file—for example, vmnero_cert.txt.

3. Send the certificate request file to the certificate authority according to your site procedures.

When you receive the signed certificate from the certificate authority, you must upload it to the server. For
details, see Upload a Certificate below.
If you want to use a self-signed certificate (for example, if you do not use a certificate authority), you need
to create a self-signed certificate. For details, see Create a Self-Signed Certificate below.

Create a Self-Signed Certificate

1. In the Certificate Portal, in the left pane, select Certificates Management > Self sign request.

2. In the right pane, click Generate certificate.

3. In the confirmation message, click OK to continue.

4. Verify that the certificate has been generated successfully.

Upload a Certificate
1. In the Certificate Portal, in the left pane, select Certificates Management > Upload X509 encoded
64 signed request.

2. In the right pane, click Browse and select the certificate file to upload.

3. Click Upload.

4. In the confirmation message, click OK to continue.

5. Verify that the certificate has been uploaded successfully.

You can also upload an X509 certificate that only applies to the Web server using the Upload Web Server
X509 encoded 64 signed request option.

Sign a Certificate Request

When working in a grid environment, you can act as a certificate authority and sign certificate requests
from satellites in the grid.

1. In the Certificate Portal, in the left pane, select Certificates Management > Sign a request.

2. In the right pane, browse to the location of the certificate to be signed and click Upload.

3. In the message that appears, click Save to save the signed certificate.

4. To verify that the certificate is valid, click Open to open the signed certificate. The Certificate
window opens, showing details of the certificate.

AG3110 │ 2019-05-07 146

View Certificates

Maintain the Trust List

You can add a certificate to your list of trusted certificates. It is added to both the JAVA-based list (JKS)
and the PEM-based list.

1. In the Certificate Portal, in the left pane, select Certificates Management > Add certificate to
trusted list.

2. In the right pane, click Browse and select the certificate file to add to the trusted list.

3. Click Upload.

4. Verify that the certificate has been uploaded successfully.

View Certificates
You can view current certificates and certificates in the trusted lists. You can choose from the following
options:

l Viewing the current root certificate

l View the current Web server certificate

l View the OpenSSL configuration file

l View the Java keystore (JKS) certificates

l View the PEM keystore certificates

In the left pane of the Certificate Portal, select Status and the relevant option.

Test the Client and Server Configuration

You can test the JAVA client and server configuration. You need to restart APACHE TOMCAT before you
perform the testing.

Test the Client Configuration

1. In the Certificate Portal, in the left pane, select Status > Test client configuration.

2. In the right pane, enter the server IP address and server port and click Run test.

Test the Server Configuration

1. In the Certificate Portal, in the left pane, select Status > Test server configuration.

2. In the right pane, enter the server port and amount of time to listen for.

3. Click Start Listening and Stop Listening, as required.

4. You can view the server status at any time by clicking View status.

AG3110 │ 2019-05-07 147

Example: Create a Valid Certificate and Configuring TLS in a Grid Environment

Example: Create a Valid Certificate and Configuring TLS in a

Grid Environment
In a grid environment, the data center can communicate with satellites using secure SSL. In this example,
you can create a valid certificate and configure TLS in a grid environment.

1. In the System Configuration tool, go to Nodes Configuration and configure the data center and
satellites according to your requirements. Make sure that you define the following settings:

a. In the FIR port, use 22104.

b. Select the Secure Server (TLS) check box.

2. Save your changes and close the System Configuration tool.

3. From the data center server, select System Administration > Certificate Manager from the
Administration Tool menu.

4. In the Certificate Portal, select Certificates Management > Self sign request.

5. Click Generate certificate. The new certificate is generated and saved in the default location.

6. To view the new certificate, select Status > View current root certificate.

7. Close the Certificate Portal and restart the data center.

8. From the satellite server, select System Administration > Certificate Manager from the
Administration Tool menu.

9. In the Certificate Portal, select Certificates Management > Certificate request. The certificate
request appears in the right pane.

10. Copy the entire text of the certificate request, including the begin and end lines, and save as a text
file. For example, vmnero_cert.txt.

11. From the data center server, open the Certificate Portal.

12. Select Certificates Management > Sign a request.

13. In the right pane, browse to the location where you saved the satellite certificate and click Upload.

14. Save and open the new certificate.

15. From the satellite server, select Certificates Management > Upload X509 encoded 64 signed
request.

16. In the right pane, browse to the location where you saved the certificate in the data center and click
Upload.

17. Close the Certificate Portal.

18. Restart the satellite server.

19. In the System Configuration tool, go to Nodes Configuration and click the DICOM Verify button to
ensure that the configuration works correctly.

20. Repeat steps 8-18 for additional satellite servers.

AG3110 │ 2019-05-07 148

Central Configuration Editor

Central Configuration Editor

The Central Configuration Editor is a simple repository that enables you to save permanent application
information in the Carestream product environment. The Central Configuration Editor is structured as a
hierarchical tree, with multiple levels of branches and keys (folders).

Important: Exercise caution when changing the Central Configuration. Changing the wrong entries or
making an incorrect entry for a setting can introduce an error that prevents the entire system from
starting or working properly. Contact Carestream Professional Services personnel for assistance
before making any changes.

Get Started with the Central Configuration Editor

To open the Central Configuration Editor, select System Administration > Central Configuration from
the Administration Tool menu.
The Central Configuration Editor opens showing the configuration tree in the left pane. You can expand the
tree to show all branches, folders, and subfolders. This pane is used to go to the required key.

Work with Keys

Right-click the left pane to open a menu with these options:

Option Description

Add Key Adds a new key to the tree.

Remove Key Removes an existing key.

Refresh node Refreshes the node with the latest

information.

Cut Removes the key from the existing location

and saves to the clipboard.

Copy Copies the key and saves to the clipboard.

Paste Pastes the key in the target location.

Rename Renames a key.

Search Searches for a string under a particular

node.

Show Search Result List Shows the search result list

Search Next Searches for the next node.

Search Previous Searches for the previous node.

Go to Path Navigates to the specified path

AG3110 │ 2019-05-07 149

Modify Parameter Values

Option Description

Get Entries Count Counts the number of entries in a particular

node.

Import For advanced users only. Imports data from

a file to the Central Configuration
repository. The file must be in Carestream
format, as created by the Export command.

Export Exports all the data under the selected key

in the hierarchy to a text file. This file is in
Carestream format and is compatible for
importing.

Dump to XML File Dumps a subtree in an XML file. The XML

format is not compatible for importing.

Copy Path to Clipboard Copies the selected path to the clipboard.

Modify Parameter Values

The right pane displays the parameters and values for the selected folder in the configuration editor tree.
Use this pane to view specific parameters and values, as well as to modify configurations.
In this pane, parameters can be managed and values assigned to a selected folder. Right-click in this pane
to access these options:

Option Description

Add Value Adds a new value to the key.

Remove Removes the selected value from the key.

Copy Copies the value and saves to the clipboard.

Paste Pastes the value in the target location.

Cut Removes the value from the existing location and saves to the
clipboard.

Edit Value Opens the Edit Value window in which you can modify the value.

Select All Selects all values of the key.

Copy Path to Clipboard Copies the selected paths to the clipboard.

Copy Path And Value to Copies the selected paths and values to the clipboard.
Clipboard

AG3110 │ 2019-05-07 150

Log Files

Log Files
Log files are a valuable source of information for all types of system errors.
There are two utilities you can use when working with log files:

l Log Update—For server-side logs. For more information, see Use the Log Update Utility below.

l Log Viewer—For client-side logs. For more information, see Use the Log Viewer Utility on page 153.

Use the Log Update Utility

You can use the Log Update utility to perform the following actions on server-side logs:

l Reset the log level for all packages

l Change the log level for a specific package

l Add filters to change the log level for a specific IP, process name, or process ID

l Dump the current log configuration from memory to file

l Update the current log state to match manual changes made in the file

l Perform additional actions that are referenced in the help screen (-h)

The default location for server-side log files is:

%imaginet_log_dir%

Get Started with the Log Update Utility

To open the Log Update utility, from the command line, type logupdate. A list of the most common
commands appears, as follows:

l logupdate RESET — Resets all packages to the default log level.

l logupdate <PACKAGE_NAME> <LOG_LEVEL> [-f <FILTER>] [-i <INPUT_METHOD>] [-
o <OUTPUT_METHOD>] [-w] — Sets log levels for a specific package.

l logupdate -m <OUTPUT_METHOD> —Changes the output method.

l logupdate -d <FILE_NAME> — Dumps the current log configuration from memory to file.

l logupdate –u — Updates the current log state to match manual changes made in the file.

l logupdate –h — Displays the help screen showing the commands available with examples

where:
PACKAGE_NAME — The name or number of the package to be changed.
LOG_LEVEL — The log level to set. Possible values are:
1=severe, 2=critical, 3=error, 4=warning (default), 5=notice, 6=information,
7=debug
FILTER — A rule list containing filters that change the log level in specific cases. For details, see Filter
Rules on the next page.

AG3110 │ 2019-05-07 151

Use the Log Update Utility

INPUT_METHOD/OUTPUT_METHOD — Where the configuration is read from/written to.

Additional Parameters
l -w — Enter filter manually using a wizard

l -h — Display the help screen

l -d — Dump logger state from memory to file

l -f — Specify filter rules for application name, IP address, or process ID.

Filter Rules
One or more filter rules can be set to a log package. They are written in the following format:
[(FILTER#1)(FILTER#2)...]
Each filter includes:
LOG_LEVEL;IP_ADDRESS_LIST;APPLICATION_NAME_LIST;PROCESS_ID_LIST
where:
LOG_LEVEL — The log level that will be written if this rule applies. The log level is mandatory.
IP_ADDRESS_LIST — A comma-separated list of IP addresses for which to change the log level.
APPLICATION_NAME_LIST — A comma-separated list of application names for which to change the log
level. The application name must match the name printed in the logs of that application.
PROCESS_ID_LIST — A comma-separated list of process IDs for which to change the log level
The IP_ADDRESS_LIST, APPLICATION_NAME_LIST, and PROCESS_ID_LIST are optional, but at
least one has to be provided. The optional sections that are not provided are left empty, for example
[(7;;;12454)]. Trailing empty sections can be omitted, for example [(7;10.2.3.4)].

Note: A filter only applies if ALL conditions are met. If you specify an application name and a process
ID, only an application with the specified name AND process ID will write to this log level.

If you want to change the log level if only one of a set of conditions is met, use multiple rules, for example:
logupdate SCL –f [(7;10.2.4.3)(7;;;12436)]

Examples
Example Description

logupdate DIDB 6 Sets DIDB package to log level 6

logupdate 217 5 Sets package number 217 to log level 5

logupdate RESET Resets logger configuration log levels to 4 and delete filters

logupdate -d c:\tmp.log Save logger configuration from shared memory to a file named
c:\tmp.log

AG3110 │ 2019-05-07 152

Use the Log Viewer Utility

Example Description

logupdate TEST –w Asks for manual input for package TEST specific filters

logupdate CONN 5 -f " Sets filters for package CONN: log level 5 is the default, and
[(7;;;1455)]" log level 7 for a process with process ID 1455

logupdate TEST -f " Sets filters for package TEST: log level 5 for IP 199.203.80.80
[(5;199.203.80.80) and log level 6 for application name SVDSER
(6;;svdser)]"

logupdate TEST -f " Sets filters for package TEST: log level 5 for IP 199.203.80.80
[(5;199.203.80.80;svdser)]" AND application name SVDSER

logupdate TEST -f "[]" Removes filters from package TEST

Use the Log Viewer Utility

You can use the Log Viewer utility to perform the following actions on client-side logs:

l Use the Logger option to reset and change the log level for packages

l Open log files to view in the Log Viewer

l Change the output method between the WINDOWS Event Log, system log, and private files

The default location for client-side log files is:

{os drive}:\ProgramData\Carestream\PACS\{server}\log

Get Started with the Log Viewer Utility

To open the Log Viewer utility, select Client Tools > Log Level Utility from the Administration Tool menu.
Select the required log file from the dropdown list and click Refresh.

Use the Logger Option

You can use the Logger option to perform the following actions:

1. Reset the log level for all packages

2. Change the log level for a specific package

3. Change the output method of the log

From the Log Viewer window, click the Logger button. The Logger window appears with a list of
packages in grid format.

To select a package

l To select a package, click a package in the grid. Press Shift and click to select a range of packages, or
Ctrl and click to select random packages.

AG3110 │ 2019-05-07 153

Dictionary Tool

l To navigate to a package in the grid, type the first few letters of the name in the list box. The grid jumps
to packages that start with those letters.

To change the log level

When you have selected one or more packages, you can perform the following actions:

l Click Set Selected to 7 to set the selected packages to log level 7=debug.

l Click Set Selected to 4 to set the selected packages to log level 4=warning.

Alternatively, you can change the log level of a single package by selecting the package and selecting the
required log level from the drop down list.
Click Reset all to reset all packages to log level 4=warning (default).

To change the output method of the log

In the Logger window, you can change the output method of the log by selecting one of the following
options from the Log to drop down list:

l 0 - StdErr

l 1 - Syslog File – In WINDOWS, this is the WINDOWS Event Log

l 2 - Private File

To save your changes

When you have finished using the Logger window, click the Dump logger button to save your changes
and close the window.

Use the Log Wizard

You can use the Log Wizard to investigate specific problems.
From the Log Viewer window, click the Log Wizard button. The Log Wizard window appears displaying
a list of typical problems that can occur, sorted into problem types. The packages that are relevant for each
of the problem types are listed in the Packages column.
Click the plus/minus buttons to expand/collapse each of the problem types. Alternatively, you can click the
plus/minus icon in the top right-hand side of the window to expand/collapse all the problem types.
Select one or more problem types that match your particular issue and click the Log It button to close the
window and return to the Log Viewer main window.

Dictionary Tool
You can use the Dictionary Tool to maintain synonyms for use by display protocols.
Synonyms are used when selecting a display protocol for a study, when selecting prior studies to be loaded
for a display protocol, and when selecting groups to be displayed in the layout of the display protocol.
The Synonym table includes dictionaries that are defined by DICOM tags and modalities. Each dictionary
is associated with a DICOM tag and, optionally, a modality, and contains groups of values (terms) that are
synonymous with each other. A group may also consist of a single value.

AG3110 │ 2019-05-07 154

Get Started with the Dictionary Tool

Terms in the synonym dictionary are used to create synonym group naming conditions. For example, when
a display protocol is saved, tags of the currently loaded exam such as Series Description are scanned to
detect significant values that appear in the dictionary. Only terms that exist in the dictionary are used to
form group naming conditions for the tag.
The synonym dictionary also plays a role in the definition of robust DICOM conditions. For example, if there
is a synonym group containing the terms HEAD, BRAIN and SKULL, conditions containing HEAD will be
evaluated as true when the tag contains BRAIN or SKULL.

Note: The Dictionary Tool is only available to users with System permissions for the DP Editor.

Get Started with the Dictionary Tool

To open the Dictionary tool, select System Administration > Client Tools > Dictionary Maintenance
Tool from the Administration Tool menu.
The Dictionary tool opens showing a list of filter values for a specific DICOM tag and modality. The active
group is the group that is selected in the right pane. The values of the active group appear in the center
pane.
When you make changes in the Dictionary Tool, click Save to save your changes.
You can use the Dictionary Tool to perform the following activities:

l Update synonym groups

l Search existing synonym groups for a specific value

l Scan the database for statistics on the associated DICOM tags

You can configure the list of DICOM tags used by the tool in the Central Configuration Editor.

Update Synonym Groups

You can perform the following activities:

Add a synonym to a group

You can add a synonym to a group in the following ways:

l Enter the term to add in the text box at the top of the center pane and press Enter. If you enter a term
that already exists in another group, a message appears, allowing you to move the term to the active
group.

l Select one or more terms from the displayed values in the left pane and drag them to any group in the
right pane

l Right-click a term and select Add to active group.

l Select one or more terms from the displayed values in the left pane and drag them to the center pane, or
click the right-arrow button to move them to the center pane.

AG3110 │ 2019-05-07 155

Search for Specific Terms

Split a group

To split a group and create several single-term groups

Right-click the group you want to split and select Split.
New groups are created, each containing one of the terms from the original group.

To extract terms from an active group and create a new group

Select one or more values in the center pane, right-click and select Extract.
A new group containing the extracted terms is added to the right pane.

To remove terms from a group

Select one or more values in the center pane, right-click and select Remove.
There terms are removed from the active group.

Merge groups
Merge groups by dragging one group onto another group.

Create a new group

Select one or more terms from the displayed values in the left pane, right-click and select Add to new
group. A new group containing the selected terms is added to the right pane. The new group becomes the
active group.

Delete a group
Right-click the group you want to split and select Delete.

Search for Specific Terms

Search for specific terms by typing the term, or a partial term, in the search fields at the top of each pane.

Scan the Database

The Dictionary Tool displays terms and groups associated with a specific DICOM tag and modality. You
can scan the database to get statistics for a specific DICOM tag and modality.
To scan the database, click Scan database. A message appears when the scan is done. The scan
duration depends on the study_age parameter.

Configure Dictionary Parameters

You can configure the following synonym dictionary parameters in the Central Configuration Editor:

AG3110 │ 2019-05-07 156

Configure Dictionary Parameters

l study_age —the maximum age (in days) of studies to be included in the scan. Studies older than this
are not scanned.

l tags —tags that are recognized by the tool for scanning, group set up, and so on.

l modalities—used for the calculation of hit percentage of each value according to the selected
modality

To configure synonym dictionary parameters

1. In the Central Configuration Editor, go to:

imaginet\system\applications\default\dictionary\tool

2. Set the following attributes:

Attribute Value

study_age 1000

3. To define the dictionary tags, go to:

imaginet\system\applications\default\dictionary\tool

In the out-of-the-box implementation, the following tags are already defined:

l body_part_examined

l series_description

l study_description

l tamar_study_body_part

You can add additional tags.

When the tag name is not identical to the column name of the scanned database (for example, with
private tags), you must change the name of the tag using the column_name attribute.

4. Save your changes.

AG3110 │ 2019-05-07 157

Maintenance Checklists

Maintenance Checklists
Use the checklists provided in this section for performing daily, weekly, and monthly tasks.

Daily Maintenance Tasks

Perform the following tasks on a daily basis:

Task Procedure Comments

Check that 1. Log in to Administration Tool > System Monitoring > Info Make sure that
Info Router Router to open the Info Router client. the Info Router
commands are is working. If
2. Check for failed/waiting commands and retry commands to get
processing there is a
them to succeeded state.
problem and
3. Check for backlog in Not Started queues. commands are
not going to
4. Verify Info Router activity and make sure that commands are succeeded
running and transitioning to succeeded state. state, contact
5. Stop and start Imaginet Auto-Router Server service if needed Customer
(log in to Administration Tool > System Monitoring > Server Service.
Processes)

For more information, see Use the Info Router on page 114.

AG3110 │ 2019-05-07 158

Daily Maintenance Tasks

Task Procedure Comments

Run a system 1. Log in to Administration Tool > System Monitoring > System If you have a
check Check. critical error,
which cannot
2. Select the relevant local node and click Run System Check.
be explained,
3. Review the warning and critical error messages. The most contact
important categories to monitor include: Customer
Service.
l Uptime

l Storage partition filling

l General system partition filling

l Remote DICOM Connectivity

l Studies Need Backup

l Oracle Status

l Oracle Backup

l CFG Backups

Note: Other categories are also important but do not affect

maintenance as much.

For more information, see Run System Checks on page 109.

Check Oracle 1. In WINDOWS, select Start > Administrative Tools > Task A daily task
database Scheduler. runs at 6 am to
backup ensure that the
2. Select the relevant scheduled task and check that the date in the
previous
Last Run Time column is today’s date. The following scheduled
backup was
tasks are defined:
successful.
l run_al_backups You can also
perform this
l run_cold_backups backup
l run_full_backups verification
manually when
3. Go to <Backup_drive>:\oradata\mst1\backup and there is a
check whether the name of the log file includes the status ok or related problem
err . reported by the
system check.
For more information, see Verify the Database Backup on page 127.
If there is a
problem,
contact
Customer
Service.

AG3110 │ 2019-05-07 159

Daily Maintenance Tasks

Task Procedure Comments

Check Central Make sure that the Central Configuration backup completed If there is a
Configuration successfully. You can do this from the System Check or by problem,
backup manually checking the (servername)_cfg.exp.1.log (look at contact
the end of the file to verify that the export terminated successfully Customer
without warnings). Service.
For more information, see Back up the Central Configuration on
page 128.

Check if any Check whether any studies need backing up. You can do this from Contact
studies need the System Check or by filtering by Study Need Backup = Y in the Customer
backing up Workflow Manager Administration tool. Service if the
count of
You can also check whether the Needs Backups Info Router
studies older
commands are succeeding.
than 48 hours
is growing, or if
there is
problem
archiving data
to the backup
device.

Check partition Check the Storage and General System partition filling amounts. Contact
filling (Storage You can do this from the System Check or by manually checking the Customer
and General total size and available free space of partitions in Windows Explorer. Service if free
System) space is above
You can also review the Storage Partition filling in Administrator
defined high
Tool > System Configuration > Application Configuration > Life
watermark
Cycle Management > Archive Configuration.
thresholds for
Storage
partition filling
or is indicating
a critical error
in the System
Check.
Approximately
20% minimum
free space is
recommended
but this can
vary depending
on the system
and overall
storage size.

AG3110 │ 2019-05-07 160

Daily Maintenance Tasks

Task Procedure Comments

Check Check whether services are running by logging in to Administration Attempt to

services are Tool > System Monitoring > Server Processes or in WINDOWS start/restart a
running from Start > Administrative Tools > Services. service that
should be
Check that the following services are running:
running and not
AppFabric Event Collection Service disabled.
AppFabric Workflow Management Service Contact
Customer
IIS Admin Service Service if
APACHE TOMCAT service cannot
be
FLEXlm Service
started/restarte
Imaginet Auto-Router d
Imaginet CDDirect Server
Imaginet DB Audit
Imaginet Failover
Imaginet Loader
Imaginet MediLink Converter
Imaginet MediLink Listener
Imaginet Medilink Sync Listener (only if synchronization is
configured)
Imaginet MstSync Server (only at data center if synchronization is
configured)
Imaginet MVSMain Secured
Imaginet MVSMain Server
Imaginet RisSync Server
Imaginet Startup-Shutdown
Imaginet System Check
Imaginet Task Dispatcher
Imaginet Task Scanner
Imaginet WCF
Mirth
OracleOraDB12Home1TNSListener
OracleServicemst1
Redis
For more information, see Monitor Server Processes on page 110.

AG3110 │ 2019-05-07 161

Daily Maintenance Tasks

Task Procedure Comments

Check From the WINDOWS Task Scheduler, check that all tasks ran and Contact
scheduled completed successfully (including fir_autodelete, Db Worker, and Customer
tasks backups). Service if an
enabled task is
For more information, see Run Other Scheduled Database
not completing
Maintenance Tasks on page 129.
successfully.

Check IS Link Check for backlogged queues via Administration Tool > System Attempt to
queues Administration > IS Link Administration Tool >>IS Link Queues. start/restart the
Imaginet
The number of notifications should be zero or working its way down
Medilink
to zero.
Converter
Service to see
if the queues
start to process
down. If
queues are
growing,
contact
Customer
Service.

Check study You validate study statuses by reviewing data in the Vue PACS Depending on
statuses are Client or from Workflow Manager Administration filtered queries. the defined
up to date workflow,
Make sure that the studies are in expected statuses.
status changes
For Vue Reporting, ensure studies are not stuck in Pending or should be
Processing XXX statuses. happening
automatically.
If not, contact
Customer
Service.

Check RIS Search for $$$ in the Patient ID column. In the Workflow Manager
Synchronizatio Administration tool, query for %$%. Merge patients into correct
n status of patient data, then perform a RIS synchronization.
studies
In the RIS Synch column, query for N.
In RIS, investigate if there is an order or problem with the study, then
perform the RIS synchronization.

AG3110 │ 2019-05-07 162

Daily Maintenance Tasks

Task Procedure Comments

Check the Check for metadata synchronization issues via Administration Tool Contact
Synchronizatio > System Monitoring > Synchronization Monitor. Customer
n Monitor (only Service if the
Verify that the last communication time for the remote site is as
relevant for last
close to the current time as possible.
Vue Connect communication
sites or sites Verify that the Sync Gap is not indicating a warning or error. time is not
with Downtime current or the
Backup server) Sync Gap is
widening.

Monitor Log in to the VERITAS Cluster Explorer via the VERITAS Cluster Contact
VERITAS Manager and verify that all resource groups are online and running. Customer
cluster status Service if
Verify that the resource groups are running on the expected node.
(only relevant resource
for cluster groups are not
environments) fully online, or if
the resource
group is
running on a
different node
than expected.

Check the The ORACLE database has a built-in alert file, in which system Contact
ORACLE alert alerts and important messages are registered. You should read this Customer
file file daily to identify potential problems at an early stage, as follows: Service if an
error exists.
1. Go to:
<DB_drive>:\imaginet_
db\oracle\admin\diag\rdbms\mst1\mst1\trace\al
ert_mst1.log

1. Open the alert file using Notepad or WordPad.

2. Scroll down to the last section of the file.

3. Locate the last week’s dates and review the messages.

4. Only informative messages are acceptable, such as startup,

shutdown, and changing log files. (Thread 1 advanced to log
sequence)

For more information, see Check the ORACLE Alert File on

page 128.

AG3110 │ 2019-05-07 163

Weekly Maintenance Tasks

Task Procedure Comments

Check MIRTH l Verify channels are being backed up Contact

and IS Link Customer
l Observe the statistics on messages that are going into error
Service for
l Replay any critical messages that have gone into error (Reports) issues that
cannot be
l Check Mirth.log for exceptions (located in C:\Program overcome
Files\Mirth Connect\logs)

l Observe medilink_erroneous_Messages.log for

recurring errors

l Check IS Link queues for message build up

Check EIS (if l Make sure the Carestream-EIS service is up and running and all Contact
used) logs are being updated. Customer
Service for
l Observe XISErrorlog located in C:\Program Files 
issues that
(x86)\Carestream\EIS\LOGS for recurring errors.
cannot be
l Verify channels are being backed up (if MIRTH is implemented overcome.
with EIS) on the service partition.

l Verify that the EISCleanup and EISDBBackup jobs are being

executed successfully in WINDOWS Task Scheduler.

l Make sure the following folders are backed up on the service

partition:
C:\Program Files (x86)\Carestream\EIS\ADAPTER
C:\Program Files (x86)\Carestream\EIS\CONFIG.

l Replay any critical messages that have gone into error (Reports).

l Make sure the EIS license is valid and never expires.

Weekly Maintenance Tasks

Perform the following tasks on a weekly basis:

Task Procedure Comments

Check load balancers (if Ensure that both load balancers in front of the Downtime Contact Customer
in use) Backup server or Vue Motion servers are operational. Service if a load
balancer is not
operational.

AG3110 │ 2019-05-07 164

Weekly Maintenance Tasks

Task Procedure Comments

Check server room Verify if there are amber lights on the following: Contact vendor
hardware support or
l Production server
Customer
l Downtime Backup server Service, as
appropriate.
l RAID

l Archive server

l RIS server

l Tape Library

Check the status of UPS units or back up power

sources.

Reboot the reading Restart the reading workstations:

workstations
Start > Shutdown > Restart

Check the ConText 1. Go to Start > Programs > SpeechMagic >

adaptation on the ConText Adaptation.
Speech Server (for Vue
2. Select the ConText to review and click OK.
Reporting sites only)

Note: There should only be one ConText

available for review.

3. Go to the Handle Unknown Words tab to address

any unknown words, adding all that are relevant.

Note: Only select Add or Ignore Now when

managing unknown words. Do not to use Ignore
Always to do a mass cleanup of unknown words.
Only use this button when there are reoccurring
instances of individual illegitimate words.

See the Vue Reporting 12.2 Administration Guide for

more information.

Confirm 1. To access the Service Viewer, go to Start > Contact Customer

SPEECHMAGIC Programs > SpeechMagic > Tools> Service Service if service
services are running or Viewer. or tasks will not go
active on the Speech to running or
2. Validate that NT Service is Running, and
Server (for Vue active states.
RcgTask , PurgeTask , and CtxtTask are
Reporting sites only)
Active.

3. If not running, right- click and select Stop

SpeechMagic Windows Service, and then Start
SpeechMagic Windows Service.

AG3110 │ 2019-05-07 165

Monthly Maintenance Tasks

Monthly Maintenance Tasks

Perform the following tasks on a monthly basis:

Task Procedure Comments

Install Install MICROSOFT WINDOWS Security and Critical updates. Do this

MICROSOFT before rebooting the server.
WINDOWS
updates

Reboot Reboot all servers.

servers

Validate Verify workflow by testing complete workflow (book one exam, check the
Downtime HL7 message arrives in PACS, and the worklist on the modality, acquire
Backup server one exam, send it to PACS, check RIS-PACS synchronization, check
functionality reports arrive in PACS).
You can also transition complete site to Downtime Backup server prior to
performing monthly WINDOWS updates and server reboot on production
server.

Situational Maintenance Tasks

Perform the following tasks when required:

Task Procedure Comments

Test the Test the complete workflow:

workflow
1. Book one test exam.

2. Check the HL7 message arrives in PACS from IS Link.

3. Check the HL7 message arrives in the DICOM Modality

Worklist query on the modality.

4. Acquire images for the test exam.

5. Send the test images to PACS.

6. Verify RIS-PACS synchronization.

7. Dictate/mark the test study as READ/FINAL.

8. Check reports arrive in PACS/RIS.

AG3110 │ 2019-05-07 166

Situational Maintenance Tasks

Task Procedure Comments

Shut down and If you need to restart PACS application services, do the
restart PACS following:
services
l To stop PACS application services, open a command prompt
as administrator and type:
system5_shutapp

l To restart PACS application services after the services have

been shut down, enter the following command:
system5_startapp

If you need to restart PACS application services as well as the

database services, do the following:
l To stop PACS application services and database services,
open a command prompt as Administrator and type:
system5_shutdown

l To restart PACS application services and database services

after all services have been shut down, enter the following
command:
system5_startall

or perform a WINDOWS reboot to the server and everything

will start up following the reboot.

Monitor the Make sure the calibration is current and good for the diagnostic
calibration monitors.
Follow best practices determined by state guidelines or a
medical physicist.

Monitor the Log in to Administration Tool > System Monitoring > Test the
bandwidth Bandwidth Test and do the following: bandwidth when
directed by
l Test the bandwidth between your workstation and the local
Customer
node
Service.
l Test the bandwidth between the local node and remote nodes
Check periodically
l Test the bandwidth between server nodes using the to establish
command line expected
baselines.
For more information, see Monitor the Bandwidth on page 112.

AG3110 │ 2019-05-07 167

Situational Maintenance Tasks

Task Procedure Comments

Perform an When the system is restarted, or after a failure or invoked Contact Customer
ORACLE operation, such as installation, upgrade or restructuring, you Service if there is
server general must ensure that all of system components are functioning a problem.
fitness check properly.
You should perform the ORACLE Server general fitness check
manually after every reboot.
When the system is up, these services should be running:
l OracleServicemst1 – The Workflow Manager database
service

l OracleOraDB12Home1TNSListener – The ORACLE Listener

service

For more information, see Perform an ORACLE Server General

Fitness Check on page 129.

AG3110 │ 2019-05-07 168

Publication History

Publication History
Revision Date Comments

A 2018-12-27 Initial version

B 2019-01-28 Updated to conform to regulatory requirements

C 2019-05-07 Updated to correct a spelling error in Configure the Converter Process

on page 77

AG3110 │ 2019-05-07 169

 Carestream Health, Inc.
150 Verona Street
Rochester, NY, USA 14608
© Carestream Health Inc., 2019
CARESTREAM is a trademark of Carestream Health.

Authorized Representative (European Union)

Carestream Health France

1 rue Galilée
93192 Noisy-le-Grand cedex
France

Importer for European Union

Carestream Health Netherlands B.V
Bramenberg 12
3755 BZ Eemnes
The Netherlands

Made in the USA

Part # AG3110
Rev. C

AG3110 │ 2019-05-07 170