Difference between revisions of "Making a browse-only model and hiding definitions"

Latest revision as of 21:35, 21 December 2022

Analytica User GuideWorking with Large ModelsMaking a browse-only model and hiding definitions

With Analytica Enterprise and Optimizer, you can save a model as Browse-only so that end users can view the model and results and change user inputs, but not edit the model (using any Edition of Analytica, including Free Edition and Professional). You can also hide definitions that contain sensitive or proprietary data or algorithms.

When you are ready to let others use the models you have created, you might want to save it as browse-only, so that end users can only change the variables you have designated as inputs (by making input nodes for them). You might also want to hide definitions of variables or functions to protect confidential or proprietary data or algorithms.

With Analytica Enterprise and Analytica Optimizer, you can save models in a form that is locked as browse-only and with hidden definitions. It also encrypts the Analytica source file in a form that is not human readable so that no-one can view or modify it outside of Analytica -- with a text editor. These are the basic steps, explained further below:

Hide selected definitions, by variable, module, or the entire model.
Save your master model file (and any filed submodules) so that you can still view and modify the original yourself.
Select Save a copy from the File menu, and check Lock and encrypt and optionally Save as a browse-only model copy to save an encrypted copy.
Distribute the locked and encrypted copy to your end users.

The third step locks and encrypts the model permanently and irretrievably. No-one (not even the author) can see or modify Hidden definitions. That's why you must save the encrypted model as a copy, and keep the original model master (unprotected) copy. Any definitions that you have set as "Hidden" in the model master can still be viewed and unhidden in the original model or model file. You must Hide them and Save a Copy checking "Lock and Encrypt" to complete the process.

Tip

No-one, not even the original author can unlock or decrypt an encrypted model file or view hidden definitions. So you must always retain a master copy of your model (and any sub-modules) in a safe place before making an encrypted copy.

Hiding and unhiding definitions

To hide the definition of a single variable or function, or all variables and functions in a module:

Select the node of the variable, function, or module in its parent diagram, or open the module and select no nodes inside it.
Select Hide Definition(s) from the Object menu, so it becomes checked.

You cannot hide multiple nodes at once except by hiding their parent module.

If a variable, function, or module is hidden, when you try to view its definition, it displays:

[Definition is Hidden]

Tip

You cannot hide the definition of a variable with an input node -- regardless of whether it or its parent module is marked as Hidden.By giving a variable a User Input, you are saying that all users can see and modify that variable.

Unhiding and inheritance of hiding

Definition hiding is inherited down the module hierarchy. If you hide a module, you hide the definitions of all the objects that it contains, including its submodules and all the objects that they contain — unless you explicitly unhide an object or submodule. To unhide a variable, function, or module:

Select its node in its parent diagram.
Select Unhide Definition(s) from the Object menu, so it becomes checked.

In the module hierarchy shown below, module Mo1 is hidden, and therefore so are the objects it contains, module Mo2, Va1, and Va2. But module Mo3 is unhidden, and therefore so are the objects it contains, Va3 and Mo4. However, object Va4 is itself explicitly hidden.

Tip

The Hide Definition(s) and Unhide Definition(s) menu options are disabled in Browse mode or if the current model, or any of its filed submodules, are encrypted. Encryption locks hiding.

Hiding does not become permanent until you save the file as locked and encrypted. In the original file, you can unhide, edit, or hide as you wish in the original model. That’s why it’s so important that you save a master copy for your own use.

Saving an encrypted copy of your model

When you are ready to save an encrypted copy of your model, select Save a Copy In from the File menu.

Enter a filename that is different than the filename of your master copy, to make sure that you retain an editable version for your self.

Check Lock and encrypt the copy at the bottom of the dialog to save the model in an encrypted form that makes any hidden definitions unviewable, even if you try to edit the file.

Check Save as a browse-only model if you also want to prevent users from changing any variables not designated as inputs. In that case, the model is locked in browse-only mode, even if the user runs the model with an Analytica edition that normally allows editing.

