Controlled Vocabulary Configuration¶

Controlled vocabularies can be configured through JSON configuration files. This is useful if you wish to deploy a configuration throughout your organization.

Configuration location for individual users¶

To deploy a controlled vocabulary configuration for a single user, deploy a JSON configuration file (documented below) in:

%appdata%\Algenta\Colectica\controlledVocabularies.json

Configuration location for all users¶

To deploy a controlled vocabulary configuration for all users on a machine, deploy a JSON configuration file (documented below) in:

%programdata%\Algenta\Colectica\controlledVocabularies.json

Configuration file format¶

The controlled vocabulary configuration file is in JSON format.

A sample file may look like this:

{
  "Mappings": [
    {
      "PropertyName": "VariableGroup.TypeOfGroup",
      "CodeListId": "urn:ddi:int.example:5f3fd909-3e69-4fd5-9354-e25824fc557e:1"
    },
    {
      "PropertyName": "QuestionGroup.TypeOfGroup",
      "CodeListId": "urn:ddi:int.example:29e7631e-8bc7-49e4-b669-30f9bfcc0540:1"
    },
    {
      "PropertyName": "Coverage.Subjects",
      "CodeListId": "urn:ddi:int.example:7b93910e-f379-432a-9789-cc71a557aa08:1"
    },
    {
      "PropertyName": "Coverage.Keywords",
      "CodeListId": "urn:ddi:int.example:29e7631e-8bc7-49e4-b669-30f9bfcc0540:1"
    }
  ]
}

PropertyName: Concatenate the name of the object type with the name of the property. See below for supported properties.
CodeListId: The full identifier of the CodeList that contains the terms of the vocabulary to use for the specified property.

Vocabulary Resolution¶

The CodeList configured for a property must be accessible to the user, so it can be used in the Designer user interface. Colectica Designer looks for the configured code lists in the following locations.

The Local Items in the user’s local Colectica Designer database
The local item cache, located in %appdata%AlgentaColecticaItems or %programdata%AlgentaColecticaItems Each file in those locations should be a DDI FragmentInstance file with a CodeList as the top level item.
The currently selected remote repository

Properties supporting custom fields¶

The following can be used as PropertyNames in the configuration file.

CategoryGroup.TypeOfGroup
ClassificationCorrespondenceTable.RelationshipMapping
ClassificationLevel.LevelCodeStructure
ClassificationLevel.LevelTypeCode
ClassificationSeries.Keywords
ClassificationSeries.SeriesContext
ClassificationSeries.SubjectAreas
CodeDomain.GenericOutputFormat
CodeListGroup.TypeOfGroup
CollectionEvent.DataCollectionFrequency
ConceptGroup.TypeOfGroup
ConceptualComponent.Keywords
ConceptualComponent.Subjects
ConceptualVariableGroup.TypeOfGroup
Contributor.Roles
ControlConstructGroup.Keywords
ControlConstructGroup.Subjects
ControlConstructGroup.TypeOfGroup
CountryCode.Value
Coverage.Keywords
Coverage.Subjects
CustomSequenceActivity.TypeOfSequence
DataCollectionItem.CodedType
DataSource.SourceType
DateTimeDomain.DateTimeType
FundingInformation.Role
Group.Abbreviations
Group.SeriesStatement
Group.TypeOfItem
IndividualName.TypeOfName
InformationClassification.InformationClassificationType
InformationClassification.LevelOfInformationClassification
InstructionGroup.TypeOfGroup
Instrument.Type
InstrumentGroup.TypeOfGroup
ManagedDateTimeRepresentation.DateTimeType
ManagedNumericRepresentation.NumericType
ManagedRepresentationGroup.TypeOfGroup
Measurement.TypeOfMeasurement
MeasurementActivity.AnalysisUnit
MeasurementActivity.ResponseUnit
NCube.AnalysisUnit
NCube.SourceUnit
NCubeGroup.TypeOfGroup
NumericDomain.NumericType
OrganizationGroup.TypeOfGroup
OtherMaterial.MaterialType
OtherMaterialGroup.TypeOfGroup
ProcessingEventGroup.TypeOfGroup
ProcessingInstructionGroup.TypeOfGroup
QualityStatementGroup.TypeOfGroup
QuestionActivity.AnalysisUnit
QuestionActivity.ResponseUnit
QuestionGroup.TypeOfGroup
RepresentedVariableGroup.TypeOfGroup
Software.SoftwarePackage
StudyBase.AnalysisUnits
StudyBase.KindsOfData
UnitTypeGroup.TypeOfGroup
UniverseGroup.TypeOfGroup
Variable.Role
VariableGroup.TypeOfGroup
Methodology.DataCollectionMethodology
Methodology.TimeMethod
Methodology.SamplingProcedure
Methodology.DeviationFromSampleDesign