Analytica Docs - User contributions [en]

Installation of ADE

2024-01-25T12:55:35Z

Dpaine+25deca:

[[Category:ADE User Guide]]
{{ReleaseBar}}
<languages />
<translate>

[[ADE User Guide]] >


This chapter explains the system requirements for the Analytica Decision Engine (ADE) and describes how to install, upgrade, and uninstall ADE.

==System Requirements== 


*Windows XP, Windows Server 2003, 2008, or 2012, Windows Vista, Windows 7, or Windows 8.
*40 MB of hard drive space, plus whatever you need for your applications
*At least 2GB of RAM. More is better if your users will run multiple parallel applications.
*You also need a development language environment to build your application using ADE. This could be Visual Studio with VB.NET, C#, ASP.NET, VC++, or any other COM or .NETenabled development environment. You can also use ADE from Microsoft Office Visual Basic for Applications (VBA) or from Windows Scripting Host (<tt>'''CScript.exe''</tt>' or <tt>'''WScript.exe'''</tt>), as well as other COM-enabled or ActiveX automation-enabled packages.


You can download the ADE installer from [[http://www.analytica.com/ana/support/download.htm Analytica Downloads]]. The installation contains the ADE in-process automation server (<tt>'''Adew.dll'''</tt>), the ADE local automation server (<tt>'''ADE.exe'''</tt>), auxiliary files needed by ADE, this ''ADE User Guide'', and example programs.

==Installing the Analytica Decision Engine Files== 
===Installing from the Network===
# Obtain an ADE activation key from Lumina. You normally get one via e-mail when you buy an ADE license or subscription.
# Download the ADE setup executable. The location of the file on the internet is provided when you receive your activation key. Save the file to disk.
# Run (i.e., double click) the file you just downloaded to begin the ADE installer. Make sure you are running it from an admin account.
# Follow the instructions. Read and agree to the license agreement, select a directory for the installation, and enter your activation key when prompted. The installer communicates with Lumina’s activation server to activate and download a license that is keyed to you computer.

The activation process stores a license in a file named <tt>'''ADE*.lic'''</tt>, where the * is completes the name of your own license. This license is keyed to the computer (the same ADE.lic won’t work on a different computer), but is valid for all users of the same computer, including special accounts used by your web server.

===Manual Activation=== 
If activation fails as a result of the installer being unable to communicate with the activation server (either because your computer is not connected to the internet, or because your corporate firewall blocked the communication), you will need to manually activate the license. This involves these steps:


#Allow the installer to finish (leave the activation key blank).
#Find your computer’s host id as follows.
##'''Start''' > '''All Programs''' > '''Analytica Decision Engine''' > '''Configure License'''
## Find your host id at the bottom right corner of the dialog.
#Go to http://analytica.com/support/activate-analytica
#Select ADE, Individual license, and fill in the remaining fields (make sure your host id is entered exactly, including any hyphens if any) and submit.
#On the thank you web page, find your license name. It will appear after “<tt>'''LICENSE lumina'''</tt>” and will look something like ade_123_45 (the numbers will differ).
#When you receive the email, save the attachment (ADE.lic) to the ADE install directory.
#Run <tt>'''ADE.exe'''</tt>
#In the dialog that appears, enter your license name from step5. Leave the RLM Server field blank.
#Test the installation by running <tt>'''AdeTest'''</tt> and pressing the '''New ADE.CAEngine''' button. If this succeeds without reporting a licensing error, you got it right.

===Installed Manuals and Examples=== 
The default installation directory, if you did not change it when running the installer, is
<code>C:\Program Files\Lumina\ADE {{#svarget:anarelease|6.0}}</code>


Four example programs should also have been installed in that directory underneath the examples directory. They are as follows:
*'''Tutorial.NET''' — This program is referred to by the Analytica Decision Engine Tutorial. It is recommended that you read the Analytica Decision Engine Tutorial completely before writing your own programs that depend on ADE.
*'''AdeTest''' — This program allows you to call or test the methods of ADE objects through a GUI. You can run AdeTest.Exe (in the bin directory), or you can trace through the code in the Visual Studio.NET 2005 debugger to observe each method being called.
*'''asp_exam''' — This program shows you how to access ADE through a Microsoft ASP program.
*'''excel_exam''' — This program shows you how to access ADE from any application with Visual Basic for Applications (VBA) support, including the Microsoft Office suite of applications.

===Entering a new license code=== 
If you need to activate a different license you must run the ADE installer (or go through the [[Installation of ADE#Manual Activation | manual activation]] process).

===Upgrading from an earlier version of ADE=== 
ADE {{#svarget:anarelease|5.4}} has been configured to install without disturbing previously installed versions of ADE. This allows you to compare the performance and output of your application under the different versions. However, it also means that your existing applications continue to use the previous version until you have changed them to use ADE {{#svarget:anarelease|6.0}}

===Uninstalling ADE=== 
To uninstall ADE, select '''Add/Remove Programs''' in the Windows Control Panel. Scroll through the list to find “Analytica Decision Engine {{#svarget:anarelease|5.4}}.” Click the Remove button and proceed through the uninstall wizard

==See Also== 

* [[Installing ADE in a Docker image]]


{| style="margin: 1em auto 1em auto;width: 100%;border:0;table-layout: fixed;" cellpadding=5
|- style="text-align: center"
| [[Introduction to ADE]] <- || [[Installation of ADE]] || -> [[The ADE Tutorial]]
|}
</translate>

Analytica Cloud Platform (ACP)

2024-01-25T12:52:50Z

Dpaine+25deca:

[[Category:Analytica User Guide]]
[[Category: Analytica Cloud Platform]]
<breadcrumbs>Analytica User Guide > User Interfaces for End Users> {{PAGENAME}}</breadcrumbs>

You can rapidly make an Analytica model available via a web browser by publishing it to the [[Analytica Cloud Platform]] (ACP) hosted by [http://acp.analytica.com Lumina]. Your collaborators and end users can then view and run the model on the web. They don't have to install Analytica or any other software on their computer other than a web browser. They can access it from non-Windows computers. After you upload your model to ACP, you can simply email your end-users an invitation with a URL link to view the model.

'''ACP individual account''': Every copy of Analytica comes with a free ACP account. You get 25 free sessions with [[Analytica Free Edition]] or Analytica with expired support. If you have a paid Analytica license with active support, you get 25 user sessions per month. You can always buy more session credits [https://analytica.com/purchase-analytica/ online].

'''ACP Group Plan''' enables a group of modelers to collaborate, share models, and provide them to end users. As a member of a Group Plan, you can save changes to model inputs as a snapshot so that you can modify and run it over multiple sessions. You can organize models into '''Project Directories'''. Group members may have different levels of access for each Project Directory: '''Reviewer access''' lets you run models; '''Author access''' lets you upload or edit models; '''Manager access''' lets you add new members or modify their access. '''Admin access''' is a Manager, which can also add or delete projects, and delete users.

'''ACP Premium Group Plan''' allows more members, more sessions, more CPU time per session, and supports models that use the [[Analytica Optimizer Guide|Optimizer]]. To see prices or buy a Group Plan, see [https://analytica.com/purchase-analytica/ Analytica.com].

==Upload to ACP==

To publish a model to ACP, open the model in Analytica, then select [[File menu|File]] → '''Publish to cloud...'''.

If you already have an ACP account set up, it shows this dialog with the '''Publish model''' tab (see below to Set up an account):

:[[File:Chapter9_23.png]]

You can optionally change ACP model name from your local file name -- useful if you want to keep several local file revisions, or want to publish different revisions. When you press '''Publish''', it uploads the model to the ACP server. You have three options for what happens once the upload completes:

* Open ACP model folder page
* Open model in ACP
* Do nothing

Opening the model in ACP consumes a session credit, while viewing the model folder page does not. From the folder page, you have the option of launching the model.

You can also jump to the ACP model folder page by selecting [[File menu|File]] → '''Manage published models...'''.

'''To Set up an ACP account''': The first time you select '''Publish to cloud...''', it opens the dialog showing the '''Configure account '''tab.

:[[File:Chapter9_24.png]]

Click the [https://www.analyticacloud.com/acp/Signup/acpIndividualSignup.aspx sign up] link for a free ACP individual account in a web browser. You will get account information to enter in this dialog. Then press '''OK'''. For detailed steps on signing up for an ACP account, see [[Tutorial: Sharing a model with ACP#Analytica_Cloud_Platform_.28ACP.29|Analytica Cloud Platform (ACP)]] in the [[Analytica Tutorial]].

== Designing models for ACP ==

You can upload and run any Analytica model via a web browser with ACP. But, here are some guidelines to design a user interface to work well as a web application. ACP also offers some user interface options not yet available in Analytica on the desktop, such as a tab-based interface, where each module in the main model is accessible via a tab.

'''Limit computation times''': People expect each operation in a web application to complete quickly. When operations take more than a minute or so, users may give up and leave the page. Normally, ACP enforces a 60 second maximum compute time for each step. (If you have an ACP Group Account, you can modify this.) The Lumina-hosted ACP server is shared by many users. It is not a super computer, and is not intended for computationally intensive models.

'''Use small diagrams''': Even people with large screens often narrower web browser windows. We recommend that you don't design a web app that needs more than 1200 pixels wide. ACP shows scroll bars if the window is wider than fits in the browser window, but that doesn't make for a great user experience. You can achieve this by organizing a large model into a hierarchy of modules, each with not more than about 20 nodes.

'''Single window design''': Analytica on the desktop lets you have multiple windows open simultaneously, side-by-side or overlapping. This gives lots of flexibility to display and arrange information. ACP shows only a single diagram (or result or object view), plus an Outline view on the left -- and you can expand a view in ACP by [[Embed table or graph with ACP | embedding tables and graphs in a diagram]] using Tall nodes or Frame nodes.

'''Navigation styles''': ACP provides some [[ACP Style Library#Navigation styles| layout options]] that are not (yet) available in Analytica. These include tabbed module navigation, embedded tables and graphs, an outline tree or hierarchy header, control over what surrounding interface components display, and visual styles for diagram nodes.

:[[File:Chapter9_25a.png|600px]]

The full set of layout options and how to specify the settings are beyond the scope of this manual. The reference guide for these is on the Analytica Docs, see [[AcpStyles]], [[ACP Rendering tables and graphs on the diagram]], and [https://docs.analytica.com/index.php?title=What%27s_new_in_ACP%3F What's new in ACP].

'''ACP Style Library''' '''makes it easy '''to select most navigation options and display settings in ACP. The Style Library is packaged as an Analytica library file, which you add to your model, then access the control panels by opening the library diagrams from within Analytica.

You can make use of the styles without using the Style Library. Styles are specified in the AcpStyles attribute, as described at [[AcpStyles]]. However, the Style Library makes these far easier to use.

See also the instructions for obtaining the latest version of the [[ACP Style Library]], and for using it.

<iframe width="560" height="315" src="https://www.youtube.com/embed/uUAk4TwrOAw" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

==Summary==
'''Analytica Cloud Platform''' (ACP) is a convenient way to share models over the internet, and is usable by people who have not installed any edition of Analytica, as well as people on non-Window’s platforms. ACP accounts are free, and a moderate level of usage is free as long as you keep your support active.

When sharing models from the Cloud Platform, additional stylistic considerations are important for providing users of your model with a satisfactory browser-based experience. These include limiting evaluation times, keeping diagrams small, and making effective use of diagram real estate through embedded tables and graphs, tabbed panes and hierarchy headers. The Style Library provides an interface for selecting ACP styles.

==See Also==
* [[Analytica Cloud Platform]] More in-depth information.
* [[Tutorial: Sharing a model with ACP]]
* [[Model Licensing]]
* [[Editions of Analytica]]
* [[What's new in ACP?]]
* [[ACP Style Library]]
* [[AcpStyles]]

<footer>User Interfaces for End Users / {{PAGENAME}} / Arrays and Indexes</footer>

CAEngine::ErrorCode

2024-01-25T12:46:28Z

Dpaine+25deca:

[[Category:ADE Methods and Properties]]
[[Category:ADE User Guide]]
[[Category: Error messages]]

[[ADE User Guide]] > [[ADE Server Class Reference]] > [[CAEngine]]
<languages />
<translate>

= {get} int ErrorCode = 


Returns the error code generated by the last communication with the Analytica Decision Engine
Server. The property ErrorCode should be checked after setting and retrieving critical [[CAEngine]]
properties and calling [[CAEngine]] methods. An ErrorCode of zero indicates the last action was
successful.

= Data type = 


:integer

= Access = 


:read

= Usage = 


Dim x As Integer
x = ADE.ErrorCode

= Error Codes = 
{| style="text-align:left;align:top"
!0
| OK
|-
!1
| Unimplemented
|-
!2
| Warning
|-
!3
| Lexical error
|-
!4
| Statement error
|-
!5
| Expression error
|-
!6
| Execution error
|-
!7
| System error
|-
!8
| Fatal error
|-
!9
| Undefined variable error
|-
!10
| Aborted
|-
!11
| Analytica expired -- contact Lumina
|-
!12
| Insufficient Memory
|-
!13
|
|-
!14
|
|-
!15
|
|-
!16
|
|-
!17
|
|-
!18
|
|-
!19
|
|-
!20
| Analytica is uninitialized
|-
!21
| Bad parameter passed
|-
!22
| Value not found in index
|-
!23
| Illegal position in index
|-
!24
| Subscripts must be an array of variants
|-
!25
| Subscript cannot be accessed
|-
!26
| Lower bound of subscript array inaccessible
|-
!27
| Upper bound of subscript array inaccessible
|-
!28
| Must specify at least one element in table
|-
!29
| Position specified is out of bounds
|-
!30
| Position does not exist
|-
!31
| Illegal position specified in table
|-
!32
| Index object not found
|-
!33
| Illegal index number specified
|-
!34
| Definition table not found
|-
!35
| Attribute could not be retrieved
|-
!36
| Attribute could not be set
|-
!37
| Could not retrieve result
|-
!38
| Could not get result table
|-
!39
| Module/Model/Script could not be found
|-
!40
| Object could not be created
|-
!41
| Invalid name for object
|-
!42
| Object name already in use
|-
!43
| Current module could not be retrieved
|-
!44
| Module could not be set
|-
!45
| Model could not be created
|-
!46
| Model/Module could not be saved
|-
!47
| Illegal command
|-
!48
| Invalid object class
|-
!49
| There is no model in memory to save
|-
!50
| Safe-array has incorrect size or number of dimensions
|-
!51
| Element position is non-numeric
|-
!52
| Specified name is not an index of the array
|-
!53
| Insufficient memory
|-
!54
| Unrecognized MIME type
|-
!55
| Value is not atomic
|-
!56
| Operation allowed only on a result CATable, not on a definition table
|-
!57
| First param is not an IStream*
|-
!58
| Subscript array contains the wrong number of elements. There should be one element for each dimension.
|-
!59
| CATable is not associated with an object, so it cannot be updated
|-
!60
| A result table is read-only
|-
!61
| Expression could not be parsed
|-
!62
| Error evaluating expression
|-
!63
| GraphWidth and GraphHeight must be positive.
|-
!64
| Value is atomic (not an array). To get value, use AtomicValue method.
|-
!65
| Index value could not be computed
|-
!66
| No picture stored with object
|-
!67
| Internal picture format not supported
|-
!68
| Filename too long
|-
!69
| Result cannot be graphed.
|-
!70
| Definition is Hidden
|-
!71
| The maximum number of CAEngine instances allowed by license are already in use.
|-
!72
| Invalid license code
|-
!73
| Stale license code
|-
!74
| Expired license code
|-
!75
| No ADE license code is present. Re-install ADE.
|-
!76
| Not an application license code.
|-
!77
| Method Evaluation Time Limit exceeded
|-
!78
| Computation aborted
|-
!79
| License Code is not valid for this computer. If the hardware or network configuration of your computer has changed, you will need to re-enter a fresh license code. Run ""ADE.EXE /RegServer"" to re-enter. and visit http://analytica.com/ana/staleLicense.htm to freshen a stale license code.
|-
!80
| Linked module not found
|-
!81
| License code is not valid for 64-bit edition
|-
!82
| Must include at least one index to CreateDefTable
|-
!83
| Operation allowed only on a definition table, not a result table
|-
!84
| The license for ADE is not valid for this computer
|-
|}

= See Also = 


* [[CAEngine::ErrorText]]
* [[Analytica Decision Engine (ADE) API]]
</translate>