Opening the Hamburger Menu of File-Related Commands

     

The Hamburger menu, , opens the file-related commands. You can open an existing document, save an active document, and print an active document. The Options button opens the WebFOCUS App Studio Options dialog box, where you can set user preferences. The Hamburger menu also lists recently opened documents. The Hamburger menu is always available. It is located in the upper-left corner of the WebFOCUS App Studio interface.

Tip: Double-click the Hamburger menu to exit WebFOCUS App Studio. If you exit it in this way, active (open) applications will not be saved.

From the Hamburger menu, you can perform the following actions:

  • Open. Open an existing document. You can open a file from the list of configured WebFOCUS environments.
  • Save. Save the active document.
  • Save As. Save the active document with a new name.
  • Save All. Save all open documents with the current file names. There will be no prompting for file names.
  • Run. Run the report, chart, HTML page, or document. When you click the Run menu, the Message Viewer Options submenu opens.

    From the Message Viewer Options submenu, you can select from among four Message Viewer Options that affect the WebFOCUS App Studio Viewer display when a report, chart, HTML page, or document is run. The options are:

    • When you select Message Viewer OFF and run a report, the WebFOCUS App Studio Viewer window displays the report without any messages.
    • When you select Message Viewer ON and run a report, the WebFOCUS App Studio Viewer window displays the report and a message.
    • When you select Display command lines, the WebFOCUS App Studio Viewer window displays the report and the command lines.
    • When you select Display Dialogue Manager commands, the WebFOCUS App Studio Viewer window displays the report and the Dialogue Manager commands, and the result of their evaluation.
  • Print. Print the active document. When you click the Print menu, the Preview and print the document submenu opens.

    From the Preview and print the document submenu, you can print the active document using the current print options, preview the active document before printing, and configure your print options.

    Note: The Print and Quick Print options are only available when you edit content in the Text Editor, or when the Source view tab, in the Report canvas, is active.
  • Close. Close the active document.
  • Close All. Close all open documents. If changes were made to a file, you will be prompted to save the changes.
  • Options. Open the Options dialog box, where you can set user preferences.
  • Exit. Close the active document and exit WebFOCUS App Studio.
Note:
  • In the Hamburger menu, the terms document and active document represent all files which you can create in WebFOCUS App Studio.
  • Spaces are not allowed in file names. When naming a report, chart, HTML page, or document in their respective wizards or in the Save As dialog box, spaces are replaced with underscores (_). When naming a procedure, spaces and underscores are not permitted, and when you press the Space bar, nothing happens. If the domain is set to display by title, the wizards, Open dialog box, and Save As dialog box will still expect a proper name, with no spaces, to be entered.

Open File Dialog Box

The Open File dialog box opens when you click Open from the Hamburger menu or the Quick Access toolbar. 

The Open File dialog box displays files that you can open and edit in WebFOCUS App Studio.

Configured Environments list

Contains a list of currently Configured Environments. You can navigate to different environments and development areas to display different files in the file list.

File list

Displays all files of a specific type in a selected folder and includes the name, size, type, last modified date, location, database type, title, and status of the file.

Note: Instead of the regular Master File icon, Master Files that have a DEFINE use the DEFINE icon and Master Files that have a Join use the JOIN icon.
Preview

Displays a preview of the contents in a selected file or a thumbnail preview of a selected image.

File name text box

Use this text box to type the name of a file you want to open.

Note: If you are in the Workspaces area and the Configured Environments tree is set to display by title, the Open File dialog box will only require a name to be entered.
File Type drop-down list

Filters to display all files of a specified file type. You can filter for .fex, .htm, .js, .css, .prtl, .page, .blog, .sch, .adr, .ad, .sty, .mnt, .txt, and .lib. You can also choose to display all files.

Use Qualified Path

When selected, the fully qualified path name of the file you select will be used.

Note: This check box appears only in the Report and Chart Wizard.
Show Tree

When selected, displays the Configured Environments tree. This option is only available when opening a file using commands and features in the Report canvas, HTML canvas, Document canvas, Join canvas, and the Procedure View panel.

Details Toggle

Toggles between displaying the files in the file list with details (date modified, size, and so on) or in a list. Displaying files with details is the default.

