DocumentationEverything you need to understand IST at a glance and to learn, configure and develop it in practice.

This section includes the IST Data Sheet, a concise overview of capabilities, architecture, supported standards and formats, training and the implementation roadmap. It also provides a complete set of user, administrator, and developer documentation to help you work confidently with IST, whether you are entering data, managing a national survey, or customizing reports. All guides are practical and field-tested, tailored to the needs of statistical offices. You will also find FAQs and troubleshooting tips for quick resolution of common issues, plus detailed technical references for extending IST through custom development or integration.

IST Data Sheet

A summarized, visual introduction to IST covering data collection modes (CAPI/CAWI/CATI and Desktop/Web/Android clients), data processing and validation, preparation of dissemination outputs, Quality and Performance Indicators (QPI), integration with common analytical and mapping tools (e.g. SPSS, Stata, R, QGIS, Power BI), supported formats (XLS, CSV, XML, JSON, TXT), technical specifications (MS SQL Server, .NET, Windows/browser compatibility, security features), training offer, and the implementation roadmap with indicative infrastructure needs.

Download IST Data Sheet:

IST Data Sheet ⭳

User Guide

The IST User Guide provides comprehensive, step-by-step instructions for everyday users of IST - statistical office staff responsible for data entry, editing, logical control, and monitoring. This guide is a practical tool for mastering IST’s metadata-driven logic, multi-mode operation, and intuitive interface across the .NET desktop, web, and Android environments.

Key Topics Covered:

  • Launching IST and Application Selection
  • Data Entry
  • Logical Control (LC) and Error Management
  • Data Editing & Record Management
  • Batch Logical Control & Automatic Correction
  • Advanced Search
  • Reporting & Output Procedures
  • Record Locking & Access Control
  • Survey & Data Transfer via XML
  • Generating Web Applications
Each topic includes screenshots and examples to guide users through real IST applications and workflows.

Target Audience

This guide is tailored to:
  • Field users (CAPI/CAWI) and CAWI respondents
  • Data editors, validators, and supervisors
  • Planners and statisticians working with metadata
  • IT staff supporting survey transfers, app generation, and backups

Download the full user guide:

IST User Guide ⭳

Administrator Guide

The IST Administrator Guide is intended for IT personnel and advanced users responsible for maintaining, securing, and optimizing the IST system environment. This guide provides detailed instructions for configuring the system, managing databases and user roles, performing backups, and monitoring application performance.

They ensure that IST remains reliable and scalable as national statistical operations evolve.

Key Topics Covered:

  • System Installation and Configuration
    Step-by-step procedures for setting up IST on on-premise, cloud, or hybrid infrastructures, including shared folder structure, system parameters, and environment variables.
  • User Management and Permissions
    Guidance on managing IST access through SQL Server roles, Active Directory integration, and custom role-based permissions for modules such as data entry, validation, report access, and CAWI.
  • Database Structure and Maintenance
    Explanation of key databases (METADB, subject-matter DBs), and how to configure connections via _ISTDatabaseConnStrings. Includes maintenance of log tables and execution of scheduled SQL Jobs.
  • Backup and Recovery Procedures
    Instructions on automating backups of both metadata and subject-matter databases, as well as manual export of XML-based backups before critical deployments or system updates.
  • Log Monitoring and System Diagnostics
    How to access and interpret logs:
    • _ISTLogBatchLC, _ISTLogDelete, _ISTVariablesChange for editing and control history
    • _ISTLogExcelXMLJSON, _ISTLogProcessUsage, ISTSavedAdvancedSearch for monitoring reporting usage and outputs
    • Databases event logs for troubleshooting failed tasks or database access
  • Version Control and Metadata Management
    Managing application versions using VALIDFROM and VALIDTO logic, metadata package storage by year and survey, and guidelines for testing new versions using separate folders and schemas.
  • Performance Optimization
    Includes best practices for indexing, query optimization, SQL Server memory management, and checking for blocked processes or deadlocks in production.
  • Security Hardening
    Advice on server-level protection, limiting permissions, and integrating mail servers or secure VPN access where needed.

Target Audience

This guide is intended for:
  • IST System Administrators
  • IT Support Teams
  • Database Administrators (DBAs)
  • Power Users in NSOs
    who support system reliability and deployment

Download the full administrator guide:

Coming Soon

Developer Guide