Optionally check Save everything in one file by embedding filed modules to produce a single file that can be distributed. If your model is utilizing unlocked filed modules, the content in those may remain exposed unless you use this option (alternatively, you can link to locked copies of those modules in your main model before saving your main model in a locked form). Even if you do not lock your model, this option can provide a convenient way to distribute your model as a single file to end-users, or to bundle it for upload to the Analytica Cloud Platform. Publish to cloud on the File menu saves everything in a single file automatically during the upload.

A browse-only model is always encrypted to prevent anyone from editing the source Analytica file. That's why it automatically checks Lock and encrypt the copy and the Save in XML format option is not available.

If you want end users to be able to use other Enterprise features, such as database access, file reading and writing, Huge Arrays, or performance profiling, they need the Power Player — or their own Enterprise edition. Enterprise and Optimizer-level features are available to users viewing your model through the Analytica Cloud Platform (ACP).

When a user runs a browse-only model (saved as such from Enterprise) into Analytica Professional, it runs it in Power Player mode, so that database access, etc., is available (features not otherwise accessible from Analytica Professional).

Filed libraries and submodules

Warning

If your model uses separately filed libraries or submodules, you need to be very careful that the module files you distribute to your users are indeed encrypted or locked as you intend. You must also ensure that you don't accidentally encrypt your master copies of these modules. Because locking a model as encrypted or browse only is irreversible, it is extremely important that you don’t accidentally lock your master versions. To avoid inadvertently locking separately filed modules, we highly recommend that you embed all modules and libraries check in your encrypted copy by checking Save everything in one file by embedding filed modules.

When you save a copy of your model without checking the Save everything in one file by embedding filed modules option, it saves a locked copy only of the top-level model file. The locked status of any filed modules remain in their original state, such that individual module files may remain non-encrypted or editable. If you don’t want to embed all filed modules in your encrypted copy, you’ll need to save an encrypted copy of each submodule individually, and use “Add Module...” with the Link and Merge options to switch your model to using the locked copy, prior to saving a copy of your top-level model.

You can distribute locked copies of libraries or modules to let other model developers use them without being able to see your proprietary definitions (if Hidden) or being able to modify them (when locked as browse-only). When using locked libraries, certain operations involving objects in those modules are restricted. You cannot embed an encrypted sub-module within a non-encrypted module, unless it is a separately filed module. You can embed an encrypted module in an encrypted parent model. Various operations that might allow a user to gain access to your hidden definitions are disallowed, such as moving an object with a hidden definition from an encrypted module to a non-encrypted module.

@@ Line 1: / Line 1: @@
 [[Category:Analytica User Guide]]
-<breadcrumbs>Analytica User Guide > {{PAGENAME}}</breadcrumbs><br />
+<breadcrumbs>Analytica User Guide > Working with Large Models > {{PAGENAME}}</breadcrumbs><br />
-When you are ready to let others use the models you have created, you might want to save it as browse-only, so that end users can only change the variables you have designated as inputs (by making input nodes for them). You might also want to hide definitions of variables or functions to protect confidential or proprietary data or algorithms.
+With [[Analytica Enterprise]]  and [[Optimizer]], you can save a model as Browse-only so that end users can view the model and results and change user inputs, but not edit the model (using any [[Analytica Editions|Edition of Analytica]], including [[Free Edition]] and [[Professional]]).  You can also hide definitions that contain sensitive or proprietary data or algorithms.
 __TOC__