Note: WebFOCUS App Studioremembers your choice and will keep the setting you chose the next time the Open File dialog box is open. For example, if you choose to display file details the first time you invoke the Open File dialog box, then the next time you invoke the Open File dialog box, file details are shown.
Refresh Button

When clicked, refreshes the list of available files.

Save As Dialog Box

 

The Save As dialog box opens when you click Save As from the Hamburger menu. You can use this dialog box to save a file to another location or to provide a different file name.

Configured Environments list

Contains a list of currently Configured Environments. You can navigate to different environments and development areas to display different files in the file list.

File list

Displays all files of a specific type in a selected folder.

File name text box

Use this text box to type the name of a file you want to open.

Note: If you are in the Workspaces area and the Configured Environments tree is set to display by title, the Save As dialog box will only require a name to be entered.
File Type drop-down list

Displays the filter based on the applicable file type.

Details Toggle

Toggles between displaying the files in the file list with details (date modified, size, and so on) or in a list. Displaying files with details is the default.

Note: If you choose to display details or not, WebFOCUS App Studio remembers your choice and will keep the setting you chose the next time the Open File dialog box is open. For example, if you choose to display file details the first time you invoke the Open File dialog box, then the next time you invoke the Open File dialog box, file details are shown.
Refresh Button

When clicked, refreshes the list of available files.

Setting User Preferences Using the Options Dialog Box

 

You can customize WebFOCUS App Studio by setting specific user preferences, using the following tabs in the WebFOCUS App Studio Options dialog box. To open the Options dialog box, click Options in the Hamburger menu.

General Tab

 The General tab contains options for starting WebFOCUS App Studio, minimizing the main window, and other settings. The following options are available.

Main Window Options

Option

Description

Maximize main window

Maximizes the application window when you begin each session.

Smart Context

Option

Description

Set new column type based on metadata/surrounding fields

Sets new column types by using metadata and surrounding fields.

Activate Field ribbon tab when selecting a field on the report canvas

Activates the Field tab on the ribbon upon selection of a field within the report canvas.

Activate Layout ribbon tab when no selection is made on the report canvas

Activates the Layout tab on the ribbon when no selection is made on the report canvas and you click the white space.

Other Settings

Option

Description

Show Welcome Screen

Controls the appearance of the Welcome screen when WebFOCUS App Studio is launched.

Confirm close

Displays a prompt for users to confirm that they want to exit WebFOCUS App Studio.

Recent file list limit

Allows you to set the number of recently used files that appear in the Recent file lists. The default value is 25.

Ping Interval (minutes)

Sets the frequency at which requests are sent to the web or application server so your connection does not time out. The default is 5.

Save Document Recovery Information every (minutes)

Sets the frequency for saving document recovery information. The default is 5.

Reset All Message Boxes

Resets all message boxes to their default state. For example, if you selected the Don’t show this message again check box in any message box, clicking this button will reset all message boxes. Once you click this button, it becomes inactive until you choose not to display a message box in the product.

Reset All Options to Default

Restores all options in WebFOCUS App Studio to the default settings.

Default file editor

Lists file editor options, such as:

  • Edit in WebFOCUS App Studio canvas
  • Edit in Text Editor
  • Edit in Windows registered tool
Note: The Edit in Windows registered tool option is only visible if the file type you are accessing has been associated with a Windows application.

The file editor used determines which shortcut menu options are available and controls the default behavior for double-clicking and right-clicking files.

Language

Provides a drop-down list that allows you to change the language of the WebFOCUS App Studio screen text. After you change the language, restart WebFOCUS App Studio to make the change effective. The languages listed are selected in the Dynamic Language Switch setting in the WebFOCUS Administration Console.

The Sync with WebFOCUS check box is selected, by default. When this check box is selected, the language used for WebFOCUS App Studio and WebFOCUS are synced with the language selected in the Language drop-down list. If this check box is not selected, WebFOCUS App Studio uses the language selected in the Language drop-down list and WebFOCUS uses the language selected in the Environments dialog box. If you make changes, restart WebFOCUS App Studio to make the change effective.

Reporting Tab

 

