Task Description

This document explains how to find your tenant folder within the source code trees for each of CollectionSpace's three layers.

Your tenant folder is the space or partition within which you'll make most of the configuration changes to adapt CollectionSpace for your museum (or other collecting institution).

Contents

Prerequisites

You will first need to have created folders for your tenant within the source code trees for each of CollectionSpace's three layers. To do so, follow the instructions in Creating your new tenant.

Procedure

Finding your tenant folder in the Application layer source code

Unknown macro: {multi-excerpt}

Find your folder, named application, that contains the Application layer source code. (You will have previously created that folder as part of the process of creating your new tenant.) Depending on your naming practices, it may be located within a parent folder named something like collectionspace-source or cspace_source_code or another name similar to these.
Within that application folder, find your tenant folder - the folder in which you make Application configuration changes for your museum. Your tenant folder will be a folder named for your museum, inside the tomcat-main/src/main/resources/tenants folder. For instance, if your tenant folder is named mymuseum, you would find that folder at tomcat-main/src/main/resources/tenants/mymuseum
If you still can't find your tenant folder, or need a refresher about how you set up this folder, see Creating your new tenant.

Here's a map to finding your tenant folder, within the application folder that contains the Application layer source code:

Tip

The sample lifesci tenant provides an up-to-date example of a tenant folder containing representative Application layer configuration changes that make it different from the sample core tenant, in order to meet some of the needs of life sciences museums. It can be useful to study this folder's contents as an example of how to make configuration changes for your own museum. You can browse the lifesci tenant's folder via the CollectionSpace GitHub repository.

Finding your tenant folder in the Services layer source code

Unknown macro: {multi-excerpt}

Find your folder, named services, that contains the Services layer source code. (You will have previously created that folder as part of the process of creating your new tenant.) Depending on your naming practices, it may be located within a parent folder named something like collectionspace-source or cspace_source_code or another name similar to these.
Within that services folder, find your tenant folder - the folder in which you make Services configuration changes for your museum. Your tenant folder will be a folder named for your museum, inside the services/common/src/main/cspace/config/services/tenants folder. For instance, if your tenant folder is named mymuseum, you would find that folder at services/common/src/main/cspace/config/services/tenants/mymuseum
If you still can't find your tenant folder, or need a refresher about how you set up this folder, see Creating your new tenant.

Here's a map to finding your tenant folder, within the services folder that contains the Services layer source code:

Tip

The sample lifesci tenant provides an up-to-date example of a tenant folder containing representative Services layer configuration changes that make it different from the sample core tenant, in order to meet some of the needs of life sciences museums. It can be useful to study this folder's contents as an example of how to make configuration changes for your own museum. You can browse the lifesci tenant's folder via the CollectionSpace GitHub repository.

Finding your tenant folder in the User Interface (UI) layer source code

Unknown macro: {multi-excerpt}

Find your folder, named ui, that contains the UI layer source code. (You will have previously created that folder as part of the process of creating your new tenant.) Depending on your naming practices, it may be located within a parent folder named something like collectionspace-source or cspace_source_code or another name similar to these.
Within that ui folder, find your tenant folder - the folder in which you make UI configuration changes for your museum. Your tenant folder will be a folder named for your museum, inside the src/main/webapp/tenants folder. For instance, if your tenant folder is named mymuseum, you would find that folder at src/main/webapp/tenants/mymuseum
If you still can't find your tenant folder, or need a refresher about how you set up this folder, see Creating your new tenant.

Here's a map to finding your tenant folder, within the ui folder that contains the UI layer source code:

Tip

The sample lifesci tenant provides an up-to-date example of a tenant folder containing representative User Interface (UI) layer configuration changes that make it different from the sample core tenant, in order to meet some of the needs of life sciences museums. It can be useful to study this folder's contents as an example of how to make configuration changes for your own museum. You can browse the lifesci tenant's folder via the CollectionSpace GitHub repository.

Summary

This document has explained how to find your tenant folder within the source code trees for each of CollectionSpace's three layers.

Browser not supported