-With Analytica Enterprise, you can save models that are locked as browse-only and with hidden definitions, using these steps:
-# Hide selected definitions in your model, for entire model, modules, or by variable.
+When you are ready to let others use the models you have created, you might want to save it as browse-only, so that end users can only change the variables you have designated as inputs (by making input nodes for them). You might also want to hide definitions of variables or functions to protect confidential or proprietary data or algorithms.
-# Save your master model file (and any linked submodules) so that you can still view and modify it yourself.
-# Select '''Save a copy''' from the '''File''' menu, and check '''Lock and encrypt''' and optionally '''Save as a browse-only model copy''' to save an '''''encrypted''''' copy — that is a file scrambled into a non-human-readable form.
+With [[Analytica Enterprise]] and [[Analytica Optimizer]], you can save models in a form that is locked as browse-only and with hidden [[definition]]s.  It also encrypts the Analytica source file in a form that is not human readable so that no-one can view or modify it outside of Analytica -- with a text editor. These are the basic steps, explained further below:
-# Distribute the encrypted copy to your end users.<br />
+# Hide selected definitions, by variable, module, or the entire model.
+# Save your master model file (and any filed submodules) so that you can still view and modify the original yourself.
+# Select '''Save a copy''' from the [[File menu]], and check '''Lock and encrypt''' and optionally '''Save as a browse-only model copy''' to save an '''''encrypted''''' copy.
+# Distribute the locked and encrypted copy to your end users.
-The third step permanently locks your model so that hidden definitions can never again be viewed in that copy. It is therefore recommended that you save a protected copy of your model, and leave your original model as a master (unprotected) copy. Until the model is stored in an encryped form (step 3), an end user is not prevented from unhiding your definitions, or from viewing them by other means (e.g., by loading the Analytica model file into a text editor).
+The third step  locks and encrypts the model permanently and irretrievably. No-one (not even the author) can see or modify Hidden definitions. That's why you must save the encrypted model as a copy, and keep the original model master (unprotected) copy.  Any definitions that you have set as "Hidden" in the model master can still be viewed and unhidden in the original model or model file. You must Hide them and Save a Copy checking "Lock and Encrypt" to complete the process.
-<Tip Title="Tip"> An encrypted model file cannot be decrypted, even by the original author. If it is locked as browse-only, it can never again be edited. If definitions are hidden, they can never again be viewed or edited. Always place a master copy of your model (and any sub-modules) in a safe place before making an encrypted copy.</Tip>
+<Tip Title="Tip"> No-one, not even the original author can unlock or decrypt an encrypted model file or view hidden definitions. So you must always retain a master copy of your model (and any sub-modules) in a safe place before making an encrypted copy.</Tip>
 ==Hiding and unhiding definitions==
-To hide the definition of a single variable or function, select its node and select '''Hide Definition(s)'''  from the '''Object''' menu, so it becomes checked. You cannot hide multiple nodes, except by hiding all nodes in a parent module. To hide the definitions of all objects in a module:<br />
-# Select the node of the module in its parent diagram, or open the module and select no nodes inside it.
+To hide the definition of a single variable or function, or all variables and functions in a module:
-# Select '''Hide Definition(s)''' from the '''Object''' menu, so it becomes checked.<br />
+# Select the node of the variable, function, or module in its parent diagram, or open the module and select no nodes inside it.
+# Select '''Hide Definition(s)''' from the [[Object menu]], so it becomes checked.<br />
+You cannot hide multiple nodes at once except by hiding their parent module.
 If a variable, function, or module is hidden, when you try to view its definition, it displays:
@@ Line 29: / Line 33: @@
 :<code>[Definition is Hidden]</code>
-<Tip Title="Tip">The definition of a variable with an input node is always visible regardless of whether it or its parent module is marked as Hidden.</Tip >
+<Tip Title="Tip">You cannot hide the definition of a variable with an input node -- regardless of whether it or its parent module is marked as Hidden.By giving a variable a User Input, you are saying that all users can see and modify that variable. </Tip >
 ==Unhiding and inheritance of hiding==
-Definition hiding is inherited down the module hierarchy. If you hide a module, you hide the definitions of all the objects that it contains, including its submodules and all the objects that they contain — unless you explicitly unhide an object or submodule, in which it or the objects it contains are not hidden. To unhide a variable, function, or module:
+Definition hiding is inherited down the module hierarchy. If you hide a module, you hide the definitions of all the objects that it contains, including its submodules and all the objects that they contain — unless you explicitly unhide an object or submodule. To unhide a variable, function, or module:
 # Select its node in its parent diagram.
