Central Management in Collaborative Networks

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Introduction

A number of features are available for managing the look and feel of member institutions in a collaborative network. These features are configured in the Network Zone (NZ) institution. Member institutions can configure the extent to which the NZ settings are inherited to their institutions through the settings in their individual Institution Zones (IZ).

The features that can be configured in the NZ, and described below, are:

Central customization package
Display fields and local fields
Resource types
Code and mapping tables

Managing the Central Customization Package

The Central Package is a customization package that is managed from the NZ. It is just like the customization packages used to customize individual institutions' look and feel (see Configuring Discovery Views for Primo VE), and is used to provide a standard look and feel to the UIs of member institutions in the collaborative network. Member institutions can choose to inherit its settings as is, without further customizations, or they can use it as a template and make specific modifications in keeping with their institutions' requirements.

As with customization packages in general, customization packages that are deployed in a collaborative network need only contain settings for elements for which the default Primo VE settings need to be overridden. If the default settings are fine as they are, there is no need to deploy a customization package.

Managing the Central Package in the Network Zone

The Central Package is a folder containing a number of subfolders, under which the custom assets, such as images and css code, are saved. On the IZ level, customization packages are created per view. The Central Package is created for a special view called CENTRAL_PACKAGE that belongs to the NZ institution.

The Central Package is initially created by downloading a template, unzipping it, and adding assets to it, as required. It can then be zipped up and uploaded back to the NZ for deployment. Once a package has been deployed in this way, it can be downloaded and modified later on, at any time, and the original template is no longer needed (although it is still available for download, if required).

In the original UI, the downloading and customization of the package can be done manually, as described below, or interactively using Primo Studio. In either case, the modified package must then be uploaded to the NZ, as described below. For more information about working with Primo Studio, see Primo Studio for Primo VE.
In the NDE UI, Primo Studio is not supported.

Managing the Central Package in the NZ institution is performed in the Manage Central Customization Package page (Configuration Menu > Discovery > Display Configuration > Manage Customization Package).

Manage Central Customization Package page with sections for the original and the NDE UIs, each of which has options for downloading the template, the existing Central Package, and uploading a new Central Package..

Manage Central Customization Package Page

The page has two sections:

Classic Central Package – Controls for managing Central Packages for views that use the original UI
NDE Central Package – Controls for managing Central Packages for views that use the NDE UI

In each section, there are two Download buttons:

Download button for the Central Customization Package (Download Central Customization Package or Download NDE Central Customization Package) – These buttons are used to download the currently deployed Central Package, if one exists. If no Central Package is currently deployed, the Download button for this option is not available, and No Package Loaded appears beside the option. If a central Package is currently deployed, this button is available, and a Remove button appears at the bottom of the section.
Download button for the Template package (Template View Customization Package or Download NDE Central Package Template) – These buttons are used to download a blank template of a Central Package, which can be populated with custom assets. If a Central Package is already deployed, it is not generally recommended to use this template, because it is usually easier to simply modify the current Central Package than to create a new one from scratch.

To create or modify the Central Package:

In the NZ configuration, in the Manage Central Customization Package page (Configuration Menu > Discovery > Display Configuration > Manage Customization Package), select the appropriate Download button for the Central Package you want to create or modify:
- For views using the original UI, under Classic Central Package, if a Central Package is already deployed, select Download Central Customization Package to download it for editing. If no Central Package is deployed, select Template View Customization Package to download the template.
- For views using the NDE UI, under NDE Central Package, if a Central Package is already deployed, select Download NDE Central Customization Package to download it for editing. If no Central Package is deployed, select Download NDE Central Package Template to download the template.
Extract the package you downloaded.
If you downloaded a template, rename the VIEW_CODE directory using the following format: <institution_code>-CENTRAL_PACKAGE. For example, PRMO_NZ_INST-CENTRAL_PACKAGE.
Make your customizations to the package. For more information, for the original UI, see Original UI Customization - Best Practices, and for the NDE UI, see NDE UI Customization - Best Practices.
Compress the package into a ZIP file, ensuring that the root directory of the package is the <institution_code>-CENTRAL_PACKAGE directory.

