Development Tools

In this section:

 

Developer Studio offers a selection of graphical development tools for building web-based reporting applications. These tools can be accessed from the Projects on localhost folder for local development and deployment to the web. A subset of the tools can also be accessed from the WebFOCUS Environments folder for development or editing directly on the Reporting Server and the web server.

Note: When naming applications, spaces and special characters are not allowed. For example:

! @ # $ % ^ & * ( ) + =

Below are some of the tasks and tools that you can use in Developer Studio.

Creating your local project

The Project Wizard, which you can access only from the Projects area, creates an application control file and defines search paths for additional project resources. For more information, see Project Wizard.

Creating data source descriptions

Use one or more of the following:

Building report procedures

Use one or more of the following:

Creating launch pages

Developer Studio creates launch pages that prompt for values.

HTML Composer. Creates reporting procedures and highly refined HTML pages from which the procedures can be run, in a single process. For more information, see HTML Composer.

Performing iterative OLAP analysis

Use the following:

Deploying projects to the web

Deploy Wizard. Partitions and copies files to the specified Reporting Server and web server. You can only access this option from the Projects folder. For more information, see Deploy Wizard.

Coding project components

Use the following:

Managing your environment

Use one of more of the following:

Managing communication with the server


Top of page

x
Project Wizard

The Project Wizard enables you to name the project, designate a directory for it, and optionally add other directory paths to data sources from which the project can retrieve information, or paths to other resources.

Note: Projects directories are created in lowercase.

Create Project

When you have completed the Project Wizard, the new project is added as a node in the Explorer under Projects on localhost.

For details about this tool, see Creating a Reporting Application in the Creating Reporting Applications With Developer Studio manual.


Top of page

x
Synonym Editor

The Synonym Editor enables you to view and edit existing synonyms. This tool generates the data description language required to read the data.

The Synonym Editor supports hierarchical data and the Financial Report Painter uses this data to create a tree hierarchy.

For details about the Synonym Editor, see Using the Synonym Editor in the Describing Data With Graphical Tools manual.

For more information about the Financial Report Painter, see Creating Reports With Financial Report Painter in the Creating Financial Reports manual.


Top of page

x
Create Synonym Tool

Whether you are developing projects in the local server environment (the Projects on localhost area), or running procedures from the Data Servers area under WebFOCUS Environments, you will need to ensure that the Reporting Server has the data source descriptions or synonyms it requires to locate and interpret your data sources. You can create synonyms using the Create Synonym tool.

You must configure a data adapter before you can create a synonym. You may configure adapters with the Create Synonym Tool.

For details about the Synonym Editor, see Using the Synonym Editor in the Describing Data With Graphical Tools manual.

For details about this tool, see Accessing Data and Creating Synonyms in the Describing Data With Graphical Tools manual.


Top of page

x
Synonym Wizard

For z/OS platforms, the Synonym Wizard is used to create synonyms when reporting against other remote servers (or subservers) that are configured on the target server. You can also create synonyms against DB2, the only relational data source supported on MVS.

You can use the Synonym Wizard to create a synonym for a data source on the Reporting Server, based on the native schema that resides with the data. If the remote server is configured as a subserver to a hub server, the Synonym Wizard can generate a synonym on the hub server, including an Access File that identifies the location of the data on the subserver.

The Synonym Wizard guides you through the creation process for one or more synonyms. The synonyms are created on the Reporting Server in the current application. The new synonym appears in the Master Files folder from which the wizard is launched.

Note: For data sources, Web Query uses the original Master Files stored on the server, therefore no synonyms are required.

The wizard consists of panels beginning with one shown below, where you select the relational data source you want to generate a synonym for.

Synonym Wizard


Top of page

x
Component Connector Toolbar

The Component Connector menu, which appears in the Procedure window, enables you to create components that make a procedure executable. A Comment component is displayed by default. A procedure can include one or a combination of components, as illustrated in the following window.

