Creating Reports in Dashboard

In this section:

How to:

Reference:

You can create My Reports using Reporting Objects. You can also copy a Shared Report and save and modify it as your own My Report.

In addition, you can create new reports from scratch in the Custom Reports folder. Custom Reports enable you to create your own reports using a reporting tool or the text editor. Reporting tools include InfoAssist, Report Assistant, Graph Assistant, and Power Painter. The tools you have access to are dependent on how your MR Administrator configured the Dashboard environment and whether or not you are assigned the Advanced privilege. Depending on which tool you use to create your report, you can edit your report using the same tool or the text editor. You can change the name of your Custom Report from the Properties window, and you can create new folders in the Custom Reports folder.

From Custom Reports, you can also upload (import) an external data file for use in one of the available reporting tools. For details, see Uploading Data Files.

You can insert a procedure within another procedure when creating a custom report. For details, see Execution of a Custom Report Using -INCLUDE.

Note:


Top of page

x
Procedure: How to Create or Delete a My Report in Dashboard
  1. In the Domain Tree, expand the Reporting Objects folder, then expand the desired subfolder.
  2. Right-click a Reporting Object and select InfoAssist, Power Painter, Report Assistant, or Graph Assistant.

    Note: The reporting tools that are available are dependent on the Dashboard configuration set by your MR Administrator. If InfoAssist was used to create the Reporting Object, then the only reporting tool available from this option list will be InfoAssist.

  3. Create the report.

    For details on using:

    • InfoAssist, see the InfoAssist User’s Manual.
    • Power Painter, see the Creating Compound Reports With Power Painter manual.
    • Report Assistant, see the Creating Reports With Report Assistant manual.
    • Graph Assistant, see the Creating Charts With Graph Tools manual.
  4. Save the report.

    The report is saved with the name you provided in a subfolder within the My Reports folder. The subfolder is named for the group folder where the selected Reporting Object is located.

To delete a report or folder in My Reports, right-click the report or folder and select Delete from the menu.

Note:

  • Create or edit only one report at a time when using InfoAssist, Power Painter, Report Assistant, or Graph Assistant.
  • If you log off Dashboard without first closing the Report or Graph Assistant, you must manually close the tools.


x
Procedure: How to Copy a Shared Report and Save it as a My Report

Copying a Shared Report and saving it as a My Report enables you to edit the report or graph without affecting the original. For details, see How to Copy a Shared Report.


Top of page

x
Procedure: How to Create a Custom Report in Dashboard
  1. In the Domain Tree, expand the My Reports folder.
  2. Right-click the Custom Reports folder and select one of the following reporting tools:
    • InfoAssist to create a report or chart using InfoAssist.
    • Power Painter to create a report, graph, or page layout using Power Painter.
    • Report Assistant to create a report using Report Assistant.
    • Graph Assistant to create a graph using Graph Assistant.
    • Editor to create a report or graph using the Dashboard text editor.

    Note: The reporting tools that are available are dependent on the Dashboard configuration set by your MR Administrator.

    If you have selected InfoAssist, Power Painter, Report Assistant, or Graph Assistant, you will be prompted to select a data source from which you want to report, then click OK to continue.

    The selected tool opens.

  3. Design and then save your Custom Report.

    For details on using:


Top of page