The Reporting tab contains format options for output, field list displays, formatting a report for the web, and setting the record retrieval limits. The following options are available.

Field List Options

The following options affect the appearance of the Fields tab of the Object Inspector.

Option

Description

Sort the list by field name

Sorts any list of field names alphabetically.

Show fully qualified field names

Displays any list of field names as qualified field names, which include data source and table names, alphabetically.

Display the field name

Displays the full field name in the Fields tab, as specified in the file description.

Display the field alias

Displays the alternate field name in the Fields tab, as specified in the file description.

Display field titles

Displays the titles for columns, filters, and computes in the Fields tab, as specified in the file description.

Display field descriptions

Displays descriptive information about the field in the Fields tab, as specified in the file description.

Display the data formats

Displays the field length and format type in the Fields tab, as specified in the file description.

Expand field tree

Displays fields in expanded mode when using a Field tree. If this option is not selected, segments appear collapsed wherever a Field tree appears.

Note: This option can also be accessed from the Field tree shortcut menu.

Display Filters in Filters Folder

Displays Filters in a separate Filters folder of the Field tree. If this option is not selected, Filters appear with the rest of the fields in the segment.

Note: This option can also be accessed from the Field tree shortcut menu.

Authoring Mode

The Authoring Mode options determine how field names in a procedure (.fex) are written in the WebFOCUS App Studio source code. These options are not affected by the selected Field List options.

Option

Description

Qualified fieldname

Writes the source code using qualified field names, for example:

BY 'GGSALES.SALES01.CATEGORY'

Unqualified fieldname

Writes the source code using unqualified field names, for example:

BY CATEGORY

Alias fieldname

Writes the source code using alias field names, as defined in the ALIAS field of the Master File. The ALIAS field assigns an alternative name for a column.

The following example shows source code in which the Category field name is assigned E02 in the ALIAS field of the ggsales.mas Master File:

BY E02

Other

Option

Description

Default Report Format

Sets a report format to use as the default format by the Reporting feature.

Select the display format for your reports. You can select from the following options:

  • HTML
  • PDF
  • Excel XLSX
  • Excel XLS
  • PowerPoint PPTX
  • PowerPoint PPT
  • Default (This option is the FOCUS default. It applies to whichever of the previous formats was set as an environment parameter.)
  • User

Maximum number of records to retrieve

Specifies a limit on the number of records to retrieve from the data source. Setting a retrieval limit creates selection criteria for both Retrieval Limit and Read Limit dialog boxes.

Specify a retrieval limit when you need only a few records to test the design of a new report, or you know how many records meet the test criteria and want to stop a search after those records are retrieved. This reduces total retrieval time.

Maximum number of readings to make

Specifies a limit on the number of readings that can be made against the data source.

Default Style Template

Specifies the default styling template when you open the Report feature.

Default Report Template

Specifies the default report settings when you open the Report canvas. Click Browse to select user-created templates.

Retrieve master file descriptions

Displays Master File suffix and description in the Environments Tree, and in the Chart Wizard and the Report Wizard. System performance may be affected if there are a large number of Master Files. This option is not selected, by default.

If you change this option, you must exit WebFOCUS App Studio and reopen it for the change to take effect.

Binary FTM files

Allows the use of binary FOCUS Temporary Master (.ftm) files in WebFOCUS App Studio. When this option is not selected, .ftm files are read as text, which is the default.

Enable OLAP

Activates the use of OLAP within WebFOCUS App Studio.

This option is not selected, by default.

Display Styling Toolbar

Specifies the click option to trigger the mini styling toolbar, which enables you to style content. You can access the toolbar by selecting one of the following options:

  • On left-click selections only.
  • On right-click selections only. This is the default value.
  • On both left-click and right-click selections.

HTML Page Tab

 

The HTML Page tab enables you to set grid settings for an HTML page, preview reports and charts, set single or multiple layers, and alter the frequency in which you refresh thumbnails.

Note: If you make changes to the HTML Page settings in the WebFOCUS App Studio Options dialog box (Grid Settings, Preview Settings), you need to press F5 to refresh an HTML page that is currently open in order to see the changes.

The following options are available.

Grid Settings

Option

Description

Show Grid