This section is written for IT staff who build statistical applications on the IST platform. IST allows you to define metadata, design forms, add validations, and produce reports without changing the core system. The materials below provide the technical detail needed to work confidently with IST.

Key Topics Covered:

  • Architecture and platform
    IST runs on Microsoft SQL Server and .NET Framework on Windows. Desktop, Web CAWI, and Android interpreters use the same central metadata.
  • Installation and versioning
    Users start IST from a shared location by using a launcher. Configuration selects the active version and keeps previous versions for rollback.
  • Application lifecycle
    Define code lists and tables, design forms, set skips and validations, test on desktop and web, then deploy to users.
  • Metadata model
    Core tables include _IST, _ISTDatabaseConnStrings, _ISTTables, _ISTTablesColumns, _ISTRulesDataValidation, and related lookup and parameter tables. These tables control structure, labels, behavior, and rules.
  • Validation and logical control
    Record checks run on field exit and table checks run in batch. Rules are stored in metadata and can update fields or block entry until conditions are met.
  • Custom SQL procedures and reporting
    Reports are defined in metadata and executed through parameterized SQL. Output can include headers, parameter inputs, and optional post-processing.
  • Versioning of applications
    Use VALIDFROM and VALIDTO in metadata and follow folder naming conventions to manage pilot versions and parallel releases.
  • Logs and auditing
    System logs capture deletes, batch control runs, variable changes, process usage, exports, and saved searches. Logs support traceability and troubleshooting.
  • Integration hooks
    Data can be prepared for common analytical and dissemination tools by using SQL scripts that produce the required formats.

Tools and Technologies Used:

  • Microsoft SQL Server for metadata and subject-matter data
  • .NET Framework Windows Forms for Desktop interpreter
  • Web CAWI and Android interpreters that read the same metadata
  • Microsoft Excel for optional report post-processing

Target Audience

This guide is intended for:
  • IST application developers and power users
  • Database engineers and DBAs
  • Technical consultants and trainers
  • NSO IT teams that maintain or customize IST installations

Download the full developer guide:

IST Developer Guide ⭳

FAQ – Frequently Asked Questions

This section provides quick answers to the most common questions raised by IST users, administrators, and developers. Whether you’re troubleshooting an issue, unsure about a setting, or planning your first deployment, the IST FAQ is a helpful starting point for resolving day-to-day problems without delay.

  • Q: Do I need to install IST on every user’s computer?
    A: No. IST Desktop runs without installation. Users launch it via a shared folder shortcut or central launcher (ProcessStarter.exe).
  • Q: Can IST be used in multiple languages?
    A: Yes. Metadata tables allow for multilingual labels, forms, validations, and reports.
  • Q: Does IST support CAWI?
    A: Yes. IST has a built-in CAWI portal that supports secure login for respondents, form auto-save, and remote submission.
  • Q: I see red or yellow fields when entering data - what do they mean?
    A: Red fields indicate a failed logical control (critical error); yellow means a warning or light inconsistency. Click the LC button or hover to see an explanation.
  • Q: How do I validate all records in bulk?
    A: Use the Batch Logical Control tool to validate multiple tables or records at once, with summary results shown per rule and record.
  • Q: Can I auto-correct values flagged as errors?
    A: Yes, if the metadata includes an errAction SQL command, IST can apply the correction directly after user confirmation.
  • Q: How do I manage user access?
    A: Via SQL Server roles and/or Active Directory integration. Permissions are assigned based on user function (e.g. data entry, validator, CAWI admin).
  • Q: Is backup automated?
    A: Yes. IST includes scheduled SQL Jobs and Windows tasks to back up metadata, data, and logs on a regular basis.
  • Q: Can IST be deployed in the cloud?
    A: Absolutely. IST is cloud-ready and has been deployed in Microsoft Azure, including hybrid setups linking local SQL servers with remote access via browser and Android apps.
  • Q: Can I define my own validation rules?
    A: Yes. Validation rules are added via metadata in _ISTRulesLogicalControl or _ISTRulesDataValidation - no programming needed.
  • Q: How do I create a custom report?
    A: Use the _ISTReportsProcedures table to define SQL code, headers, and optional macros. Reports can be parameterized and exported in Excel/XML/JSON.
  • Q: Can I test a new version without affecting production?
    A: Yes. IST supports parallel application versions using VALIDFROM, VALIDTO, and separate metadata folders.

Next segment:

Training & Support ⇒