Analytica Docs - User contributions [en]

ACP Style Library

2021-03-04T21:54:11Z

Davidpaine:

[[Category: Analytica Cloud Player]]

The [[Analytica Cloud Player]] (ACP) offers a variety of user-interface styles and features useful for web applications, and not available in desktop Analytica. These include navigation styles with tabs across the top or down the left side, node styles, and Frame nodes to show tables and graphs embedded in a Diagram. The '''ACP Style Library''' helps you select these user-interface styles and options in Analytica on the desktop. You could specify these styles by setting flags and codes in the [[CloudPlayerStyles]] attributes of the model. But it's much easier just to use the ACP Style library. That way you don't have to learn these special codes.

You can see a video of the ACP Style library in use in the [https://youtu.be/OH3mYa_m0xE Analytica Cloud Player (ACP) Webinar].

=== How to install the ACP Style library ===
-

The simplest way to add the ACP Style library is to load it from the standard Analytica libraries:

You can also download the latest version of the ACP style library from here: [[Media:ACP style library.ana]], which includes some more recent [[What's new in ACP?|enhancements to ACP]].

# Make sure you are in edit mode.
# Click [[File menu]] > '''Add Library...'''
# The file explorer lists the standard Libraries installed. Select '''ACP Style Library.ANA''' and click '''Open''':

:[[File:Add library01.PNG]]

It adds the 'ACP Style library' to the diagram:

:[[File:Add styles library01.PNG]]

=== How to use the ACP Style library ===

After installing the library into your model, double-click the '''ACP Style library''' node to view its main control panel:

:[[File:Open Styles Library01.png]]

Click one of these buttons to open a dialog to select those styles and options:
* [[#Navigation styles]]: For tab styles, expandable module outline, window size, and other options to navigate the model in ACP.
* [[#Node styles]]:For styles to display nodes, balloon help.
* [[#Frame nodes]]: To select text nodes that display edit and result tables and graphs embedded in a user-interface diagram.
See below for details on each dialog.

=== Set ACP styles in Analytica, and view them in ACP ===
You use the '''ACP Style library''' to set styles in Analytica on the desktop, but you can only see their effect in ACP. (The ACP Style library does show some examples of what the styles look like.) After setting some ACP styles, you can see their full effect by uploading your model into ACP. You can do this quickly by selecting '''Publish to cloud...''' from the '''File''' menu. It lets you upload and run the model in your free individual ACP account, or in an [[ACP Group Accounts|ACP Group account]] if you have one.

The library is invisible in ACP. Once you have selected the ACP styles you want, you can delete the ACP Styles Library from your model. Your selections model will remain. Tthe library file size is over 1 MB, so removing it from your model saves a little time when uploading and running the model in ACP.

==Navigation styles==

This dialog lets you configure the navigation style using the outline view, hierarchy header as in Analytica, or tabs across the top or down the left. You can also control the display of some elements such as those in the banner shown above the diagram. Click the '''Navigation styles''' button to get started.

[[File:NavStyleButton01.png]]

The Navigation styles dialogue window opens...

:[[File:Navstyle pane01.png]]

The '''Navigation style''' pulldown menu selects ways to navigate the model: The '''Preview''' pane beneath the menus shows an example ACP interface with the options you have selected:
:[[File:Navstyle01.png]]

The '''Navigation style''' options are:

* '''Outline''': With an expandable module hierarchy (see example below) that lets you quickly find the module you want to see, similar to the [[Outline window]] in Analytica on the desktop.
:[[File:Outline01.png]]

* '''Top diagram only''': Shows in ACP as a single diagram, with no Outline or hierarchy or tabs. This is useful when creating a simple Web application with a single UI, and no need for any navigation. Prevents opening other diagrams with the '''[https://wiki.analytica.com/index.php?title=CloudPlayerStyles_Attribute_Values#Display_Only_a_Single_Diagram top_diagram_only:yes]'''. flag You need to arrange, and size the diagram to display what you want users to see in ACP.

'''Tabbed Navigation''' styles: These show the main modules in your top model as tabs (ordered left to right then top to bottom). It is most useful for creating a web application for people not familiar with Analytica. It works best when you create a few modules at the top level with user inputs and outputs, showing input tables and result tables and charts in [[#Frame nodes]]. The Navigation style menu offers these options:

'''Single level tabs''':

* '''Top tabs''': Display the tabs left to right across the top of the diagram. For example:

:[[File:ACP Tabs across top01.png]]

* Side tabs: Display the tabs in a column on the left of the diagram. For example:

:[[File:ACP Tabs down left01.png]]

'''Two-level hierarchical tabs''' : Modules in the main model appear as top tabs (left tabs). Modules in those top level modules appear as subtabs. When you select a top-level tab, it shows its submodules as subtabs.

*Two top tabs
*Two side tabs

'''Other Navigation Options''' In the top pane of the Navigation style dialog:

''These next two checkboxes are unusable - and so are hidden - when you have not selected a tabbed Navigation style.''

*'''Include top level diagram as tab:''' Can be used only with 'Side tabs' or 'Top tabs'. You may check this checkbox to include the top model diagram as the leftmost tab for "Side tabs", or top tab for "Top tabs". If you uncheck this checkbox, the top diagram will not display in ACP, so you include the key user interface pages as modules in the main model. Currently for 2 level tabs it is required to exclude the top diagram from the tabs, so this checkbox is hidden. [[CloudPlayerStyles_Attribute_Values#Exclude_the_top_level_diagram_from_tabs| More...]]

:[[File:Show as tab01.png]]

*'''Show hierarchy''': Lists the titles of the top, ancestor, parent, and current modules to show where you are in a model (see example below). You can click any ancestor to move up the module hierarchy, similar to the [[Show module hierarchy]] in Analytica on the desktop. Note that, to save screen space, the hierarchy does not display when it would be redundant, showing the same information displayed on the top tabs or side tabs, i.e. in the top levels of the model. The Show Hierarchy style is controlled by a checkbox in the Edit menu's preferences dialog in Desktop Analytica. Both the Hierarchy and the outline tree will show if this preference is checked, but the Styles library will turn this preference off if you select '''Outline''' style, since it duplicates the information on the outline. For the '''Top diagram only''' style there is no need for the hierarchy.
:[[File:Show hierarchy01.png]]

*'''Minimum resolution''': The resolution in pixels of the smallest screen that your end users may have. ACP uses a fixed browser window size (canvas) for all Diagrams (tabs), unlike Analytica on the desktop that lets you have a different window size for each one. It's important to select a size that works well for all users, even on laptops with smaller screens. When you select a minimum resolution for the screen, it automatically resizes the main Diagram size in the desktop so that it will work well in ACP. The actual diagram size will be smaller than the screen resolution to allow for space for the web browser controls, menus, and tabs at the top, and window edges and scroll bars that take a little space on the sides and bottom.

:[[ACP_Diagram_Sizes#Diagram_Size_in_the_ACP_Style_Library|More...]] 
:[[File:Min res01.png]]

===ACP Navigation options===

In this bottom section of the ACP Navigation styles, you can control how the banner area above your diagram appears and whether or not to add scroll bars. To simplify the process of setting the styles, these checkboxes are hidden if you have selected an incompatible Navigation style in the top pane.

:[[File:Navigation checkboxes01.png]]
====Banner logo and tabs====
Unchecking the 'Banner logo and tabs' hides the banner space usually present at the top of ACP. The banner typically contains the Lumina Logo, the '''Parent Diagram''' button, tabs, '''Close Model''' button, and '''Save''' button.

:[[File:Styles library 16.png]]

====Parent button====
Flag to control the display of the '''Go into Parent''' button. Currently the button is shown by default with Outline style. The checkbox is hidden in other styles. It is possible to display this button with top tabs, but not by using the styles library, since there are some model specific settings involved. [[CloudPlayerStyles_Attribute_Values#Go_into_Parent_Button Not compatible with Side tabs. | More...]]

:[[File:Styles library 17.png]]

====Toolbar tabs====

By clearing this checkbox, you can remove the default ACP tabs that appear at the top of ACP. These are the tabs with titles like "Diagram", "Object", "Edit Table", "Table", "Graph"... Toolbar tabs are compatible only with 'Outline' style. They will not show if the model title is shown, since they would tend to overlap.

:[[File:Styles library 18.png]]

====Use Top diagram size for all windows====
Sets the size of all diagrams based on the size of the diagram window of the top level when the model was last viewed in Desktop Analytica (in non-maximized mode). This is mandatory in all but 'Outline' style.

====Model title====
Shows the title of the model at the top to the right of the Lumina (or other) logo. Note that if you check this the toolbar tabs will not show, because the tabs and title would overlap,

:[[file:Styles library 19.png]]

===Diagram title===
You can control whether or not to display the diagram's title at the top of the diagram. Only usable with 'Outline' style. (And the preference for showing the model hierarchy needs to be turned off as explained above, ).

:[[file:styles library 20.png]]

====Auto calc====
Checking this causes ACP to calculate any result (table or graph) as it displays a diagram window containing the result, and to immediately recalculate any result when the user changes an input on that diagram that affects the result. (It combines Calculate on open and Auto recalc results.) This behavior is unlike Analytica which does not usually calculate results until the user asks for them by clicking the Calc button.

====Add Scroll bars====
When checked, ACP adds scroll bars if needed to be able to see the entire diagram. When unchecked, the diagram will be either the top diagram size if this flag is set, or the canvas size.

'''Once you have the navigation styles set the way you want, click '''Close'''. This will close the Navigation panel and take you back to the Main ACP Style Library diagram. '''

:[[File:CloseNavstyles01.png]]

==Node styles==

The Node styles dialog lets you configure how nodes are displayed including bevels and shadows. You can specify the style for highlighting when you move the mouse over a node, and whether to show [[Help balloons|balloon help]] with a description for each node.

:[[File:Nodestyledialog01.png]]

===Node effect on mouse-over===
Select a highlighting effect for nodes when you move the cursor over the node. The default setting is 'Outline', with 'Glow' and 'None' as the other choices. As you select an effect from the pulldown menu a preview is shown.

:[[File:ACP Effect on mouseover01.PNG]]

===Node edge appearance===
In this pane, the 2 checkboxes set flags controlling the appearance of the edge of the nodes. Bevels adds a 3 d bevel to the node. Shadows adds a drop shadow effect. You can select either of these effects or both.

:[[File:ACP Node edge appearance01.PNG]]

===Balloon help===
This pane has two checkboxes to set whether the identifier and/or the definition is also shown in the [[Help balloons|balloon]], and a pulldown menu which sets the delay before a balloon appears.

By default, ACP displays the description - if any - the units, and the title of an object in a balloon as you place the mouse over it. If there is no description the balloon will not appear.

:[[File:Default Balloon wiki071212.PNG]]

'''Identifier in balloon.''' This can be useful when a node is titled 'Net present value' and has an identifier <code>Npv</code> for example.

:[[File:Id in balloon wiki071212.PNG]]

'''Definition in balloon.''' When checked, it shows the Definition of a variable in the balloon when you move the mouse cursor over its node.

:[[File:Def in Balloon wiki071212.PNG]]

'''Both Definition and Identifier boxes checked'''

:[[File:Def id in balloon wiki071212.PNG]]

'''Balloon delay''' When you mouse over a node, there's a short delay of about half a second before it displays the balloon (to prevent wild balloon appearance when you move the cursor rapidly over a diagram.) You can tweak this delay time measured in seconds.

:[[File:Balloon delay wiki 071212.PNG]]

===Uncertainty icon in outputs===
Analytica normally shows, just to the right of an output node, a little icon indicating the uncertainty view last displayed e.g. [[mid]], [[mean]], [[ProbBands]], [[pdf]] ...

You can suppress these icons. This might be desirable, for instance, if your model is not probabilistic.

:[[file:styles library 27.png]]

===Flash buttons===
For button nodes, instead of drawing a button that looks like a button node in desktop Analytica, use a Flash button. A Flash button component looks and feels a little bit more like a GUI button used in software applications.

If you are building a web application which uses '''Submit''' or other buttons, you might find it looks better using the Flash button component rather than a traditional Analytica button node.

However, if you are using multi-line text or have images embedded in any of the button nodes, then you should not use Flash Buttons since they don't support these features.

:[[File:Styles library 28.png]]

'''*Once you have the Node styles set remember to click 'done'. This will apply the node style attributes you have selected to the model and return you to the ACP Style Library diagram'''

:[[File:Nodestyleclose01.png]]

==Frame nodes==

:[[File:Styles library 05.png]]

:[[File:Styles library 08.png]]

'''What is a frame node?'''
If you are creating a Web Application which does not use the toolbar tabs, then you probably will want to display tables and graphs on the influence diagram. You can specify the location and size of the tables and graphs on the diagram using a Frame node. A module frame node is just a text node in a module that one tells ACP to use as the location for displaying tables and graphs in that module.

These are used with Web Application navigation styles where the toolbar tabs are not present. If you are not using one of the Web Application navigation styles, then you can skip this step.

'''How to make a text node be a frame node'''

First, create a text node in the module you want to display tables and graphs. Here is a Model with a text node on the top diagram.

:[[file:Styles library 30.png]]

===Select frame===

*In the Frame Nodes control panel, select the module where the text node is located from the 'Select module' pulldown menu.

*Select the frame node's identifier from the 'Select frame node' pulldown menu.
''(If the text node is newly added to the model, it may not be listed if this variable has not been 'dirtied'. If it is not listed, you need to click the refresh button.)''

:[[File:Styles library 29.png]]

*Once you have the correct node selected, then check "Use as a module frame node".

:[[File:Use as frame node 071212.PNG]]

Once you check this checkbox the options in the field below will be displayed and enabled..

:[[File:Set Frame node01 071212.PNG]]

===Select frame node styles===

'''Index Menus''' Controls the display of the Index pulldown menus on the diagram. Unchecked by default, since this saves diagram space, and it is assumed that a modeller will usually choose how he wants people to view the orientation and dimensions of a table/graph in his model on the web. If you want people to be able to view and use these menus in ACP, check this box.

:[[File:Index menu no 0071212.PNG]][[File:Index menu yes 0071212.PNG]]

'''Title''' This checkbox controls whether or not the title of the node is shown above the table or graph on the diagram.

'''Description''' This checkbox controls whether or not the description of the node is shown above the table or graph on the diagram.

'''Description length''' Length of description of variable as a percent of Frame height. Not enabled if the 'description' check box is unchecked. If the Description is too long to fit the allotted space, it will be truncated and a scroll bar will be used to view the entire description. (This feature will only display correctly if you have made the frame node large enough to accommodate the scroll bar within the allotted space).

:[[File:Descr 50 071212.PNG]]

'''Table and or graph''' When the results of a node are shown, you have the following options, to show just the graph, just the table, show both the table and the graph. If you want the table or graph to be shown based on what was viewed last in Analytica, you can choose 'As saved in Analytica'.

For edit tables, the table will always be displayed regardless of this setting.

:[[File:Table over graph 071212.PNG]]

Once you have chosen the settings for your frame node, you can make another frame node, either in a different module or in the same module. If there is more than one Frame, each time you click on a node, it will show its table or graph in the Frame whose contents was displayed the longest ago. Thus, as you click on different nodes, it cycles through the Frames. In this way, you can see and compare edit tables or results from multiple nodes -- all in the same diagram window.

Click '''Done''' when your settings are complete.

==See Also==
* [[Media:ACP style library.ana|ACP style library.ana]]
* [[CloudPlayerStyles Attribute Values|CloudPlayerStyles attribute]]
* [https://youtu.be/OH3mYa_m0xE Analytica Cloud Player (ACP) Webinar]
* [[Analytica Cloud Player]]

File:Edit Tables Test model.ana

2019-01-23T06:38:10Z

Davidpaine: Davidpaine uploaded a new version of File:Edit Tables Test model.ana

File:Edit Tables Test model.ana

2019-01-22T07:29:27Z

Davidpaine: Davidpaine uploaded a new version of File:Edit Tables Test model.ana

Defining Utility as a deterministic table

2019-01-21T08:16:33Z

Davidpaine:

[[Category: Party Problem model]]
[[Category: Definitions]]

*Double click on ‘Utility’ to bring up its object window
*Click on the Units field, type ‘$’.
*Press tab key to get to get to Description field.
*Type ‘The utility, or value to me, given party location and weather outcome, assigned in dollars.’
*Open pulldown menu of expression.
*Select Other

:[[Image:Object Utility.jpg]]

'''Expected: Object finder window should appear'''

:[[Image:Object LibraryJPG.jpg]]

*Click Library popup menu, select array -> Table Functions
:[[Image: Object array.png]]

*Scroll down on the main window and select ‘Determtable()’.
*Click ‘indexes’ button.
Indexes window should appear
*Select Party Location and Weather as your indexes

:[[Image:Object finder indexes.jpg]]

*Click ‘ok’ button.

:[[Image:Indexes P.L.W.jpg]]

*Click ‘ok’ on the Object finder window.

'''Expected: Determ edit table should appear.'''
*If necessary, change the row index to 'Party location' and the columns Domain of weather.
*Click on column Sunny, row header Outdoor.
*Change 0 To 100
*Arrow down
*Replace o to 90
*Arrow down
*Change o to 40
*Click on column header Rainy, row header Porch
*Replace 0 with 20
*Arrow down
*Replace cell value 0 with 50
*Click the green checkbox.

:[[Image:Edit table utility.jpg]]

*Press result button

'''Expected: Result table of Utility will appear with row headers, Indoors, Outdoor, Porch and cell values 0, 20,50 will show'''

*Click on the Diagram button to return to the diagram window.

==See Also==
* [[Creating the Party Problem model (based on chapter 6 of tutorial)]]
* [[Tutorial: Decision trees]]

2018-07-16T16:54:10Z

Davidpaine: /* CloudPlayerStyles Attribute values */

[[Category: Analytica Cloud Player]]
[[Analytica_Cloud_Player#See_also|<<Back to Analytica Cloud Player]]

__TOC__

This page describes recent enhancements to [[Analytica Cloud Player]] (ACP)


=Features which have been recently deployed and can be now used in ACP.=

==ADE MaxMemoryLimit for ACP==

''New to release ACP 3.0.0.35'': Maximum memory limits for different account types: 2 GB for individual, 4 GB for Group, and 8 GB for group premium.

==Stop Computing==
While ACP is computing (waiting for a result), if it takes more than 3 seconds, it shows a dialog saying "Computing..." with a "Stop" button. Clicking Stop will stop computation. While this is running, all buttons, including tabs, are disabled -
==Showwindow()==
"New to release ACP3.0.0.35." Added functionality for showing diagram windows using the new [[ShowWindow|ShowWindow()]] function. Note: Other windowType parameter options have yet to be implemented as of 3.0.0.35.

==Text node Titles==
"New to release ACP3.0.0.35." Functionality to display the title in text nodes, if the model is created In Analytica 5.0 or later. [[What%27s_new_in_Analytica_5.0%3F#Text_nodes_with_Title|Text nodes with title]].

==Node Visibility==

"New to release ACP3.0.0.35." Added support for the [[ChangeNodeVisibility]] feature. [[What%27s_new_in_Analytica_5.0%3F|(new to Desktop Analytica 5.0)]]

==Show same Table/Graph pivot as last viewed in Desktop Analytica (DTA)==

"New to release ACP3.0.0.28." Added functionality for detecting the axis' pivot saved in DTA for Edit Tables, Result Tables, and Result Graphs. Tables and graphs now display initially in ACP the same as last viewed in DTA.

==Truncate large tables==
''New to release ACP3.0.0.30.'' Because large tables take a long time to load in ACP, large tables will be truncated. If the number of rows is larger than the number of columns than the number of rows will be truncated and vice versa.

Current limits are: 
Result tables 20K cells 
Edit tables 10K cells 

==Ability to change the logo==
''New to release ACP3.0.0.16.'' In an ACP Group account, you can change the logo displayed at the top left of your model.

*Prepare an image file to use as the logo for your model. You can use png or jpg.
*Open the model in the ACP Group account.
*Right - click the Lumina logo at the top left.

[[File:Right click lumina logo.png]]

*Select Change image from the right - click menu.
(Opens a window prompting you to open an image file.)

*Then navigate to the image you want to use as the logo for this model and open it,

[[File:Select image.png]]

That's it - the image you selected will replace the Lumina logo in this model.

(If the image is larger than the space allotted on the ACP canvas, it will be resized to fit, so you may need to tweak the image dimensions to make it look the way you want it.)

==Models which use Excel Spreadsheets==
===SpreadsheetOpen()===

*Models which use data from Excel spreadsheets can be uploaded and played in ACP.
*''New to release ACP3.0.0.16:'' - Reviewers in a Group account may upload spreadsheets.
*''New to release ACP3.0.0.17:'' - Reviewers in a group account may download spreadsheets if they 'own' the spreadsheet - that is if they uploaded it.
:*The File name parameter in [[SpreadsheetOpen]] needs to be that of an Excel worksheet that has been uploaded to your ACP model listing.

*''New to release ACP3.0.0.7:'' - Ability to upload a spreadsheet file while the model is playing.

*''New to release ACP3.0.0.30':' - When evaluating a variable which calls a spreadsheet, with the show dialog: true parameter, the message has been changed.
:: Previous: Message box says, "Do you want to upload a spreadsheet contain 'variable_id'?
:: New Message: Message box says, “Do you want to upload a spreadsheet file?"[[Future_ACP_Features#SpreadsheetOpen_in_ACP|More on this...]]

===CSV files===
''New to relase ACP3.0.0.3:'' CSV files are now supported by ACP.

*You need to have the [[Analytica_Libraries_and_Templates#Flat_File_Library|Flat File library]] in your model to access the functions to read/write/parse these files.
*To access csv file data in ACP you upload the CSV file as detailed above for a spreadsheet file.

==New functionality requiring Asynchronous calls==
''Most are still in testing'' [[Future_ACP_Features#Async_calls | More...]]

*''New to release ACP3-0-0-29'' Implemented Asynchronous polling when using an [[OnClick]] attribute to save a model. When the Onclick calls functions after the Save, this speeds up the rest of the Onclick. 

*Analytica functions that generate user dialog boxes are possible now in ACP with the upgrade to Analytica Decision Engine 4.6.
*''New to release ACP3.0.0.10:'' [[Future_ACP_Features#Async_calls|Async calls]] have been implemented as the default in ACP. This means callbacks like [[MsgBox]] and [[ShowProgressBar]] bar work by default. The <code>use_asynch_calls: yes</code> [[CloudPlayerStyles Attribute Values|cloudplayerstyle]] is no longer necessary and has no effect.

===Uploading Spreadsheets while playing a model===
''New to release ACP3.0.0.7:'' [[Future_ACP_Features#SpreadsheetOpen_in_ACP | More here]]

===ReadTextFile ===
''New to release ACP3.0.0.10:'' Basically works the same as Spreadsheet open while playing a model.

[[Future_ACP_Features#SpreadsheetOpen_in_ACP | More here]]

===ShowProgressBar()===
"New to ACP3.0.0.30'' The [[ShowProgressBar]] functionality was enhanced so that behaves as in desktop Analytica (DTA). Specifically, in this build, when the 'p' parameter is greater than 1, the dialog disappears in ACP as in DTA.

===MsgBox()===
''New to ACP3.0.0.8:'' This works as in Desktop Analytica except no icon is displayed [[MsgBox]].

===AskMsgText()===
''New to ACP3.0.0.24:'' The MaxText parameter was implemented, making [[AskMsgText]] fully functional in ACP.

''New to ACP3.0.0.26:'' An enhancement to ACP's AskMsgText() functionality, The dialog adds extra lines if necessary up to 30 lines.

==CloudPlayerStyles Attribute values==

ACP styles library has been updated since the 5.1 distributed version. Download the latest library version here: [[media:ACP style library.ana]]

More information here: [[CloudPlayerStyles Attribute Values]]

===Show_table_graph_toggle:no===
<code>''New to build 3.0.0.15''</code> 
*Turns off the [[What%27s_new_in_ACP%3F#Table_.2F_Graph_toggle|table / graph toggle]] button.
Can be used as a model level flag, or (new to build 3.0.0.18) as a flag for individual variables. When used as a flag for individual nodes, it trumps the global flag, if present.

===Show_as_tab:No===
<code>''New to build 3.0.0.14''</code> 
*Add support for this cloudplayerstyles flag when using side tabs Navigation style.

===ShowIONodeButtonText: no===

<code>''New to build 3.0.0.12'' </code> 
CloudPlayerStyles</code> flag for not showing the text on input / output node buttons.
*The flag is: ShowIONodeButtonText: no
*This flag has been added to the node styles dialog of the most recent [[media:ACP style library.ana]]

===Tall Output Nodes===
''New to ACP3.0.0.4:''

CloudPlayerStyle flags are now supported in [[ACP_Rendering_tables_and_graphs_on_the_diagram#Tall_input_and_output_nodes|'Tall' Output Nodes]] to show embedded result graphs or tables on the diagram.

===Flags for controlling the Tab color====
''New to 3.0.0.20: ''
When using Tabbed Navigation, you can use these flags to control how the color of the tabs display on your model in ACP. To use, add one of them to the CloudPlayerStyle attribute of the top level diagram of your model. They have no effect if added to a module other than the top diagram.

*'''<code>Tab_color: Default </code>''' The default. Non-selected tabs are all blue white. Selected tab matches the background color.
*'''<code>Tab_color: Background </code>''' All tabs selected or not match the diagram background color
*'''<code>Tab_color: Node </code>''' Selected Tab matches the diagram background color; Non-selected tabs match the color of the Module node.

*'''<code>all_tabs_diagram_color: yes</code>''' This flag has been deprecated and may not work in future ACP releases. Replaced by '''<code>Tab_color: Background </code>'''.

===Show 2 tiers of tabs===
''New to 3.0.0.30:''
[[CloudPlayerStyles_Attribute_Values#Flags_to_display_2_tiers_of_tabs|more...]]

*Currently these must be used with the '''<code>show_as_tab:no</code>''' style set. 

* '''<code>navigation_style:Two_top_tabs</code>''' Replaces the 2 style combination of '''<code>navigation_style:top_tabs, two_tiers_tabs:yes</code>'''

* '''<code>navigation_style:Two_side_tabs</code>''' Replaces the 2 style combination of '''<code>navigation_style:side_tabs, two_tiers_tabs:yes</code>'''

===screen_width: 999 and screen_height: 999===
''New to 3.0.0.1:'' CloudPlayerStyles flag to optionally set the ACP 3 canvas size; 999 is the number of pixels to use for the ACP Canvas.

[[CloudPlayerStyles_Attribute_Values#Set_the_ACP_canvas_size. | See more...]]

===Add_scroll_bars: no===
''New to 3.0.0.2:'' <code>CloudPlayerStyles</code> flag to suppress scroll bars on the ACP 3 diagram.
[[CloudPlayerStyles_Attribute_Values#Scroll_Bars|More...]]

===message_box_location: x, y===
''New to 3.0.0.4:'' By Default, ACP 3 shows error and other message boxes right in middle of the screen. You can change this using this cloudplayerstyle in the top level diagram of your model. [[CloudPlayerStyles_Attribute_Values#Message_boxes|More...]]

===Download_Spreadsheet: xyz.xlsx===
(Downloading Spreadsheets from a Button)

''New to ACP3.0.0.6:'' If an Excel worksheet is present in your ACP model listing, you can download it while playing your model. Just set this flag in the CloudPlayerStyles attribute of a button.[[CloudPlayerStyles_Attribute_Values#Download_Spreadsheet:xyz.xlsx|More...]]

===Upload_Spreadsheet:===
{Uploading spreadsheets from a button)

''New to ACP3.0.0.42:'' If you have "spreadsheet_upload" in the CloudPlayerStyle of a button, you are prompted with a file upload after the button onclick completes.[[CloudPlayerStyles_Attribute_Values#Upload_Spreadsheet| More...]]

===Save_on_click:yes===
''New to ACP 3.0.0.24:'' This flag can be added to the cloudplayerstyles attribute of a button. Then it works as a "save as" button. Ie the save dialog opens when the button is pressed.

==="ACP save as filename" variable===
''New to ACP3.0.0.24:'' Can be used to create a custom default model name in the save as dialog. Used in combination with the <code>save_on_click:yes</code> flag.

*In Desktop Analytica, add a variable to your model with the identifier <code>acp_save_as_filename</code>

[[Media:Saveasfilename.ana|Here is an example model]] using the <code>save_on_click:yes</code> flag and <code>acp_save_as_filename</code> variable.


===Asynchronous calls===
'''<code>use_async_calls: no</code>''' This flag needs to be set in the top diagram of your model if you don't want to use asynchronous calls. This may slightly speed up model playing for some models {of course, you don't want to add this flag if you have features in your model which require asynchronous polling}

==Meta Modeling==
===Ability to change node titles and colors===
''New to ACP 3:''

Use [[Scripting_Guide|scripting]] or the function [[EvaluateScript]] to change the title or color of a node.

You can use this model as an example: [[Media:Update titles.ana|ACP UpdateTitles]]

*Play this model in ACP 3

===Change Title===
''New to ACP 3:''
*Enter the model <code>Update titles</code> and evaluate "Triggering Node" or click the Button node.

:[[File:ACP Update titles01.PNG]]

Note that the title of the checkbox input node and the variable node with titles 'zero' changes to 'one'.

:[[File:ACP Update titles02.PNG]]

If you uncheck the checkbox for the input node "make title one"...

:[[File:ACP Update titles03.PNG]]

...Clicking the button or evaluating "triggering node" changes the titles back to 'zero'.

===Change Color===
''New to ACP 3:''
*Navigate to the module 'Change node color'.
*Press the Calc button/Output node for the node indicated.

:[[File:Change ACP node color 01.png]]

Note the color change of the node. The script is in the definition of the node 'Evaluate this node'.

:[[File:Change ACP node color 02.png]]

===Altering navigation tabs' color===
''New to ACP3.0.0.8'': When using Top Tabs or Tabs down left, with the tab color flag set to '''<code>Tab_color: Node. </code>'''[[What%27s_new_in_ACP%3F#Flags_for_controlling_the_Tab_color.3D|Controlling ACP Tab colors.]] If a script or onclick event changes a module's node color, the module's Tab color will change accordingly. Can be used for instance when creating a wizard.

==Group Account UI==

''New to releae ACP 3.0.0.23'': For group accounts, shows the expiration date on the models listing page.

===Project list===
''New to release ACP 3.0.0.42'' If a project has been manually deleted from the windows file system on the server, it no longer shows in the Projects pulldown menu. Mostly applicable to ACP servers.
''New to release ACP 3.0.0.42'' With a large number of projects, typing the first letter of the project name will cause the project listing to jump to projects starting with that letter.

===Model list===
''New to release ACP 3.0.0.42'' Added a column 'File size' to the Model list. Removed the columns for 'Author', 'Saved by' and 'Access'. 

''New to release ACP 3.0.0.42'' You can sort the model list either by forward or reverse order by clicking on the column header of the Model name or Save date column.

===Users tab===
Only members of the project selected in the project combo display by default, In alphabetical order.

===Admin users===
*Admin users can see all projects, even those for which they are not explicitly a member.
*For Admin users, the project list puts those projects for which the user is an explicit member first, and then the rest for which they can access (because they are an Admin) but which they are not an explicit member of.
*For admin users, search functionality in the Users tab. Along with the option to display all users or only the users who are members of the project.

===Removed 'Public/Private' Feature===
''New to release ACP3.0.0.42'' 'Public/Private' access to models and spreadsheets has been removed.

==Miscellaneous==
===Table / Graph toggle===
''New to release ACP3.0.0.15:''

Result tables and graph views in a Frame node show a table or graph button to toggle between table and graph nodes, similar to
Desktop Analytica. This button doesn't appear in:
*Edit tables.
* Table over Graph or Graph over Table views (which anyway show both).
* A table with only one cell (that can't be graphed anyway).
[[File:Graph table togle 01.png]] 
If you want your user to be able to see only the designated view, you can this turn feature off: [[What%27s_new_in_ACP%3F#Show_table_graph_toggle:no|Show_table_graph_toggle:no]]

===Suppress formnode icons.===
''New to release ACP3.0.0.3:''

Added support for suppressing the output formnode icons. ACP will display these the same way they are set in Desktop Analytica, via the nodeinfo attribute. [[Objects_and_Their_Attributes_-_Part_2_of_3#User_Interface_Attributes|more on the nodeinfo attribute]]

===Html links in Text nodes ===
As of release ACP3.0.0.6., html links in text boxes are now the same as in Desktop Analytica.

===OpenUrl() sysfunction===
As of ACP 3.0.0.6, ACP Supports the new [[OpenURL|OpenURL(()]] system function for Buttons and Picture nodes.

=== Multitable() ===
''In Testing:'' Multitables will display in ACP but some of the functionality has not been implemented.

===Support showing message boxes when loading diagrams===
''New to ACP3.0.0.10: ACP,'' like Desktop Analytica, now supports message boxes which display when a diagram loads.
Example: [[Media:DiagramOpenMsgBox.ana]]
===Support for callbacks fired while retrieving an edit table===
''New to ACP3.0.0.10: ACP,'' like Desktop Analytica, now supports called when viewing an edit table

===Module descriptions show Balloon help===

''New to ACP 3.0.0.28:'' In tabbed navigation - Tabs across the top or Tabs down left, Modules with a description will display the description in a balloon upon mousing over the tab.

===More===
''Some Miscellaneous enhancements that are new to ACP 3:''
*''New to ACP 3.0.0.33'':All types of table form node buttons now say simply "Table", same as DTA 5.0
*''New to ACP 3.0.0.30'':Added a progress bar when waiting for a model to load from the model listing.
*''New to ACP 3.0.0.30'':In a group account, the dropdown menu for Projects now shows 20 items before adding a scroll bar. Previously it showed 5.
*''New to ACP 3.0.0.30'':When you log into ACP it now displays the user logged in - “Logged in as <user name>” - below the Sign out link on the upper right.
*For large diagrams, Scroll bars have been added when necessary {I.e. the diagram is larger than the canvas}.
*When saving snapshots of models in Group accounts, it's possible another user has saved a snapshot of the same model and has set it's access as private (so it won't appear in your model listing). To reduce the chance of getting an error message that a model with the same name exists, your user name is now inserted into the default suggested name.
*Several tweaks to the appearance of form nodes in ACP, to make them look closer to what you see in Desktop Analytica.
*The uncertainty view popup menu has been removed from the result window for Variables whose result was selected as 'mid' view in DTA, {or in ACP if saved as a snapshot}.
*''New to ACP 3.0.0.18'': Support has been added for Multiline column and row headers.
*''New to ACP 3.0.0.25''; A Save date column was added to the model listing.
*''New to ACP 3.0.0.28''; Improved the appearance of models with many top tabs by truncating the titles when necessary, so that all tabs fit on the diagram.
*''New to ACP 3.0.0.30';The animation when a model is loading from the model listing now shows a progress bar.
*''New to ACP 3.0.0.30';The help balloon positioning has been tweaked so that the top line is aligned vertically with the top line of node — except if that would make the balloon off the bottom of the diagram, in which case its bottom is aligned with the node bottom line.
*''New to ACP 3.0.0.35'; If a user is a Manager of a Project, then they can see the private snapshots in the list of models. If the user is not a manager i.e. he's a reviewer or author, then don't show the private snapshots.
*''New to ACP 3.0.0.35';Form Node button labels for Edit tables have been shortened to just "Table"
*''New to ACP 3.0.0.35'; Hidden nodes are not displayed on diagram in ACP (for models created in Analytica 5.0 or later)

==See Also==
* [[Analytica Cloud Player]]
* [[media:ACP style library.ana]]
* [[Future ACP Features]]

AcpStyles

2018-07-16T16:51:14Z

Davidpaine:

[[Category: Analytica Cloud Player]]
[[Category: Attributes]]
[[Analytica_Cloud_Player#See_also|<<Back to Analytica Cloud Player]]

ACP offers a wide variety of styles and options to control the look and functioning of the user interface. Many of these go beyond what is (currently) available in Desktop Analytica (DTA).

The easiest way to set most of these styles and options is to use the [[ACP Style Library]]. Select '''Add Library...''' from the '''File''' menu and select the [[ACP Style Library]] to add into your model. This library lets you select most ACP styles and options interactively from checkboxes and menus. You can configure Navigation styles, Node styles and Frame nodes. For many options, it shows a preview of what it will look like in ACP. When you set an option, it automatically sets the corresponding '''CloudPlayerStyles''', ''so you don't need to worry about them, and can ignore the rest of this page.''

This page is for those geeks who want to know the details of these '''CloudPlayerStyles''', or if you want to use those few '''CloudPlayerStyles''' not (yet) accessible in the [[ACP Style Library]].

You set general styles and options that apply to the whole model by adding flags to the '''CloudPlayerStyles''' attribute for the main model. You set styles specific to a particular module or node by adding flags to the '''CloudPlayerStyles''' attribute for that object.

The easiest way to view and edit the CloudPlayerStyles attribute in Desktop Analytica is to use the [[Attribute panel]]. Select '''CloudPlayerStyles''' from the list of Attributes at the top of that panel. By default, '''CloudPlayerStyles''' is not shown in the [[Object window]], so you first need to set it to be shown in the [[Manage attributes|Attributes dialog]].

The '''CloudPlayerStyles''' and their flags are not case sensitive.

When you put multiple flags in a '''CloudPlayerStyles''' attribute, you can separate them by commas, spaces, or newlines. We recommend putting each flag on a separate line for clarity. ACP just looks for the particular text values and doesn't care about the separators.

=== Model level styles ===

These styles apply to the entire model. You set them in the '''CloudPlayerStyles''' attribute for the Main Model. (They have no effect when set for a submodule.)

==== Navigation style ====

ACP offers these options for Navigation_style:
* <code>Navigation_style: Outline</code> - An expandable tree of modules on the left of the ACP window, similar to the outline view in desktop Analytica. This is the default style.
* <code>Navigation_style: Top_tabs</code> -- The main modules in the top model appear as a row of tabs across the top of the window. Click a tab to show the diagram for that module.
* <code>Navigation_style: Two_top_tabs</code> -- The main modules in the top model appear as a row of tabs. The submodules of the module whose tab is selected appear as a second row of tabs. Needs to be used with the style'''<code>show_as_tab: no</code>'''.
*<code>Navigation_style: Side_tabs</code> -- The main modules in the top model appear as a column of tabs on the left of the window. Click a tab to show the diagram for that module.
* <code>Navigation_style: Two_side_tabs</code> -- The main modules in the top model appear as a column of tabs on the left of the window. The submodules of the module whose tab is selected appear as a second column of tabs on the left. Needs to be used with the style '''<code>show_as_tab: no</code>'''.

We describe each in more detail below.

====Outline Tree====

By default, ACP shows an expandable outline tree of modules on the left hand side of the window, similar to the Outline view in Analytica on the desktop. This makes it easy to navigate a model with an extensive hierarchy of modules.

A navigation flag is not needed for this style, but if you want to explicitly set this style you can add '''<code>Navigation_style: Outline</code>''' to the top diagram's '''CloudPlayerStyles''' attribute.

For small models, and most web apps, you may want to suppress the Outline view. Do this by inserting the text '''<code>show_outline: no</code>''' into the top diagram's CloudPlayerStyles attribute. (If a model has only one diagram, i.e. with no modules, it never shows the outline tree.)

:[[Image:ACP Outline Tree.png]]

===== Toolbar Tabs =====
*'''<code>show_tabs: no</code>'''
::By default, ACP shows navigation tabs for "Diagram", "Object", "Table", "Graph" along the top. Use this flag to hide those tabs. If you display the model inputs and outputs on the diagram -- using embedded tables and graphs on the diagram -- your users may not need those tabs. (You can also use <code>show_tabs: yes</code> to explicitly show the tabs.)

====Module hierarchy bar ====

For a multi-module model, ACP normally shows the model hierarchy in a bar at the top of the diagram. The model hierarchy header shows you where you are in a large model by listing the titles of the ancestor modules in which the current diagram is nested. You can click any ancestor to click up levels in the hierarchy. The Hierarchy Bar takes up much less screen real estate than the Outline Tree.

With [[CloudPlayerStyles_Attribute_Values#Tabbed_Module_Navigation|tabbed navigation]] style, it doesn't show the hierarchy bar when you are viewing a top level module, since its title is already in the selected tab. With a two-level tab navigation, it shows the hierarchy bar only when viewing a module nested 3 or more levels down. Basically, the hierarchy header does not duplicate what you can see in the tabs.

Note that this setting is not based on a CloudPlayerstyle attribute, but rather on the ''Show module hierarchy'' check box in the model [[Preferences]] in Analytica. With the model opened in Analytica, on the [[Edit menu]], select '''Preference...''', and check (or uncheck) the ''Show module hierarchy'' checkbox.
:

:[[Image:Acp hh.png]]

====Tabbed Module Navigation====

As an alternative to the Outline view, you can set the '''<code>Navigation_style</code>''' to use use a tabbed interface which is often more convenient and familiar for web applications. By default, the main model appears as the first tab. You can sw

There are four tabbed styles, Top_tabs and Two_top_tabs, with one or two rows of tabs across the top, respectively; and Side_tabs and Two_side_tabs with one or two columns of tabs down the side. Top_tabs works well if you have up to 5 to 8 modules in the main diagram (tabs), depending on the length of their titles and the width of the ACP window. If you have a lot of modules, or they have long titles, it may be better to use Side_tabs. If you have too many modules to fit at the top or side, you can use Two_top_tabs or Two_side_tabs. In those cases, you must organize the modules into a two-level hierarchy with logical groupings.

'Tabs across top' (i.e. top tabs) or 'Tabs down left' (i.e. side tabs). In this case, the tabs display different influence diagrams. The first tab displays the top level diagram, and the remaining tabs display the modules present on the top level diagram of the model. (The modules will not display on the diagram, so you need to tweak your diagram for playing in ACP so that it looks right without these present). The size of the diagram is determined by the size of the top level diagram window when the model was last saved in Analytica.

* '''<code>navigation_style: top_tabs</code>'''
::This setting instructs ACP to use the 'Tabs across top' navigation style.

:[[File:acp top tabs.png]]

* '''<code>navigation_style: side_tabs</code>'''
::This setting instructs ACP to use the 'Tabs down left' navigation style. Side tabs work better than top tabs when there are more module nodes present.

:[[File:acp side tabs.png]]
* <code>Navigation_style: Two_top_tabs</code>
* <code>Navigation_style: Two_side_tabs</code>

'''These 2 Navigation styles replace the style <code>two_tiers_tabs:yes</code> which has been deprecated.'''

These styles are useful for modules with several layers of modules and submodules - to reduce the clutter of the top layer of tabs. Modules in the model's top diagram appear as top tabs (left tabs). Modules within those top level modules appear as subtabs, the 'second tier'. When you select a top-level tab, it shows its submodules as subtabs. This means that the top level of modules will not show any contents other than their submodules, so the model needs to be designed with this in mind.
*Currently these 2 styles must be used with the '''<code>show_as_tab: no</code>''' style set. 
*The selected tab appears with the color of the diagram background of it's module

====Tab color====

When using Tabbed Navigation, you can use these flags to control how the color of the tabs display on your model in ACP. To use, add one of them to the CloudPlayerStyle attribute of the top level diagram of your model. They have no effect if added to a module other than the top diagram.

*'''<code>Tab_color: Default </code>''' The default. Non-selected tabs are bluish white. The selected tab uses the background color for that diagram.
*'''<code>Tab_color: Background </code>''' All tabs use their diagram background color, whether selected or not
*'''<code>Tab_color: Node </code>''' The selected Tab uses its diagram background color; The other tabs use the color of their Module node (not their diagram background color). You can use this to change the color of the tabs by modifying their node color in an Analytica functions.

*'''<code>all_tabs_diagram_color: yes</code>''' This flag has been deprecated and may not work in future ACP releases. Replaced by '''<code>Tab_color: Background </code>'''.

====Display Only a Single Diagram====

*'''<code>top_diagram_only: yes</code>'''
::Use this flag if you want to restrict users access to only the top diagram. With this flag, any action that would normally bring up a different diagram will just reload the top diagram. (If you are using this setting, you will also want to also not display the Outline Tree as explained above.)

====Go into Parent Button====

The user clicks this button to display the parent module diagram of the current diagram:
:[[Image:ACP parent button.png]]

It appears by default in the :Analytica model review" navigation style, but in the tabbed "Web application" style. The button does not appear in the top diagram, where it would have no function.

* '''<code>show_parent_diagram_button: no</code>'''
::Set this flag to "no" to stop displaying the 'Go into Parent' button.

* '''<code>parent_diagram_button_coordinates: x, y</code>'''
::Show the 'Go to parent' button at a non-default location, where x and y are the number of pixels to the right and down, respectively, from the top left of the window. E.g. <code>parent_diagram_button_coordinates: 10, 100</code> will change the position of this button to <code>x = 10</code>, and <code>y = 100</code>.

'''Show the parent diagram button in 'tabs across the top' navigation style'''
:If you want to display the 'Go to Parent' button when using the "Tabs across the top":
:*Add the <code>parent_diagram_button_coordinates: xy</code> ACP attribute style flag, along with the <code>navigation_style: top_tabs</code> flag (see [[CloudPlayerStyles_Attribute_Values#Tabbed_Module_Navigation|Tabbed Module Navigation]] below) to the CloudPlayerStyles attribute. The actual coordinates of your parent diagram button may need to be tweaked.

*The button appears only in submodules of a tab, not in a tab diagram where it is not needed.
:[[File:Parentdiagbutton w top tabs01.PNG]]

====Show or hide the Diagram Title and Model title====
You should use the [[ACP Style Library]] if you want to change the defaults for these flags, since they are only compatible with certain combinations. The Styles library changes all the flags at once, and prevents you from entering incompatible combinations.

*'''<code>show_diagram_title: no</code>'''
::You can control whether or not to display the diagram's title at the top of the diagram. Use <code>show_diagram_title: no</code> to suppress the diagram title. You can also explicitly tell ACP to show the diagram title by using <code>show_diagram_title: yes</code>, but this is not really necessary because the currently ACP shows the diagram title by default.
*'''<code>show_model_title: yes</code>'''
::Show title of the model at the top to right of the [http://lumina.com Lumina] (or other) logo. Note this flag only works properly when you also Hide Tabs because the tabs and title will overlap.

====Hide the Banner and Logo====
Another flag it's easier to use the [[ACP Style Library]] to set, since it is only compatible with the parent button and toolbar tabs hidden. The Styles library changes all the flags at once, and prevents you from entering incompatible combinations.

*'''<code>show_banner: no</code>'''
::Hides the banner space usually present at the top of ACP. The banner typically contains the Lumina Logo, the '''Parent Diagram''' button, tabs, '''Close Model''' button, and '''Save''' button.

:*This could be useful for customizing the appearance of a model [[Putting_ACP_in_a_Web_Page|embedded in a web page]], for instance.
:[[File:Banner area 01.PNG]]
:*If you play a model without the banner area in ACP, there isn't a convenient way to close the model without closing the browser.

====Exclude the top level diagram from tabs====

You should use the [[ACP Style Library]] if you want to set this flag, to avoid incompatible settings.

*Optionally, Enter the text <code>Show_as_tab: no</code> in the CloudPlayerStyles attribute of the top level module.

*'''<code>show_as_tab: no</code>'''
::Excludes the top level diagram and just shows the submodules of the top level diagram as tabs. Since the top diagram will not display in ACP, you include the key user interface pages as modules in the main model. Can be used only with 'Top tabs' or 'Side tabs' styles.
*When setting tabbed Navigation styles using the ACP Styles Library, the default is for the Top level diagram to be included, except with two tiers of tabs, for which it is (Currently) required to exclude the top diagram from the tabs.

If you want to see what it looks like, play this model [[Media:Show as tab no.ana|Array examples]] in ACP, with the <code>show_as_tab: no</code> style in the cloud player styles attribute, and set to tabs along top.

:[[File:Show as tab no02.png]]

*Play this model in ACP and the top level diagram does not show. Rather the diagram for 'Intro to Arrays' shows as the first tab and then the other tabs.'''

:[[File:Show as tab no01.png]]

=== Styles for diagram nodes ===

You can set some styles for your model which will affect how nodes on the diagram are displayed.

*'''<code>Show_table_graph_toggle:no</code>'''
::Turns off the [[What%27s_new_in_ACP%3F#Show_table_graph_toggle:no|table / graph toggle]] button. Can be used as a model level flag, or as a flag for individual nodes. When used as a flag for individual nodes, it trumps the global flag, if present. Can save you some space if this button is not needed, or you have set your model up to show the only result you want the model viewer to see.

ShowIONodeButtonText: no

*'''<code>show_unc_view_in_outputs: no</code>'''
::In Desktop Analytica, each user output node has a little icon on the right-hand side showing the uncertainty view last viewed (e.g. mid, mean, stats...). In ACP, you can suppress these with the flag <code>show_unc_view_in_outputs: no</code>. We recommend this for ACP since the icon is usually confusing to end users. This style should be applied to the top level model object. It does have any effect currently when applied to individual nodes.

:[[Image:Uncertainty view icons.png]]

*'''<code>calc_on_open: yes</code>'''
::By default, ACP, like Analytica, does not compute results when you first view a diagram, leaving any User output nodes showing the '''Calc''' button. The user must click on each to see its result, as a scalar embedded in the Diagram, or as a separate Result window. Unless some results take a long time to evaluate, it is usually friendlier to compute the values before showing the Diagram. You can make this happen by inserting <code>calc_on_open: yes</code> into the top level diagram's CloudPlayerStyles attribute. This flag doesn't have any effect currently when applied to individual nodes.

*'''<code>auto_recalc_results: yes</code>'''
::Causes ACP to immediately recalculate any result when the user changes an input on that diagram that affects the result.

*'''<code>show_hover_highlight: no</code>'''
::By default, ACP displays a hover highlight -- a contrasting light rectangle behind a node -- when you move the cursor over the node. You can suppress this by including the <code>show_hover_highlight: no</code>. This style should be applied to the top level model object. It does have any effect currently when applied to individual nodes. (The hover highlight is different from the [[help balloons|Help Balloon]] described below.)

:[[File:acp hover hl.png]]

*'''<code>show_copy_table_icon: no</code>'''
::Usually, ACP displays a copy table icon near the upper right hand corner of a result table (or edit table, but less useful here). Clicking the icon copies the table as displayed so it can be pasted into another place, e.g. Excel. If you want to hide this icon, this is the flag to use. The Copy Table Icon is the icon shown in the image below. This style should be applied to the top level model object. It doesn't have any effect currently when applied to individual nodes.

:[[File:Copy table icon.png]]

*'''<code>ShowIONodeButtonText: no</code>'''
::This flag will cause the text Calc/Result/Edit Table etc. to not appear on the input / output buttons
::Needs to be added to the <code>Cloudplayerstyle</code> attribute for the top diagram of your model. Has not yet been implemented for individual nodes.

==== Balloon Help ====

When you move the cursor over a node, ACP usually shows a "balloon" popup next to the node with the title, units and description of the node (if it has one) to help end users understand what its for, or what to enter for a user input. If the node has no description, the [[help balloons|balloon help]] will not appear.

*'''<code>show_id_in_balloon: yes</code>'''
::Use this flag to show each node's identifier below its title in the balloon -- unless the identifier and title are identical (except for spaces which are replaced by underscores).

*'''<code>show_definition_in_balloon: yes</code>'''
::Use this flag to show the node's definition in the balloon below the description.

*'''<code>hover_balloon_delay</code>'''
::When you mouse over a node, there's a short delay of about half a second before it displays the balloon (to prevent wild balloon appearance when you move the cursor rapidly over a diagram.) You can tweak this delay time measured in milliseconds by inserting this flag. E.g. '''<code>hover_balloon_delay: 200</code>''' to reduce the delay to .2 seconds.

The three flags above go in the CloudPlayerStyles of the model and apply to all nodes in the model. You can also modify some aspects of the balloon separately for each node by inserting these flags in CloudPlayerStyles for each node:

*'''<code>show_hover_balloon: no</code>'''
::Insert this flag in the CloudPlayerStyles for a node, to suppress display of its balloon.

*'''<code>show_hover_balloon_title: no</code>'''
::Insert this flag in the CloudPlayerStyles for a node, to suppress its title in the balloon.

==== Enhanced Diagram Graphics ====

You can control the appearance of nodes, with bevels, shadows, and highlights, by setting these in the CloudPlayerStyles for the model. By default (for now) ACP displays nodes without these effects, similar to Desktop Analytica, looking rather flat like this: 

:[[Image:Nodes no shadow or bevel.png]]

*'''<code>node_drop_shadow: yes</code>'''
::Setting this flag, displays a drop shadow behind each node, giving a kind of 3D effect: 

:[[Image:Nodes drop shadow.png]]

*'''<code>bevel_node_border: yes</code>'''
::Setting this flag, displays a bevel border for each node, giving another kind of 3-D effect:

:[[Image:Nodes beveled border.png]]

*'''<code>glow_hover_highlight: yes</code>'''
:: Set this flag to show a "glowing" highlight around each node when you move the cursor over a node. <code>glow_hover_highlight: no</code>. Switches off this behavior, which is the default behavior in ACP

Here is the glow hover effect on a node, along with Drop shadow and Beveled border effects.

:[[Image:Nodes all graphic effects.png]]

 These effects are new and are still somewhat experimental, so, they are off by default. You are welcome to try them out, by setting CloudPlayerStyles for the main model. Eventually, these effects may become the default. Then you'll be able to turn each one off using <code>Node_drop_shadow: no, Bevel_node_border: no</code>, and<code>Glow_hover_highlight: no</code>.

===Styles to adjust the ACP canvas===

====Set the ACP canvas size====

The default ACP3 Flash Canvas is set to "100%". This means that the canvas is the same size as the browser window.

There are two cloud player styles for optionally controlling screen size.

*'''<code>screen_width: 999</code>''', and '''<code>screen_height: 999</code>'''
::where 999 is the number of pixels to use for your ACP canvas. If you use these flags you need to add space for the Banner/Tabs/Hierarchy headers or the outline on the left.

====Scroll Bars====

*'''<code>Add_scroll_bars: no</code>'''
::You can add this flag to the top level diagram's CloudPlayerStyles attribute if you want to suppress the scroll bars which would otherwise appear on a large diagram.

===Other Model level styles===

====Message boxes====

*'''<code>message_box_location: x, y</code>'''
::By default, ACP shows error and other message boxes right in middle of the screen, but you can change where these display using this flag. Set this flag - with the x, y coordinates in pixels on the ACP canvas - where you want the message boxes to display. Needs to be put into the CloudPlayerStyles attribute for the top diagram of your model.

== Node Level Settings ==

These style flags and options apply to individual nodes (variables), rather than the model as a whole. So, you set these flags on the CloudPlayerStyles for selected objects (nodes).

=== Input nodes ===

*'''<code>textalways</code>'''
::Usually in ACP and Desktop Analytica, to enter a text value into a user input node you have to enclose it in quotes. Insert this flag into the CloudPlayerStyles for each Input node if you want it treat the input as text without requiring the user to use quotes. Note this flag is inserted into the Formnode's CloudPlayerStyles attribute and cannot be done in the Object window or attribute panel. Instead figure out what the identifier of the formnode is and then set the CloudPlayerStyles in the typescript window.

*'''<code>tabindex: ''n''</code>'''
::In ACP and Desktop Analytica, the user can press tab to go to the next input control to enter its input. You can control the tab order -- the sequence followed by tabbing through inputs -- by adding this flag. Put <code>tabindex: 1</code> into the CloudPlayerStyles of the first one. Put <code>tabindex: 2</code> into the second, and so on. Note this flag is inserted into the Formnode's CloudPlayerStyles attribute and cannot be done in the Object window or attribute panel. Instead figure out what the identifier of the formnode is and then set the CloupPlayerStyles in the typescript window.

=== Other node level flags ===
==== Prevent nodes from showing on the diagram ====

*'''<code>Show_Object: no</code>'''
::You can prevent nodes or modules from showing on the diagram of your model, by adding this flag to the CloudPlayerStyles attribute of the object you wish to hide.

*Once played in ACP the objects aren't visible, and if the outline is displayed the module will not be shown in the Outline either.

==Special Flags==

===Download_Spreadsheet:xyz.xlsx===
*This Cloud Player style allows you to download a spreadsheet while playing a model. You could of course have modified this Spreadsheet while working with the model.
*This flag can be added to the CloudPlayerStyle attribute of a button. E.g. if you want to download <code>xyz.xlsx</code> you add <code>download_spreadsheet xyz.xlsx</code> to the CloudPlayerStyle attribute of the button. Then when pressed the button will prompt you to save the file.
*You can't download a spreadsheet in the same button click that causes a spreadsheet to be uploaded.
*If you don't specify the name of the spreadsheet file ACP downloads the last file uploaded without a dialog.
*This is not the same as using [[SpreadsheetSave]]() {If you evaluate a variable in your model using [[SpreadsheetSave]], it will save the spreadsheet to the server by default}.

*You can also do this "on the fly" in your model by having an [[OnClick]] attribute that sets this flag in the CPS attribute.

===Upload_Spreadsheet===

*This flag can also be added to the CloudplayerStyle attribute of a button. It results in the user being prompted with a file upload after the button onclick completes.

*As with the <code>Download_Spreadsheet</code>, flag, you can do this "on the fly" in your model by having an [[OnClick]] attribute that sets this flag in the CPS attribute.

===Save_on_click:yes===
This flag can be added to the cloudplayerstyle attribute of a button. Then it works as a "save as" button. Ie the save dialog opens when the button is pressed.

==="ACP_save_as_filename" variable===
Can be used to create a custom default model name in the save as dialog. Used in combination with the <code>save_on_click:yes</code> flag.

*In Desktop Analytica, add a variable to your model with the identifier <code>acp_save_as_filename</code>

[[Media:Saveasfilename.ana|Here is an example model]] using the <code>save_on_click:yes</code> and <code>acp_save_as_filename</code> flags.


===Asychronous calls===

See the what's new page [[What%27s_new_in_ACP%3F#New_functionality_requiring_Asynchronous_calls|here]] also [[Future_ACP_Features#Async_calls|Explanation of ACP's use of Asynchronous polling]]

*'''<code>use_async_calls: no</code>'''
::This flag needs to be set in the top diagram of your model if you don't want to use asynchronous calls. This may slightly speed up model playing for some models of course, you don't want to add this flag if you have features in your model which require [[Future_ACP_Features#Async_calls|asynchronous polling]])

*'''<code>use_async_calls: yes</code>'''
::This flag has been deprecated since asynchronous polling has been implemented as default in ACP, and will be removed from this wiki eventually.

==="ACP Current User" Variable===
Add a variable to your model which will show the current user's email address as a result.

*Open the model in Desktop Analytica.
*Add a variable with identifier <code>Acp_current_user</code> to the model and save it.
 
:[[File:ACP current user01.PNG]]

*When you play the model in ACP, and evaluate Acp_current_user, the result is the user e.g. <code>johndoe@gmail.com</code> {when playing an email invite the result will be "anonymous"}.
 
:[[File:ACP current user03.PNG]]

== Embedded Tables and Graphs ==

In ACP it is possible to display graphs and tables directly on the diagram. The '''CloudPlayerStyles''' can be used to specify the region on the diagram to display these tables or graphs.

More on [[ACP Rendering tables and graphs on the diagram |embedded tables and graphs]].

==See Also==
* [[ACP Style Library]]
* [[media:ACP style library.ana]]
* [[Analytica Cloud Player]]
* [[ACP Rendering tables and graphs on the diagram]]
* [[Putting ACP in a Web Page]]
* [[Help balloons]]
* [[Attributes]]
* [[Manage attributes]]

Differences between ACP and Desktop Analytica

2018-06-28T12:25:34Z

Davidpaine: /* DTA features not available in ACP */

[[Category: Analytica Cloud Player]]
[[Category:Analytica editions]]

Analytica Cloud Player (ACP) lets you share and run via a web browser any model created in desktop Analytica (DTA). A model looks and works almost the same on the web with ACP and on a desktop with DTA. But, there are some important differences. ACP offers some special user-interface features that let you create a better user experience for a web application, which has some different opportunities and challenges than a desktop application. Plus a few special features of DTA have not yet made it to ACP. This page explains the main differences.

== ACP is like desktop Analytica in Browse Mode==

[[Analytica Cloud Player]] (ACP) offers almost all the features of desktop Analytica in [[Browse mode]]. ACP lets users open a model, view influence diagrams, object windows, and results as graphs or tables. Users can change any variable designated as an input, including fields for text or number, Checkbox es and Choice menus, and Edit tables containing them. But, ACP doesn't have an [[Edit mode]], to let you change definitions, or add new variables or other objects. If you want to change or extend a model, you should do it with Analytica on your desktop (or laptop).

A minor difference is button clicks: In ACP, a click on a variable node in a Diagram shows its edit table or result view. A click on a module node, shows its diagram view. ACP, like most web applications, doesn't use double clicks. In DTA, a single click simply selects a node without opening anything. A double click on a variable node opens its Object view, and a double-click on a module opens its diagram.

== ACP Features not in desktop Analytica ==

ACP, like most web applications, shows the model via a single browser window, where DTA, like many desktop applications, uses multiple windows. Most ACP features are designed to provide a user-interface experience similar to other web applications, and to
reduce the limitations of a single window. You can run any Analytica model directly in ACP, but to to convert it to a web-application that works well for end users, you should understand and use some of these special ACP features.

* ACP offers a tabbed navigation style with modules listed as tabs across the top or down the left side of the window -- providing a familiar navigation style for web users. You can set all or selected modules to appear as tabs. ACP also offers a navigation style more like DTA, with an [[Outline window|outline view]] (expandable module hierarchy, similar to a file browser) on the left, or a hierarchy bar across the top to show current context. Or you can just show the top model as a single page to make a simple web application, with no tabs and no access to submodules, if your end users don't need to see all the gory details. See [[ACP Style Library]] for how to choose these options.

* ACP can display a result table or graph, or edit table, embedded in a user interface diagram, instead of requiring a separate window to show the table or graph as in DTA. In this way, you can see one or more tables and graphs in the same window. You can make a user input embed its edit table, or user output embed its result table or graph, simply by making the node tall enough (>=104 pixels or four times the default node height). Or you can create a Frame node, which is a special text node which shows the edit table or result of any user input or output when you click on it. See [[Embed table or graph with ACP]].

* You can show bevels and/or shadows on nodes to make diagrams appear more dramatic. See [[ACP Style Library]].

* Autocalc: You can set a model to automatically calculate result tables or graphs when you open a diagram (user interface tab) with those results.

* Press icon on top right of a result graph or table to copy data, or right-click to download data to a text file.

* ACP lets you control these and many other details of user interaction by setting the [[CloudPlayerStyles Attribute Values]] for the Model, Module, and other objects.

* The easiest way to use these ACP-specific user-interface features is to import the [[ACP Style Library]] into your model in DTA, and make the selections you want using that library.

== DTA features not available in ACP ==

Some features of Desktop Analytica (DTA) in browse mode are not (yet) available in ACP:
* Dialog boxes for styles, formats, and preferences, including the [[Graph setup dialog]], [[Number format]], [[Diagram Style dialog|Diagram]] and [[Node Style Dialog]]s, [[Uncertainty Setup dialog|Uncertainty Setup]], and [[Preferences dialog]]. ACP uses whatever options and styles you chose in Analytica before uploading the model to ACP.
* Slicer menus in graphs for multidimensional results, including the Color key, Symbol key, Symbol Size Key, and the bar origin.
* Clickable references.
* Ability to copy and paste a subset of values from and to a table.
* Ability to copy diagrams and graphs -- but you can always use Snagit or a similar application to copy directly from the screen.
* Support for the '[[Check]]' attribute.
* Ability to limit input nodes set to accept only a literal number, a text value (without quotes), or number or text.
* These interactive dialog functions: [[AskMsgChoice]], [[AskMsgNumber]], [[ShowPdfFile]]. But, it does support [[Msgbox]], [[Error]], [[AskMsgText]], and [[ShowProgressBar]].
* No support for separators in Choice and Multichoice lists
* [[MultiTable]]
* [[MultiChoice]] Uses a standard list control: Select the first data item in the List by clicking on it. Then hold down the Control key to select additional items. If the item is currently deselected, clicking on it while holding down the Control key selects it. If the item is already selected, clicking on it while holding down the Control key deselects it. You can also use the Shift key to select a range of data items. To select a range, select the first data item in the List by clicking on it. Then hold down the Shift key to select one additional item. The List control selects all data items between the two data items.
* No support for displaying [[Icon images in a node]].
* [[EditBoxCueText|Cue text in textbox input nodes.]]
* [[What%27s_new_in_Analytica_5.0%3F#New_icons_and_pop-up_node_controls|Popup node controls]]
* [[What%27s_new_in_Analytica_5.0%3F#Cell-level_formatting|Cell level Table formatting]]
* [[What%27s_new_in_Analytica_5.0%3F#Column_widths_and_row_heights:Variable Table row heights]]
* [[What%27s_new_in_Analytica_5.0%3F#Images_in_tables|Display images in table cells]]
We plan to add these and other features over time to ACP. Let us know if something is missing that you would really like to have.

===Linked Modules/Libraries===

ACP can run a model that uses separately [[Filed modules and libraries]], just like DTA. You need to make sure to upload all the linked files into the same directory so that ACP will find them. Alternatively, you can embed the linked modules and libraries into the model so that it becomes a single file. There are several ways to do that:

* In Analytica, you publish the model to ACP by clicking the Publish to Cloud menu item on the File menu. Analytica will automatically convert Linked Modules/Libraries to be embedded.
* Open the model. Go through each linked module or library and convert it to the embedded equivalent. You can do this in their object windows. Change its [[Class]] to an embedded (i.e. not linked) module or library using the pulldown menu at top left of the [[Object window]]. Or you can change the Class in the [[Attribute panel]], selecting the [[Class]] attribute, and then setting the desired class.
* If the model has a lot of linked libraries or modules, it may be easier to select '''Save a copy in ..''' from the '''file''' menu. In the '''Save...''' dialog, check the ''Save everything in one file by embedding linked modules'' checkbox. (Available in Analytica 4.2 and later.) See screenshot: 

:[[Image:Save everything in one file.png]]

==See Also==
* [[Analytica Cloud Player]]
* [[CloudPlayerStyles Attribute Values]]
* [[ACP Rendering tables and graphs on the diagram]]
* [[Editions of Analytica]]