Enables you to view a grid while you create an HTML page. The Show Grid check box is selected, by default. Clear this check box if you do not want to develop with a grid.

Snap to Grid

Enables you to snap to grid on demand. The Snap to Grid check box is selected, by default. Clear this check box if you do not want to enable the snap to grid option.

Width

Customizes the width of your grid. The default is 10 pixels.

Height

Customizes the height of your grid. The default is 10 pixels.

Form type

Option

Description

None

Specifies no form object in the HTML page.

Single layer

Specifies a single layer form in the HTML page. This is the default setting.

Multiple layer

Specifies a multiple layer form in the HTML page.

Form Settings

Opens the Form settings dialog box.

Tab Characters

Option

Description

Insert spaces

Indicates that, when the Tab key is pressed, the number of spaces specified in the Tab size option is inserted.

Keep tabs

Indicates that, when the Tab key is pressed, a tab character is inserted.

Tab size

Specifies the number of spaces inserted when you press Tab.

Check boxes

Option

Description

Show 'New Parameters' dialog

Sets the New Parameters dialog box to appear in the HTML page. This is the default setting.

Default caching option

Sets the Default caching option to run in the HTML page. By default, this option is not selected.

Auto Arrange Objects

Sets the objects in the HTML page to arrange automatically. This is the default setting.

Preview settings

Option

Description

Reports and Charts Preview

Enables you to preview reports and charts before saving and deploying the HTML page. This is the default setting.

Simulated Data

Enables you to view the HTML page based on simulated data from WebFOCUS.

Live Data

Enables you to view reports and charts using live data in the HTML page. This is the default setting.

Record limit for reports

Sets the record limit for reports. Values range from -1 to 999. The default setting is 500.

Record limit for input controls

Sets the record limit for input controls. Values range from -1 to 999. The default setting is 10.

Use Prefix

Sets a prefix to run before each report or chart component on an HTML page.

Refresh thumbnails every seconds

Sets the time interval for refreshing thumbnails. Values range from 0 to 999 seconds. The default setting is 20.

Default Theme

Sets the default theme for an HTML page. The Information Builders theme is the default theme.

HTML

 Sets an alias for a new HTML page or changes the alias for an existing HTML page.

Custom. Has the value of the HTML Alias from the settings in the WebFOCUS Environment Properties dialog box. Custom is the default value.

Generic. Allows for files to be moved from one environment to the other.

Form Settings Dialog Box

The following table describes the options available in the Form Settings dialog box.

Option

Description

To the left of the input

Sets the prompt orientation to appear to the left of the input controls.

Above the input

Sets the prompt orientation to appear above the input controls. This is the default setting.

Distance between prompt and input

Sets the distance between prompt and input. The range is from 0 to 99 pixels. The default setting is 5 pixels.

Horizontal distance between controls

Sets the horizontal distance between controls. The range is from 0 to 99 pixels. The default setting is 10 pixels.

Vertical distance between controls

Sets the vertical distance between controls. The range is from 0 to 99 pixels. The default setting is 10 pixels.

Number of columns

Sets the number of columns in the form object. The default setting is 4.

Add schedule button

Adds a schedule button to the form object. This is the default setting.

This button can also be inserted from the New Parameters dialog box.

Add defer button

Enables deferred running of a report. This is the default setting.

This button can also be inserted from the New Parameters dialog box.

Start each chain on a new line

Starts chains on a new line. This is the default setting.

Document Tab

The Document tab enables you to set grid settings for a document, preview reports and charts, and alter the frequency in which you refresh thumbnails. The following options are available. 

Grid Settings

Option

Description

Show Grid

Enables you to view a grid while you create a document. The Show Grid check box is selected, by default. Clear this check box if you do not want to develop with a grid.

Snap to Grid

Enables you to snap to a grid on demand. The Snap to Grid check box is selected, by default. Clear this check box if you do not want to enable the snap to grid option.

Width

Customizes the width of your grid. The default is 10 pixels.

Height

Customizes the height of your grid. The default is 10 pixels.

Tab Characters

Option

Description

Insert spaces

Indicates that, when the Tab key is pressed, the number of spaces specified in the Tab size option is inserted.

Keep tabs

