AIMMS Logo

DOCUMENTATION

  • Function Reference
    • User’s Guide
    • Language Reference
    • Modeling Guide
    • WebUI
      • Getting Started
        • Requirements
        • Creating a WebUI
        • Publishing on AIMMS PRO
        • Quick Start: My First WebUI App
      • WebUI Menu Bar
        • Page Menu
        • Page Manager
        • Page Settings
        • Widget Manager
        • Widget Types
          • Bar Chart Widget
          • Bubble Chart Widget
          • Button Widget
          • Download Widget
          • Gantt Chart Widget
          • Group Widget
          • Image Widget
          • Label Widget
          • Line Chart Widget
          • Map Widget
          • Map Widget old style
          • Pie Chart Widget
          • Scalar Widget
          • Selection Widgets
          • Slider Widget
          • Table Widget
          • Text Widget
          • Tree Map Widget
          • Upload Widget
        • Widget Options
        • Data Manager
        • Application Settings
      • WebUI Folder
      • WebUI System Library
      • Technical Background
      • Developing Custom Widgets
    • PRO Platform
      • Introduction to the AIMMS PRO Platform
      • Installation
        • System Requirements
        • Installation and Configuration of the License Server
        • General Architecture
        • Installation of AIMMS PRO on Windows
      • The AIMMS PRO Configurator
        • Configuring the configurator
        • Various sections of the configurator
        • Setting up an AIMMS PRO Cluster
        • Server-side Logging
      • Server Administration
        • AIMMS Application Management
        • AIMMS Version Management
        • User Management
        • Monitoring
        • Configuration
          • AD Settings
          • Retention Settings
          • Portal Customization
          • Tunnels
          • Queue Priorities
          • Log Management
          • Active Data Sessions
          • Seats Management
        • Linking Environments to Active Directory Domains
          • Link to Active Directory for AD Member Servers
          • Link to Active Directory for Non-AD Member Servers
        • SAML Support
        • Tunneling support
        • Commonly Encountered Errors
        • Miscellaneous
      • AIMMS PRO End-User Portal
      • Project Setup
        • Adding PRO Libraries to your Project
        • Basic AIMMS PRO Workflow
        • Conversion Guidelines
        • AIMMS PRO and Data Management
        • Advanced AIMMS PRO Workflows
          • Determining the Application State to Transfer
          • Advanced Usage of pro::DelegateToServer
          • Communication Between client-side and Server-side Sessions
          • Using Messages in Your PRO Applications
          • The PRO Progress Window
          • Using Solver leases instead of DelegateToServer
        • Debugging PRO-enabled Projects
      • AIMMS PRO API
    • Cloud Platform
      • Introduction to AIMMS Cloud Platform
      • General Architecture
      • System Requirements
      • Server Administration
        • AIMMS Application Management
        • Activate AIMMS Version
        • User Management
        • Configuration
          • AD Settings
          • Retention Settings
          • Portal Customization
          • Tunnels
          • Queue Priorities
          • IP Range Blocking
          • DB IP Range Blocking
          • AIMMS Cloud Database and VPN configuration
          • Active Data Sessions
          • Seats Management
        • Linking Environments to Active Directory Domains
          • Link to Active Directory for AD Member Servers
          • Link to Active Directory for Non-AD Member Servers
        • SAML Support
        • Tunneling support
        • Commonly Encountered Errors
        • Miscellaneous
      • AIMMS PRO End-User Portal
      • Project Setup
        • Adding PRO Libraries to your Project
        • Basic AIMMS PRO Workflow
        • Conversion Guidelines
        • AIMMS PRO and Data Management
        • Advanced AIMMS PRO Workflows
          • Determining the Application State to Transfer
          • Advanced Usage of pro::DelegateToServer
          • Communication Between client-side and Server-side Sessions
          • Using Messages in Your PRO Applications
          • The PRO Progress Window
          • Using Solver leases instead of DelegateToServer
        • Debugging PRO-enabled Projects
      • AIMMS PRO API
    • Library Repository
      • CDM Library
        • Introduction
        • Installing AIMMS CDM
        • Configuring your model for CDM
        • Day-to-day CDM operations
        • Callbacks and hooks provided by CDM
        • CDM Authentication and Authorization
        • CDM implementation details
        • Low-level CDM API
        • Release Notes
      • DataLink Library
        • What is DataLink?
        • The Data Map
        • Read and Write
        • Source Information
        • Data Map Automation
        • Tips and Tricks
        • Providers
        • Examples
        • Release Notes
      • Email Client Library
        • Introduction
        • Email Client API
        • Release Notes
      • HTTP Client Library
        • Introduction
        • HTTP Client API
        • Release Notes
      • RLink Library
        • Setting up RLink
        • Using RLink
        • Iris Example
        • Release Notes
      • Unit Test Library
        • Creating unit test suites
        • Running test suites
        • Automated testing
        • Release Notes
    AIMMS Documentation
    AIMMS Logo
    • Community
    • How-To
    • Downloads
    • Release Notes
    • Docs »
    • Library Repository »
    • DataLink Library

    DataLink Library¶

    Data comes in many different flavors and each piece of software defines its own particular format tailored to its own particular need. If we have a data source that is stored in such format and we want to use it in an AIMMS model, we somehow need to import this. We could create custom importers for all flavors but that would lead to a lot of extra coding, and model developers would need to learn the usage of many importers.

    Furthermore there is a catch when using custom importers (and also exporters). In order to access the external data, somehow you have to ask for the data in the source in the “language” of that particular format. In the AIMMS model parts will be very specific not just for the format, but also for the data source itself. So even changing the data source may require the model to be modified.

    DataLink is created with the idea that if the structure of data in a source follows some kind of schema, it is possible to implement a generic strategy to fetch the data from the source. This can then be possible without having to address the data elements in the language of the format, but in a more general, source independent, way.

    As schema we consider data sources that are organized as a collection of tables, consisting of named columns. Examples of such sources include relational databases, excel files, or directories containing CSV files. DataLink can be used to read from and write to these sources, by only using the names of the tables and columns.

    ” Use the Source, Luke! “
    – DataLink
    • What is DataLink?
      • The problem with tables
      • The DataLink solution
      • Installation and setup
    • The Data Map
      • What is a data map
      • The “Classic” Data Map
      • The New Data Map
      • Valid tables and their domains
    • Read and Write
      • Reading and writing
      • Types
      • ReadWriteAttributes
    • Source Information
      • Get Schema of Source
    • Data Map Automation
      • Category Mapping
    • Tips and Tricks
      • Read from file
    • Providers
      • XLSProvider
      • CSVProvider
    • Examples
      • The data source
      • The AIMMS model
      • The data map
      • The code
    • Release Notes
      • New Features and Bug Fixes

    Last Updated: December, 2019

    Next Previous

    • © 1989 - 2019 AIMMS B.V.
    • AIMMS COMMUNITY
    • HOW-TO DOCS
    • DISCLAIMER
    • PRIVACY STATEMENT