-# Select '''Unhide Definition(s)''' from the '''Object''' menu, so it becomes checked.<br />
+# Select '''Unhide Definition(s)''' from the [[Object menu]], so it becomes checked.<br />
+In the module hierarchy shown below, module <code>Mo1</code> is hidden, and therefore so are the objects it contains, module <code>Mo2</code>, <code>Va1</code>, and <code>Va2</code>. But module <code>Mo3</code> is unhidden, and therefore so are the objects it contains, <code>Va3</code> and <code>Mo4</code>. However, object <code>Va4</code> is itself explicitly hidden.
-In the module hierarchy shown below, module '''Mo1''' is hidden, and therefore so are the objects it contains, module '''Mo2''', '''Va1''', and '''Va2'''. But module '''Mo3''' is unhidden, and therefore so are the objects it contains, '''Va3''' and '''Mo4'''. However, object '''Va4''' is itself explicitly hidden.
+:[[File:browse-only_1.png|250px]]
-:[[File:browse-only_1.png|300px]]
+<Tip Title="Tip"> The '''Hide Definition(s)''' and '''Unhide Definition(s)''' menu options are disabled in Browse mode or if the current model, or any of its filed submodules, are encrypted. Encryption locks hiding.</Tip>
-<Tip Title="Tip"> The '''Hide Definition(s)''' and '''Unhide Definition(s)''' menu options are disabled if the current model, or any of its linked submodules, has been encrypted. In this case, encryption has locked hiding in place.</Tip>
+Hiding does not become permanent until you save the file as locked and encrypted. In the original file, you can unhide, edit, or hide as you wish in the original model. That’s why it’s so important that you save a master copy for your own use.
-After hiding the definitions you want, you can view your model to check everything is as you want. You can still Unhide items if you want to view or edit them. But, after saving the model in encrypted form, no one, even you, can view hidden definitions or edit any variables that are not inputs, even if they open the model file in a text editor. That’s why it’s important that you save a master copy for your own use.
 ==Saving an encrypted copy of your model==
-When you are ready to save an encrypted copy of your model, select '''Save a Copy''' In from the '''File''' menu.
+When you are ready to save an encrypted copy of your model, select '''Save a Copy''' In from the [[File menu]].
 :[[File:browse-only_2.png|500px]]
@@ Line 58: / Line 61: @@
 Check ''Save as a browse-only model'' if you also want to prevent users from changing any variables not designated as inputs. In that case, the model is locked in browse-only mode, even if the user runs the model with an Analytica edition that normally allows editing.