Indicates that, when the Tab key is pressed, a tab character is inserted.

Tab size

Specifies the number of spaces inserted when you press Tab.

Preview Settings

Option

Description

Reports and Charts Preview

Enables you to preview reports and charts before saving and deploying the document. This is the default setting.

Simulated Data

View the document based on simulated data from WebFOCUS.

Live Data

View reports and graphs using live data in the document. This is the default setting.

Record limit for reports

Sets the Record limit for reports. Values range from -1 to 999. The default setting is 500.

Use Prefix

Sets a prefix to run before each report or chart component on a document.

Refresh thumbnails every seconds

Sets the time interval for refreshing thumbnails. Values range from 0 to 999 seconds. The default setting is 20.

Environments Tab

 
Note: The Environments options are used to control the development areas that are visible in the Configured Environments tree. At least one option must be selected and applied to all configured environments.

The Environments tab enables you to change the viewable contents of the Configured Environments tree. The following options are available.

Environments settings

Option

Description

Show Data Servers area

Displays the Data Servers area in the Configured Environments tree.

Show domain area

Displays the domain area in the Configured Environments tree.

Show Web Applications area

Displays the Web Applications area in the Configured Environments tree.

Show master files for "Show all content files"

Displays Master Files when the All Files option is selected in the Environments Tree panel toolbar.

Help Configuration Tab

 

The Help Configuration tab enables you to configure the location of the web-based Help system for WebFOCUS App Studio. It provides the fields in which you can modify the WebFOCUS App Studio Help configuration information to access the online Help system from your environment. The following options are available.

Option

Description

Protocol

Specify the protocol, either HTTP or HTTPS.

Host

Type the name of the machine where the Help resides.

Port

Type the port number of the web and/or application server.

Help Context Root

Type the context root for the location where the Help is hosted.

Output Viewer Settings Tab

The Output Viewer Settings tab enables you to set a specific browser to use for output, and to set the navigation options for the output (run in new window, run in same window). The following options are available. 

Browser Setup

Option

Description

Browser Setup

Select a browser to use for output.

Note:

  • The Browser Setup section is populated with a list of browsers that are installed on the WebFOCUS App Studio machine.
  • WebFOCUS App Studio works with Mozilla Firefox®, Google Chrome™, and Microsoft Edge® browsers.

Note:

As of June 15, 2022, Internet Explorer is no longer supported. Chrome will be the default setting.

  • The setting from the Output Viewer Browser Setup option is used to determine the browser to use.
  • The browser that is highlighted when you close the dialog box is the browser that will be used for execution.

Browser executable path

Sets the location of the browser executable. This field box is populated based on the browser selection.

Test URL

Indicates the test URL for testing the browser setup. The default URL is http://www.tibco.com/.

Timeout

Specifies when to interrupt an executing script in a current browsing context for the Selenium driver. The timeout value can be set between 60 seconds and 300 seconds. The default value is 60 seconds.

If you run a report that takes longer than the setting in the Timeout field, you will receive a Timeout exception message. To resolve this issue, you can either set the Timeout value between 60 seconds and 300 seconds or clear the Timeout field completely. You will no longer receive a Timeout exception message. However, if you clear the Timeout field, you will see two tabs. The first tab shows a blank page and the second tab shows the report output.

Note: The Timeout field does not apply to the Internal Viewer.

Web driver location

Sets the location of the web driver for the browser. This field box is populated based on the browser selection.

Test browser setup

Tests the browser setup, using the test URL. If the test is successful, the webpage will display in the browser and you will receive a success message. If the test is unsuccessful, you will receive a failed message.

Save selected browser setup

Saves the setup information for the selected browser.

Navigation Options

Option

Description

Run in new window/tab*

Sets the output to run in a new window or tab.

Run in same window

Sets the output to run in the same window.

File Extensions Tab

The File Extensions tab lists the currently supported file extensions. They are all selected, by default, and you can clear the check box for any file types that you do not want retrieved from the server.

 
Note: You must exit and restart WebFOCUS App Studio for your selections to take effect.

Option

Description

File Type

The file extension for a specific type of file.

Display

If selected, displays this file type throughout WebFOCUS App Studio.