To deploy a Central Package:

In the NZ configuration, in the Manage Central Customization Package page (Configuration Menu > Discovery > Display Configuration > Manage Customization Package), in the relevant section, select to open a file selector, and then select the compressed Central Package file.
Select Upload. The file is uploaded.
Select Save. The Central Package is deployed. Whether or not its settings affect each member institution in the collaborative network depends on the member-institution's settings, as explained in the next sections.

To remove a Central Package from the NZ, and revert to the default Primo VE settings:

In the NZ configuration, in the Manage Central Customization Package page (Configuration Menu > Discovery > Display Configuration > Manage Customization Package), in the relevant section, select Remove.
Select Save. The Central Package is removed, and the NZ reverts to the default Primo VE settings. Whether or not the change affects each member institution in the collaborative network depends on the member-institution's settings, as explained in the next sections.

Configuring the IZ's Implementation of the Central Package

Each member of a collaborative network can decide how they want to implement the Central Package of the NZ in each of their views. You can configure a view to automatically inherit all of the customizations in the Central Package, or you can use their own customization package. If you choose to use your own customization package, you can configure it from scratch, just as you would if you were not part of a consortium, or you can download the Central Package, modify it as you choose, and then upload and deploy it manually in the relevant view.

If customizations are deployed both by inheritance from a Central Package and by uploading a custom package, the customizations are merged as follows:

Customizations in the custom package are given precedence over inherited customizations. Thus, for example, if the favicon is customized both in the custom package uploaded in the IZ and in the Central Package, the former favicon – the one from the custom package – is used, not the one in the Central Package.
If a customization appears in either of the packages, but not in both, it is implemented. Thus, for example, if the favicon is customized in the custom package uploaded in the IZ, but not in the Central Package, the custom favicon is used. Similarly, if the favicon is customized in the Central Package, but not in the custom package uploaded in the IZ, the favicon from the Central Package is used.

Automatically Inheriting the Central Package Customizations

You can choose to inherit the customizations in the Central Package automatically. With this option, the IZ view receives updates automatically from the Central Package whenever it is updated.

If you do not want to make any additional customizations for your institution, selecting this option is all you need to do.

If you want to inherit the customizations from the Central Package and also implement your own customizations, you can do so by selecting this option and also uploading a custom package of your own, as explained in the next section.

To inherit the settings from the Central Package automatically:

In the View Configuration page (Discovery > Display Configuration > Configure Views > [Edit view]), in the Manage Customization Package tab, select Inherit from Central Package.
Select Save.

Implementing Local Customizations in the IZ

If you want to implement your own customizations, with or without the customizations defined in the Central Package, you can do so by creating a customization package in one of the following ways:

Download a blank template package and configure it.
Download the Central Package and use it as a template.
If the IZ has already deployed a customization package, download that package and modify it.

Once you have downloaded one of these packages, you can customize it as required and then upload and deploy it in the view.

If the view is in the original UI, you can use Primo Studio to create the customization package; see Using Primo Studio to Create a Custom Package (Original UI), below.

To create a local customization package for an IZ view:

In the View Configuration page (Discovery > Display Configuration > Configure Views > [Edit view]), in the Manage Customization Package tab, select the Download button beside one of the following options:
- Template View Customization Package – A blank customization-package template.
- Current View Customization Package – The currently deployed customization-package. (This option is only available if a customization package has already been deployed for this view.)
- Download Central Customization Package – The Central Package of the NZ
Unzip the package you downloaded.
If you downloaded the template package, rename the root directory of the package to the view's code. The name should be in the following format: <institution_code>-<view_code>. For example, PRMO_MY_INST-OpenU. For example, PRMO_NZ_INST-CENTRAL_PACKAGE.
Make your customizations to the package. For more information, for the original UI, see Original UI Customization - Best Practices, and for the NDE UI, see NDE UI Customization - Best Practices.
Compress the package into a ZIP file, ensuring that the root directory of the package is the <institution_code>-<view code> directory.