-Optionally check ''Save everything in one file by embedding linked modules'' to produce a single file that can be distributed. If your model is utilizing unlocked linked modules, the content in those may remain exposed unless you use this option (alternatively, you can link to locked copies of those modules in your main model before saving your main model in a locked form). Even if you do not lock your model, this option can provide a convenient way to distribute your model as a single file to end-users, or to bundle it for upload to the Analytica Cloud Player. '''Publish to cloud''' on the '''File''' menu saves everything in a single file automatically during the upload.
+Optionally check ''Save everything in one file by embedding filed modules'' to produce a single file that can be distributed. If your model is utilizing unlocked filed modules, the content in those may remain exposed unless you use this option (alternatively, you can link to locked copies of those modules in your main model before saving your main model in a locked form). Even if you do not lock your model, this option can provide a convenient way to distribute your model as a single file to end-users, or to bundle it for upload to the [[Analytica Cloud Platform]]. '''Publish to cloud''' on the [[File menu]] saves everything in a single file automatically during the upload.
-A browse-only model is always encrypt to prevent anyone from editing the source Analytica file. Thus, it automatically checks ''Lock and encrypt the copy'' and the ''Save in XML format'' option is not available.
-If you want end users to be able to use other Enterprise features, such as database access, file reading and writing, Huge Arrays, or performance profiling, they need the Power Player — or their own Enterprise edition. Enterprise and Optimizer-level features are available to users viewing your model through the Analytica Cloud Player (ACP).
+A browse-only model is always encrypted to prevent anyone from editing the source Analytica file. That's why it automatically checks ''Lock and encrypt the copy'' and the ''Save in XML format'' option is not available.
-When a browse-only model (saved as such from Enterprise) is loaded into Analytica Professional, it runs it in Power Player mode, so that database access, etc., is available.
+If you want end users to be able to use other Enterprise features, such as database access, file reading and writing, Huge Arrays, or performance profiling, they need the Power Player — or their own Enterprise edition. [[analytica Enterprise|Enterprise]] and [[analytica Optimizer Guide|Optimizer]]-level features are available to users viewing your model through the [[Analytica Cloud Platform]] (ACP).
-==Linked libraries and submodules==
+When a user runs a browse-only model (saved as such from Enterprise) into Analytica Professional, it runs it in Power Player mode, so that database access, etc., is available (features not otherwise accessible from Analytica Professional).
-<Tip Title="Warning"> When your model utilizes linked libraries or submodules, you need to be very careful that the module files you distribute to your users are indeed encrypted or locked as you intend, while at the same time ensuring that you do not accidentally encrypt your master copies of these modules.  Because locking a model as encrypted or browse only is an irreversible operation, it is extremely
+==Filed libraries and submodules==
-important that you don’t accidentally lock your master versions. If your model uses linked libraries or linked modules, to avoid inadvertently making these mistakes, it is highly recommended that you embed all modules and libraries check in your encrypted copy by checking Save everything in one file by embedding linked modules.</Tip>
-When you save a copy of your model, without checking the ''Save everything in one file by embedding linked modules'' option, Analytica 4.2 and later will save a locked copy only of the top-level model file. The locked status of any linked modules remain in their original state, such that individual module files may remain non-encrypted or editable. If you don’t want to embed all linked modules in your encrypted copy, then you’ll need to save an encrypted copy of each submodule individually, and then use '''“Add Module...”''' with the ''Link and Merge'' options to switch your model to using the locked copy, prior to saving a copy of your top-level model.
+<Tip Title="Warning"> If your model uses separately filed libraries or submodules, you need to be very careful that the module files you distribute to your users are indeed encrypted or locked as you intend. You must also ensure that you don't accidentally encrypt your master copies of these modules.  Because locking a model as encrypted or browse only is irreversible, it is extremely important that you don’t accidentally lock your master versions. To avoid inadvertently locking separately filed modules, we highly recommend that you embed all modules and libraries check in your encrypted copy by checking Save everything in one file by embedding filed modules.</Tip>
-If you ever use a pre-4.2 release of Analytica, take extreme caution when encrypting a model containing linked modules -- release 4.1 and earlier will also encrypt the linked module files. Thus, it is imperative that you make a copy of all linked sub-modules before saving an encrypted copy.
+When you save a copy of your model without checking the ''Save everything in one file by embedding filed modules'' option, it saves a locked copy only of the top-level model file. The locked status of any filed modules remain in their original state, such that individual module files may remain non-encrypted or editable. If you don’t want to embed all filed modules in your encrypted copy, you’ll need to save an encrypted copy of each submodule individually, and use '''“Add Module...”''' with the ''Link and Merge'' options to switch your model to using the locked copy, prior to saving a copy of your top-level model.
-In Analytica 4.2 and later, you can distribute locked copies of libraries or modules, allowing other model developers to utilize those libraries without being able to view your proprietary definitions (when they are encrypted) or being able to modify the libraries (when locked as browse-only). When using locked libraries, certain operations involving objects in those modules are restricted. You cannot embed an encrypted sub-module within a non-encrypted module, but you can use it as a linked module. Embedding an encrypted module in an encrypted module is allowed. Various operations that might allow a user to gain access to your hidden definitions are disallowed, such as moving an object with a hidden definition from an encrypted module to a non-encrypted module.
+You can distribute locked copies of libraries or modules to let other model developers use them without being able to see your proprietary definitions (if Hidden) or being able to modify them (when locked as browse-only). When using locked libraries, certain operations involving objects in those modules are restricted. You cannot embed an encrypted sub-module within a non-encrypted module, unless it is a separately filed module. You can embed an encrypted module in an encrypted parent model. Various operations that might allow a user to gain access to your hidden definitions are disallowed, such as moving an object with a hidden definition from an encrypted module to a non-encrypted module.
-<Tip Title="Warning"> If you distribute locked module files for use by others to use in their models, it is important to ensure that they are using Analytica 4.2 or later. Loading an encrypted or browse-locked module into a model from Analytica 4.1 or earlier will result in the entire model being placed in the same locked state. The ability to utilize a combination of locked and unlocked modules in the same model requires Analytica 4.2 or later.</Tip>
+== See Also ==
+* [[Modules and Libraries]]
+* [[Obfuscated and Browse-Only Models]]
+* [[Definition]]
-<footer>Read data from URL on internet / {{PAGENAME}} / Huge Arrays</footer>
+<footer>Combining models into an integrated model / {{PAGENAME}} / Managing windows</footer>