Skip Headers
Oracle® Multimedia DICOM Developer's Guide
11g Release 1 (11.1)

B28416-03
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

8 Overview of DICOM Administration

This chapter briefly describes the tasks that are related to the administration of the Oracle Multimedia DICOM data model repository.

The Oracle Multimedia DICOM data model repository is a set of collectively managed, user-configurable XML documents that defines the run-time behavior of Oracle Multimedia DICOM. Because Oracle Multimedia DICOM is fully functional after installing Oracle Multimedia, administrators need not access the repository unless they want to update it to configure Oracle Multimedia DICOM for a particular database instance. Each database has its own set of configuration documents. Administrators can customize the repository by adding or deleting configuration documents. Only one administrator at a time is allowed to make changes in the data model repository. Administrators of the DICOM data model repository are assigned the ORDADMIN role.

Administrators can perform a number of repository management tasks. This chapter provides guidelines for the following tasks: loading the repository, and retrieving, adding, and removing content from the repository. See Chapter 11 for detailed information about writing configuration documents.

The DICOM data model repository provides an administrative (PL/SQL) application programming interface (API) for managing configuration documents. See Chapter 9 for detailed reference information about the ORD_DICOM_ADMIN data model repository API.

In addition, administrators can use the following APIs, which are also provided by Oracle Multimedia DICOM:

Note:

Keep these administrative guidelines in mind:

This chapter includes the following sections:

Table 8-1 provides cross-references for administrators to other locations within the Oracle Multimedia software documentation set where you can access additional information about topics mentioned in this chapter.

Table 8-1 Additional References for Administrators

Topic More Information

Reference information for public information views

Chapter 4

Reference information for administrator information views

Chapter 9

Reference information for the DICOM data model utility API

Chapter 4

Reference information for the ORDDicom object API

Chapter 5

Reference information for the DICOM relational API

Chapter 6

Reference information for the ORD_DICOM_ADMIN data model repository API

Chapter 9

Reference information for the DICOM Java API

Oracle Multimedia DICOM Java API Reference

Examples of operations on DICOM content

Chapter 7

Examples of administrative operations in the data model repository

Chapter 10

Information about writing configuration documents

Chapter 11

Listings of the DICOM XML schemas

Appendix B


8.1 Assigning Administrator Roles and Privileges

After installing Oracle Multimedia DICOM, the ORDADMIN role is created, with the database system privileges required for administration of the DICOM data model repository.

The ORDADMIN role must be assigned to the administrator of the DICOM data model repository. The following code segment shows a sample GRANT statement for the administrator dcmadmin:

GRANT ORDADMIN to dcmadmin;

Because of the way database roles behave, tasks for which the administrator must write PL/SQL named procedures require explicit privileges. The following code segment shows a sample of a GRANT statement for an administrator named dcmadmin:

GRANT EXECUTE on ORD_DICOM_ADMIN to dcmadmin;
GRANT SELECT on orddcm_document_refs to dcmadmin;

Administrators must also be granted the write privilege for specified directories. For example, during operations where configuration documents are exported, administrators must have write access to the directory where those documents are to be stored.

All users can load the data model repository into memory structures and view a number of public information views. Only administrators can export, insert, or delete configuration documents from the data model repository. And, only administrators can query administrator only information views.

8.2 Loading the Data Model Repository

At the start of every database session, administrators and users must load the data model repository from the database into memory structures. Users load the data model by calling the setDataModel( ) procedure. Administrators load the data model by calling either the setDataModel( ) procedure or the editDataModel( ) procedure.

After loading the repository into memory, administrators and users can call the setDataModel( ) procedure whenever the application needs to see new data model changes.

Note:

Administrators and users must call the setDataModel( ) procedure before calling any other DICOM methods, functions, or procedures.

Administrators can call the setDataModel( ) procedure when no changes are being made to the data model (for example: when calling the getDocumentContent( ) procedure or the exportDocument( ) procedure only).

