8.5 Reference Information and Examples

This section contains the following topics:

List of Built-in Parameters
List of Status Page Types
List of URL Elements Available for Use in Custom Online Status Pages
Example of Oracle IRM Desktop State in XML

8.5.1 List of Built-in Parameters

Table 8-1 and Table 8-2 contain the built-in parameters that can be used with the HTTP GET method.

Table 8-1 Built-in Parameters (A)

Parameter	Description
application.container	The container application can be considered the application hosting the desktop logic, such as a browser or word processor.
application.name	The application name can be used to identify the application used to access the sealed content.
desktop.operating.system	This value can be used to determine the operating system that is hosting the desktop logic.
desktop.uuid	The desktop UUID is used to identify a particular desktop independently of the product version number.
desktop.version	The desktop version identifies the product version of the desktop used to access the sealed content.
page	The status page type provided by the desktop web site. See Table 8-3, "Status Page Types".

Table 8-2 Built-in Parameters (B)

Parameter	Name	Description
irm-time	Current Time	The time on the web server on which Oracle IRM Server resides.
irm-locale	Desktop Locale	The locale of the desktop installation.
irm-location	Content Location	The location to which the sealed content was opened on the desktop.
irm-mime	Sealed MIME Type	The sealed content MIME type.
irm-extension	Sealed File Extension	The sealed content file extension.
irm-account-uuid	Account UUID	The UUID value that identifies the user.
irm-account-name	User Name	The user name of the user.
irm-creation-time	Creation Time	The time the sealed content was created.
irm-edit-time	Edit Time	The time the sealed content was last edited.
irm-schema-version	Schema Version	The sealed content schema version.
irm-classification-name	Sealed To	The classification label.
irm-classification-description	Description	The classification label description.
irm-classification-keyset	Key Set UUID	The classification key set UUID that identifies which key set was used to seal the content.
irm-classification-system	Classification System	The classification system UUID. This value identifies the type of classification, for example, context classified content.
irm-classification-time	Classification Time	The classification time is set when sealed content is sealed.
irm-classification-url	Server Address	The server URI sealed into content.
irm-host	Desktop Host Name	The desktop host name.
irm-context-uuid	Context UUID	The UUID value that identifies the context.
irm-context-itemcode-value	Item Code Value	The item code value.
irm-context-itemcode-time	Item Code Time Stamp	The item code time stamp, if provided.

8.5.2 List of Status Page Types

Table 8-3 contains the status page types for use with the page built-in parameter in Table 8-1.

When Oracle IRM Desktop requests a status page, it will set the appropriate status using a query parameter. For example, if the user is using content, but the license they are using expired, Oracle IRM Desktop will request a status page with a query parameter set as page=LICENSE_EXPIRED. Table 8-3 lists all the status page types that Oracle IRM Desktop can request.

Table 8-3 Status Page Types

Status	Description
DIAGNOSTICS	When the self-test action is performed within the desktop, one of the steps is to contact the desktop web site. In this scenario, the desktop will ask for the diagnostic status page.
INFORMATION	When the user clicks on the 'Information' button or link, the information status page is requested. The information status page should provide details about the content's classification.
GENERAL_ERROR	A general desktop error has occurred.
UNKNOWN	Unknown status page.
PRIVACY	Privacy statement status page.
LICENSE_EXPIRED	When a user is using sealed content, their license-based rights may expired. If the license cannot be refreshed from the server, this status page will be displayed.
LICENSES_CHECKED_IN	A license is applicable, but in use on another device. This status page will display details about the other device or devices.
LICENSE_CHANGED	When a user is using sealed content, their license-based rights may be refreshed from the server. If these rights change, for example allowing printing, this status page will be displayed.
NO_LICENSES	The user has no rights to access the content.
NO_LICENSES_OFFLINE	The user has no rights stored off-line to access the content. The server cannot be contacted to see if there are licenses available.
UPGRADE	The server has prompted the desktop to perform a mandatory upgrade.
REPUDIATED	The server has denied access to the desktop.
SERVER_CONNECTION	The server cannot be contacted.
AUTHENTICATION_ANONYMOUS	The user has accessed content but chosen to cancel the authentication process.
AUTHENTICATION_FAILED	The user has accessed content, attempted authentication, but failed to authenticate (for example, a bad password).
UNKNOWN_CLASSIFICATION	The server does not know about the classification of the content. This would typically occur if the classification has been removed from the server after creating sealed content.
UNSUPPORTED_FORMAT	The desktop cannot render the content format. For example, occurs when the application that normally renders the content has not been installed.
OFFICE_PASSWORD_PROTECTED	The desktop attempts to protect the content with password protection. If this password protection cannot be applied, this status page is displayed.
OFFICE_PLUGIN_NOT_TRUSTED	A third party plug-in is not trusted and is preventing the sealed content from being accessed.
MOVIE_BEFORE_MOVIE	This status page is displayed before a sealed movie has been started.
MOVIE_AFTER_MOVIE	This status page is displayed after a sealed movie has been shown.