Open the Component Connector toolbox by clicking one of the yellow diamonds.

As you add components, the Procedure window displays an icon that represents the component. Each icon on the Component Connector toolbar launches either a graphical tool or the text editor.

You can check components in order to locate errors. Each component tool includes a Check button that checks the syntax of the code against the server.

The options available in the Component Connector menu are also available in the Task Viewer toolbar and in the Insert menu.

For details about this tool, see Creating a Reporting Procedure in the Creating Reporting Applications With Developer Studio manual.


Top of page

x
Report Painter

Report Painter provides a graphical representation of the report you are creating.

Report Painter offers great flexibility in how you can:

For details about these and many other features, see the Creating Reports With Report Painter manual.

The following list highlights features that extend your reporting capabilities:

For more information about Report Painter, see the Creating Reports With Report Painter manual.


Top of page

x
SQL Report Wizard

The SQL Report Wizard assists you with SQL passthru, which allows you to execute SQL code that retrieves data from an RDBMS. You can use the resulting extract file in Report Painter. The supported engines are DB2, DB2 for AS/400, Microsoft SQL Server, Oracle, Sybase, and Teradata.

The SQL Report Wizard is available throughout all development areas of Developer Studio: Projects, Data Servers, and Managed Reporting. When working in Managed Reporting, the tool enables administrators to use SQL in Standard Reports available in the Domain or use procedures that reside on the Reporting Server.

For more information, see the Creating Reporting Applications With Developer Studio manual.


Top of page

x
Graph Tool

The Graph Tool provides an easy way to transform almost any type of data into an effective graph that you can customize to suit your needs. Working through the tabs of the Graph Tool, you will see the many features available when creating a graph.

From the tabs in the Graph Tool, you can:

The Graph Tool is available for local and server-based development.


Top of page

x
Define Tool

The Define tool enables you to create a virtual field as a component in a reporting procedure. A virtual field is evaluated on each retrieved record that passes any selection criteria on the real fields. Define the virtual field by assigning a format and typing an expression or composing it using the calculator and the fields and functions listed in the tabbed panes in the Define tool window. The result of the expression is treated as though it were a real field stored in the data source.

When you click the Check button, the generated code is validated. A dialog box opens, displaying the component code and either an error message or text stating that no error exists.

For details about this tool, see Creating Temporary Fields in the Creating Reporting Applications With Developer Studio manual.


Top of page

x
Define Function Wizard

The Define Function wizard guides you through the process of creating a user function. The first screen of the wizard is shown in the following image.

You can view the progression of the wizard through the images that are shown on the following pages.

The Name section of the Define Function Wizard is shown in the following image. In this window, you supply a name for the Define function, as well as a description.

The Parameters section of the Define Function Wizard is shown in the following image. In this window, you specify the input parameters of the Define Function. You can rename the parameters, select a format type, and provide a description.

The Defined Fields section of the Define Function Wizard is shown in the following image. A defined field, with the same name as your function, appears. You can add multiple expressions to the Define Function.

The Complete the Define Function Wizard window is shown in the following image. The function, as well as its parameters and logic, are shown in this window before completion of the Define Function.


Top of page

x
Graph

If you would like to create a graph, InfoAssist guides you through the best way to add a customizable graph to your report. For more information, see the WebFOCUS InfoAssist manual.


Top of page

x
Set Tool

The Set tool enables you to customize procedure development. It controls the way that reports and graphs appear on the screen or printer, the content of reports and graphs, data retrieval characteristics that affect performance, and system responses to user requests. It also helps you set up your metadata and manipulate information, such as dates.

You can select parameters from a list in the Set tool, and apply an appropriate value. The tool provides the acceptable values for most of the parameters.

The Check button replaces the Run button. When you click the Check button, the generated code is validated. A dialog box opens that displays a code for the component, and either an error message or text stating that no error exists.

For details about this tool, see Customizing Your Environment in the Developing Reporting Applications manual.


