Difference between revisions of "BI Editor"

From Fishbowl
Jump to: navigation, search
m (Text replacement - "|link=" to "")
Line 3: Line 3:
 
== View {{top}} ==
 
== View {{top}} ==
  
* Open a {{Module Button|Page|3=text-top}} and click the {{Icon Button|Run|Preview}} on the component toolbar to the right.<br>[[File:Component toolbar scripts.png|link=]]
+
* Open a {{Module Button|Page|3=text-top}} and click the {{Icon Button|Run|Preview}} on the component toolbar to the right.<br>[[File:Component toolbar scripts.png]]
* The buttons at the top of the preview window can be used to {{Module Button|Refresh}}, {{Module Button|Modify Report|Modify}}, {{Module Button|Save}}, or {{Module Button|Print}} the current view. The preview can also be refreshed by pressing '''F5''' on the keyboard.{{Vertical Spacer}}[[File:BI Script.png|link=]]
+
* The buttons at the top of the preview window can be used to {{Module Button|Refresh}}, {{Module Button|Modify Report|Modify}}, {{Module Button|Save}}, or {{Module Button|Print}} the current view. The preview can also be refreshed by pressing '''F5''' on the keyboard.{{Vertical Spacer}}[[File:BI Script.png]]
* Click the {{Button|Modify Report|Modify Parameters}} to change the parameter data displayed in the current view.{{Vertical Spacer}}[[File:Script parameters.png|link=]]
+
* Click the {{Button|Modify Report|Modify Parameters}} to change the parameter data displayed in the current view.{{Vertical Spacer}}[[File:Script parameters.png]]
 
* BI scripts can also be viewed by adding them to the {{Module|Dashboard|Add gadgets}}.
 
* BI scripts can also be viewed by adding them to the {{Module|Dashboard|Add gadgets}}.
  
 
== Edit {{top}} ==
 
== Edit {{top}} ==
  
* Scripts can be edited by modifying the text in the code area and then clicking the {{Button|Save}}.<br>[[File:Edit script.png|link=]]
+
* Scripts can be edited by modifying the text in the code area and then clicking the {{Button|Save}}.<br>[[File:Edit script.png]]
* Built-in scripts, created by Fishbowl, display a lock icon.<br>[[File:Locked script.png|link=]]
+
* Built-in scripts, created by Fishbowl, display a lock icon.<br>[[File:Locked script.png]]
* If a built-in script is modified, the original will be duplicated, prefixed with '''(FB)''', and inactivated.<br>[[File:Locked inactive script.png|link=]]
+
* If a built-in script is modified, the original will be duplicated, prefixed with '''(FB)''', and inactivated.<br>[[File:Locked inactive script.png]]
* Inactive scripts can be seen by using the '''Advanced Search'''.<br>[[File:BI Scripts Advanced Search.png|link=]]
+
* Inactive scripts can be seen by using the '''Advanced Search'''.<br>[[File:BI Scripts Advanced Search.png]]
* To find text in a file, select the text and then press '''Ctrl''' + '''F'''.<br>[[File:BI Find.png|link=]]
+
* To find text in a file, select the text and then press '''Ctrl''' + '''F'''.<br>[[File:BI Find.png]]
* To replace text in a file, select the text and then press '''Ctrl''' + '''R'''.<br>[[File:BI Replace.png|link=]]
+
* To replace text in a file, select the text and then press '''Ctrl''' + '''R'''.<br>[[File:BI Replace.png]]
* To see changes that have been made to a file, select two versions on the '''History''' tab and then click the {{Icon Button|Compare versions}}.<br>[[File:BI Compare.png|link=]]
+
* To see changes that have been made to a file, select two versions on the '''History''' tab and then click the {{Icon Button|Compare versions}}.<br>[[File:BI Compare.png]]
 
* To revert to a previous version of a file, click the {{Icon Button|Compare versions}}, then copy and paste the text from a prior version.
 
* To revert to a previous version of a file, click the {{Icon Button|Compare versions}}, then copy and paste the text from a prior version.
  
