ADE User Guide

Other languages:

The Analytica Decision Engine (ADE) provides an Application Programming Interface (API) for other applications to run and access an Analytica model running on a server. The other application may supply inputs, run the model, and collect and display results. It may also create, read, check, parse, evaluate, modify, and save Analytica models. ADE provides access using the Component Object Model (COM), a widely used standard to enable communication between processes or applications, supported by a large range of programming languages.

ADE provides the same model parsing and calculation engine used in Analytica. ADE does not itself provide a user interface, as Analytica does on a desktop computer. If you want to create a web-based user interface to an Analytica model, the easiest way is simply to upload the model to the Analytica Cloud Player (ACP). You can do that using Publish to Cloud directly from Analytica's File menu. Every Analytica license comes with free access to ACP to deploy your models via the web. For larger enterprise web applications with multiple collaborating users, you may consider [1]. Cubeplan lets you create dashboards tailored to each type of user. ACP and Cubeplan themselves both use ADE internally.

This user guide is for programmers that wish to develop applications using ADE. It includes an introduction, how to install ADE, a Tutorial, details on the ADE COM classes, and a reference to the ADE Server classes.

How to use this document

Each page shows where it is in the page hierarchy and its parent pages just below its title. You may read the pages in any order, but there are Previous and Next links at the bottom of each page if you want to read the pages in sequence.

At the bottom of each page, a Navbox lists the contents of the guide, so you can jump to other sections.

Contents of the ADE User Guide

Introduction to ADE

This chapter explains what ADE is and how to use the ADE Server.

Installation of ADE

This chapter explains the steps required to install ADE 4.6 on your Windows 7 or higher, or Windows Server computer.

The ADE Tutorial

This chapter shows you how to use ADE from within a Visual Basic program, and steps you through building your first ADE application using Visual Basic.

Using the ADE Server

This chapter provides a step-by-step guide to the functionality accessible through ADE. You should read this section to get better acquainted with the classes, and their methods and properties. By using the sample code fragments presented in this section in your code, you can begin accessing information in your models from your Visual Basic applications immediately.

Working with Models, Modules, and Files in ADE

This chapter contains examples of common operations and manipulations you might perform on objects in your Analytica model.

ADE Server Class Reference

This chapter provides reference materials on the object classes in ADE and their properties and methods, including method syntax, data types, and property access information. Refer to the information in this section after you’ve read through Using the ADE Server and have specific questions about particular methods and properties.