Top of page

x
Join Tool

If a report requires data from two or more related data sources, you can temporarily join the files and report from them as if they were one. Joined files remain physically separate, but are treated as one data source structure.

The Join tool provides a graphical method for creating and manipulating all types of Joins. You must specify a host file, then a cross-referenced file to create a join. The Join tool displays both files and ordinarily, a default Join.

Using the Join tool, you can create:

For details about this tool, see Joining and Merging Data Sources in the Creating Reporting Applications With Developer Studio manual.


Top of page

x
Allocation Wizard

For a file managed by the operating system, such as an ISAM or comma-delimited data file, the physical file name is the actual name of a file as it appears to the operating system. A logical name (or ddname) is a shorthand name that points to the physical file name. Logical names simplify code by allowing short names to be used in place of the longer physical file name.

The Allocation Wizard enables you to create a FILEDEF command and generates platform independent file paths for all portable platforms by creating FILEDEF syntax with application names.

Tip: Instead of including an allocation component in individual procedures, you can include all FILEDEF commands in a single file that you call with the Include tool at the beginning of each procedure. This enables you to make changes to your allocation assignments globally instead of changing the information in each procedure. For more information, see Execute Wizard and Include Tool.

For details about the Allocation Wizard, see Assigning a Logical Name With the Allocation Wizard in the Creating Reporting Applications With Developer Studio manual.


Top of page

x
USE Tool

When you access a FOCUS data source, WebFOCUS searches for a Master File with the specified file name and then searches for a data source with the same name. The USE tool enables you to specify the name and location of a FOCUS data source. This is helpful under the following conditions:

Tip: Instead of including a USE component in every procedure, you can create a USE directory by including all USE specifications in a single file, which you call with the Include tool at the beginning of each procedure that needs to access the USE directory. For more information, see Execute Wizard and Include Tool.

The Check button replaces the Run button. When you click the Check button, the generated code is validated. A dialog box opens, displaying the code of the component and either an error message or text stating that no error exists.

For details about this tool, see Accessing a FOCUS Data Source in the Developing Reporting Applications manual.


Top of page

x
Impact Analysis

You can use the Impact Analysis tool to analyze Master Files and fields and determine if they are used in WebFOCUS procedures. This tool helps developers determine how frequently a Master File or field is used and the impact that would result if you change the Master File.

The Impact Analysis tool provides developers with a listing of all the procedures that are impacted. It can also interactively open procedures based on the results and make necessary changes. You can access this tool in the Explorer window of Developer Studio.


Top of page

x
Execute Wizard and Include Tool

The Execute Wizard and the Include tool enable you to call other procedures from the current procedure.

The Execute Wizard allows one procedure to execute or call another procedure. The called procedure behaves as a completely separate procedure, with its own context.

With the Execute Wizard, you can pass parameters directly from the user interface to the called procedure by automatically checking the called procedure for available parameters. If parameters are available, the tool will display the available parameters, allow you to provide values, and even test the called procedure. The Execute Wizard is available throughout all development areas of the product: Projects, Data Servers, and Managed Reporting.

The following screen is the first window of the Execute Wizard.

Execute Wizard

The Include tool allows one procedure to run another procedure as if the second one were embedded in the first. In this case, the procedure being included (called) has full access to variables defined in the calling procedure. Using this tool, you can create an object that includes another procedure within a host procedure.

Note: Recursive includes can only be embedded up to four levels deep.

For details about these tools, see Creating a Reporting Procedure in the Creating Reporting Applications With Developer Studio manual.


Top of page

x
Dimensions Tool

The Dimensions Tool allows you to create a temporary OLAP hierarchy and dimensions. Unlike the Dimension Builder, this tool does not modify the Master File. Information is stored in the active procedure instead. You may access the Dimensions Tool by selecting OLAP Dimensions from the Component Connector toolbox.

To create a hierarchy, drag and drop fields from the left pane into the Dimensions pane.