Line 23: Line 23:
 
The following buttons are located at the top of the module.
 
The following buttons are located at the top of the module.
  
[[File:BI Script Module Buttons.png|link=]]
+
[[File:BI Script Module Buttons.png]]
  
 
* {{Module Button|New}} creates a new {{Module Button|Page|3=text-top}}. Click the drop-down arrow to create a new {{Module Button|Template|3=text-top}}, {{Module Button|Style|3=baseline}}, or {{Module Button|Script|3=text-top}}.
 
* {{Module Button|New}} creates a new {{Module Button|Page|3=text-top}}. Click the drop-down arrow to create a new {{Module Button|Template|3=text-top}}, {{Module Button|Style|3=baseline}}, or {{Module Button|Script|3=text-top}}.
Line 39: Line 39:
 
The following buttons are located on the component toolbar to the right.
 
The following buttons are located on the component toolbar to the right.
  
:[[File:BI Script Component Buttons.png|link=]]
+
:[[File:BI Script Component Buttons.png]]
  
* The {{Icon Button|Run|Preview page}} shows a preview of any {{Module Button|Page|3=text-top}}.<br>[[File:BI Script.png|link=]]
+
* The {{Icon Button|Run|Preview page}} shows a preview of any {{Module Button|Page|3=text-top}}.<br>[[File:BI Script.png]]
* The {{Icon Button|Include script}} inserts the name of a saved {{Module Button|Script|3=text-top}}, {{Module Button|Style|3=baseline}}, or {{Module Button|Template|3=text-top}}.<br>[[File:Include Script.png|link=]]
+
* The {{Icon Button|Include script}} inserts the name of a saved {{Module Button|Script|3=text-top}}, {{Module Button|Style|3=baseline}}, or {{Module Button|Template|3=text-top}}.<br>[[File:Include Script.png]]
* The {{Icon Button|Include parameter}} inserts the name of a built-in parameter.<br>[[File:Include Parameter.png|link=]]
+
* The {{Icon Button|Include parameter}} inserts the name of a built-in parameter.<br>[[File:Include Parameter.png]]
* The {{Icon Button|Include built-in JavaScript}} inserts the name of a built-in JavaScript.<br>[[File:Include Javascript.png|link=]]
+
* The {{Icon Button|Include built-in JavaScript}} inserts the name of a built-in JavaScript.<br>[[File:Include Javascript.png]]
* The {{Icon Button|Lint check}} suggests improvements for a JavaScript file.<br>[[File:JS Lint Check.png|link=]]
+
* The {{Icon Button|Lint check}} suggests improvements for a JavaScript file.<br>[[File:JS Lint Check.png]]
* The {{Icon Button|Save script to file}} saves the file that is currently open as a JSON file.<br>[[File:Save JSON.png|link=]]
+
* The {{Icon Button|Save script to file}} saves the file that is currently open as a JSON file.<br>[[File:Save JSON.png]]
  
 
== Tips {{top}} ==
 
== Tips {{top}} ==
  
* Items on a pie chart can be hidden by clicking the label in the legend.<br>[[File:Pie hide.png|link=]]
+
* Items on a pie chart can be hidden by clicking the label in the legend.<br>[[File:Pie hide.png]]
* Press '''Ctrl''' + '''G''' to jump to a line of code.<br>[[File:Line jump.png|link=]]
+
* Press '''Ctrl''' + '''G''' to jump to a line of code.<br>[[File:Line jump.png]]
 
* Press '''Ctrl''' + '''C''' to copy a line of code or the selected text.
 
* Press '''Ctrl''' + '''C''' to copy a line of code or the selected text.
 
* Press '''Ctrl''' + '''X''' to cut a line of code or the selected text.
 
* Press '''Ctrl''' + '''X''' to cut a line of code or the selected text.

Revision as of 14:24, 19 July 2018

