talk@lists.collectionspace.org

WE HAVE SUNSET THIS LISTSERV - Join us at collectionspace@lyrasislists.org

View all threads

adding a vocabulary to concept authority

AB
Al Bersch
Thu, Oct 24, 2013 5:46 PM

Hello all,

For our demo of cspace (we're using v3.3), we wanted to load a sample vocabulary tree from our Argus lexicon into an instance of the concept authority that we want to call "common name."

for example:

<instance id="concept-commonname"> <web-url>commonname</web-url> <title-ref>commonname</title-ref> <title>Common Names</title> </instance>

Would the process for doing so be similar to adding a vocabulary to the citation authority, as outlined here?

http://issues.collectionspace.org/browse/CSPACE-6027

Or is there other documentation on the wiki?

Thanks,

Al

Al Bersch
Digital Project Coordinator
Oakland Museum of California
1000 Oak Street, Oakland, CA 94607
abersch@museumca.org
510-318-8468

Hello all, For our demo of cspace (we're using v3.3), we wanted to load a sample vocabulary tree from our Argus lexicon into an instance of the concept authority that we want to call "common name." for example: <instance id="concept-commonname"> <web-url>commonname</web-url> <title-ref>commonname</title-ref> <title>Common Names</title> </instance> Would the process for doing so be similar to adding a vocabulary to the citation authority, as outlined here? http://issues.collectionspace.org/browse/CSPACE-6027 Or is there other documentation on the wiki? Thanks, Al Al Bersch Digital Project Coordinator Oakland Museum of California 1000 Oak Street, Oakland, CA 94607 abersch@museumca.org 510-318-8468
AR
Aron Roberts
Thu, Oct 24, 2013 7:15 PM

Yes, that example should work for your own 'commonname' Citation vocabulary.

Adding the vocabulary in the Application layer:
https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f

  • Adding your vocabulary instance to the App layer's citation
    authority configuration file.
  • Adding that vocabulary to one or more autocomplete fields, in the
    config files for various record types.

Adding labels for the vocabulary in the UI layer:
https://github.com/collectionspace/application/commit/e986755d45715b6e714eb4784b76d5607c66739f

Have you already found, or do you still need, an example of importing
the vocabulary's term records themselves?

On Thu, Oct 24, 2013 at 10:46 AM, Al Bersch abersch@museumca.org wrote:

Hello all,

For our demo of cspace (we're using v3.3), we wanted to load a sample
vocabulary tree from our Argus lexicon into an instance of the concept
authority that we want to call "common name."

for example:

<instance id="concept-commonname"> <web-url>commonname</web-url> <title-ref>commonname</title-ref> <title>Common Names</title> </instance>

Would the process for doing so be similar to adding a vocabulary to the
citation authority, as outlined here?

http://issues.collectionspace.org/browse/CSPACE-6027

Or is there other documentation on the wiki?

Thanks,

Al

Al Bersch
Digital Project Coordinator
Oakland Museum of California
1000 Oak Street, Oakland, CA 94607
abersch@museumca.org
510-318-8468


Talk mailing list
Talk@lists.collectionspace.org
http://lists.collectionspace.org/mailman/listinfo/talk_lists.collectionspace.org

Yes, that example should work for your own 'commonname' Citation vocabulary. Adding the vocabulary in the Application layer: https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f * Adding your vocabulary instance to the App layer's citation authority configuration file. * Adding that vocabulary to one or more autocomplete fields, in the config files for various record types. Adding labels for the vocabulary in the UI layer: https://github.com/collectionspace/application/commit/e986755d45715b6e714eb4784b76d5607c66739f Have you already found, or do you still need, an example of importing the vocabulary's term records themselves? On Thu, Oct 24, 2013 at 10:46 AM, Al Bersch <abersch@museumca.org> wrote: > Hello all, > > For our demo of cspace (we're using v3.3), we wanted to load a sample > vocabulary tree from our Argus lexicon into an instance of the concept > authority that we want to call "common name." > > for example: > > <instance id="concept-commonname"> > <web-url>commonname</web-url> > <title-ref>commonname</title-ref> > <title>Common Names</title> > </instance> > > Would the process for doing so be similar to adding a vocabulary to the > citation authority, as outlined here? > > http://issues.collectionspace.org/browse/CSPACE-6027 > > Or is there other documentation on the wiki? > > Thanks, > > Al > > Al Bersch > Digital Project Coordinator > Oakland Museum of California > 1000 Oak Street, Oakland, CA 94607 > abersch@museumca.org > 510-318-8468 > > _______________________________________________ > Talk mailing list > Talk@lists.collectionspace.org > http://lists.collectionspace.org/mailman/listinfo/talk_lists.collectionspace.org >
AB
Al Bersch
Fri, Oct 25, 2013 6:10 PM

Hi Aron,

Thanks again for this. Quick question: these examples suggest I should make the changes in the defaults folders or the UI and Application layers, rather than the corresponding folder in our tenant, but my understanding was that the files would be copied to our tenant folders and then modified. I just wanted to clarify this before I edited the default files.

Thanks,

Al

Al Bersch
Digital Project Coordinator
Oakland Museum of California
1000 Oak Street, Oakland, CA 94607
abersch@museumca.org
510-318-8468
----- Original Message -----

From: "Aron Roberts" aronroberts@gmail.com
To: "Al Bersch" abersch@museumca.org
Cc: "talk" talk@lists.collectionspace.org
Sent: Thursday, October 24, 2013 12:15:31 PM
Subject: Re: [Talk] adding a vocabulary to concept authority

Yes, that example should work for your own 'commonname' Citation vocabulary.

Adding the vocabulary in the Application layer:
https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f

  • Adding your vocabulary instance to the App layer's citation
    authority configuration file.
  • Adding that vocabulary to one or more autocomplete fields, in the
    config files for various record types.

Adding labels for the vocabulary in the UI layer:
https://github.com/collectionspace/application/commit/e986755d45715b6e714eb4784b76d5607c66739f

Have you already found, or do you still need, an example of importing
the vocabulary's term records themselves?

On Thu, Oct 24, 2013 at 10:46 AM, Al Bersch abersch@museumca.org wrote:

Hello all,

For our demo of cspace (we're using v3.3), we wanted to load a sample
vocabulary tree from our Argus lexicon into an instance of the concept
authority that we want to call "common name."

for example:

<instance id="concept-commonname"> <web-url>commonname</web-url> <title-ref>commonname</title-ref> <title>Common Names</title> </instance>

Would the process for doing so be similar to adding a vocabulary to the
citation authority, as outlined here?

http://issues.collectionspace.org/browse/CSPACE-6027

Or is there other documentation on the wiki?

Thanks,

Al

Al Bersch
Digital Project Coordinator
Oakland Museum of California
1000 Oak Street, Oakland, CA 94607
abersch@museumca.org
510-318-8468


Talk mailing list
Talk@lists.collectionspace.org
http://lists.collectionspace.org/mailman/listinfo/talk_lists.collectionspace.org

Hi Aron, Thanks again for this. Quick question: these examples suggest I should make the changes in the defaults folders or the UI and Application layers, rather than the corresponding folder in our tenant, but my understanding was that the files would be copied to our tenant folders and then modified. I just wanted to clarify this before I edited the default files. Thanks, Al Al Bersch Digital Project Coordinator Oakland Museum of California 1000 Oak Street, Oakland, CA 94607 abersch@museumca.org 510-318-8468 ----- Original Message ----- From: "Aron Roberts" <aronroberts@gmail.com> To: "Al Bersch" <abersch@museumca.org> Cc: "talk" <talk@lists.collectionspace.org> Sent: Thursday, October 24, 2013 12:15:31 PM Subject: Re: [Talk] adding a vocabulary to concept authority Yes, that example should work for your own 'commonname' Citation vocabulary. Adding the vocabulary in the Application layer: https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f * Adding your vocabulary instance to the App layer's citation authority configuration file. * Adding that vocabulary to one or more autocomplete fields, in the config files for various record types. Adding labels for the vocabulary in the UI layer: https://github.com/collectionspace/application/commit/e986755d45715b6e714eb4784b76d5607c66739f Have you already found, or do you still need, an example of importing the vocabulary's term records themselves? On Thu, Oct 24, 2013 at 10:46 AM, Al Bersch <abersch@museumca.org> wrote: > Hello all, > > For our demo of cspace (we're using v3.3), we wanted to load a sample > vocabulary tree from our Argus lexicon into an instance of the concept > authority that we want to call "common name." > > for example: > > <instance id="concept-commonname"> > <web-url>commonname</web-url> > <title-ref>commonname</title-ref> > <title>Common Names</title> > </instance> > > Would the process for doing so be similar to adding a vocabulary to the > citation authority, as outlined here? > > http://issues.collectionspace.org/browse/CSPACE-6027 > > Or is there other documentation on the wiki? > > Thanks, > > Al > > Al Bersch > Digital Project Coordinator > Oakland Museum of California > 1000 Oak Street, Oakland, CA 94607 > abersch@museumca.org > 510-318-8468 > > _______________________________________________ > Talk mailing list > Talk@lists.collectionspace.org > http://lists.collectionspace.org/mailman/listinfo/talk_lists.collectionspace.org >
AR
Aron Roberts
Fri, Oct 25, 2013 7:42 PM

Good point.  These examples indeed use the Application and UI layer's
'defaults' folder.

Although strictly speaking, on a single-tenant system, you could make
all your configuration changes in the defaults, it's clearer and
cleaner to make these changes instead in your tenant folder.  That
way, you can isolate and readily see at a glance the changes you've
made just for your tenant - and that's also a big help when migrating
to higher CollectionSpace versions.

In the UI layer

Make an overlay message bundle file (the file in which most of
CollectionSpace's text labels are maintained) in your tenant folder;
e.g.:
src/main/webapps/tenants/omca/core-messages.properties-overlay

And add your 'commonname' vocabulary's text labels in a manner similar
to that in:
https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f

Here's an example of that overlay message bundle file, for the Lifesci
tenant in version 3.3:
https://github.com/collectionspace/ui/blob/v3.3/src/main/webapp/tenants/lifesci/bundle/core-messages.properties-overlay

In the Application layer

Make a 'merge' file in your tenant folder; e.g.:

tomcat-main/src/main/resources/tenants/omca/local-authority-concept.xml

That file would contain something like (untried by me):

<record id="concept"> <instances id="concept"> <!-- New instance --> <instance id="concept-commonname"> <web-url>commonname</web-url> <title-ref>commonname</title-ref> <title>Common Names</title> </instance> </instances> </record>

And then tell the Application layer that you want this file to be
merged into the default base-authority-concept.xml file, so you can
either supplement or override the default behavior in that base file.

To do that, you'd edit your tenant's 'includes' file: the App layer
file identifies all of the files that make up your tenant's
configuration and identifies how each file is included or merged.
That file is likely named something like:

tomcat-main/src/main/resources/omca-tenant.xml

And the relevant line you'd edit might look something like this:

<include src="base-authority-concept.xml"/>

So you'd change it to something like this, to specify that the
contents of your own 'merge' file are to be merged in with the
defaults, using a default (usually sensible) set of merge rules:

<include src="base-authority-concept.xml,local-authority-concept.xml" merge="xmlmerge.properties"/>

Here's Ray's example for the Concept vocabulary for the PAHMA tenant:

The 'merge' file:
https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/tenants/pahma/local-authority-concept.xml#L11

The declaration that this file is to be merged with its base file:
https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/pahma-tenant.xml#L41

After this, you'd likely also want to specify, via another file or
files to be added to your tenant folder, which autocomplete fields
should 'pick up terms from' your new 'commonname' Concept vocabulary.
I'll leave that as an exercise for the reader :-), with this example:

https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/tenants/pahma/local-procedure-groups.xml#L5

Aron

P.S. It looks like, in my earlier message of October 24th, I swapped
links and descriptions between the UI and App layers; please mentally
swap these back ... thanks!

On Fri, Oct 25, 2013 at 11:10 AM, Al Bersch abersch@museumca.org wrote:

Hi Aron,

Thanks again for this. Quick question: these examples suggest I should make
the changes in the defaults folders or the UI and Application layers, rather
than the corresponding folder in our tenant, but my understanding was that
the files would be copied to our tenant folders and then modified. I just
wanted to clarify this before I edited the default files.

Thanks,

Al

Al Bersch
Digital Project Coordinator
Oakland Museum of California
1000 Oak Street, Oakland, CA 94607
abersch@museumca.org
510-318-8468


From: "Aron Roberts" aronroberts@gmail.com
To: "Al Bersch" abersch@museumca.org
Cc: "talk" talk@lists.collectionspace.org
Sent: Thursday, October 24, 2013 12:15:31 PM
Subject: Re: [Talk] adding a vocabulary to concept authority

Yes, that example should work for your own 'commonname' Citation vocabulary.

Adding the vocabulary in the Application layer:
https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f

  • Adding your vocabulary instance to the App layer's citation
    authority configuration file.
  • Adding that vocabulary to one or more autocomplete fields, in the
    config files for various record types.

Adding labels for the vocabulary in the UI layer:
https://github.com/collectionspace/application/commit/e986755d45715b6e714eb4784b76d5607c66739f

Have you already found, or do you still need, an example of importing
the vocabulary's term records themselves?

On Thu, Oct 24, 2013 at 10:46 AM, Al Bersch abersch@museumca.org wrote:

Hello all,

For our demo of cspace (we're using v3.3), we wanted to load a sample
vocabulary tree from our Argus lexicon into an instance of the concept
authority that we want to call "common name."

for example:

<instance id="concept-commonname"> <web-url>commonname</web-url> <title-ref>commonname</title-ref> <title>Common Names</title> </instance>

Would the process for doing so be similar to adding a vocabulary to the
citation authority, as outlined here?

http://issues.collectionspace.org/browse/CSPACE-6027

Or is there other documentation on the wiki?

Thanks,

Al

Al Bersch
Digital Project Coordinator
Oakland Museum of California
1000 Oak Street, Oakland, CA 94607
abersch@museumca.org
510-318-8468


Talk mailing list
Talk@lists.collectionspace.org

http://lists.collectionspace.org/mailman/listinfo/talk_lists.collectionspace.org

Good point. These examples indeed use the Application and UI layer's 'defaults' folder. Although strictly speaking, on a single-tenant system, you could make all your configuration changes in the defaults, it's clearer and cleaner to make these changes instead in your tenant folder. That way, you can isolate and readily see at a glance the changes you've made just for your tenant - and that's also a big help when migrating to higher CollectionSpace versions. In the UI layer ------------------------------ Make an overlay message bundle file (the file in which most of CollectionSpace's text labels are maintained) in your tenant folder; e.g.: src/main/webapps/tenants/omca/core-messages.properties-overlay And add your 'commonname' vocabulary's text labels in a manner similar to that in: https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f Here's an example of that overlay message bundle file, for the Lifesci tenant in version 3.3: https://github.com/collectionspace/ui/blob/v3.3/src/main/webapp/tenants/lifesci/bundle/core-messages.properties-overlay In the Application layer ------------------------------ Make a 'merge' file in your tenant folder; e.g.: tomcat-main/src/main/resources/tenants/omca/local-authority-concept.xml That file would contain something like (untried by me): <record id="concept"> <instances id="concept"> <!-- New instance --> <instance id="concept-commonname"> <web-url>commonname</web-url> <title-ref>commonname</title-ref> <title>Common Names</title> </instance> </instances> </record> And then tell the Application layer that you want this file to be merged into the default base-authority-concept.xml file, so you can either supplement or override the default behavior in that base file. To do that, you'd edit your tenant's 'includes' file: the App layer file identifies all of the files that make up your tenant's configuration and identifies how each file is included or merged. That file is likely named something like: tomcat-main/src/main/resources/omca-tenant.xml And the relevant line you'd edit might look something like this: <include src="base-authority-concept.xml"/> So you'd change it to something like this, to specify that the contents of your own 'merge' file are to be merged in with the defaults, using a default (usually sensible) set of merge rules: <include src="base-authority-concept.xml,local-authority-concept.xml" merge="xmlmerge.properties"/> Here's Ray's example for the Concept vocabulary for the PAHMA tenant: The 'merge' file: https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/tenants/pahma/local-authority-concept.xml#L11 The declaration that this file is to be merged with its base file: https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/pahma-tenant.xml#L41 After this, you'd likely also want to specify, via another file or files to be added to your tenant folder, which autocomplete fields should 'pick up terms from' your new 'commonname' Concept vocabulary. I'll leave that as an exercise for the reader :-), with this example: https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/tenants/pahma/local-procedure-groups.xml#L5 Aron P.S. It looks like, in my earlier message of October 24th, I swapped links and descriptions between the UI and App layers; please mentally swap these back ... thanks! On Fri, Oct 25, 2013 at 11:10 AM, Al Bersch <abersch@museumca.org> wrote: > Hi Aron, > > Thanks again for this. Quick question: these examples suggest I should make > the changes in the defaults folders or the UI and Application layers, rather > than the corresponding folder in our tenant, but my understanding was that > the files would be copied to our tenant folders and then modified. I just > wanted to clarify this before I edited the default files. > > Thanks, > > Al > > Al Bersch > Digital Project Coordinator > Oakland Museum of California > 1000 Oak Street, Oakland, CA 94607 > abersch@museumca.org > 510-318-8468 > ________________________________ > From: "Aron Roberts" <aronroberts@gmail.com> > To: "Al Bersch" <abersch@museumca.org> > Cc: "talk" <talk@lists.collectionspace.org> > Sent: Thursday, October 24, 2013 12:15:31 PM > Subject: Re: [Talk] adding a vocabulary to concept authority > > Yes, that example should work for your own 'commonname' Citation vocabulary. > > Adding the vocabulary in the Application layer: > https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f > > * Adding your vocabulary instance to the App layer's citation > authority configuration file. > * Adding that vocabulary to one or more autocomplete fields, in the > config files for various record types. > > Adding labels for the vocabulary in the UI layer: > https://github.com/collectionspace/application/commit/e986755d45715b6e714eb4784b76d5607c66739f > > Have you already found, or do you still need, an example of importing > the vocabulary's term records themselves? > > On Thu, Oct 24, 2013 at 10:46 AM, Al Bersch <abersch@museumca.org> wrote: >> Hello all, >> >> For our demo of cspace (we're using v3.3), we wanted to load a sample >> vocabulary tree from our Argus lexicon into an instance of the concept >> authority that we want to call "common name." >> >> for example: >> >> <instance id="concept-commonname"> >> <web-url>commonname</web-url> >> <title-ref>commonname</title-ref> >> <title>Common Names</title> >> </instance> >> >> Would the process for doing so be similar to adding a vocabulary to the >> citation authority, as outlined here? >> >> http://issues.collectionspace.org/browse/CSPACE-6027 >> >> Or is there other documentation on the wiki? >> >> Thanks, >> >> Al >> >> Al Bersch >> Digital Project Coordinator >> Oakland Museum of California >> 1000 Oak Street, Oakland, CA 94607 >> abersch@museumca.org >> 510-318-8468 >> >> _______________________________________________ >> Talk mailing list >> Talk@lists.collectionspace.org >> >> http://lists.collectionspace.org/mailman/listinfo/talk_lists.collectionspace.org >> >
AB
Al Bersch
Fri, Oct 25, 2013 8:14 PM

Thanks Aron!

Al Bersch
Digital Project Coordinator
Oakland Museum of California
1000 Oak Street, Oakland, CA 94607
abersch@museumca.org
510-318-8468
----- Original Message -----

From: "Aron Roberts" aronroberts@gmail.com
To: "Al Bersch" abersch@museumca.org
Cc: "talk" talk@lists.collectionspace.org
Sent: Friday, October 25, 2013 12:42:06 PM
Subject: Re: [Talk] adding a vocabulary to concept authority

Good point. These examples indeed use the Application and UI layer's
'defaults' folder.

Although strictly speaking, on a single-tenant system, you could make
all your configuration changes in the defaults, it's clearer and
cleaner to make these changes instead in your tenant folder. That
way, you can isolate and readily see at a glance the changes you've
made just for your tenant - and that's also a big help when migrating
to higher CollectionSpace versions.

In the UI layer

Make an overlay message bundle file (the file in which most of
CollectionSpace's text labels are maintained) in your tenant folder;
e.g.:
src/main/webapps/tenants/omca/core-messages.properties-overlay

And add your 'commonname' vocabulary's text labels in a manner similar
to that in:
https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f

Here's an example of that overlay message bundle file, for the Lifesci
tenant in version 3.3:
https://github.com/collectionspace/ui/blob/v3.3/src/main/webapp/tenants/lifesci/bundle/core-messages.properties-overlay

In the Application layer

Make a 'merge' file in your tenant folder; e.g.:

tomcat-main/src/main/resources/tenants/omca/local-authority-concept.xml

That file would contain something like (untried by me):

<record id="concept"> <instances id="concept"> <!-- New instance --> <instance id="concept-commonname"> <web-url>commonname</web-url> <title-ref>commonname</title-ref> <title>Common Names</title> </instance> </instances> </record>

And then tell the Application layer that you want this file to be
merged into the default base-authority-concept.xml file, so you can
either supplement or override the default behavior in that base file.

To do that, you'd edit your tenant's 'includes' file: the App layer
file identifies all of the files that make up your tenant's
configuration and identifies how each file is included or merged.
That file is likely named something like:

tomcat-main/src/main/resources/omca-tenant.xml

And the relevant line you'd edit might look something like this:

<include src="base-authority-concept.xml"/>

So you'd change it to something like this, to specify that the
contents of your own 'merge' file are to be merged in with the
defaults, using a default (usually sensible) set of merge rules:

<include src="base-authority-concept.xml,local-authority-concept.xml" merge="xmlmerge.properties"/>

Here's Ray's example for the Concept vocabulary for the PAHMA tenant:

The 'merge' file:
https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/tenants/pahma/local-authority-concept.xml#L11

The declaration that this file is to be merged with its base file:
https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/pahma-tenant.xml#L41

After this, you'd likely also want to specify, via another file or
files to be added to your tenant folder, which autocomplete fields
should 'pick up terms from' your new 'commonname' Concept vocabulary.
I'll leave that as an exercise for the reader :-), with this example:

https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/tenants/pahma/local-procedure-groups.xml#L5

Aron

P.S. It looks like, in my earlier message of October 24th, I swapped
links and descriptions between the UI and App layers; please mentally
swap these back ... thanks!

On Fri, Oct 25, 2013 at 11:10 AM, Al Bersch abersch@museumca.org wrote:

Hi Aron,

Thanks again for this. Quick question: these examples suggest I should make
the changes in the defaults folders or the UI and Application layers, rather
than the corresponding folder in our tenant, but my understanding was that
the files would be copied to our tenant folders and then modified. I just
wanted to clarify this before I edited the default files.

Thanks,

Al

Al Bersch
Digital Project Coordinator
Oakland Museum of California
1000 Oak Street, Oakland, CA 94607
abersch@museumca.org
510-318-8468


From: "Aron Roberts" aronroberts@gmail.com
To: "Al Bersch" abersch@museumca.org
Cc: "talk" talk@lists.collectionspace.org
Sent: Thursday, October 24, 2013 12:15:31 PM
Subject: Re: [Talk] adding a vocabulary to concept authority

Yes, that example should work for your own 'commonname' Citation vocabulary.

Adding the vocabulary in the Application layer:
https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f

  • Adding your vocabulary instance to the App layer's citation
    authority configuration file.
  • Adding that vocabulary to one or more autocomplete fields, in the
    config files for various record types.

Adding labels for the vocabulary in the UI layer:
https://github.com/collectionspace/application/commit/e986755d45715b6e714eb4784b76d5607c66739f

Have you already found, or do you still need, an example of importing
the vocabulary's term records themselves?

On Thu, Oct 24, 2013 at 10:46 AM, Al Bersch abersch@museumca.org wrote:

Hello all,

For our demo of cspace (we're using v3.3), we wanted to load a sample
vocabulary tree from our Argus lexicon into an instance of the concept
authority that we want to call "common name."

for example:

<instance id="concept-commonname"> <web-url>commonname</web-url> <title-ref>commonname</title-ref> <title>Common Names</title> </instance>

Would the process for doing so be similar to adding a vocabulary to the
citation authority, as outlined here?

http://issues.collectionspace.org/browse/CSPACE-6027

Or is there other documentation on the wiki?

Thanks,

Al

Al Bersch
Digital Project Coordinator
Oakland Museum of California
1000 Oak Street, Oakland, CA 94607
abersch@museumca.org
510-318-8468


Talk mailing list
Talk@lists.collectionspace.org

http://lists.collectionspace.org/mailman/listinfo/talk_lists.collectionspace.org

Thanks Aron! Al Bersch Digital Project Coordinator Oakland Museum of California 1000 Oak Street, Oakland, CA 94607 abersch@museumca.org 510-318-8468 ----- Original Message ----- From: "Aron Roberts" <aronroberts@gmail.com> To: "Al Bersch" <abersch@museumca.org> Cc: "talk" <talk@lists.collectionspace.org> Sent: Friday, October 25, 2013 12:42:06 PM Subject: Re: [Talk] adding a vocabulary to concept authority Good point. These examples indeed use the Application and UI layer's 'defaults' folder. Although strictly speaking, on a single-tenant system, you could make all your configuration changes in the defaults, it's clearer and cleaner to make these changes instead in your tenant folder. That way, you can isolate and readily see at a glance the changes you've made just for your tenant - and that's also a big help when migrating to higher CollectionSpace versions. In the UI layer ------------------------------ Make an overlay message bundle file (the file in which most of CollectionSpace's text labels are maintained) in your tenant folder; e.g.: src/main/webapps/tenants/omca/core-messages.properties-overlay And add your 'commonname' vocabulary's text labels in a manner similar to that in: https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f Here's an example of that overlay message bundle file, for the Lifesci tenant in version 3.3: https://github.com/collectionspace/ui/blob/v3.3/src/main/webapp/tenants/lifesci/bundle/core-messages.properties-overlay In the Application layer ------------------------------ Make a 'merge' file in your tenant folder; e.g.: tomcat-main/src/main/resources/tenants/omca/local-authority-concept.xml That file would contain something like (untried by me): <record id="concept"> <instances id="concept"> <!-- New instance --> <instance id="concept-commonname"> <web-url>commonname</web-url> <title-ref>commonname</title-ref> <title>Common Names</title> </instance> </instances> </record> And then tell the Application layer that you want this file to be merged into the default base-authority-concept.xml file, so you can either supplement or override the default behavior in that base file. To do that, you'd edit your tenant's 'includes' file: the App layer file identifies all of the files that make up your tenant's configuration and identifies how each file is included or merged. That file is likely named something like: tomcat-main/src/main/resources/omca-tenant.xml And the relevant line you'd edit might look something like this: <include src="base-authority-concept.xml"/> So you'd change it to something like this, to specify that the contents of your own 'merge' file are to be merged in with the defaults, using a default (usually sensible) set of merge rules: <include src="base-authority-concept.xml,local-authority-concept.xml" merge="xmlmerge.properties"/> Here's Ray's example for the Concept vocabulary for the PAHMA tenant: The 'merge' file: https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/tenants/pahma/local-authority-concept.xml#L11 The declaration that this file is to be merged with its base file: https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/pahma-tenant.xml#L41 After this, you'd likely also want to specify, via another file or files to be added to your tenant folder, which autocomplete fields should 'pick up terms from' your new 'commonname' Concept vocabulary. I'll leave that as an exercise for the reader :-), with this example: https://github.com/cspace-deployment/application/blob/pahma_3.3/tomcat-main/src/main/resources/tenants/pahma/local-procedure-groups.xml#L5 Aron P.S. It looks like, in my earlier message of October 24th, I swapped links and descriptions between the UI and App layers; please mentally swap these back ... thanks! On Fri, Oct 25, 2013 at 11:10 AM, Al Bersch <abersch@museumca.org> wrote: > Hi Aron, > > Thanks again for this. Quick question: these examples suggest I should make > the changes in the defaults folders or the UI and Application layers, rather > than the corresponding folder in our tenant, but my understanding was that > the files would be copied to our tenant folders and then modified. I just > wanted to clarify this before I edited the default files. > > Thanks, > > Al > > Al Bersch > Digital Project Coordinator > Oakland Museum of California > 1000 Oak Street, Oakland, CA 94607 > abersch@museumca.org > 510-318-8468 > ________________________________ > From: "Aron Roberts" <aronroberts@gmail.com> > To: "Al Bersch" <abersch@museumca.org> > Cc: "talk" <talk@lists.collectionspace.org> > Sent: Thursday, October 24, 2013 12:15:31 PM > Subject: Re: [Talk] adding a vocabulary to concept authority > > Yes, that example should work for your own 'commonname' Citation vocabulary. > > Adding the vocabulary in the Application layer: > https://github.com/collectionspace/ui/commit/9781cea3d53d4dc15a618e621ffaee9d7554c29f > > * Adding your vocabulary instance to the App layer's citation > authority configuration file. > * Adding that vocabulary to one or more autocomplete fields, in the > config files for various record types. > > Adding labels for the vocabulary in the UI layer: > https://github.com/collectionspace/application/commit/e986755d45715b6e714eb4784b76d5607c66739f > > Have you already found, or do you still need, an example of importing > the vocabulary's term records themselves? > > On Thu, Oct 24, 2013 at 10:46 AM, Al Bersch <abersch@museumca.org> wrote: >> Hello all, >> >> For our demo of cspace (we're using v3.3), we wanted to load a sample >> vocabulary tree from our Argus lexicon into an instance of the concept >> authority that we want to call "common name." >> >> for example: >> >> <instance id="concept-commonname"> >> <web-url>commonname</web-url> >> <title-ref>commonname</title-ref> >> <title>Common Names</title> >> </instance> >> >> Would the process for doing so be similar to adding a vocabulary to the >> citation authority, as outlined here? >> >> http://issues.collectionspace.org/browse/CSPACE-6027 >> >> Or is there other documentation on the wiki? >> >> Thanks, >> >> Al >> >> Al Bersch >> Digital Project Coordinator >> Oakland Museum of California >> 1000 Oak Street, Oakland, CA 94607 >> abersch@museumca.org >> 510-318-8468 >> >> _______________________________________________ >> Talk mailing list >> Talk@lists.collectionspace.org >> >> http://lists.collectionspace.org/mailman/listinfo/talk_lists.collectionspace.org >> >