Dimensions Tool


Top of page

x
HTML Composer

You can do the following when using the HTML Composer:

When you open the HTML Composer, it appears as shown in the following image.

For more information about the HTML Composer, see the Designing a User Interface for a Web Application With the HTML Composer manual.


Top of page

x
Document Composer

Document Composer enables you to design reports, and to coordinate and distribute layouts made up of multiple reports and graphs in a single document.

You can position reports and graphs anywhere on a single page or combine a series of layouts within a single document.

When creating compound reports from Document Composer, PDF, HTML, active reports, PowerPoint, and Excel are available as output formats.

When you open Document Composer, it appears as shown in the following image.

Document Composer

Note: To include a graph in Document Composer, the graph must be saved in .SVG format.

For more information about Document Composer, see the Creating Compound Reports With Document Composer manual.


Top of page

x
Text Editor

Developer Studio provides a fully integrated text editor that you can use to create, view, and edit the source code for procedures, procedure components, Master and Access files, and other types of files required by your projects. The text editor enables you to use familiar Windows editing techniques, such as cut, copy, paste, undo/redo, and drag-and-drop.

In addition, you can:

When you open a Master File, procedure, or HTML file in the Editor window, syntax elements in the text appear color-coded for easy viewing and editing. For example, the keywords in a procedure appear in red. You can change default colors or remove text coloring to suit your preferences.

For details about this tool, see Editing Application Components as Text in Developer Studio in the Creating Reporting Applications With Developer Studio manual.


Top of page

x
OLAP Graphical Tools

The primary location from which you perform OLAP analysis is the report itself. Any changes you make are instantly applied. You can sort measure values in ascending or descending order, drill down on measures and dimensions, change sort fields from vertical (BY) to horizontal (ACROSS), add a column of data visualization graphics to track trends, and display a bar graph in a separate pane above the report.

You can supplement your OLAP analysis with two tools: the Selections pane and the Control Panel:

The following example shows how these controls look when the selections panel is positioned above the report and adjacent to the Control Panel.

Control Panel

In the following example, the Control Panel is closed to maximize the screen space available for your analytic comparisons.

Control Panel

For details about these tools, see Analyzing Data in an OLAP Report in the WebFOCUS Online Analytical Processing (OLAP) manual.


Top of page

x
SQL Editor

Developer Studio provides an SQL Editor that enables you to code SQL Passthru and highlights any SQL commands within the code. This editor also allows you to choose your connection engine and connection name from drop-down lists on the toolbar. The supported engines are DB2, DB2 for AS/400, Microsoft SQL Server, Oracle, Sybase, and Teradata. The SQL Editor provides you with the option to select another engine.

Note: If you choose the Other option, you must know the correct syntax to use for the engine name.

The SQL Editor also provides you with the option of preparing an SQLOUT file, which you can use with Report Painter or Graph Tool. The SQLOUT file is a temporary file that you can select when you invoke Report Painter and Graph Tool. It is placed in the Hold Files area of the Open (Master Files) dialog box.

To access the SQL Editor, open the Procedure Viewer and click the SQL Editor icon on the Component Connector toolbar. You can also access the SQL Report icon in the Setup area of the Report Painter Object Inspector to modify existing procedures.

For more information, see the Creating Reporting Applications With Developer Studio manual.


Top of page

x
Deploy Wizard

After you create, test, and debug a project in the development environment, you are ready to make it available as a live application on the web. This process involves moving certain project files to selected target servers in a WebFOCUS environment. Developer Studio automates the process for you.

Deploying a project is the process of copying project files to a web server and a Reporting Server so the application can run on the web and be accessed by other users. HTML forms are used to launch the application in the web environment. The Deploy Wizard guides you through the process of creating a configuration that manages the deployment of your project files to the web. You can take advantage of the following features in the Deploy Wizard:

This feature is relevant if you develop WebFOCUS reporting applications or WebFOCUS Maintain applications, and are responsible for deploying your application to end users who access it from a web browser.