Icon.BI Editor.png The BI Script module, located in the General group, allows the creation of Business Intelligence (BI) scripts, which are used to display robust HTML reports. These reports can be saved, printed, and displayed in the Small.Dashboard.png Dashboard module. Fishbowl includes several scripts for free. To purchase a custom script, contact reportsEmail.png.

View Template:Top

  • Open a Page Button.png Page and click the Run Icon Button.png Preview button on the component toolbar to the right.
    Component toolbar scripts.png
  • The buttons at the top of the preview window can be used to Refresh Button.png Refresh, Modify Report Button.png Modify, Save Button.png Save, or Print Button.png Print the current view. The preview can also be refreshed by pressing F5 on the keyboard.Template:Vertical SpacerBI Script.png
  • Click the Modify Report Button.png Modify Parameters button to change the parameter data displayed in the current view.Template:Vertical SpacerScript parameters.png
  • BI scripts can also be viewed by adding them to the Small.Dashboard.png Dashboard module.

Edit Template:Top

  • Scripts can be edited by modifying the text in the code area and then clicking the Save Button.png Save button.
    Edit script.png
  • Built-in scripts, created by Fishbowl, display a lock icon.
    Locked script.png
  • If a built-in script is modified, the original will be duplicated, prefixed with (FB), and inactivated.
    Locked inactive script.png
  • Inactive scripts can be seen by using the Advanced Search.
    BI Scripts Advanced Search.png
  • To find text in a file, select the text and then press Ctrl + F.
    BI Find.png
  • To replace text in a file, select the text and then press Ctrl + R.
    BI Replace.png
  • To see changes that have been made to a file, select two versions on the History tab and then click the Compare versions Icon Button.png Compare versions button.
    BI Compare.png
  • To revert to a previous version of a file, click the Compare versions Icon Button.png Compare versions button, then copy and paste the text from a prior version.

Module buttons Template:Top

The following buttons are located at the top of the module.

BI Script Module Buttons.png

  • New Button.png New creates a new Page Button.png Page. Click the drop-down arrow to create a new Template Button.png Template, Style Button.png Style, or Script Button.png Script.
  • Import Script Button.png Import allows BI scripts to be imported from a JSON file.
  • Save Button.png Save will save changes to the file that is currently open.
  • Delete Button.png Delete will delete the file that is currently open.
  • Duplicate Button.png Duplicate will create a duplicate of the file that is currently open.
  • Email Button.png Email opens a window to compose an email. If the module's default report is specified, the PDF report will be attached. Email can be configured on the Email tab tab of the Small.Settings.png Setup module.
  • Print Button.png Print sends the default module report to the printer.
  • How To Button.png How To opens this article in a web browser.
  • Refresh Button.png Refresh reloads whatever is currently open in the module.

Component buttons Template:Top

The following buttons are located on the component toolbar to the right.

BI Script Component Buttons.png
  • The Run Icon Button.png Preview page button shows a preview of any Page Button.png Page.
    BI Script.png
  • The Include script Icon Button.png Include script button inserts the name of a saved Script Button.png Script, Style Button.png Style, or Template Button.png Template.
    Include Script.png
  • The Include parameter Icon Button.png Include parameter button inserts the name of a built-in parameter.
    Include Parameter.png
  • The Include built-in JavaScript Icon Button.png Include built-in JavaScript button inserts the name of a built-in JavaScript.
    Include Javascript.png
  • The Lint check Icon Button.png Lint check button suggests improvements for a JavaScript file.
    JS Lint Check.png
  • The Save script to file Icon Button.png Save script to file button saves the file that is currently open as a JSON file.
    Save JSON.png

Tips Template:Top

  • Items on a pie chart can be hidden by clicking the label in the legend.
    Pie hide.png
  • Press Ctrl + G to jump to a line of code.
    Line jump.png
  • Press Ctrl + C to copy a line of code or the selected text.
  • Press Ctrl + X to cut a line of code or the selected text.
  • Press Ctrl + D to duplicate a line of code or the selected text.
  • Press Ctrl + Y to delete a line of code.
  • To purchase a custom script, contact reportsEmail.png.