Configuring CollectionSpace's User Interface (UI) Layer - An Overview
Not Yet Updated for v5.0
The documentation on this page has NOT yet been updated to describe what's changed in the v5.0 release of CollectionSpace.
This document provides an overview of the types of configuration changes you can make in CollectionSpace's User Interface (UI) layer. It also provides basic instructions about where and how you can make such changes.
About CollectionSpace's three layers
A CollectionSpace system has three layers. A simplified overview:
The User Interface (UI) layer. This layer runs in a web browser, and is what your users will see on their screens when working with CollectionSpace.
The Application layer. This layer consists of compiled code, and runs on your server. It routes and translates data between the UI and Services layers, and orchestrates some complex interactions between those two layers.
The Services layer. This layer also consists of compiled code, and runs on your server. It stores and provides data relating to your museum's object and procedural records, via a back-end content management system and databases.
About the User Interface layer
Not Yet Updated for v5.0
The documentation on this page has NOT yet been updated to describe what's changed in the v5.0 release of CollectionSpace.
The User Interface layer consists primarily of:
HTML pages
CSS stylesheets
JavaScript scripts
Configuration files (of various types)
By editing any or all of these, you can change many of CollectionSpace's behaviors. Some of these changes can be made exclusively in the UI layer, while others may require corresponding changes in the Application and/or Services layers.
The overlay model for User Interface layer configuration
Not Yet Updated for v5.0
The documentation on this page has NOT yet been updated to describe what's changed in the v5.0 release of CollectionSpace.
The User Interface layer uses an overlay model:
By default, the User Interface layer will use the files in its
defaultsfolder.However, if you copy one or more files from the
defaultsfolder to the corresponding locations within your museum's own folder - what CollectionSpace calls your "tenant" folder - modify those files, and then copy ("deploy") your tenant folder (packaged appropriately) to the CollectionSpace server, the User Interface layer will use your modified files instead, overriding the default behavior.
You only need to copy into your tenant folder the specific files you need to modify, to adapt CollectionSpace to the needs of your museum. You'll automatically get the default behavior for any files that you don't copy and modify.
Tip
By browsing the sample Lifesci tenant's folder within CollectionSpace's UI repository, you can find some useful examples of modified UI files.
The folder layout of the User Interface layer
Not Yet Updated for v5.0
The documentation on this page has NOT yet been updated to describe what's changed in the v5.0 release of CollectionSpace.
The User Interface layer consists of the following folders:
bundle
Text labels that appear onscreen for titles, fields, buttons, etc.config
Configuration of screen (page) layouts and components.css
CSS stylesheets that affect page look and feel.html
HTML templates for each of CollectionSpace's pages.images
Image files that appear on HTML pages.js
JavaScript source code that significantly affects the behavior of CollectionSpace's pages.lib
JavaScript library files.
You'll be making most of your configuration changes to files that you copy from the defaults folder's bundle, css, html, and images sub-folders, to the corresponding locations within your tenant folder.
Changing certain advanced behaviors may occasionally require copying and making changes to files in the config and js sub-folders, as well.
Configuring the User Interface layer for your museum
Not Yet Updated for v5.0
The documentation on this page has NOT yet been updated to describe what's changed in the v5.0 release of CollectionSpace.
As described in Configuring CollectionSpace, you will be making your UI configuration changes within a folder for your museum; that is, within the folder for your tenant. A tenant is a space or partition on a CollectionSpace system for your museum or collection, within which you'll make most or all of your changes.
First:
You'll need to identify - or make - the folder for your tenant.
After that:
Copy the specific files you wish to change, from the
defaultsfolder to the corresponding locations inside the folder for your tenant.
And then repeat the following steps, until you are satisfied with your changes:
Make changes to those files.
Copy ("deploy") the folder for your tenant, containing all of your modified files, to your CollectionSpace server. (You'll typically do this by typing a command at a shell or command prompt.)
Reload the appropriate page(s) in your web browser, to see the effects of your changes. (If necessary, clear the web browser's relevant cache(s).)
Making configuration changes for your museum
Not Yet Updated for v5.0
The documentation on this page has NOT yet been updated to describe what's changed in the v5.0 release of CollectionSpace.