Administrators can call the editDataModel( ) procedure when making changes to the data model (for example: when inserting or deleting documents.)

Using the DICOM data model utility in the ORD_DICOM package, call the setDataModel( ) procedure as follows:

exec ord_dicom.setdatamodel;

See setDataModel( ) Procedure in Chapter 4 for reference information.

Using the ORD_DICOM_ADMIN package, call the editDataModel( ) procedure as follows:

exec ord_dicom_admin.editDataModel();

See editDataModel( ) Procedure in Chapter 9 for reference information.

8.3 Browsing the Repository with Information Views

A number of public information views are available for browsing the DICOM repository. An administrator-only information view is also available to assist with DICOM repository administration. Information views provide details about documents in the repository, including names of documents, types of documents, references to other documents, names of constraints, and constraint validation messages.

Table 8-2 lists the information views and indicates which views are available to all users (public) or only to administrators.

Table 8-2 Administrator and Public Information Views

Name Access Category

orddcm_conformance_vld_msgs

Public (messages for user's schema only)

orddcm_constraint_names

Public

orddcm_document_refs

Administrators only

orddcm_document_types

Public

orddcm_documents

Public


Administrators can use the orddcm_document_refs information view to see the list of documents that are referenced by other documents in the repository. This read-only information view is available to administrators only. See Chapter 9 for details about this view.

In addition, administrators (and other users) can use the orddcm_documents view to see the list of details about the documents stored in the repository. They can also use the orddcm_document_types view, which identifies the supported Oracle Multimedia DICOM document types by providing the list of codes for the document types. These public information views are read-only.

Two other public information views are available. The orddcm_constraint_names view lists the names of the constraints installed in the repository. The orddcm_conformance_vld_msgs view lists the constraint messages generated during constraint validation only for the schema that belongs to the user.

See Chapter 4 for details about public information views.

Administrators commonly use the orddcm_documents, orddcm_document_types, and orddcm_document_refs views when inserting, updating, and deleting documents from the repository.

8.4 Exporting Documents from the Repository

Before exporting documents from the repository (and possibly before making any changes to the configuration documents), administrators should perform the following tasks:

  1. Call the setDataModel( ) procedure at the beginning of each database session to load the repository from the database into memory structures. Locking the repository at this point is not required.

    Administrators (and other users) can also call this procedure whenever the application needs to see new data model changes.

    See Chapter 4 for reference information about the setDataModel( ) procedure.

  2. Obtain copies of the existing documents in the repository, using either the getDocumentContent( ) function or the exportDocument( ) procedure.

    The getDocumentContent( ) function returns the specified document as data type XMLType.

    The exportDocument( ) procedure writes the contents of the specified document to a specified file in a directory for which the administrator has been granted the write privilege.

    See Chapter 9 for reference information about the getDocumentContent( ) function and the exportDocument( ) procedure.

8.5 Inserting Documents into the Repository

The process of inserting documents into the repository can involve the use of these procedures:

See Chapter 9 for reference information about these procedures. See Chapter 10 for an example of the insertion process.

The following subsections briefly describe the insertion process for different types of documents.

8.5.1 Inserting Anonymity, Mapping, and Constraint Documents

For anonymity documents and mapping documents, the order of insertion is irrelevant. For constraint documents, however, the order of insertion is important. If there are dependencies among any of the constraint documents to be inserted, insert the documents with dependencies first. Then, insert the remaining documents.

8.5.2 Inserting Dictionary Documents

Inserting standard or private dictionary documents requires merging all the dictionary attributes each time a new dictionary document is inserted, in accordance with the following rules:

  • Attribute tags must be unique, and must not match existing wildcard tags.

  • Attribute tags must not be used in other document types.

In addition, for private dictionary documents, attribute tags must not be included in any existing range tags.

Note:

Oracle recommends limiting insertions of standard dictionary documents to reflect changes or additions to the DICOM standard only.

See the XML schemas ordcmsd.xsd and ordcmpv.xsd in Appendix B for more information about DICOM attributes and attribute tags in dictionary documents.

8.5.3 Inserting Preference and UID Definition Documents

To insert preference documents, first export the installed, Oracle-defined preference document, changing parameter values as required. Then, insert the updated user-defined preference document into the repository.

Administrators can insert user-defined UID definition documents to add new private UID values or to reflect updates in the DICOM standard. If a user-defined preference or UID definition document is later deleted, the Oracle-installed document is reapplied.

Note:

Only one user-defined preference or UID definition document is allowed in the repository.

8.6 Updating Documents in the Repository

The process of updating documents in the repository can involve the use of these procedures:

See Chapter 9 for reference information about these procedures. See Chapter 10 for an example of the update process.

The following subsections briefly describe the update process for different types of documents.

8.6.1 Updating Anonymity, Mapping, and Constraint Documents

Updating anonymity documents, mapping documents, and constraint documents involves a similar set of actions. For both anonymity documents and mapping documents, follow these steps:

  1. Export the existing document.

  2. Edit the exported document.

  3. Delete the existing document.

  4. Insert the edited document.

Constraint documents are updated in reverse order from their insertion order. In addition, if there are dependencies among any of the constraint documents to be updated, update the documents with no dependencies first. Then, update the remaining documents.

8.6.2 Updating Dictionary Documents

Updating standard or private dictionary documents requires checking the attribute tags and dependencies with other documents in the repository. Standard and private dictionary documents can be updated only if no other documents are using the attribute tags that are defined in the new documents. To update the attribute tags that are being used by other documents, first update the dependent documents to remove the referenced attribute tags. Then, update the dictionary tags in accordance with the following rules:

  • Attribute tags must be unique, and must not match existing wildcard tags.

  • Attribute tags must not be used in other document types.

In addition, for private dictionary documents, DICOM attribute tags must not be included in any existing range tags.

Note:

Oracle recommends limiting updates of standard dictionary documents to reflect changes or additions to the DICOM standard only.

See the XML schemas ordcmsd.xsd and ordcmpv.xsd in Appendix B for more information about DICOM attributes and attribute tags in dictionary documents.

8.6.3 Updating Preference and UID Definition Documents

To update existing user-defined preference documents or UID definition documents, follow these steps:

  1. Export the user-defined document.

  2. Edit the exported document.

  3. Delete the existing user-defined document.

  4. Insert the edited document.

Note:

UID values defined by Oracle or the DICOM standard must not be changed.

8.7 Deleting Documents from the Repository

The process of deleting documents from the repository can involve the use of these procedures:

Use the exportDocument( ) procedure to save a copy of an original document before deleting it from the repository.

Only user-defined documents can be deleted. Documents installed by Oracle are default documents that cannot be removed. Additionally, to ensure conformance with referenced constraints, remove documents in the reverse order from the order in which they were loaded.

See Chapter 9 for reference information about these procedures. See Chapter 10 for an example of the deletion process.

The following subsections briefly describe the deletion process for different types of documents.

8.7.1 Deleting Anonymity, Mapping, and Constraint Documents

For anonymity documents and mapping documents, the order of deletion is irrelevant. For constraint documents, however, the order of deletion is important. Constraint documents are deleted in reverse order from their insertion order. In addition, if there are dependencies among any of the constraint documents to be deleted, delete the documents with no dependencies first. Then, delete the remaining documents.

8.7.2 Deleting Dictionary Documents

Deleting standard or private dictionary documents requires checking dependencies with other documents in the repository. For example, a user-defined dictionary document can be deleted only if no other documents reference it.

8.7.3 Deleting Preference and UID Definition Documents

When a user-defined preference document is deleted, the values of the preference parameters revert back to the installed values from the default Oracle-defined preference document (ordcmpf.xml). Similarly, when a UID definition document is deleted, the UID values revert back to the installed values from the default Oracle-defined UID definition document (ordcmui.xml).