To deploy a customization package locally for an IZ view:

In the View Configuration page (Discovery > Display Configuration > Configure Views > [Edit view]), in the Manage Customization Package tab, under Upload Package, in the Customization Package field, select to open a file selector, and then select the compressed file.
Select Upload. The file is uploaded.
Select Save. The Central Package is deployed. Its settings override any settings inherited from the Central Package.

Using Primo Studio to Create a Custom Package (Original UI)

If you are customizing an original-UI view, you can create your local customization package using Primo Studio, if you wish. Once you have done so, you can deploy it as explained above.

For additional information about Primo Studio, see Primo Studio for Primo VE.

To use Primo Studio to create a customization package for deployment in an IZ view:

In the View Configuration page (Discovery > Display Configuration > Configure Views > [Edit view]), in the Manage Customization Package tab, under Create Customization Package, select Go to Primo Studio. Primo Studio opens with the settings of the blank template implemented.
If you want to modify one of the existing packages instead of the blank template, do one of the following:
- To modify the current package:
  1. Download the current package. (In the View Configuration page, select the Download button beside Current View Customization Package.)
  2. Upload the package to Primo Studio. (In Primo Studio, select Upload Package; see Primo Studio for Primo VE.) The settings of the current package are loaded into Primo Studio.
- To modify the Central Package:
  1. Select Back to Configuration to open the Primo Studio Login page.
  2. Select Primo VE and Use Central Package.
    
    Primo Studio Login Page
  3. Select Start your studio with the above details. Primo Studio reopens with the settings of the Central Package loaded.
Configure the settings and create the customization package as explained at Primo Studio for Primo VE.

Defining Display Fields and Local Fields Centrally

Display fields and local fields can be managed by the NZ for distribution to member institutions from the Consortia Central Configuration Dashboard (Configuration Menu > Network Zone).

The NZ fields are managed from the Discovery drawer, under Manage display and local fields (Configuration Menu > Network Zone > Discovery > Display Configuration > Manage display and local fields). They are configured just like they would be configured in an IZ (see Managing Display and Local Fields for Primo VE).

Consortia Discovery configuration in the Consortia Central Configuration Dashboard; centralized field management is under Manage display and local fields.

Consortia Discovery Configuration in the Consortia Central Configuration Dashboard with the Discovery Drawer Expanded and Highlighted

Overriding of Locally Customized Fields

General settings for the distribution of NZ settings to member institutions control what happens when the NZ manager distributes a field to an IZ that has already customized the settings of that field locally. These settings are configured in the dashboard under Distributed Settings. Depending on the Mode setting selected there, the manager may or may not be able to choose the outcome when an NZ field is distributed under these circumstances. The possible Mode settings are:

Proposed (default) – The NZ settings do not override customized IZ settings.
Imposed – The NZ settings override the customized IZ settings.
Hybrid – When the NZ manager distributes a field, they can choose whether the NZ settings override customized IZ settings.

For additional information about the Mode setting, see Dashboard Setup; Consortia Central Configuration Dashboard.

Centrally Managed Local Fields

Local fields local_field_51 – local_field_100 are earmarked for use as centrally managed fields. (The NZ and member institutions should use local_field_1 – local_field_50 for local purposes.) Only these local fields can be distributed from the NZ to member institutions.

When local fields are used for facets and search, member institutions can have a maximum of ten locally defined fields and ten centrally defined fields.

Additional Primo VE Training > Local Fields for Consortia (4 min)

Distributing Centrally Managed Fields to Member Institutions

The manager of the NZ can distribute centrally managed display fields and local fields (51-100 only) to the member institutions (IZs) from the Consortia Central Configuration Dashboard. After a field has been added to the list of fields in the Manage Display and Local Fields page of the NZ, it can be distributed from there to other members of the consortium or groups of members.

To distribute a display field or local field from the NZ to individual members or groups of members of the consortium:

