Glossary
* A user needs to be added to openImaDis by the "Facility Administrator" using the Admin Client * User can be either an "internal" user that exists in openImaDis system only or an "external" user that exists in LDAP. If the user is created as an LDAP user, authentication will be performed using his LDAP credentials
* TEAM_MEMBER * TEAM_LEADER * FACILITY_MANAGER * administrator is a special user in the system. * TEAM_MEMBER and TEAM_LEADER have the same privileges. FACILITY_MANAGER gets additional "admin" privileges on all project. administrator gets additional user and system management privileges.
* Record is the 5D collection of images. A record contains sites, frames(t), channels(lambda), slices(z) of 2D pixel data. A record can be created using multiple image files(metamorph nd format), or a single file can result in multiple records(e.g. .lsm, .lif). In OME terminology, a series maps to the definition of record. All records created from the same input file are uploaded together. Same input file cannot be uploaded twice.
* Teams are created by "administrator" with specific amount of storage quota. These teams are used to allocate storage quota to individual projects.
* A project defines a collection of records that can be accessed by a "group" of users. Each user can have a different role in the project. Projects are created by "administrator". "Facility Manager" and administrator can link a project to one or more teams and assign "quota". Users with "MANAGER" role can add more users to the project.
* Users can have following roles in a project * READ : Read all records * EXPORT : Read and Export * WRITE: Read + Export + modify * UPLOAD: Launch Acquisition Manager+ Read + Export + modify * MANAGER : all permissions including DELETE.
* This is the browser based interface to access records available on the openImaDis server.
* This is a java based desktop application to browse records locally and upload them to the openImaDis server.
* This is a browser based web interface to manage users, projects and the system
* These are SOAP based web services and associated java wrapper classes to programmatically access information from openImaDis server.
* Records can be imported in Acquisition Client using "Import File" or "Import Using Filename". Image files are not physically moved but are processed to create records. More properties can be added to these records and they can be uploaded to the server. Once, a record is uploaded to the server, it cannot be modified.
Images in multiple files with meta-data in file names can be combined to create single record with "Import Using Filename" option.
* Multiple records created from the same file can be merged in a "single record" with "multiple sites" if the other dimensions (t,z,x,y,c) are the same. This option is available in acquisition client only.
* Records can be uploaded to the server using "Active Upload" or "Background Upload" using a service installed on the machine. Acquistion Client needs to be used to submit records and check status of upload.
* Records created from the same input files are considered duplicate. Combined md5sum of the all the input files is used to check for duplicate records.
* Records can be shared with users in other projects. Any user with a "READ" role in a project, can share a record with other project where he/she has "WRITE" permission. All user added annotations, attachments, and comments are copied to the "shared" records. More user data can be added to both the records individually. If the original record is deleted, shared record can no longer access the pixel data. If the files are uploaded again, the shared record can access the pixel data again.
* A user with "DELETE(Manager)" role can transfer a record to another project where he/she has "WRITE" role. Transfer does not change the guid of the records and all the user added meta-data is retained. Record source files are deleted from the source project and copied to the target project. Quota from "source project" is released and "target project" is consumed. Records Transfer can fail if user does not have appropriate permissions in source and target projects, or if the quota in target project is exceeded due to transfer.
* Both image files and meta data are deleted when a record is deleted from a project. Quota used by the record is also released in this operation.
* Record(s) can be downloaded in original format or "Ome tiff" format by users with "EXPORT" roles in the project.
* Public project is a project where all the users of openImaDis system have "READ" permission.
* A project can be "archived" by an administrator. All source files for the records in the project are copied and zipped in a location specified by the administrator. Record meta data and user added meta data remains in the system and can be accessed. Pixel data becomes in accessible.
* An archive project can be "restored" by the system administrator by providing the "zip" file for project at a specified location.
