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

IST Developer Resources

IST is a flexible and extensible platform that allows advanced users and developers to customize applications, reports, validations, and integrations without modifying the core system. The Developer Resources subsection provides technical documentation and reference materials needed to extend IST’s functionality through SQL, VB.NET, and metadata scripting - all while remaining fully compatible with IST’s metadata-driven logic.

Key Topics Covered:

  • Custom SQL Procedures and Reporting
    Developers can define reports using the _ISTReportsProcedures metadata table, writing parameterized SQL scripts to extract, pivot, or aggregate data. Output can be customized with macros, headers, or linked to Power BI dashboards using the PBLink field.
  • Metadata API and Extension Points
    Although not yet public, IST’s internal metadata logic allows developers to reference and reuse values across tables via IST_GGFunctions, IST_MMMFunctions, and calculated virtual fields. Developers can also create mirror tables for data validation or real-time summary views.
  • Custom Validation Logic
    IST supports rule-based validation at runtime through the _ISTRulesLogicalControl and _ISTRulesDataValidation tables. Developers can add conditional logic, SQL update rules, and multi-field consistency checks without altering the UI or main application.
  • Application Versioning and Metadata Packaging
    Instructions are provided for managing metadata versions using VALIDFROM, VALIDTO, and metadata folder naming conventions. This enables development and testing of parallel versions for pilot surveys, follow-ups, or ad hoc modules.
  • Macro and Excel Integration
    Developers can define custom Excel headers and macros (.xlsm) to enhance IST report outputs. These macros can perform post-processing operations like automated pivot generation, chart creation, or anonymization for dissemination.
  • Integration Hooks (Advanced Use)
    Advanced teams can prepare IST data outputs for integration with external systems (e.g. SPSS, R, τ-Argus, .Stat Suite) using JSON/XML/CSV formats defined through SQL. Data export automation can also be scripted via SQL Agent Jobs or linked systems.

Tools and Technologies Used:

  • Microsoft SQL Server (2016+)
  • VB.NET / WinForms (for IST Desktop application extensions)
  • ASP.NET / Web Forms (for CAWI and IST Web portals)
  • Android SDK (for survey extensions on IST Android)
  • Excel macros (VBA) for post-processing outputs (optional)

Target Audience

This content is intended for:
  • IST Developers and Power Users
  • Database Engineers
  • Technical Consultants and Trainers
  • NSO IT Teams maintaining or customizing 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 ⇒