Application Button

In this section:

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

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


Top of page

x
Application Menu

In this section:

The Application button, which is represented by the App Studio icon, opens the Application menu, as shown in the following image.

Application menu

From this menu, you can perform the following actions:

Note:



x
Reference: New Dialog Box

The New dialog box opens when you click New from the Application menu. You select the type of file you want to create and then click OK. The New dialog box is shown in the following image.

New dialog box

New list

You can use the New list to select which type of document you want to create. You can select from the following document types:

  • Procedure. Creates a .fex file, which defines how data is retrieved and displayed.

  • Procedure via Text Editor. Creates a .fex file that you can customize using the text editor.

  • HtmlPage. Creates a page in html format. You can import existing HTML content, as well.

  • Document. Creates a document into which you can import reports, charts, and images. You can also create text boxes to import text and lines to draw boxes or lines.

  • JavaScript File. Creates a new JavaScript file from which you can create original JavaScript.

  • Cascading Style Sheet. Creates a base template from which you can create a unique Cascading Style Sheet (CSS).

  • WebFOCUS Style Sheet. Creates a base template from which you can create a unique WebFOCUS Style Sheet.

  • Text Document. Creates a text document that can be stored to a local project. You can use the add or remove comment to comment the file.

OK

Closes the New dialog box.

Cancel

Closes the New dialog box and cancels file creation.

Help

Opens the App Studio Help.



x
Reference: Open File Dialog Box

The Open File dialog box is shown in the following image.

Open File dialog box

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

Configured Environments list

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

File list

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

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.

File name

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

Note: If you are in the Repository section and the 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 filter for .fex, .htm, .js, .css, .mnt, and .txt files. You can also choose to display all files.

Show All Files in Associated Paths

Displays all files that are associated with the parent folder, when selected. Only one option, Show all Files in Associated Paths or Show Files in Selected Path Only, can be selected at a time.

Show Files in Selected Path Only

Displays only files in the current, selected folder. This option is selected by default. Only one option, Show all Files in Associated Paths or Show Files in Selected Path Only, can be selected at a time.

Use Qualified Path

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

Related Information:

Show Tree

When selected, displays the Environment 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, etc) or in a list. Displaying files with details is the default.

Note: If you choose to display details or not, 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 chose 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.

File Information

Displays the name, date modified, size, and type of the file.



x
Save As Dialog Box

The Save As dialog box opens when you click Save As from the Application menu. You can use this dialog box to save a file to another location or to provide a different file name. The Save As dialog box is shown in the following image.

Save As dialog box

Configured Environments list

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

File list

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

File name

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

Note: If you are in the Repository section and the 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

Filters to display all files of a specified file type. You filter for .fex, .htm, .js, .css, .mnt, and .txt files. You can also choose to display all files.

Details Toggle

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

Note: If you choose to display details or not, 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 chose 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.

Show All Files in Associated Paths

Displays all files that are associated with the parent folder, when selected. Only one option, Show all Files in Associated Paths or Show Files in Selected Path Only, can be selected at a time.

Show Files in Selected Path Only

Displays only files in the current, selected folder. This option is selected by default. Only one option, Show all Files in Associated Paths or Show Files in Selected Path Only, can be selected at a time.

File Information

Displays the name, date modified, size, and type of the file.



x
Setting User Preferences

You can customize App Studio by setting specific user preferences through the App Studio Options dialog box, as shown in the following image.

App Studio Options screen

To open the Options dialog box, click Options in the Application menu. The tabs at the top of this dialog box include the following:



x
General Tab

The General tab contains the following options.

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 App Studio is launched.

Confirm close

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

Start local WebFOCUS Server

Starts the local Reporting Server when App Studio is launched.

Stop local WebFOCUS Server on exit

Stops and closes the local Reporting Server when you exit 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.

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.

Use short Last Modified date format

Displays the short date format, mm/dd/yyyy hh:mm AM/PM, in the Open File dialog box, and the Environments Detail panel. This is the default format. You can clear this option to display the long date format, day, month, date, year hh:mm:ss AM/PM.

Default file editor

Lists file editor options, such as:

  • Edit in App Studio canvas
  • Edit in Text Editor
  • Edit in Windows registered tool

Note: The Edit in Windows registered tool is only visible if the file type you are accessing has been associated with a Windows application.

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



x
Reporting Tab

The Reporting tab contains the following options.

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 context 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 context menu.

Authoring Mode

The Authoring Mode options determine how field names in a procedure (.fex) are written in the WebFOCUS 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

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

  • HTML
  • Active Report
  • Active Flex
  • Active PDF
  • 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.



x
Setting the Default Report Format

The Reporting tab of the App Studio Options dialog box allows you to set a report format to use as the default format by the Report feature.



x
Procedure: How to Set the Default Report Format

The following procedure describes how to set the default report format. In this example, User format is selected.

  1. From the Application menu, click Options.
  2. Click the Reporting tab.
  3. From the Default Report Format drop-down list, select the required format, as shown in the following image.

    Reporting tab of App Studio Options dialog box

  4. Click OK.

    The User output is now the Default Report Option in the App Studio Report mode. The User format allows the application to select the actual output type at run time. For example, a developer could choose to view a report as Excel XLSX, PDF, active report, and more.



x
HTML Page Tab

The HTML Page tab contains the following options.

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 layers in the HTML page.

Single layer

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

Multiple layer

Specifies multiple layers in the HTML page.

Form Settings

Opens the Form settings dialog box. The options for Form settings are described in 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 run the HTML page based on simulated data from WebFOCUS.

Live Data

Enables you to run 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 from the Default Theme drop-down list. The Information Builders theme is the default theme.



x
Reference: 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 form settings.

Above the input

Sets the prompt orientation to appear above the form settings. 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 4 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 horizontal distance between controls. The range is from 0 to 99 pixels. The default setting is 10 pixels.

Add schedule button

Adds a schedule to your HTML page. This is the default setting.

Add defer button

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

Start each chain on a new line

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



x
Document Tab

The Document tab contains the following options.

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

Runs the document based on simulated data from WebFOCUS.

Live Data

Runs 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.



x
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 contains the following options.

Environments settings

Option

Description

Show Projects area

Displays the Projects area in the Configured Environments tree. This is the default setting.

Show Data Servers area

Displays the Data Servers area in the Configured Environments tree.

Show Repository area

Displays the Repository area in the Configured Environments tree.

Show Web Applications area

Displays the Web Applications area in the Configured Environments tree.



x
Help Configuration Tab

The Help Configuration tab provides the fields in which you can modify the App Studio Help configuration information to access the online Help system from your environment.

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.



x
Output Viewer Settings Tab

The Output Viewer Settings tab enables you to set a specific browser to use for output or to use the App Studio Internal Viewer (default), and to set the navigation options for the output (run in new window, run in same window).

Option

Description

Browser Setup

Select a browser to use for output or select the App Studio Internal Viewer (default).

Note:

  • The Browser Setup section is populated with a list of browsers that are installed on the App Studio machine.
  • App Studio works with Mozilla Firefox®, Google Chrome™, and Microsoft Internet Explorer® browsers.
  • 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.

Web driver location

Sets the location of the web driver for the browser. 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.ibi.com.

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.

Run in new window

Sets the output to run in a new window.

Run in same window

Sets the output to run in the same window.


WebFOCUS