User Interface Configuration#

Configuration location#

User interface configuration can be specified in %programdata%\Algenta\Colectica\DesignerUiConfig.json

Sample User Interface Configuration File#

{
   "HiddenCommands": [
      "Algenta.Colectica.VersionableCommands.Replicate"
   ],
   "DisableSaveOnRemoteRepositories": true,
   "NewItemTypes": [
      "f50ca853-c007-4f05-8823-a1a70bfcf4a3",
      "c25e7cb7-55a9-4d2c-b8f6-f03ded7c1c10"
   ],
   "UserInterfaceLanguages": [
      "en",
      "fr",
      "fr-CA"
   ]
}

Configuring the available user interface languages#

The Languages page of the File menu lets each user choose the language Colectica’s own menus, buttons, and messages are displayed in. The UserInterfaceLanguages property can specify a custom list of languages to offer instead of every language Colectica has been translated into.

Each entry is a language abbreviation. The following languages can be offered:

  • en: English

  • de: German

  • fr: French

  • fr-CA: French (Canada)

If UserInterfaceLanguages is empty or not specified, all of the languages above are offered. Entries that name a language Colectica has not been translated into are ignored.

Colectica uses the operating system’s language when a user has not chosen one, provided that language is on offer. Otherwise the first language in the list is used. If a user had already chosen a language that is later removed from the list, that user is moved to the default language the next time Colectica starts.

Configuring item types in the Create New Checkout dialog#

By default, the Create New Checkout dialog allows creating a Group, Study Unit, Instrument, Physical Instance, or Resource Package. The NewCheckoutItemTypes property can specify a custom list of item types to show instead. If NewCheckoutItemTypes is empty or not specified, the default types are used.

Each entry is an item type identifier (UUID). See Item Type Identifiers for a full list of identifiers.

Disabling save on remote repositories#

Setting DisableSaveOnRemoteRepositories to true will disable the save button when the item is on a remote repository. When set to false the save button will be enabled and the user will be able to save changes to certain item types directly on remote repositories. Supported types are: DdiInstance, Series, StudyUnit, and ResourcePackage.

Hiding command buttons#

Commands listed in the HiddenCommands array will be hidden from the user interface. The following commands can be hidden:

Item commands#

  • Algenta.Colectica.CheckoutCommands.Publish

  • Algenta.Colectica.CheckoutCommands.Synchronization.Update

  • Algenta.Colectica.Commands.AddExistingItem

  • Algenta.Colectica.Commands.BrowseInsideCommand

  • Algenta.Colectica.Commands.BulkIngest.BulkIngestCommand

  • Algenta.Colectica.Commands.CompareWith

  • Algenta.Colectica.Commands.CreateNewItem

  • Algenta.Colectica.Commands.GenerateDdi31

  • Algenta.Colectica.Commands.GenerateDdi32

  • Algenta.Colectica.Commands.GenerateDdi33

  • Algenta.Colectica.Commands.GenerateDocumentation

  • Algenta.Colectica.Commands.MetadataImport.ConceptImportCommand

  • Algenta.Colectica.Commands.MetadataImport.ConceptualVariableConcordanceCommand

  • Algenta.Colectica.Commands.MetadataImport.ConcordanceImportCommand

  • Algenta.Colectica.Commands.MetadataImport.CreateStatisticsSheetCommand

  • Algenta.Colectica.Commands.MetadataImport.ExportMetadataInputSheet

  • Algenta.Colectica.Commands.MetadataImport.ImportSkosAsCodeList

  • Algenta.Colectica.Commands.MetadataImport.ImportSkosAsConceptSystem

  • Algenta.Colectica.Commands.MetadataImport.ImportStatisticsSheetCommand

  • Algenta.Colectica.Commands.MetadataImport.MetadataImportCommand

  • Algenta.Colectica.Commands.MetadataImport.UpdateCodeListFromSkos

  • Algenta.Colectica.Commands.MetadataImport.UpdateConceptSystemFromSkos

  • Algenta.Colectica.Commands.RemoveItem

  • Algenta.Colectica.Commands.SearchInsideCommand

  • Algenta.Colectica.Commands.TypeSpecific.AddCategorySchemeToCodeScheme

  • Algenta.Colectica.Commands.TypeSpecific.AddIndividualCategories

  • Algenta.Colectica.Commands.TypeSpecific.AlphabetizeAndRenumber

  • Algenta.Colectica.Commands.TypeSpecific.AnalyzeInstrument

  • Algenta.Colectica.Commands.TypeSpecific.AppyMetadataFromPhysicalInstance

  • Algenta.Colectica.Commands.TypeSpecific.AssignNumbersFrom0

  • Algenta.Colectica.Commands.TypeSpecific.AssignNumbersFrom1

  • Algenta.Colectica.Commands.TypeSpecific.CalculateSummaryStatistics

  • Algenta.Colectica.Commands.TypeSpecific.ClearConcordanceRelationships

  • Algenta.Colectica.Commands.TypeSpecific.ConvertRecordLayoutToDataRelationship

  • Algenta.Colectica.Commands.TypeSpecific.CreateClassificationFromCodeList

  • Algenta.Colectica.Commands.TypeSpecific.CreateCodeSchemeFromCategoryScheme

  • Algenta.Colectica.Commands.TypeSpecific.CreateComplianceDescriptionsFromConceptScheme

  • Algenta.Colectica.Commands.TypeSpecific.CreateStudyFromGroup

  • Algenta.Colectica.Commands.TypeSpecific.FillQualityInformation

  • Algenta.Colectica.Commands.TypeSpecific.GenerateDatasetFromInstrument

  • Algenta.Colectica.Commands.TypeSpecific.GenerateDdi2

  • Algenta.Colectica.Commands.TypeSpecific.GenerateDdi31Instance

  • Algenta.Colectica.Commands.TypeSpecific.GenerateDdi32Instance

  • Algenta.Colectica.Commands.TypeSpecific.GenerateDdi33Instance

  • Algenta.Colectica.Commands.TypeSpecific.GeneratePaperForm

  • Algenta.Colectica.Commands.TypeSpecific.GenerateSourceCodeFromPhysicalInstance

  • Algenta.Colectica.Commands.TypeSpecific.GenerateSurveyInstrumentFromDataset

  • Algenta.Colectica.Commands.TypeSpecific.ImportCodeLists

  • Algenta.Colectica.Commands.TypeSpecific.ImportCodes

  • Algenta.Colectica.Commands.TypeSpecific.ImportDataIntoStudy

  • Algenta.Colectica.Commands.TypeSpecific.MarkNegativeValuesAsMissing

  • Algenta.Colectica.Commands.TypeSpecific.PopulateQualityItemsFromConceptScheme

  • Algenta.Colectica.Commands.TypeSpecific.PopulateQualityStatementFromQualityStandard

  • Algenta.Colectica.Commands.TypeSpecific.RemoveSummaryStatistics

  • Algenta.Colectica.Commands.TypeSpecific.SetSourceInstrument

  • Algenta.Colectica.Commands.TypeSpecific.SortGroupItemsBase

  • Algenta.Colectica.Commands.TypeSpecific.SortGroupItemsByLabel

  • Algenta.Colectica.Commands.TypeSpecific.SortGroupItemsByName

  • Algenta.Colectica.Commands.TypeSpecific.SortyByCode

  • Algenta.Colectica.Commands.TypeSpecific.SynchronizeGroupsWithConceptSystem

  • Algenta.Colectica.Commands.TypeSpecific.UpdatePhysicalInstanceFromFile

  • Algenta.Colectica.Commands.ValidateMetadata

  • Algenta.Colectica.Commands.XPathValidationCommand

  • Algenta.Colectica.Importers.ModifiedDdiImporterCommand

  • Algenta.Colectica.VersionableCommands.CheckOutItem

  • Algenta.Colectica.VersionableCommands.ConvertCopenhagenMappingItemToDdi33

  • Algenta.Colectica.VersionableCommands.DeleteFromRepository

  • Algenta.Colectica.VersionableCommands.Deprecate

  • Algenta.Colectica.VersionableCommands.DuplicateItemCommand

  • Algenta.Colectica.VersionableCommands.FindItemsWithNewerLocalVersions

  • Algenta.Colectica.VersionableCommands.GatherReferencedItems

  • Algenta.Colectica.VersionableCommands.Replicate

  • Algenta.Colectica.VersionableCommands.ResolveUsingLocal

  • Algenta.Colectica.VersionableCommands.ResolveUsingRemote

  • Algenta.Colectica.VersionableCommands.ShowItemsWithChanges

  • Algenta.Colectica.VersionableCommands.ShowItemsWithUpdates

  • Algenta.Colectica.VersionableCommands.TagItem

  • Algenta.Colectica.VersionableCommands.UnDeprecate

  • Algenta.Colectica.VersionableCommands.UpdateDeprecationStateOf

Top level commands#

  • Algenta.Colectica.Importers.DdiImporterCommand

  • Algenta.Colectica.Importers.BlaiseImporterCommand

  • Algenta.Colectica.Importers.CasesImporterCommand

  • Algenta.Colectica.StandAloneCommands.CreateNewCheckout

  • Algenta.Colectica.Designer.Lib.CsvImporterCommand

  • Algenta.Colectica.Designer.Lib.ExcelImporterCommand

  • Algenta.Colectica.Designer.Lib.ParquetImporterCommand

  • Algenta.Colectica.Designer.Lib.SasImporterCommand

  • Algenta.Colectica.Designer.Lib.SpssImporterCommand

  • Algenta.Colectica.Designer.Lib.StataImporterCommand

  • Algenta.Colectica.Importers.DimensionsImporterCommand

  • Algenta.Colectica.Importers.QualtricsImporterCommand

  • Algenta.Colectica.Importers.QueXmlImporterCommand

  • Algenta.Colectica.Importers.RedCapImporterCommand