x
Procedure: How to Copy or Move a Custom Report in Dashboard
  1. In the Domain Tree, expand the My Reports folder, then expand the Custom Reports folder.
  2. Right-click the existing report that you want to copy or move.
  3. Perform one of the following:
  4. Right-click a Custom Reports folder.
  5. Select Paste.

    When you copy or cut and paste a file within a user My Reports Custom Reports folder, Dashboard evaluates the request based on the destination folder and whether or not the internal name and/or the display name of the source file exists in the destination folder. This is because all the reports a user creates are stored in a single directory in the MR Repository. All folders are virtual directories that allow you to organize your reports. Folder information is stored in the user metadata (.htm) file located in the user directory within the MR Repository.

    If you paste a file in the same My Reports Custom Reports folder, Dashboard creates a new file with a new internal name. Because it is within the same folder, Dashboard assumes you want to make a copy. A copy number is appended to the name of the copied file and Dashboard creates a new internal name for this file.

    For example, when you copy and paste a file named Sales Summary within the same My Reports Custom Reports folder, the copy appears in the Dashboard tree as Sales Summary (Copy #), as shown in the following image. The new internal name is sales_summary_copy_1.fex (special characters and spaces are replaced with underscores).

    My Reports example

    If you copy and paste a file to a different My Reports Custom Reports folder, the Confirm Create New File dialog box opens, as shown in the following image.

    Confirm Create New File dialog box

    This dialog box notifies you that the internal name already exists in the folder and asks you to confirm that you want to make a copy of the source file with a new internal name.

    If you confirm the copy, a copy number is appended to the name of the copied file, as shown in the following image, and Dashboard creates a new internal name for this file.

    Copied file

    Note: After pasting a file, you can change the name that displays in the Dashboard tree of the user interface using the Properties option. This does not change the internal name (filename.ext) of the file. For more information on Custom Reports properties, see Editing a Custom Report and its Properties.


Top of page

x
Procedure: How to Create or Delete New Custom Report Folders
  1. In the Domain Tree, expand the My Reports folder.
  2. Right-click Custom Reports and select New Folder.
  3. Enter a name for the new folder in the New Folder dialog box and click Save.
  4. The new folder appears in the Custom Reports folder.

To delete a folder in Custom Reports, right-click the folder and select Delete.



x
Procedure: How to Edit a Custom Report

Edit only one report at a time when using InfoAssist, Power Painter, Report Assistant, or Graph Assistant.

  1. In the Domain Tree, expand the My Reports folder, then expand the Custom Reports folder.
  2. Right-click the desired Custom Report and select the tool you created the report with (InfoAssist, Power Painter, Report Assistant or Graph Assistant) or select Editor to edit the report code manually in the Dashboard text editor.

    For details on using:

  3. Edit the report as necessary and save any changes.
  4. To change the name of the custom report, click the report and select Properties.
  5. Edit the name in the Description text box.
  6. Click OK.

Top of page

x
Reference: Dashboard Text Editor

You can use the text editor to create, view, edit, and run the source code for Custom Reports in Dashboard. The text editor enables you to use familiar editing techniques, such as cut, copy, and paste. You can also find and replace text and specify case.

Note: After editing with the Dashboard text editor, you will not be able to use reporting or graphing tools to open reports created with InfoAssist, Power Painter, Report Assistant, or Graph Assistant because the tools cannot read some user-added syntax.

The following image shows the text editor with a sample file in the editing window.

Text Editor

The following table describes all of the functions available in the Dashboard text editor. The first column lists the buttons, and the second column lists the actions they produce.

Button

Action...

Save button - Save button

Saves the report. Acts as "Save As" the first time you save the report.

Save as button - Save As button

Saves the report in the Custom Reports folder with a name you specify.

Run button - Run button

Runs the current report.

Quit button - Quit button

Exits the Editor window. If you made changes to the original report, a window prompts you to save or cancel the changes.

Help button - Help button

Opens the online help.

Cuts, Copies or paste - Cut, Copy and Paste buttons

Cuts, copies, or pastes the highlighted text.

Deletes, selects all, undoes - Delete, Select All, Undo, and Redo buttons

Deletes, selects all, undoes, and redoes.

Finds and replaces - Find and Replace button

Finds and replaces text.

Enables - Go to line button

Enables you to go to a particular line number in the report.

Converts - Uppercase button

Converts highlighted text to uppercase.

Converts - Lowercase button

Converts highlighted text to lowercase.

Text color - Text color button

Sets the text color in the editor.

Backgroud color - Background color button

Sets the background color of the editor.

Note: The text color and background colors are for the current session only.

Enable font change - Font drop-down menu

Enables you to change the font of the editor.

Enables font size - Font size drop-down menu

Enables you to change the font size of the text in the editor.

Note:



x
Working With Shared Reports

How to:

When you create reports and graphs, you may want to share them with others in your organization. The Shared Reports feature addresses this need by enabling you to create reports and graphs and make them available to other users who access the same domain.

By designating a report as shared, you allow other users to run it from the Shared Reports folder in the Domain Tree. Other users cannot edit a Shared Report in the Shared Reports folder, but they can copy a Shared Report to their own My Reports folder and then edit the copied report without affecting the original. All users who access the Domain Tree have the ability to view, run, and copy Shared Reports. Note that users with the User role cannot copy Shared Reports.

Only users who have been granted the Shared privilege by their Administrator can share a My Report. The My Reports that you contribute appear in the Shared Reports folder of other users and display the Shared Report Shared Report icon icon. These reports also appear in your My Reports folder displaying the same Shared Report icon to denote that they have been made available to others. Note that Custom Reports can be shared in the same manner as My Reports.

The Shared Reports folder in the Domain Tree consists of folders named for other users who contributed Shared Reports. All the reports contributed by a particular user appear under the Shared Reports folder in a subfolder named for the Reporting Objects group folder, Custom Reports folder, or Custom Reports subfolder where the report was created. Shared Reports are available to all other Managed Reporting users who can access the same domain. Note that reports that you share are not listed in your own Shared Reports folder.

The following image shows three Shared Reports contributed by a user named Jeff who created and shared the reports from three different locations: the Custom Reports folder, a Custom Reports subfolder, and a Reporting Objects group folder named Test IA.

Domain Tree

The Shared Reports folder enables you to:



x
Procedure: How to Share a My Report

To make an existing My Report available to other users:

  1. In the Domain Tree, expand the My Reports folder, then expand the Reporting Object or Custom Reports subfolder where the desired My Report is located.
  2. Right-click the report that you want to share and select Properties.

    The Properties dialog box opens.

  3. Select the Share Report check box and click OK.

The Properties dialog box closes and the report becomes available to all users who access the domain.



x
Procedure: How to Share a New Report

To make a new report or graph that you are creating available to every user who accesses the domain:

  1. Create and save a report or graph using the InfoAssist, Power Painter, Report Assistant, or Graph Assistant tool.

    You can create and save a report or graph from either the Custom Reports folder, a Custom Reports subfolder, or a Reporting Objects group folder.

  2. Locate the saved report or graph in the corresponding folder of the Domain Tree, right-click the report or graph, and select Properties.

    The Properties dialog box opens.

  3. Select the Share Report check box and click OK.

Tip: Alternatively, if you are using Report Assistant or Graph Assistant, when you are finished creating the desired report or graph, you can click Save As in the File menu, select the Share Report check box in the dialog box that appears, type a descriptive name, and click OK.



x
Procedure: How to Copy a Shared Report

To copy a Shared Report to your My Reports folder:

  1. In the Domain Tree, expand the Shared Reports folder.

    The Shared Report folder displays folders with the names of users who have contributed reports.

  2. Expand the desired user folder.

    The expanded user folder displays subfolders that were used to create the Shared Reports.

  3. Expand the desired subfolder that contains the Shared Report you want to copy.
  4. Right-click the Shared Report and select Save As My Report.

    The Save As My Report dialog box opens.

    You can keep the original name or change the name of the report by deleting the original and typing a new name in the Description field.

  5. Click OK.

    WebFOCUS copies the report to your My Reports folder.

After you copy a Shared Report to your My Reports folder, you can edit the report without affecting the original.



x
Procedure: How to Edit a Shared Report
  1. In the Domain Tree, expand the My Reports folder, then expand the subfolder that contains the Shared Report you previously saved as a My Report.
  2. Right-click the desired report or graph and select the reporting tool option (InfoAssist, Power Painter, Report Assistant, Graph Assistant).

    WebFOCUS opens the reporting tool used to create the Shared Report and displays the report or graph you copied from the Shared Reports folder.

  3. Edit the report or graph and save your changes.

For details on using:


Top of page

x
Uploading Data Files

How to:

Reference:

In Dashboard, you can upload (import) external data files for use in WebFOCUS reporting tools. This functionality enables you to easily create a WebFOCUS file description and data file for use in your reporting application. The Upload Data File option is enabled by default and is available to all users with access to the Custom Reports folder of the Domain Tree.



x
Procedure: How to Upload a Data File
  1. In the Domain Tree, right-click the Custom Reports folder and select Upload Data File, as shown in the following image.

    Upload Data File

    The first page of the Upload Data File dialog box opens displaying three sections that require you to make a selection:

    • Select a file
    • File Format
    • Field Names
  2. Click the Browse button to the right of the Select a file section.

    A Choose file dialog box opens.

  3. Navigate to where the file is located and select Open.

    The following image shows the first page of the Upload Data File dialog box.

  4. In the File Format section, select one of the following supported formats for the file you want to import:
    • Excel® Spreadsheet (XLS)
    • Comma-separated values (CSV)
    • Tab-separated values
    • Pipe-separated values
  5. In the Field Names section, select one of the following supported methods for how you want the field names created:
    • Auto-generate field names
    • First row contains field names
  6. Click Next at the bottom of the Upload Data File dialog box.

    The second page of the Upload Data File dialog box, as shown in the following image, appears for you to review and customize the file conversion options.

  7. For each field in the file you imported, you can select the field column heading and then edit the following attributes for that field:
    • Field Name
    • Alias
    • (Data) Type
    • Format

    If you change any of the attributes for a field, click the Apply button to apply the changes and refresh the data.

  8. When all fields have been reviewed, enter a valid name in the File Name input box (spaces are not allowed) and use the Application Directory menu to select where you want the file created.
  9. Click Next to upload the file.

    Two files are created:

    • Master File
    • Comma-delimited data file (.DAT)

    Note: If a file with the same file name already exists, a dialog box is displayed prompting you to allow file replacement.



x
Reference: Upload Data File Considerations
  • When uploading data from a supported text file, the file must have the same type of data in each field and the same fields in every row.
  • When uploading data from an Excel spreadsheet:
    • The data must be arranged in an appropriate tabular format and the spreadsheet must have the same type of data in each column and the same fields in every row.
    • The data must be stored in the first worksheet of the workbook.
    • Cells with formulas and special characters are not supported. For example, if percentages are used the cells should be formatted using the percentage data type and should not have the percentage special character "%" in the cell.
    • Excel files must be saved in a binary format. To ensure this, open an Excel file, select File, select Save As, use the Save as type drop-down list to select either Microsoft Office Excel Workbook (*.xls) or CSV (Comma Delimited)(*.csv), then click Save.



x
Amper Auto-Prompting

In this section:

Reference:

The amper auto-prompting facility enables you to select parameters and run the report while still being able to view and change your parameter selections. You can also display and hide parameters to widen the screen as needed. For example, the following image shows a report that requires parameter selection.

After you run the report, the output appears, as shown in the following image.

Parameters



x
Reference: Parameter Report Options

From the amper auto-prompting launch page, you have the following options:

Button

Description

Run

Click this button to run the report.

Reset

Click this button to reset the parameter selections.

Save

The save option is only available if the Administrator has assigned you the Save entered values privilege, and you run a Standard Report with parameters from the domain tree.

Clear Output

Click this button to clear the report output area.

Run in a new window

Select this check box to open the report in a new browser window.

Splitter bar

Show/Hide Parameters

Double-click splitter bar to hide parameters for full screen report view. Double-click splitter bar again to return to the original parameters and report view.



x
Customizing the Amper Auto-Prompting Facility

You can customize the look and feel of the amper auto-prompting facility by editing the launch page template file you are using. All of the available launch page templates are located in the ibi\WebFOCUS77\ibi_html\javaassist\ibi\html\describe directory. The default template is autoprompt_top.css.

If you want to customize the banner, create an image, save it in the describe directory, and change the background-image property, which is shown in bold type in the following Cascading Style Sheet (CSS) code:

#idBannerDiv {
height:41px; 
background-image:url(style/logo_banner_TOP.gif); 
background-position:top left;
background-repeat:no-repeat; 
margin:0px;
margin-top:0px;
cursor:pointer; }