You can create more than one deployment scenario for a project, and you can view and modify the properties of an existing scenario.

Developer Studio supplies a deployment scenario named Local Deploy, which it uses to prepare files to run on a local server. Do not modify or remove Local Deploy.

You must enter and select appropriate information in the New Deployment Scenario dialog box to create a new deployment scenario.

New Scenario Wizard

For details about this tool, see Partitioning and Deploying Project Files in the Creating Reporting Applications With Developer Studio manual.


Top of page

x
Command Console

The Command Console enables you to send commands directly to a server from Developer Studio.

This benefits users who have worked with Information Builders products and are already familiar with the command syntax.

The Command Console sends output to your web browser. Output can include error messages, responses to query commands, and report output. If you open the Command Console before you run a procedure, it will also serve as a troubleshooting and debugging tool.

For details about this tool, see Using the Command Console in the Developing Reporting Applications manual.


Top of page

x
Reporting Server Console

The Reporting Server has the capabilities of a regular Reporting Server, and its configuration procedures are identical. Reporting Servers can be configured and managed through Server Consoles that use WebFOCUS technology.

For a full understanding of configuration options and server capabilities see the Server Administration for UNIX, Windows, OpenVMS, OS/400 and z/OS manual.

The Reporting Server Console, sometimes referred to as the Web Console, enables a developer to independently manage the Reporting Server environment from the desktop product. Using this utility, you can:

If your Reporting Server is secure, WebFOCUS prompts you for your user name and password.

For details about this tool, see Partitioning and Deploying Project Files in the Creating Reporting Applications With Developer Studio manual.

Note: When launching this tool from the main toolbar, or selecting Reporting Server Console from the Command menu, the console for the project development server will open. Depending on the type of project development you are performing (local or remote), the corresponding local or remote Reporting Server Console will open. Also, when working in the WebFOCUS Environment area of the Object Explorer, and the Data Servers area is opened, an icon is enabled in the Object Explorer Toolbar. When a data server is accessed, this option is enabled to allow users to open the Reporting Server Console for the selected server. This is supported on Windows, UNIX, and USS platforms.


Top of page

x
Engine Tool

The Engine tool in Developer Studio exposes the FOCUS ENGINE SET commands and enables you to enter ENGINE commands or connection attributes, and override parameters.

Note: The Engine tool is only used to create ENGINE statements. You are responsible for having the knowledge of the ENGINE SET command or the Connection Attribute needed.

Engine Tool

For more information about this tool, see the Creating Reporting Applications With Developer Studio manual.


Top of page

x
Match Wizard

You can merge two or more data sources, and specify which records to merge and which to sort out, using the Match Wizard. The wizard creates a new data source (a HOLD file) into which it merges fields from the selected records. You can report from the new data source and use it as you would any other HOLD file. The merge process does not change the original data sources.

You select the records to be merged into the new data source by specifying sort fields in the Match Wizard. You specify one set of sort fields (using the BY phrase) for the first data source, and a second set of sort fields for the second data source. The Match Wizard compares all sort fields that have been specified in common for both data sources, and then merges all records from the first data source whose sort values match those in the second data source into the new HOLD file. You can specify up to 32 sort sets which includes the number of common sort fields.

In addition to merging data source records that share values, you can merge records based on other relationships. For example, you can merge all records in each data source whose sort values are not matched in the other data source. Yet another type of merge combines all records from the first data source with any matching records from the second data source.

You can merge up to 16 sets of data in one Match request. For example, you can merge different data sources, or data from the same data source.

Note: The limit of 16 applies to the most complex request. Simpler requests may be able to merge more data sources.

Access the Match Wizard from the Procedure Viewer in Developer Studio. It uses typical wizard behavior so you can easily navigate from one step in the process to the next.

For more information, see the Creating Reporting Applications With Developer Studio manual.


WebFOCUS