8.5.3 List of URL Elements Available for Use in Custom Online Status Pages

The following special sinfo: URL elements are available for use in links in custom online status pages. For example, <a href="sinfo:panel">Control Panel</a> will open the Oracle IRM Desktop Control Panel dialog.

Table 8-4 sinfo URL Elements

URL element	Description
sinfo:reason	Displays a message box containing further information. Only relevant to a General Error or Rights in Use status page. General Error: support details for the error. Rights in Use: message box listing the device(s) that the rights are checked out on.
sinfo:reload	Causes Oracle IRM Desktop to open the sealed file again.
sinfo:panel	Opens the Oracle IRM Desktop Control Panel dialog.
sinfo:test	Opens the Oracle IRM Server Connection Test dialog.
sinfo:help	Opens the Oracle IRM Desktop help.
sinfo:systeminfo	Opens the Oracle IRM Desktop Support Information dialog.
sinfo:about	Opens the Oracle IRM Desktop About dialog.

8.5.4 Example of Oracle IRM Desktop State in XML

The following XML document shows an example Oracle IRM Desktop state in XML form:

Example 8-1 Desktop State in XML Form

<?xml version="1.0" encoding="UTF-8"?>
<core:DesktopState xmlns:core="http://xmlns.oracle.com/irm/core">
    <desktop>
        <uuid>70678535-0a6f-4cf9-9411-2c05ed8d989</uuid>
        <version>
            <version>11.1.1.1.0</version>
        </version>
        <operatingSystem>Microsoft XP SP 2</operatingSystem>
        <locale>en</locale>
        <device>
            <uuid>a7352732-dcd0-43af-93c5-0cbc7c1f203d</uuid>
            <name>machine</name>
        </device>
        <application>
            <name>desktop</name>
            <container>browser</container>
        </application>
    </desktop>
    <contentDescription>
        <schema>
            <schemaVersion>
                <version>6.0</version>
            </schemaVersion>
        </schema>
        <classification>
            <id>7ec1c191-0531-4876-813e-c554676df09b</id>
            <system>
                <uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
            </system>
            <keySet>
                <uuid>213f8f65-c5d1-4868-9fff-ad156daa2dd6</uuid>
            </keySet>
            <uri>http://irm.example.com/irm_desktop</uri>
            <classifications:ContextCookie xmlns:classifications="http://xmlns.oracle.com/irm/classifications">
                <context>
                    <uuid>588403f9-9cff-4cce-88e4-e030cc57282a</uuid>
                </context>
                <itemCode>
                    <value>sample.sdoc</value>
                </itemCode>
            </classifications:ContextCookie>
            <classificationTime>2008-02-01T13:00:00.000+01:00</classificationTime>
            <labels>
                <locale>en</locale>
                <name>Top Secret</name>
            </labels>
        </classification>
        <creationTime>2007-01-01T12:00:00.000+01:00</creationTime>
        <editTime>2007-01-01T12:00:00.000+01:00</editTime>
        <sealedMime>application/vnd.sealed.doc</sealedMime>
        <unsealedSize>1234567</unsealedSize>
    </contentDescription>
    <contentUri>http://server/files/fish.sdoc</contentUri>
    <account>
        <uuid>17f45d8d-d5c9-4970-8808-daa0fc893c33</uuid>
        <type>USER</type>
        <name>John Smith</name>
    </account>
</core:DesktopState>