The option to select different launch page templates can be set in the WebFOCUS Administration Console using the Parameter Prompting selection under Client Settings, where you can set the IBIF_describe_xsl value to one of the launch page templates.

You can also enter the name of the desired launch page template in a FOCEXEC using the following code:

<describe_xsl>template</describe_xsl>

where:

template

Is set to one of the following launch page template values:

  • autoprompt_top displays the parameters horizontally at the top of the page and is the default template value.
  • autoprompt_top_checked is the same as autoprompt_top, but the Run in a new window check box is preselected.
  • autoprompt displays the parameters vertically at the left side of the page.
  • autoprompt_checked is the same as autoprompt, but the Run in a new window check box is preselected.
  • autoprompt_simple is the basic input form.


x
Saving Parameter Selections

How to:

You can save parameter selection values as a My Report for reports that run immediately or run deferred. By default, these reports are saved in the Saved Parameter Reports folder that is automatically created under the My Reports folder, but you can save parameter reports anywhere in the My Reports folder structure. In either case, the domain containing the My Reports folder cannot be restricted. If the domain is restricted, you can save the report output to any other domain that you are authorized to save to and that is not restricted.

You can also replace an existing Managed Reporting HTML form or procedure (FEX) when saving a Saved Parameter report. The replacement requires that the selected file must be the same type (HTML or FEX) as the file being saved. There are two cases for saving a Saved Parameter report:

  • HTML, when saved using the Save Values option in an HTML form created by HTML Composer
  • FEX, when saved from Amper Autoprompt form.

