Logo

DOCUMENTATION

  • User’s Guide
  • Language Reference
  • Modeling Guide
  • Function Reference
  • WebUI
    • Getting Started
      • Requirements
        • Developing a WebUI app
        • Publishing a WebUI app
        • Running a WebUI app
      • Creating a WebUI
      • Authorizing model content for use in the WebUI
        • Available permissions
        • Preset authorizations
        • Updating the values of authorization identifiers
      • Public Identifiers
        • Identifiers in a Library
      • Publishing on AIMMS PRO
      • Example Projects
      • Quick Start: My First WebUI App
        • Underlying model
        • Creating an empty WebUI
        • Adding the widgets for input data
        • Including widgets for optimization data
        • Adding buttons
        • Solving the optimization model
        • Providing more structure to the UI
        • Adding What-If analysis
        • Modifying widget types
        • The final result
    • WebUI Menu Bar
      • Page Menu
        • Specifying the Content
        • Custom Positions for Widgets
        • Adapting Your Custom CSS
        • The Old Style Menu
      • Page Manager
        • Adding a Page
        • Renaming a Page
        • Moving a Page
        • Changing the Visibility of a Page
        • Deleting a Page
        • Setting the Home Page
        • Wizards
        • Sidepanels
      • Page Options
        • Maximum Number of Columns
      • Widget Manager
        • Adding a widget
        • Custom Position
        • Using the Search Boxes
        • Locking Editors
      • 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
        • Pivot
        • Change Type
        • Store Focus
        • Contents
        • Filters
        • Totals
        • Identifier Settings
        • Hiding Widgets
        • Number of decimals
      • Data Manager
        • User Actions
      • Application Settings
        • Use Classic Theme
        • UI Editable
        • Limited Option Editor(1/0)
        • Licenseinfo
        • Sidebar Open by Default
        • Page Manager Hidden
    • WebUI Folder
      • Pages
      • Widgets
      • Resources
        • Images
        • Load ordering
        • CSS styling
        • JavaScript
        • Multi-Language Support
    • WebUI System Library
      • Pages Support section
      • Authorization Support
      • requestPerformWebUIDialog
        • Arguments
        • Example
        • Remarks
    • Technical Background
      • Current Limitations
      • Project Conversion
    • Developing Custom Widgets
      • Open-sourcing WebUI
      • Creating a custom widgets
      • Widget development tutorial
        • Writing your first custom widget
        • Adding dynamic contents, part I: Options
        • Adding dynamic contents, part II: Simple data from AIMMS
        • Creating a custom widget with multi-dimensional data from AIMMS
        • Changing data in AIMMS
  • PRO Platform
    • Introduction to the AIMMS PRO Platform
      • Why do you need AIMMS PRO?
      • What is AIMMS PRO?
      • How to use AIMMS PRO?
      • Some important characteristics of AIMMS PRO
      • The AIMMS PRO portal
      • Running apps from the AIMMS PRO Portal
    • Installation
      • System Requirements
        • Minimum Server Requirements
        • Client Requirements
        • Network Requirements
        • Concurrent Connections
        • License Session Count
      • Installation and Configuration of the License Server
        • Installation Location and Default Ports
        • Setting up Licenses
        • Setting up License Profiles
        • License Server Maintenance
      • General Architecture
        • Overview from left to right
        • The users view
        • The provisions given
        • The resources
        • High availability and failover
      • Installation of AIMMS PRO on Windows
        • Database Support
        • Installation and Data Location
        • Default Ports
    • The AIMMS PRO Configurator
      • Configuring the configurator
      • Various sections of the configurator
        • Connection configuration
        • PRO configuration
        • Migration from AIMMS PRO 1.0.x
        • Start/stop services
        • Backup management
      • Setting up an AIMMS PRO Cluster
        • Connecting all Nodes to the Same Database
        • PRO internal database connections
        • Shared storage directory
        • Check that the cluster was set up properly
        • Other prerequisites
        • Guidelines for using the cluster
        • Moving from a single node configuration
        • ActiveMQ Setup
      • Server-side Logging
        • Logs Location
        • Log files
        • Log Configuration
        • Changing the logging Level
    • Server Administration
      • AIMMS Application Management
        • Publishing Applications
        • Direct App Launch
        • Tag as latest
        • Manage Categories
        • Configuring User Access
        • Different Rights
        • Hierarchy of Rights
        • Changing Permissions
        • Update and Delete Applications
        • Edit Applications
        • Windows 8 support
      • AIMMS Version Management
        • Deletion
      • User Management
        • Environments
        • Groups
        • Users
        • The ROOT Environment
        • Creating a New Environment
        • Default Environment for login
        • Hierarchy
        • Adding New Entities
        • Adding a New User
        • Group Membership
        • Editing and Deleting Users and Groups
      • 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
        • AIMMS PRO Configuration
        • SAML Identity Provider (IDP) Configuration
        • Single Sign-on
        • Role-based Authentication
        • On-demand User Information Retrieval
        • Project Publishing Rights for SAML Users
      • Tunneling support
        • General Design
        • Tunnel configuration
        • Security
        • Changes to AIMMS model
        • Known issues
      • Commonly Encountered Errors
        • Job finished with errors
        • Did not get a valid ticket from the server during Active Directory logons
        • Empty AllIdentifiers
        • The icon for the application does not appear on the portal
        • The jobs page on the portal is very slow
        • Jobs deletion is slow
        • Using ScheduledAt argument with wrong value leads to ‘created’ job
        • Error in model after launching an AIMMS client application
      • Miscellaneous
        • Case Sensitivity
        • AIMMS PRO Installation Healthcheck
    • AIMMS PRO End-User Portal
      • The AppLauncher
      • PRO Jobs
        • Jobs Overview
        • Jobs and Requests
        • Terminating Running Jobs
        • Inspecting Jobs
        • Deleting Jobs
      • Application Statistics
        • Queued and Running Jobs
        • Historical Runtime Data
        • How to Interpret
    • Project Setup
      • Adding PRO Libraries to your Project
        • Install AIMMS PRO System libraries
        • Downloading the AIMMS PRO Client library
      • Basic AIMMS PRO Workflow
        • Basic Usage
        • Other Workflows
        • Modify Procedures
        • Displaying the Request Manager
        • Create a .aimmspack File and Publish
      • Conversion Guidelines
        • Constructs to Avoid
        • Symptoms When You Violate These Limitations
        • Application Experience
      • AIMMS PRO and Data Management
        • Where to Locate Data
        • PRO Central Data Management
        • PRO User Cases
        • PRO Shared Cases
        • PRO Central Storage
        • Central Case URL’s
        • User and Shared Case Shortcuts
        • Transferring Files
        • Manipulating PRO Files and Folders
        • Access Rights
        • Specifying Access Rights
        • Using a Database
      • 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
        • Connecting With the PRO Server
        • Opening the Project
        • Logging on
        • Debugging the Client Session
        • Server-side Session Debugging is Hard
        • Server-side Debugging in Developer Mode
        • Debugging a Server-side Session
        • Debugging Your Model
    • AIMMS PRO API
  • Cloud Platform
    • Introduction to the AIMMS Cloud Platform
      • Why do you need AIMMS PRO running on our AIMMS Cloud Platform?
      • What is AIMMS PRO and what is the AIMMS Cloud Platform?
      • How to use AIMMS PRO?
      • Some important characteristics of AIMMS PRO
      • The AIMMS PRO portal
      • Running apps from the AIMMS PRO Portal
    • General Architecture
      • Overview from left to right
      • The users view
      • The provisions given
      • The resources
      • High availability and failover
    • System Requirements
    • Server Administration
      • AIMMS Application Management
        • Publishing Applications
        • Direct App Launch
        • Tag as latest
        • Manage Categories
        • Configuring User Access
        • Different Rights
        • Hierarchy of Rights
        • Changing Permissions
        • Update and Delete Applications
        • Edit Applications
        • Windows 8 support
      • Activate AIMMS Version
        • AIMMS Versions
        • Activate AIMMS Version
        • Deletion
      • User Management
        • Environments
        • Groups
        • Users
        • The ROOT Environment
        • Creating a New Environment
        • Default Environment for login
        • Hierarchy
        • Adding New Entities
        • Adding a New User
        • Group Membership
        • Editing and Deleting Users and Groups
      • Configuration
        • AD Settings
        • Retention Settings
        • Portal Customization
        • Tunnels
        • Queue Priorities
        • IP Range Blocking
        • DB IP Range Blocking
        • 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
        • AIMMS PRO Configuration
        • SAML Identity Provider (IDP) Configuration
        • Single Sign-on
        • Role-based Authentication
        • On-demand User Information Retrieval
        • Project Publishing Rights for SAML Users
      • Tunneling support
        • General Design
        • Tunnel configuration
        • Security
        • Changes to AIMMS model
        • Known issues
      • Commonly Encountered Errors
        • Job finished with errors
        • Did not get a valid ticket from the server during Active Directory logons
        • Empty AllIdentifiers
        • The icon for the application does not appear on the portal
        • The jobs page on the portal is very slow
        • Jobs deletion is slow
        • Using ScheduledAt argument with wrong value leads to ‘created’ job
        • Error in model after launching an AIMMS client application
      • Miscellaneous
        • Case Sensitivity
        • AIMMS PRO Installation Healthcheck
    • AIMMS PRO End-User Portal
      • The AppLauncher
      • PRO Jobs
        • Jobs Overview
        • Jobs and Requests
        • Terminating Running Jobs
        • Inspecting Jobs
        • Deleting Jobs
      • Application Statistics
        • Queued and Running Jobs
        • Historical Runtime Data
        • How to Interpret
    • Project Setup
      • Adding PRO Libraries to your Project
        • Install AIMMS PRO System libraries
        • Downloading the AIMMS PRO Client library
      • Basic AIMMS PRO Workflow
        • Basic Usage
        • Other Workflows
        • Modify Procedures
        • Displaying the Request Manager
        • Create a .aimmspack File and Publish
      • Conversion Guidelines
        • Constructs to Avoid
        • Symptoms When You Violate These Limitations
        • Application Experience
      • AIMMS PRO and Data Management
        • Where to Locate Data
        • PRO Central Data Management
        • PRO User Cases
        • PRO Shared Cases
        • PRO Central Storage
        • Central Case URL’s
        • User and Shared Case Shortcuts
        • Transferring Files
        • Manipulating PRO Files and Folders
        • Access Rights
        • Specifying Access Rights
        • Using a Database
      • 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
        • Connecting With the PRO Server
        • Opening the Project
        • Logging on
        • Debugging the Client Session
        • Server-side Session Debugging is Hard
        • Server-side Debugging in Developer Mode
        • Debugging a Server-side Session
        • Debugging Your Model
    • AIMMS PRO API
  • Library Repository
    • CDM Library
      • Introduction
        • Characteristics of multi-user decision support applications
        • Different types of decision support applications
        • Comparison to version control systems
        • AIMMS CDM as a version control system
        • What data to manage using AIMMS CDM
        • Complementary to regular databases
      • Installing AIMMS CDM
        • Adding the CDM library to your model
        • Installing the CDM service
      • Configuring your model for CDM
        • CDM categories
        • Specifying categories
        • Taking care of dependencies
        • Initializing CDM support in your model
        • Model constructs to reconsider when using CDM
      • Day-to-day CDM operations
        • General concepts
        • Basic actions
        • Corrective actions
        • Working with branches
        • Auto-committing and auto-pulling changes
        • Obtaining identifier history
        • Implementing locking semantics
      • Callbacks and hooks provided by CDM
        • Remote commit notification
        • Providing commit info
        • Local data change notification
        • Changes in connected state
        • Getting notified of errors
        • Custom handling of conflict resolution
      • CDM Authentication and Authorization
        • The system branch and category
        • Assignable permissions
        • Creating authorization profiles
        • Assigning authorization profiles to branches
      • CDM implementation details
        • General CDM database structure
        • CDM element spaces
        • Multi-dimensional data in CDM
        • Dealing with inactive data
        • Shadow identifiers
        • Data read sequence
        • Data read sequence when merging branches
      • Low-level CDM API
        • Library Management Functions
        • ApplicationDB Functions
        • Branch and Revision Functions
        • Authorization Functions
        • Category Functions
        • Commit and Pull Functions
        • Embedded Server Functions
        • Utility Functions
    • DataLink Library
      • DataLink configuration
        • Installation and setup
        • Read and Write Attributes
        • The mapping
      • Providers
        • Setup
        • XLSProvider
        • CSVProvider
      • Examples
        • The data source
        • The AIMMS model
        • The data map
        • The code
    • Email Client Library
      • Introduction
        • Adding the Email Client library to your model
        • Example
        • Creating HTML and text templates
      • Email Client API
    • HTTP Client Library
      • Introduction
        • Adding the HTTP Client library to your model
        • Example
        • Limitations
      • HTTP Client API
        • Request Management
        • Request Getters and Setters
        • Utility functions
        • Library Management
    • RLink Library
      • Setting up RLink
        • Requirements and responsibilities
        • Installation
      • Using RLink
        • Execute R code
        • Passing Data
      • Iris Example
        • The iris data set
        • Calling scripts
        • Plotting in WebUI
    • Unit Test Library
      • Creating unit test suites
        • Creating a test suite
        • Adding setup and teardown procedures
      • Running test suites
        • Example
        • Detailed inspection of results
      • Automated testing
        • Requirements for the Python script
        • Example
AIMMS Documentation
  • Home
  • Software & Solutions
  • Resources
  • Customers
  • Developers
  • About Us

Welcome to AIMMS Documentation

Find out how AIMMS Software works

WebUI

Documentation for AIMMS WebUI

PRO

Documentation for the AIMMS PRO platform

Cloud Platform

Documentation for the AIMMS Cloud platform

Library Repository

Documentation for the AIMMS Library repository
_images/favicon.png

Last Updated: March, 2019

Next
  • © 1989 - 2019 AIMMS B.V.
  • SUPPLYCHAIN BLOG
  • AIMMS HOW-TO
  • DISCLAIMER
  • PRIVACY STATEMENT