Skip to main content
ExLibris
Ex Libris Knowledge Center

Working with Configuration Files

Working with Configuration Files

Configuration files are text files that enable Deposit Managers to configure advanced settings for Producers such as metadata configuration and e-mail formatting. Configuration files can be stored in various formats, including XML and XSL.

Configuring Copyright Boilerplate Statements

Copyright boilerplate statements contain copyright statements displayed to Producer Agents when they deposit content. Deposit Managers can create multiple boilerplate statements and then use them in different material flows.
Deposit Managers work with copyright boilerplate statements using the Boilerplate Statements page (see Accessing the Copyrights Boilerplate Page). The following activities can be performed using this page:

Accessing the Copyrights Boilerplate Page

The Copyrights Boilerplate page enables Deposit Managers to view the list of boilerplate copyright statements stored in the Rosetta system. In addition, Deposit Managers can use this page to edit existing boilerplate statements.
To access the Copyrights Boilerplate page:
From the Rosetta rollover menu, click Deposits > Deposit Arrangements> Copyrights Boilerplate.
The Configuration Files page opens to the boilerplates subgroup.
boilerplate_statements.png
Boilerplate Statements Page

Editing Boilerplate Statements

Deposit Managers can edit an existing boilerplate statement to modify the copyright statement displayed to Producer Agents when they deposit content.
To edit a boilerplate statement:
  1. On the Boilerplate Statements page (Deposits > Deposit Arrangements > Copyrights Boilerplate), locate the boilerplate statement you want to modify and click Edit.
    The Edit Boilerplate Statement page opens.
  2. Edit the copyright statement as required and then click Save. The updated boilerplate copyright statement is saved in the Rosetta system.
The updated statement is now displayed to Producer Agents depositing content.

Viewing Boilerplate Statements

Deposit Managers can view copyright boilerplate statements.
Deposit Managers cannot modify the statements while viewing them.
To view a boilerplate statement:
On the Boilerplate Statements page (Deposits > Deposit Arrangements > Copyrights Boilerplate), locate the boilerplate statement you want to modify and click View. The View Boilerplate Statement page opens.

Configuring Producer Agent E-mail

Communication between Staff users who review SIP submissions and the Producer Agents who submit them is automated in the Rosetta system. Some communications (e-mail) are sent by default, others must be configured by a Deposit Manager.

Default E-mail to Producer Agents

When a SIP is rejected, declined, or when a SIP is received successfully by the staging server or accepted for deposit in the permanent repository, Rosetta sends a confirmation e-mail to the Producer Agent. The default fields that appear on these reports include the deposit activity ID, Title, Deposit Date, and Status, as well as the Agent’s name and the URL where the Agent can link to view the deposit. Further fields that appear on the e-mails:
  • For IEs, the PID.
  • For each file:
    • The applicable identifier (such as ISBN, ISSN, or ISMN)
    • The computed checksum(s)
    • The time stamp of the Rosetta activity (that is, the date and time of the SIP status change)
E-mail notifications can make use of digital signatures if configured by a Deposit Manager (see Digital Signature in the Configuration Guide).

Customizing Display Fields

E-mails are drawn from an XML file defining many of the fields a user might want to add to the e-mail. All additions and adjustments are made through the email_to_depositor.xsl file.
To access this file and make changes to the e-mail:
  1. Access the Configuration Files page of the Management module by following the path Deposits > Advanced Tools > Email Configuration
email_configuration.png
Configuration Files for Formatting Deposit-Related E-mail
  1. In the Filename column, find the email_to_depositor.xsl file and click on it or on the corresponding Edit text link.
    The file opens in an editable window
editing_email_configuration_file.png
Editing a Configuration File
  1. Add or edit definitions for any available fields. The following information can be transmitted if it is added to the XSL file:
    • For each IE in an approved SIP:
      • IE PID
      • IE title
    • For each file in the IE:
      • the applicable identifier (that is, ISBN, ISSN, ISMN, and so forth)
      • the computed checksum (md5, SHA‐256, and CRC32)
      • file name
      • the time stamp of the file status change (that is, the date and time the file status changed to Moved to Permanent)
    • For each rejected or declined IE in the SIP and for each IE containing rejected or declined files:
      • the IE PID
      • the IE title
    • For each file in the IE:
      • the applicable identifier (that is, ISBN, ISSN, ISMN, and so forth)
      • the file status (Approved, Rejected, or Declined)
      • if the file status is Rejected or Declined, the time stamp of the file status change (that is, the date and time the file status changed to Reject or Decline)

Additional E-mail Configuration Files

In addition to the email_to_depositor.xsl file and related XSL files, the following XSL files are available for editing:
  • deposit_activity_status_change/email_to_depositor.xsl: Email sent to the producer agent when a deposit is rejected or declined
  • deposit_activity_status_change/email_to_depositor_body.xsl: Email sent to the producer agent when a deposit is rejected or declined
  • deposit_activity_status_change/email_to_depositor_preview.xsl: Email sent to the producer agent when a deposit is rejected or declined
  • deposit_activity_status_change/email_to_depositor_submission.xsl: Email sent to the producer agent when a deposit is submitted
  • EmaiToPlanAnalyst.xsl: sends preservation plan information to the Preservation Analyst
  • EmailAddingRepresentation.xsl: sends an e-mail to the user when a representation is added to an IE
  • EmailIndividualProducerRegister.xsl: confirms the registration of an individual Producer
  • EmailProducerReport.xsl: sends deposit report to the Producer
  • EmailProducerWithNoContact.xsl: sends a notification to a Producer that there are no contacts associated with the account
  • EmailUserIsPrimaryContact.xsl: notifies the user that he or she is the primary contact
  • EmailUserNewPasswordIndProd.xsl: confirms a new password for an individual Producer
  • EmailUserRegister.xsl: confirms a user’s registration
  • EmailUserassignedAsPA.xsl: sent when a user is assigned as a Producer Agent to a Producer
  • EmailUserNew.xsl: sends an acknowledgment confirming a new user
  • EmailUserUpdate.xsl: confirms the update of a user’s information
  • EmailUserDelete.xsl: notifies the user that they are being deleted from the system
Most e-mail messages can be previewed by the sender before being sent to the recipient.

Adding an E-mail Confirmation

Rosetta can be configured to send confirmation e-mail to depositors when
  • a SIP has been accepted by the staging server and is being processed or
  • a SIP has been approved and its contents sent to the permanent repository.
These confirmation emails will be sent if Email Notification is set to true in the SIP processing configuration for this Material Flow. See SIP Routing Rules for further details.

Configuring Terms of Use

A Terms of Use (TOU) statement appears in the Deposit interface and in the viewers that render objects in the Rosetta interface. Viewers display a TOU statement for the institution that owns a displayed object.
Only one TOU file is allowed for each institution. The file can be edited but not deleted.
To view or edit TOU text for your institution:
  1. Open the Configuration Files page from the Rosetta menu (Deposits > Advanced Tools > Terms of Use Configuration Files).
    The Configuration Files page opens.
​​​​​​​terms_of_use_configuration_files.png
Configuration Files Page
  1. To view the text file or edit it, click the relevant link, View or Edit.
    The View or Edit Configuration File page opens.
  2. If you selected Edit, you can make edits to the file and click the Save button. (If you selected View, you do not have a Save button on the page. Click Cancel or Back to return to the Configuration Files page.)
  • Was this article helpful?