BI Editor

From Fishbowl
Revision as of 21:48, 10 April 2018 by Ncarter (talk | contribs)
Jump to: navigation, search

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, or 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

  • BI scripts can be viewed by double-clicking a Page Button.png Page, and then clicking 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.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 modified by editing text in the code window and then clicking the Save Button.png Save button.
  • 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. The Include... buttons will insert the name of an item at the current cursor position.

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 File:Include built-in javascript Icon Button.png Include built-in javascript button inserts the name of a built-in javascript.
    Include Javascript.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 + C to copy a line of code.
  • Press Ctrl + X to cut a line of code.
  • Press Ctrl + Y to delete a line of code.
  • Press Ctrl + D to duplicate a line of code.
  • Press Ctrl + G to jump to a line of code.
  • To purchase a custom script, contact reportsEmail.png.