Skip to main content
Ctrl+K

Colectica 7.6

  • Introduction
  • DDI Tools
  • Additional Resources
  • Changelog
  • X
  • GitHub
  • LinkedIn
  • YouTube
  • Introduction
  • DDI Tools
  • Additional Resources
  • Changelog
  • X
  • GitHub
  • LinkedIn
  • YouTube

Section Navigation

  • Colectica for Excel
    • Document Data
      • Document your Excel Workbook
      • Add Detailed Information about each Column
      • Add Additional Fields to your Documentation
      • Create a Code List for a Column
      • Reuse a Code List
      • Validate Metadata Quality
    • Publish Documentation
      • Export Information to Standardized XML
      • Create Publishable Documentation
    • Import Data
      • Import Data into Excel from SAS
      • Import Data from SPSS
      • Import Data from Stata
    • Configuration
      • Modify the Authoritative Agency of your Metadata
      • Register your copy of Colectica for Excel
    • Frequently Asked Questions
  • Colectica Designer
    • Get Started
      • Installation
      • The Ribbon
      • The Navigator
      • Send Feedback
    • Create Items
    • Browse and Search
      • Home Page
      • Checkouts
      • Browse
      • Search
    • View and Edit Items
      • The Item Editor
      • Work with Text
      • Reference Items
      • Controlled Vocabularies
      • Annotations and Custom Fields
      • File Attachments and Other Materials
      • Save Items
      • View References
      • View History
    • Manage Content
      • Data
        • Document a Dataset
        • Update Dataset Documentation Based on a Data File
        • Generate a Dataset Description from a Survey Instrument
        • Apply a Metadata Input Sheet
        • Apply Metadata from Another Dataset
        • Compute Summary Statistics
        • Apply Statistics from a Spreadsheet
        • Remove Summary Statistics
        • Create a PDF Data Dictionary or Codebook
        • Organize Variables into Groups
        • Synchronize with Concept System
      • Data Collection
        • Design a survey instrument
          • Add a new question
          • Add an existing question
          • Add a statement
          • Add a conditional branch
          • Add a section
          • Add an existing sequence
          • Add a loop
          • Reorder items
          • Remove items from a survey
        • View All Questions in a Survey Instrument
        • Manage survey questions
        • Generate a Paper Questionnaire
        • Publish to a Computer-assisted Interviewing System
          • Generate Blaise Source Code
          • Generate a REDCap Survey or Data Dictionary
          • Generate a queXML Survey
          • Generate CASES Source Code
          • Generate a CSPro Survey
      • Research Lifecycle
        • Document a Study
        • Document a Series of Studies
      • Data Concordance
      • Classifications and Code Lists
        • Create a Code List
        • Edit Classifications
      • Quality Statements
        • Define a Quality Standard
        • Quality Standards for SIMS, ESQRS, and ESMS SDMX
        • Create a Quality Statement
        • Publish to PDF
        • Specify Site-wide Information to be used in all Quality Statements
      • Foundational Metadata
        • Manage Concepts
        • Universes and Populations
        • Code Lists and Categories
        • Metadata Packages
    • Common Commands
      • Validate Metadata Quality
      • Validate with XPaths
      • Duplicate a Metadata Item
      • Deprecation
      • Delete from Repository
    • Import
      • Import Data
      • Import Surveys
        • Blaise
        • CASES
        • IBM SPSS Data Collection / SPSS Dimensions
        • QueXML
        • REDCap
      • Bulk Ingest
      • Concordance Information
      • Import Other Resources
        • Code Lists
        • Metadata Spreadsheets
        • DDI
        • Import from SKOS
    • Publish
      • Generate Documentation
      • Publish to Colectica Repository
        • Configure a Remote Repository
        • Check out an Item
        • Publish a Checkout
        • Update a Checkout
        • Tag a Checkout
      • Export to Open Standards
      • File Storage Service
    • Work with Open Standards
      • View DDI 3
      • Validate DDI 3
    • Administration
      • Local Database
      • User Settings
      • User Interface Configuration
      • Site-wide Repository and Workflow Server Configuration
      • Site-Wide Default Language
      • Site-wide Custom Field Configuration
      • Site-wide User ID Configuration
      • Controlled Vocabulary Configuration
      • Disable Update Check
      • Disable Application Insights
  • Colectica Questionnaires
    • Get Started
      • Installation
      • Activation
      • Create a Survey
      • Open a Survey
      • Save a Survey
      • Configure Repositories
    • Design Surveys
      • Add a Question or Other Survey Item
      • Survey Items
        • Static Content
        • Questions
        • Choice Grids
        • Question Grids
        • Rosters
        • Sequences
        • Computations
          • Functions for Computation Assignments
        • Edit Checks
        • Blaise 5 Data Lookup
      • Dynamic Text Replacement
      • Custom Fields
      • Reuse Questions
      • Organize a Survey
      • Display Logic
      • Parameters
      • Survey Output Names
      • Survey Properties
      • Multiple Languages
    • Search and Analysis
      • Search
      • Check for Errors
      • Questions
      • Flowchart
    • Collaboration
      • Synchronize with Repository
      • Commenting
    • Publish
      • Survey Specification
      • Paper Form
      • DDI XML
      • Blaise 5
    • Roadmap
  • Colectica Repository
    • Functionality
      • Metadata Repository
        • Colectica Platform Overview
        • Colectica Repository Overview
        • Storage
        • Security
          • User Authentication
          • Security Modes
          • Roles
          • Repository Methods and Roles
          • Permission Management
          • Access Controls (Permissions)
          • Encryption
        • Agency Management
        • Multilingual Support
        • Search Capabilities
      • Web Portal
        • Home
        • Search
        • Explore
        • Basket
        • Item Details
        • Account Management
        • Administration
          • Dashboard
          • Reports
          • System Status
          • Users
          • Site Information
          • Agencies
          • Item Types
          • Languages
          • Pages
          • Extensible Buttons
          • File Storage Service
        • Extensibility
      • REST API
        • Web Services Overview
        • Configure the REST API
        • REST API Examples
          • Search
          • Get an Item
          • Relationship Search
      • Colectica Workflow Services
        • User Guide
          • Request publication of an item
          • View workflow items that need review
          • Preview an item that needs review
          • Approve publication of an item
          • Deny publication of an item
          • Designate a user or group to be responsible for an item
          • Unpublish an item
        • Deployment 6.2
          • Deployment Options
          • Set up DNS
          • Create the Database
          • Configure System Prerequisites
          • Deploy Site Binaries
          • IIS Configuration
          • Configure Workflow Website
          • Install and Configure the Workflow Service
          • Install and Configure the Workflow Preview website (Optional)
          • System Configuration
          • Test
        • Deployment 7.0
          • Deployment Options
          • Set up DNS
          • Create the Database
          • Configure System Prerequisites
          • Deploy Site Binaries
          • IIS Configuration
          • Configure Workflow Website
          • Configure Windows Authentication
          • Install and Configure the Workflow Task Runner
          • Install and Configure the Workflow Preview website (Optional)
          • System Configuration
          • Test
        • Configuration
          • Configure email notifications
          • Configure email templates
          • Configure live previews
      • Colectica RDF Services
    • Technical Documentation
      • Hosting Options
      • Database Options
      • Authentication
        • Configure OAuth2 OpenID Connect (OIDC)
        • Configure Local JWT Token Provider (Optional)
        • Configure Active Directory
        • Configure Azure Active Directory
      • Security and Attack Mitigation
      • Item Type Identifiers
      • Advanced Search
      • Elastic Indexer
      • Elasticsearch Indices
      • Theme and Styles
      • Localization
      • Observability
      • Discoverability and Harvesting
      • Metadata Structure for the Explore Page
      • Frequently Asked Questions
    • Deployment
      • Preparation
        • DNS
        • Configure System Prerequisites - Windows
        • Configure System Prerequisites - Linux
        • Create the Repository Database
        • Configure the Environment
        • Service Account Permissions - Windows
      • Deploy Binaries
      • Configuration
        • appsettings.json
        • Web Portal Administration
        • Email Templates
      • Authentication
        • Configure OAuth2 OpenID Connect (OIDC)
        • Configure Local JWT Token Provider (Optional)
        • Configure Active Directory
        • Configure Azure Active Directory
      • Running Repository
        • Running Repository on Linux
          • Running Repository Standalone on Linux
          • Running Repository with a Proxy on Linux
          • Running Repository on Linux with Docker
        • Running Repository on Windows
        • First Run Configuration
        • Test
      • Windows Upgrade Guide
  • Colectica Curation Tools
    • Feature Overview
    • Depositor Guide
      • Sign Up
      • Log In
      • Create a New Catalog Record
      • Edit Methods Information
      • Upload Files
      • Submit for Curation
      • View Catalog Records
      • Depositor Alerts
    • Curator Guide
      • Log In
      • View Catalog Records
      • Perform Curator Review Tasks
        • Confirm Observation Counts
        • Check for Missing Variable and Value Labels
        • Compare Questionnaires, Codebooks, and Data
        • Check for Personally-Identifiable Information
        • Identify Potential Errors in Data Files
        • Confirm Code Executes Successfully
        • Confirm Code Replicates Reported Results
        • Create Preservation Formats
      • Update Data Files from Metadata
      • Request Publication
      • Catalog Record History
      • File History
      • Curator Alerts
    • Organization Administrator Guide
      • Log In
      • Create a User
      • Assign Permissions to a User
      • View Catalog Records
      • Assign Curators
      • Accept Publication Request
      • Catalog Record History
      • File History
      • Organization Settings
      • Organization Administrator Alerts
    • Site Administrator Guide
      • Site Settings
      • Create an Organization
    • Technical Documentation
      • Overview
      • Data Model
      • Automatic Information Versioning
      • DDI Lifecycle in Colectica Curation Tools
      • Storage
      • Software Components
      • Extension Points
      • User Roles
      • Multiple Organizations
      • Deployment
        • Create the Curation Database
        • Provision Storage Areas
        • Configure System Prerequisites
        • Deploy the Curation Web Application
        • Deploy the Curation Service
        • Deploy ClamAV
        • Configure the Curation System
        • Configure Error Alerts
      • Upgrade
    • ChangeLog
  • Colectica SDK
    • Class Level Documentation
    • Code Samples
    • Colectica Designer Addins
    • Deployment with Nuget
    • Enabling Visual Studio Intellisense for Colectica SDK
  • DDI Tools
  • Colectica SDK
  • Class Level Documentation

Class Level Documentation#

Colectica SDK Class Documentation v7

Colectica SDK Class Documentation v6

Colectica SDK Class Documentation v5

previous

Colectica SDK

next

Code Samples

© Copyright 2025 Colectica.