Working with Delivery Rules
Working with Delivery Rules
The following actions can be performed on the List of Delivery Rules page:
- Adding a Delivery Rule
- Updating a Delivery Rule
- Deleting a Delivery Rule
- Activating and Deactivating a Delivery Rule
- Re-Ordering the List of Delivery Rules
Adding a Delivery Rule
When adding a new delivery rule, Administrators define general information for the rule (such as the name and description of the rule), input parameters (such as entity type and file format), and output parameters (such as viewer preprocessor and viewer to be used to display the content).
To add a delivery rule:
- From the IE or File Delivery Rules page, click Add Delivery Rule. The Delivery Rule Details page opens.
Add Rule Page (IE rule example)
- In the General Information pane, enter a name for the rule and, optionally, a description.
- Use the information in Table for IEs and Table for File Delivery Rules to enter information in the remainder of the fields. Fields with a magnifying glass and arrow open a selection list in a light box. For these field formats, entries must be selected from the available list(s).
Any fields without entries will be ignored when the system is looking for a match. All populated fields must match.
| Field | Description |
|---|---|
| Owner | This Institution that owns the IE |
| IE Entity Type | This type of resource, such as a book or a movie |
| Staff | Checked, this indicates that any staff member can be calling the rule |
| User IDs | The ID of the user calling the rule |
| Browser Type | Select non-mobile for a standard desktop or laptop, mobile for a smart phone or tablet. External viewers that support an alternative UI for mobile devices can use this parameter. |
| Request Parameters | An open parameter known to the calling system (for example, Primo or Aleph) and shared with Rosetta (through the Delivery rules) |
| Add Entry | Button that opens a light box containing options for a Representation Profile and Viewer combination |
| Representation Profile | The profile for the output object, such as Derivative Copy or Preservation Master |
| Viewer | The type of viewer (for example, Flex Paper or Photo Album) that delivers the IE in the representation profile |
| Field | Description |
|---|---|
| File Extensions | The typically 3-digit extension identifying the file format |
| File Mime Types | The classification of a file type used for identifying Internet types. Stands for Multi-purpose Internet Mail Extensions. |
| File Entity Types | Entity type used by the file/file’s format |
| File Formats | The format of the file as defined by several factors including the numeric fmt/ standardized and used in the Preservation module. |
| Owner | The institution carrying out the rule. |
| Viewer | The type of viewer (for example, Flex Paper or Photo Album) that delivers the IE in the representation profile |
| Parameters | An open parameter shared by the calling system and Rosetta. Multiple parameters can be added (and removed) as part of the default output parameter. |
- Click Save.
The new delivery rule is saved in the Rosetta system.
Updating a Delivery Rule
Administrators can update general, input, and output information of an existing delivery rule.
To update a delivery rule:
- On the List of Delivery Rules page (see Delivery Rules), locate the delivery rule you want to update and click Update. The Rule Editor page opens.
- Modify the fields you want to update, and then click OK.
The delivery rule is updated in the Rosetta system.
Deleting a Delivery Rule
Administrators can delete an existing delivery rule.
After deleting a delivery rule, it is no longer available to the Rosetta system for matching.
To delete a delivery rule:
- On the List of Delivery Rules page (see Delivery Rules), locate the delivery rule you want to delete and click Delete. The confirmation page opens.
- Click OK.
The delivery rule is deleted from the Rosetta system.
Activating and Deactivating a Delivery Rule
Administrators can activate or deactivate a delivery rule. After deactivating a delivery rule, it is no longer available to the Rosetta system for matching.
On the List of Delivery Rules page, the delivery rule’s status is indicated by the check mark in the Active column:
- Yellow - The delivery rule is active.
- Grey - The delivery rule is inactive.
To activate or deactivate a delivery rule:
- On the List of Delivery Rules page (see Delivery Rules), locate the delivery rule you want to activate or deactivate.
- In the Active column, click the check mark. The check mark in the Active column indicates the new status.
The delivery rule is changed from active to inactive, or from inactive to active.
Re-Ordering the List of Delivery Rules
To define the viewer, viewer profile, and viewer preprocessor that must be used for a specific content object, the Rosetta system compares the input parameters defined in a delivery rule with the parameters of the content object.
The delivery rules are analyzed in the same order as they are displayed on the List of Delivery Rules page. The Rosetta system uses the first delivery rule found that matches the parameters of the content object.
An Administrator can re-order delivery rules to change their priority.
To re-order the list of delivery rules:
On the List of Delivery Rules page (see Delivery Rules), select the rule, and then use the up and down arrows to change the rule’s priority.
The Rosetta system now analyzes the delivery rules in the newly defined order.
Representation Profiles
The Representation Profile is a set of attributes that define a representation or group of representations which, based on their content, should be viewed by a dedicated viewer that can handle them as a whole.
The following are two examples:
- a representation that contains the JPEG images of a scanned book, which can be delivered through the Book Reader – see the example below
- a set of images held in one representation and a METS ALTO file that is held in a different representation. The Representation Profile can be defined so it includes these two representations and the METS-ALTO viewer will deliver all the relevant files from both representations.
The Representation Profiles are managed in the List of Representation Profiles:
List of Representation Profiles
The Representation Profile includes the attributes of the representation as shown in the details of one profile (Derivative Low, see Figure).
Representation Profile Details
The Input Parameters section includes the following fields:
- Preservation Type: The out-of-the-box values of this field are Preservation Master, Modified Master, and Derivative Copy. However, users can add values to the code table and define additional types of representations.
- Representation Code: The out-of-the-box values of this field are High, Medium, and Low. This field is used mostly for derivative copies, in order to differentiate between them.
- Representation Entity Type: This field has always been part of the Data Model, but it was never used in any of the Rosetta modules. It can be used as another field by which to group representations or to identify specific representations as a profile.
The Output Parameters section includes the following fields:
- Download All:
- Disallow – No download option is available
- All representations – the Download icon appears that allows you to download all files in the representations.
- Selected Representations – An option is available that allows you to download the files of the representation that you are currently viewing
- Hide Restricted Files: Select to hide files in the viewer to which you are denied access due to an access rights restriction. If cleared, the restricted file names appear in the viewer and a denied access page appears if the file name is clicked.
- Download File: Select to display the option to download the original file.
A process automation task is available for updating representation metadata for a set of representations.
During delivery, multiple representations are sorted according to the fields in the chosen Representation Profile: first by Preservation Type, then by Representation Code, and finally by Representation Entity Type. If a field is marked as Any, the field is ignored for sort purposes.
Logical structmap will precede physical structmap of the same representation.