Difference between revisions of "Analytica Cloud Platform (ACP)"
 
(53 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
[[Category:Analytica User Guide]]
 
[[Category:Analytica User Guide]]
−
<breadcrumbs>Analytica User Guide > Creating Interfaces for End Users > {{PAGENAME}}</breadcrumbs>
+
[[Category: Analytica Cloud Platform]]
 +
<breadcrumbs>Analytica User Guide > User Interfaces for End Users> {{PAGENAME}}</breadcrumbs>
 +
<br>
 +
You can make an Analytica model accessible via a web browser in a few seconds by publishing it to the [[Analytica Cloud Platform]] (ACP).
 +
<br><br>
 +
Collaborators and end users can then view and run the model on the web. Key advantages of ACP are that:
 +
* End users don't have to install Analytica or any other software on their computer, and can access it from non-Windows computers.
 +
* They can modify inputs to define their own scenarios and generate result tables and graphs.
 +
* 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 Account types==
  
−
By publishing your model directly to the [[Analytica Cloud Player]] (ACP), you eliminate the need for your end-users to install Analytica on their computer before viewing your model. This also makes it possible for users on non-Windows platforms to use and view your model. The model is uploaded directly to Lumina’s Cloud server, and you simply send your end-users an invitation to view your model with a URL link to access the model.
+
Every copy of Analytica on the desktop comes with a free ACP account. We offer these kinds of ACP accounts:
  
−
'''ACP account types''': Signing up for an ''ACP individual account ''is free. You can upload models to your account at any time, and as long as your Analytica support is active, your account allows 25 user sessions per month at no cost1. You also receive 25 sessions credits to be used in the first 12 months when you sign up for an ACP individual account, even if you do not have active support. If you foresee higher user loads, you can pre-purchase additional session credits.
+
* '''ACP individual 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 buy more session credits [https://analytica.com/purchase-analytica/ online].  
  
−
''ACP group accounts ''are also available, and are appropriate for collaborative projects and higher usage situations. Group accounts include the ability for end-users to save changes to inputs in snapshot files, to manage multiple users and multiple projects, and to control access permissions to different models. Group accounts involve a monthly or annual subscription cost, and include a high level of user sessions.
+
* '''ACP Group Plan''' lets a group of up  to 5 modelers 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.
  
−
For further information on ACP accounts types, please visit http://www.lumina.com/products/analytica-cloud-player/
+
* '''ACP Premium Group Plan''' extends the basic Group Plan up to 12 users, more sessions, more CPU time per session, and supports models that use the [[Analytica Optimizer Guide|Optimizer]].
  
−
'''Uploading / Publishing''': To publish a model to ACP, open the model in Analytica, then select '''File &rarr; Publish to cloud...'''.
+
* '''ACP Server license''' lets you install ACP on a dedicated server for your organization. The number of users, sessions, and computational time is limited only by the configuration of your server. A dedicated ACP Server can provide a higher level of security for sensitive data and models.
  
−
If you already have an ACP account set up, the following dialog appears:
+
To see prices or buy a Group Plan, see [https://analytica.com/purchase-analytica/ Analytica.com].
  
−
[[File:Chapter9_23.png]]
+
==Publish to ACP==
  
−
The ACP model name may optionally be different from your local file name, which you may take advantage of if you keep multiple local file revisions, or conversely want to publish different revisions. When you press '''Publish''', the model is uploaded to the cloud. You have three options for what happens once the upload completes:
+
To publish a model to ACP, open the model in Analytica, then select [[File menu|File]] &rarr; '''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 ACP model folder page
Line 25: Line 44:
 
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.
 
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 &rarr; Manage published models...'''.
+
You can also jump to the ACP model folder page by selecting [[File menu|File]] &rarr; '''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.
  
−
'''Setting up an ACP account''': The first time you select '''Publish to cloud...''', the dialog will open in the '''Configure account '''tab.
+
:[[File:Chapter9_24.png]]
  
−
[[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]].
  
−
If you do not already have an account, click the [https://www.analyticacloud.com/acp/Signup/acpIndividualSignup.aspx sign up] link to sign up for a free ACP individual account. Once you have an ACP account, enter your account information and press '''OK'''. For detailed steps on signing up for an ACP account, please see Chapter 8 of the Analytica Tutorial.
+
== Designing models for ACP ==
  
−
== Designing models for viewing in web browsers ==
+
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.
−
Some models are ill-suited for use from a web browser. When you create your model with the intention of eventually publishing it to [[Using Analytica Cloud Player|Cloud Player]], keeping certain stylistic and pragmatic considerations in mind can help you achieve a more effective presentation once the model is published. ACP also exposes several style settings that are not yet available in Analytica itself, many of which are very helpful for optimizing the browser-based experience.
 
  
−
'''Limit computation times''': People expect each operation in a web application to complete quickly. When operations take more than about 60 seconds, users will typically leave or close the page. ACP itself enforces a 60 second maximum duration on any single computational step (you can configure this maximum in an ACP group account, even though it isn’t highly recommended for these stylistic reasons). Models that inherently involve multi-minute computations or longer are not well-suited for publishing on the Cloud.
+
'''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.  
  
−
The ACP server is not a super computer, and is not intended for the evaluation of computationally excessive models. The server(s) are shared by all ACP users.
+
'''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.
  
−
'''Use small diagrams''': Even people with huge monitors make use of narrow web browser windows. A standard guideline is that web-apps should be a maximum of 800 pixels in width to display fully in the browser window. While ACP does not limit the actual displayed diagram size (scroll bars appear when required), you should keep diagrams within this size range to eliminate the need for users to scroll when viewing your diagrams.
+
'''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.  
  
−
Achieving small diagrams usually translates to keeping influence diagrams to 15 nodes or less, not exceeding 5 nodes wide. For input/output panels, limit these to two columns. It is also desirable to limit the length of diagrams and input/output panels similarly so that they be fully visible without scrolling for most users. These guidelines are highly recommended even when models will not be viewed on the web, since they also correspond to the amount of visual information the human brain can assimilate holistically in a glance.
+
'''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.
  
−
To attain small diagrams, you should make use of modules to structure your models hierarchically. Each module should “tell” a small self-contained story. The default ACP presentation includes a outliner bar along the left side of the screen (which you can disable using an ACP style setting, if desired). Although this consumes some valuable screen width, it helps to make the module hierarchy more visible and accessible, and thus help you feel more comfortable with keeping each module small.
+
:[[File:Chapter9_25a.png|600px]]
  
−
'''Single window design''': Desktop Analytica uses a Multiple Document Interface (MDI) paradigm, in which you can have multiple windows open simultaneously, side-by-side or overlapping. This provides a tremendous flexibility to display many items of information simultaneously in flexible arrangements, with other information close at hand. However, ACP model users view one diagram, one result, or one table at a time. It thus becomes important to cluster information that is intended to be viewed together within the same diagram. Make use of ACP layout to help accomplish this.
+
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].
  
−
'''Utilize layout styles''': ACP provides several layout options that are not yet available in Analytica 4.6. These include tabbed module navigation, embedded tables and graphs, re-usable embedded space for result views, an outline tree or hierarchy header, control over what surrounding interface components display, and additional control over node-level appearance.
+
'''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.
  
−
[[File:Chapter9_25.png]]
+
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.
  
−
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 Wiki, see [http://wiki.lumina.com/index.php/CloudPlayerStyles_Attribute_Values CloudPlayerStyles attribute values], [http://wiki.lumina.com/index.php/ACP_Rendering_tables_and_graphs_on_the_diagram ACP rendering tables and graphs on the diagram], and [http://wiki.lumina.com/index.php/Analytica_Cloud_Player#Features_of_ACP_not_available_in_Analytica Features of ACP not available in Analytica].
+
See also the instructions for obtaining the latest version of the [[ACP Style Library]], and for using it.
  
−
'''Use the Style Library''': The ACP Style Library is a tool you can use when defining the ACP styles. It provides a set of control panels to select options with immediate preview displays to help you understand what each setting does. 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.
+
<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>
  
−
You can make use of the styles without using the Style Library. Styles are specified in the Cloud Player Styles attribute, as described at CloudPlayerStyles attribute values. However, the Style Library makes these far easier to use.
+
==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.
  
−
Instructions for obtaining the latest version of the ACP Style Library, and for using it, are located on the Analytica Wiki at http://wiki.lumina.com/index.php/ACP_Style_Library.
+
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]]
  
  
−
==See Also==
+
<footer>User Interfaces for End Users / {{PAGENAME}} / Arrays and Indexes</footer>
−
*[[Analytica Cloud Player]]
 
−
<footer>Analytica Free 101 / {{PAGENAME}} / Using Expressions</footer>
 

Latest revision as of 21:24, 7 May 2024

Analytica User GuideUser Interfaces for End UsersAnalytica Cloud Platform (ACP)


You can make an Analytica model accessible via a web browser in a few seconds by publishing it to the Analytica Cloud Platform (ACP).

Collaborators and end users can then view and run the model on the web. Key advantages of ACP are that:

  • End users don't have to install Analytica or any other software on their computer, and can access it from non-Windows computers.
  • They can modify inputs to define their own scenarios and generate result tables and graphs.
  • 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 Account types

Every copy of Analytica on the desktop comes with a free ACP account. We offer these kinds of ACP accounts:

  • ACP individual 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 buy more session credits online.
  • ACP Group Plan lets a group of up to 5 modelers 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 extends the basic Group Plan up to 12 users, more sessions, more CPU time per session, and supports models that use the Optimizer.
  • ACP Server license lets you install ACP on a dedicated server for your organization. The number of users, sessions, and computational time is limited only by the configuration of your server. A dedicated ACP Server can provide a higher level of security for sensitive data and models.

To see prices or buy a Group Plan, see Analytica.com.

Publish to ACP

To publish a model to ACP, open the model in Analytica, then select 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):

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 → 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.

Chapter9 24.png

Click the 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 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 embedding tables and graphs in a diagram using Tall nodes or Frame nodes.

Navigation styles: ACP provides some 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.

Chapter9 25a.png

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 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.

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


User Interfaces for End UsersAnalytica Cloud Platform (ACP)Arrays and Indexes
Comments


You are not allowed to post comments.