If the selected file type is not the same as the content being saved, you will receive the following message

To replace a file, the file types must be the same.

Click OK to close the message and return to the Saved Parameters dialog box, where you can choose another file or type a file name.

If the file name you type exists for the same file type (FEX or HTML), you will receive a message stating that the file name already exists. Click Replace to overwrite the existing file, or click Cancel to return to the Saved Parameters dialog box.

Note: Administrators and Developers can save parameter selection values as Standard Reports.

When you select Run from the menu options for Saved Parameter Reports, the saved values are used to run the report and the prompt form does not display. When you select Edit Parameters, the prompt form appears so you can make changes to the values before running the request. You can Run Deferred, which also shows the prompt form before running the request. Additional menu items for Saved Parameter Reports that are available from Dashboard are Delete, Add to Favorites, Add to Mobile Favorites, and Properties. You can also schedule the report for later execution if you have scheduling capabilities.

Note:

  • Saving parameter selections is only available if you have been assigned the Save entered values privilege by your administrator.
  • Multi-select drop-down list values are not selected when you view the launch form for the My Report with saved parameters.
  • The Saved Parameter report and the report it was created from must reside in the same Managed Reporting Domain. If you copy a Saved Parameter report from one domain to another, you must also copy the original report to the target domain.
  • When creating multiple saved parameter reports for the same report or graph, if the report or graph was created in Version 7 Release 6 and earlier, it is recommended that you create all of the Saved Parameter reports from the same procedure that contains the report or graph request. This is recommended because prior to Version 7 Release 6.1, a saved parameter report has a reference to the procedure (FEX) from which it was created. If you create a saved parameter report from an existing saved parameter report, the new saved parameter report has a reference to the prior saved parameter report, which has a reference to the original report or graph procedure. This creates a series of chained dependent procedures, and if one of the chained procedures is deleted, the reports with references to the deleted procedure will no longer run successfully.
  • If you are a Developer or Managed Reporting Administrator, you can save Saved Parameter reports to the Standard Reports or Other Files folders. Note that the Edit Parameters menu option is not available for auto prompt reports that are saved with parameter values in the Standard Reports or Other Files folders. You can edit parameter values from the launch form or edit the –DEFAULT values for the procedure (FEX) using the text editor. When you run a Saved Parameter report from these folders, the auto prompt form launches with the saved parameter values selected.
  • Consider the following when you save a parameter report from an HTML form created with HTML Composer:
    • In Version 7 Release 6.9 and higher, the report is saved as a HTML form and not a procedure (FEX), and therefore, cannot be scheduled. (For more information, see Version 7 Release 6.1 and higher Upgrade Considerations.) You can schedule the report from the HTML form if it includes the Schedule option. For information on adding ReportCaster scheduling capabilities to a form, see Designing a User Interface for a Web Application With the HTML Composer manual.
    • In Version 7 Release 7, because Saved Parameter reports created from an HTML Composer form with Save Value option should not be edited due to their internal structure, the Restrict Developer Access property is enabled for these reports. Even though Managed Reporting Administrators can edit Saved Parameter reports, we recommend that they not because changes to these reports could render them unusable.


x
Procedure: How to Save Parameter Values to a My Report
  1. Run a report that has parameters.
  2. Select your parameter values and then click the Save the Parameter selections as a My Report Save the parameter selections as a My Report button.

    Note: The appearance of this button may be different depending on your application.

    The Save Parameters dialog box opens, as shown in the following image.

    Save Parameters dialog box

  3. From the Save In drop-down menu, you can navigate to the xxxxxx folder where you want to save the report.

    Note:

    • The Save In drop down menu is a list of domains that you are authorized to save to. The Save In value that appears when the Save Parameters Dialog box initially opens is the Saved Parameters folder under the domain where you ran the report.
    • Some domains may be restricted and not allow you to save My Reports. In this case, the OK button is not available to you (it is greyed out). When you select a domain where you are authorized to save My Reports, then the OK button is available for selection.
  4. Type a name for the report and click OK. The report is saved in the Saved Parameter Reports folder under My Reports.

    Note: You may need to click the refresh button (circle with arrow) in the toolbar to refresh the domain and view the new report.


WebFOCUS