In the Consortia Central Configuration Dashboard, in the Manage Display and Local Fields page (Configuration Menu > Network Zone > Display Configuration > Manage Display and Local Fields), in the More Actions menu, select Distribute. The Confirm Distribution dialog box opens.

Distribute Local Field to Member Institutions

Confirm Distribution Dialog Box
If the Distribution mode field is active, select the desired distribution mode (If it is not active, the option displayed will be implemented; see Defining Display and Local Fields Centrally, above.), as follows:
- Do not override member institution customization – When selected, the local field is distributed only to member institutions that are not using the selected local field or that have already inherited it from the NZ and have not customized it.
- Override member institution customization – When selected, the local field is distributed to all member institutions and overrides any customizations made to that local field in the IZ.
Select the members to which the field should be distributed, as follows:
- Distribute to all – Select this option to distribute the field to all of the members of the consortium. The Members and Groups options are hidden when you select this option.
- Members – Select one or more individual members of the consortium to which to distribute the field.
- Groups – Select one or more groups of members of the consortium to which to distribute the field.
Select Confirm. The Distribute network display field / local field <field> to members job is submitted to distribute the field to the specified members.

Monitoring the Job

You can monitor the progress of the job while it is running, and view a report about what it did when it finishes running, in the Monitor Jobs page (Admin > Manage Jobs and Sets > Monitor Jobs).

Monitor Jobs Page when a Distribution Job Is Running

When the job finishes, its report contains overall status information (such as status and start and end timestamp) and result statuses per member institution. The following statuses may appear:

Field was distributed – Indicates that this local field did not exist previously for this member and has been distributed.
Field already exists and was not distributed – Indicates that this local field already exists in the member institution, and it could not be distributed because the Override member institution customization option was not selected for the local field.
Field already exists and was overridden with network data – Indicates that this local field already exists in the member institution, and either the Override member institution customization option was selected or the field was last modified by the network distribution job.
Failed to distribute field data – Indicates that an internal error occurred during the distribution process. If this result appears, the job status will be set to Completed with warnings.

Report for Local Field's Distribution Job

Identifying Distributed Fields in the IZ

If the distribution of a field from the NZ was successful, the field appears in the Manage Display and Local Fields page (Discovery > Manage Display and Local Fields) of each IZ to which it was distributed. The fields are identified by the value Network in the Updated by field.

Local Field Inherited from NZ

Defining Resource Types Centrally

The Network Zone (NZ) institution can create local resource types to share with member institutions so that configuration is not needed at the Institution Zone (IZ) level. If member institutions decide to configure the same resource type, their customizations will override the settings of the NZ. If a code is not found in either the NZ or the member's institution, the system will display the code for the local resource type as it did in previous releases.

Defining Code and Mapping Tables Centrally

The Network Zone (NZ) institution can define code and mapping tables to share with member institutions so that configuration is not needed at the Institution Zone (IZ) level. If member institutions decide to configure the same tables, their customizations will override the settings of the NZ.

Managing Complete Keys for Dedup and FRBR Centrally

After you have made changes to the Dedup/FRBR complete keys in the NZ, you can distribute the changes to the member institutions. The Distribute action creates and executes the Distribute Network Zone configuration table changes to member institutions job, which can be monitored in the Running or History tabs on the Alma Monitor Jobs page (Admin > Manage Jobs and Sets > Monitor Jobs). For information on how to customize the complete keys, see Configuring the Dedup and FRBR Complete Keys in Primo VE.

To distribute complete key changes in the NZ to the members:

Open the Dedup/FRBR Complete Key Combination page (Configuration Menu > Discovery > Other > Dedup/FRBR Complete Key Combination).
Select the tab of the process (Dedup or FRBR) from which you want to distribute complete keys to the member institutions.

Distribute Action
Select Distribute.
Select one of the following distribution options:
- Do not override member institution customization – When selected, the complete keys are distributed only to member institutions who have not made local changes to their complete keys.
- Override member institution customization – When selected, the complete keys are distributed to all member institutions and will override any customizations to complete keys in the IZ.