Creating a View-Level Package

1. From the Owner drop-down list, select your institution.
2. From the View drop-down list, select your view.
3. Under the Download a Package section, click Download to select one of the following templates:
   • Template package – This template defines a package's folder structure and includes the files (such as custom1.css and home_en_US.html) needed to create a package.
   • Central package – For member institutions in a consortium, download the Central package if you want to override settings from it and the out-of-the-box configuration.
4. Create the new package from the template:
   1. Uncompress the template.
   2. Change the name of the VIEW_CODE folder to your view's code.
      
      Change Folder's Name
   3. Use the browser's inspect functionality to determine which CSS elements to modify in the new Front End UI.
   4. Update the relevant files that are stored under the directories shown in the following figure. Remember to add any new or updated images to the img folder.
      
      Package Folder Structure
      In order for the system to recognize your customizations, you must retain the package structure (including folder and file names). In addition, it is necessary to retain the file names for images and other files that you modify and include in your customization package.

   5. Compress the view's package. In this example, you would compress the My_View folder. 

      For Windows users, it is recommended that you use a compression tool such as 7zip or Winrar instead of Windows Send to > Compress folder to avoid upload errors.

       

      For Mac users, use the following procedure to zip and remove any hidden .DS_Store files:

      1. Open the Terminal application under Applications > Utilities.

      2. Move to the parent directory of the folder that you want to compress. For example: cd /Users/<user name>/<parent folder>

      3. Enter the following command to compress the file: zip –r <target file>.zip <My_View> -x "*.DS_Store"

5. Upload the new package (for example, My_View.zip):
   1. Under the Upload Package section, click Choose File.
   2. Specify the name of the compressed package.
   3. Click Upload.
6. Deploy your view.

Modifying a View-Level Package

1. From the Owner drop-down list, select your institution.
2. From the View drop-down list, select your view.
3. Under the Download a Package section, click Download to download view-level package (which is identified by the view's code).
   
   Download View-Level Package
4. Decompress, modify, and then compress the modified package.
   To avoid upload errors, it is recommended that you use a compression tool such as 7zip or Winrar instead of Windows Send to > Compress folder.
5. Upload the updated package:

   1. Under the Upload Package section, click Choose File.

   2. Specify the name of the compressed package.

   3. Click Upload.

6. Deploy your view.

Creating the Central Package

1. From the Owner drop-down list, select All Institutions.
2. From the View drop-down list, select CENTRAL_PACKAGE.
3. Under the Download a Package section, click Download to download the Template package.
4. Create the new package from the template:
   1. Uncompress the template.
   2. Change the name of the VIEW_CODE folder to CENTRAL_PACKAGE.
      
      Template's Root Folder
   3. Use the browser's inspect functionality to determine which CSS elements to modify in the new Front End UI.
   4. Update the relevant files that are stored under the directories shown in the following figure. Remember to add any new or updated images to the img folder.
      
      Central Package Folder Structure
   5. Compress the view's package. In this example, you would compress the CENTRAL_PACKAGE folder.

      To avoid upload errors, it is recommended that you use a compression tool such as 7zip or Winrar instead of Windows Send to > Compress folder.

5. Upload the new package:
   1. Under the Upload Package section, click Choose File.
   2. Specify the name of the compressed package.
   3. Click Upload.
6. Deploy your view.

Modifying the Central Package

1. From the Owner drop-down list, select All Institutions.
2. From the View drop-down list, select CENTRAL_PACKAGE.
3. Under the Download a Package section, click Download to download the Central package.
   
   Download Central Package
4. Decompress, modify, and then compress the modified package.
   To avoid upload errors, it is recommended that you use a compression tool such as 7zip or Winrar instead of Windows Send to > Compress folder.
5. Upload the updated package:

   1. Under the Upload Package section, click Choose File.

   2. Specify the name of the compressed package.

   3. Click Upload.

6. Deploy your view.

Inheriting from the Central Package

1. From the Owner drop-down list, select your institution.
2. From the View drop-down list, select your view.
3. Under the Download a Package section, verify that a package has been loaded for the Central package field.
4. Under the Upload Package section, select the Inherit from Central Package check box and click Save.
5. Deploy your view.

Disabling Packages While Testing

1. Open the new Front End UI in a browser.
2. Add the &package=OTB parameter to the end of the URL and press ENTER to refresh the page. For example:
   http://my-primoqa02:1701/primo-explore/search?vid=MY_VIEW&lang=en_US&package=OTB
3. You can toggle between the out-of-the-box formatting and your customized formatting by adding and removing this parameter.

Adding a Clickable Logo

1. Open the UI Customization Package Manager (Primo Home > Utilities > UI Customization Package Manager).
2. In the Upload Logo section, select Browse to locate and select the image that you want to use for your institution's logo.
   The system places the following restrictions on the logo file:

   • The file format of the image must be .png.

   • The height of the image cannot exceed 120 pixels.

   • The width of the image cannot exceed 300 pixels.

   • The size of the image cannot exceed 30 KB.

3. Click Upload to upload your selection the to Front End server. If you want to remove the logo, click Delete.
4. If you want to redirect users to a page other than the Primo Home page, specify a URL in the Logo Clickable URL field.
5. Click Save to save your changes.
6. Deploy the changes to the Front End.  

Customizing the Email Template

Primo allows you to customize the format of emails sent to users after selecting the Send To Email action in the new UI. You can customize the format with or without Primo Studio. With either method, you must upload the customized email templates with the Customization Package Manager in the Primo Back Office. In addition, you can create separate email templates for each supported language in the UI.

The following figure shows the sample output of the out-of-the-box Email template for the new UI.

The Email template is in HTML format and includes the following sections:

• Logo – Displays the logo, which is taken from your view's customization package.

• Institution note – Displays the text configured with the following code in the Send Email and SMS code table: default.nui.email.institutionNote. By default, this field has no value and will not display if left empty.

• List of records – For each record, the email displays the record's brief display and availability statement.

• Disclaimer – Displays the text configured with the following code in the Send Email and SMS code table: default.nui.email.disclaimer. 

Accessing Primo Studio

Primo Studio is an integrated environment that allows you to customize and test various aspects of your Primo views. For more information, see Using Primo Studio.

1. In the Go to Primo Studio section, select Primo Studio.

   

   Primo Studio Login Page

2. Enter the following information:

   • Primo URL – Specify the base URL of your Primo UI.

   • Primo View – Specify your view's code.

   • Primo VE – For Primo VE environments, select this check box.

3. Select Start your studio with the above details.