Describing Data With Graphical Tools

Version 7 Release 7

DN4501000.0510

Cactus, EDA, EDA/SQL, FIDEL, FOCUS, Information Builders, the Information Builders logo, iWay, iWay Software, Parlay, PC/FOCUS, RStat, TableTalk, Web390, and WebFOCUS are registered trademarks, and DataMigrator and Magnify are trademark of Information Builders, Inc. Adobe, the Adobe logo, Acrobat, Adobe Reader, Flash, Flex, and PostScript are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Due to the nature of this material, this document refers to numerous hardware and software products by their trademarks. In most, if not all cases, these designations are claimed as trademarks or registered trademarks by their respective companies. It is not this publisher’s intent to use any of these names generically. The reader is therefore cautioned to investigate all claimed trademark rights before using any of these names other than to refer to the product described. Copyright © 2010, by Information Builders, Inc. and iWay Software. All rights reserved. Patent Pending. This manual, or parts thereof, may not be reproduced in any form without the written permission of Information Builders, Inc.

WebFOCUS

Contents
Preface................................................................................................................7
Documentation Conventions..............................................................................................8 Related Publications..........................................................................................................9 Customer Support.............................................................................................................9 Information You Should Have.............................................................................................9 User Feedback................................................................................................................10 Information Builders Consulting and Training.....................................................................10

1. Describing and Accessing Data Overview......................................................13
A Note About Data Source Terminology.............................................................................14 How Applications Interpret Data.......................................................................................14 Obtaining a Synonym ......................................................................................................15 What You Can Do With a Synonym....................................................................................16 Ways to Enhance a Synonym............................................................................................16 How an Application Uses a Synonym................................................................................17 Alternative Tools on the Reporting Server Console.............................................................17

2. Accessing Data and Creating Synonyms.......................................................19
Configuring Adapters and Remote Servers in Developer Studio...........................................20 Configuring the Application Path...............................................................................23 Showing Only Applications in Path.............................................................................24 Data Access Configuration Variations........................................................................26 Managing Adapter Configurations..............................................................................36 Configuring Adapters in Developer Studio..................................................................41 Creating Synonyms in Developer Studio............................................................................48 Using the Reporting Server Web Console for Data Access and Synonym Preparation.....63 Defining a Remote Server in the WebFOCUS Client Communication File...............................65

3. Using the Synonym Editor..............................................................................73
Introduction to Synonym Editor.........................................................................................74 Synonym Editor Layout....................................................................................................74

Describing Data With Graphical Tools

3

Contents

Viewing and Editing Synonym Attributes............................................................................97 Setting Up Multilingual Titles and Descriptions................................................................107 Enhancing Synonyms Using the Modeling View................................................................110 Viewing Data Profiling Characteristics.............................................................................123 Data Profiling a Synonym or Segment......................................................................123 Data Profiling a Single Column................................................................................124 Creating Cluster Joins....................................................................................................126 Defining Dimensions for OLAP Analysis...........................................................................134 Using the Dimension Builder in the Synonym Editor Modeling View............................134 Using the Synonym Editor for Cube Data Sources............................................................139 Creating Business Views...............................................................................................149 Adding Virtual Columns (DEFINE) in a Synonym................................................................157 Creating Filters in a Synonym.........................................................................................161 Adding Computed Fields (COMPUTE) in a Synonym..........................................................164 Storing the Number of Repetitions of a Repeating Field in a Virtual Field...........................167 Defining Attributes and Creating Expressions for Custom Fields........................................172 Adding Group Fields in a Synonym..................................................................................179 Applying Database Administrator Security.......................................................................185 Selecting the Type of Access..................................................................................190 Restricting Access to Segments, Fields, Field Values, and Noprint............................191 Deleting a DBA or User Password...........................................................................198 Encrypting and Decrypting a Master File..................................................................199

4. Analyzing Metadata and Procedures...........................................................201
Analyzing Procedures With the Impact Analysis Tool.........................................................202 Viewing Data Profiling Characteristics.............................................................................206 Data Profiling a Synonym or Segment......................................................................206 Data Profiling a Single Column................................................................................208

5. Adding Data and Rebuilding FOCUS Data Sources......................................217
Creating a FOCUS Data Source......................................................................................218 Rebuilding a Data Source..............................................................................................219 Rebuilding a Disorganized File................................................................................220 Rebuilding the Index..............................................................................................221 Checking the Integrity of a Data Source...................................................................222

4

WebFOCUS

............................227 Describing Data With Graphical Tools 5 ..............................................................Contents Reader Comments..

Contents 6 WebFOCUS .

How This Manual Is Organized This manual includes the following chapters: Chapter/Appendix 1 2 3 4 Describing and Accessing Data Overview Accessing Data and Creating Synonyms Using the Synonym Editor Analyzing Metadata and Procedures Adding Data and Rebuilding FOCUS Data Sources Contents Introduces data source descriptions and explains how to use them. Describes utilities to create new FOCUS data sources and to refresh existing data sources after the structure has changed. or other information technology professionals who will create the metadata used by WebFOCUS to access corporate data. Describes how to create a synonym for your data source description. Describes how to analyze procedures using Impact Analysis. It is intended for database administrators.WebFOCUS Preface This documentation describes how to create the metadata for the data sources that your WebFOCUS projects will access. Describes the Synonym Editor and how you may use it to view and edit synonyms. 5 Describing Data With Graphical Tools 7 . application developers. and how to view Data Profiling for the columns in a synonym.

Highlights a file name or command. It may also indicate a button. . 8 WebFOCUS . Indicates keys that you must press simultaneously.). a crossreference. Type one of them. Indicates that there are (or could be) intervening or additional commands. . menu item. Type one of them. or an important term. or dialog box option you can click or select. Represents a placeholder (or variable).. Indicates a group of optional parameters.Documentation Conventions Documentation Conventions The following table lists and describes the conventions that apply in this manual. Indicates that you can enter a parameter multiple times. not the ellipsis points (. Indicates two or three choices. Indicates a default setting. not the braces. Type only the parameter in the brackets. not the symbol. Convention THIS TYPEFACE Description Denotes syntax that you must enter exactly as shown. but you may select one of them. Type only the parameter... None are required.. underscore this typeface this typeface Key + Key { } [ ] | . Separates mutually exclusive choices in syntax. . not the brackets. or this typeface this typeface Represents a placeholder (or variable) in syntax for a value that you or the system must supply.

Preface Related Publications To view a current listing of our publications and to place an order. You can also contact the Publications Order Department at (800) 969-4636. be prepared to provide the following information when you call: Your six-digit site code (xxxx. The communications protocol (for example. http://documentation. and 8:00 p. Describing Data With Graphical Tools 9 .informationbuilders. Call Information Builders Customer Support Service (CSS) at (800) 736-6130 or (212) 7366130. http://www. EST to address all your questions. diagnostic tips. Your WebFOCUS configuration: The front-end you are using. TCP/IP or HLLAPI). ask your Information Builders representative about InfoResponse Online. It is an interactive network of more than 3. update.com also provides usage techniques.com. Registered users can open. It connects you to the tracking system and knownproblem database at the Information Builders support center. and view the status of cases in the tracking system and read descriptions of reported software issues. 24 hours a day. Information You Should Have To help our consultants answer your questions effectively.informationbuilders. To learn about the full range of available support services.m. including vendor and release. New users can register immediately for this service. The technical support section of www. Information Builders consultants can also give you general guidance regarding product capabilities and documentation.xx) when you call. http://forums.xx). The software release. including vendor and release. Focal Point is our online developer center and more than a message board. Customer Support Do you have any questions about this product? Join the Focal Point community. Please be ready to provide your six-digit site code number (xxxx.com/eve/forums. InfoResponse Online is accessible through our World Wide Web site. Customer Support Consultants are available Monday through Friday between 8:00 a.com.informationbuilders. You can also access support services electronically.000 developers from almost every profession and industry.m. and answers to frequently asked questions. visit our Technical Documentation Library.informationbuilders. collaborating on solutions and sharing tips and techniques. with InfoResponse Online. or call (800) 969-INFO.

http://documentation. The Master File and Access File.User Feedback Your server version and release.asp. The stored procedure (preferably with line numbers) or SQL statements being used in server access. Please use the Reader Comments form at the end of this manual to communicate suggestions for improving this publication or to alert us to corrections. The exact nature of the problem: Are the results or the format incorrect? Are the text or calculations missing or misplaced? The error message and return code. how? Have you tried to reproduce your problem in the simplest form possible? For example. for your comments. Thank you.informationbuilders.com/feedback. if applicable. Information Builders Consulting and Training Interested in training? Information Builders Education Department offers a wide variety of training courses for this and other Information Builders products. in advance. your security system. the Documentation Services staff welcomes your opinions regarding this manual. 10 WebFOCUS . communications protocol. You can also use the Documentation Feedback form on our Web site. or front-end software changed? Is this problem reproducible? If so. have you tried executing a query containing just the code to access the data source? Do you have a trace file? How is the problem affecting your business? Is it halting development or production? Do you just have questions about functionality or documentation? User Feedback In an effort to produce effective documentation. if you are having problems joining two data sources. You can find this information using the Version option in the Web Console. Is this related to any other problem? Has the procedure or query ever worked in its present form? Has it been changed recently? How often does the problem occur? What release of the operating system are you using? Has it.

Describing Data With Graphical Tools 11 . locations. or to register for classes.informationbuilders.com) or call (800) 969-INFO to speak to an Education Representative. visit our World Wide Web site (http://www. and dates.Preface For information on course descriptions.

Information Builders Consulting and Training 12 WebFOCUS .

such as IMS and FOCUS. such as DB2. Procedures. such as Lotus Notes and LDAP.WebFOCUS 1 Describing and Accessing Data Overview Developer Studio provides a set of graphical tools that you can use to describe and access many types of data sources. both fixed-format and free-format. such as Web Services and CICS Transactions. These graphical tools are designed to: Translate the schema of the data source into metadata that WebFOCUS can read and report against. such as SAP BW and Essbase. Oracle. and JDBC. Hierarchical. enable you to customize and enhance the generated metadata. Topics: A Note About Data Source Terminology How Applications Interpret Data Obtaining a Synonym What You Can Do With a Synonym Ways to Enhance a Synonym How an Application Uses a Synonym Alternative Tools on the Reporting Server Console Describing Data With Graphical Tools 13 . Multidimensional. Indexed. Sybase. such as ISAM and VSAM. such as XML and Tamino. Other popular data sources. XML. such as CA-IDMS. without having to know the details of the underlying WebFOCUS data description language. Network. Informix. Optionally. Sequential. including: Relational.

hierarchical. we usually refer to the smallest meaningful element of data as a field. multidimensional. The Master File describes the structure of a data source and its fields. how is it arranged or indexed? The specific data elements. 14 WebFOCUS . integer.A Note About Data Source Terminology A Note About Data Source Terminology Different types of data sources make use of similar concepts. However. it includes the full data source name and location. we have standardized on a single set of terms. You need one Master File and. but refer to them differently. The primary component of a synonym is a Master File. what fields are stored in the data source. An Access File includes additional information that completes the description of the data source. For example. For example. Your application needs to know about: The overall structure of the data. but called a column by relational database management systems. an Access File supplements the Master File. we define it and compare it to equivalent terms used with different types of data sources. one Access File to describe a data source. is the data relational. Each time we introduce a new standard term. For some types of data sources. How Applications Interpret Data When your application accesses a data source. the smallest meaningful element of data is called a field by many hierarchical database management systems and indexed data access methods. we use the term specific to a given data source. To accomplish this the application reads a synonym. or some other type)? The synonym provides an alias for the data source that tells the server how tables are described and where to find them. For example. for some types of data sources. when required for clarity. regardless of the type of data source. For simplicity. For example. or sequential? Depending upon the structure. which is an Information Builders term for the generated metadata associated with the particular data source. There are other cases in which a common concept is identified by a number of different terms. the application needs to know how to interpret the data that it finds. it includes information such as field names and data types. For example. For example. The nature of the information in the Access File is specific to each data source. and what is the data type of each field (character. date.

schema. data types. Reference: How an Adapter Works The adapter manages the communication between the data interface and the data source. In order to generate a synonym. Developer Studio opens the adapter configuration window. catalogs. using standard attachment calls. Attaches to the targeted data source. Describing Data With Graphical Tools 15 . and z/OS manual. When you begin to create a synonym. including product differences in syntax. and. see How an Adapter Works on page 15. Every adapter is specifically designed for the data source that it accesses. you must be authorized to use the data against which you plan to report and you must have configured an adapter to access that type of data. is able to translate between SQL or WebFOCUS and the data management language (DML) of the data source. The parameters required to configure over 60 supported adapters and to create synonyms for the corresponding data sources are described in detail in the Adapter Administration for UNIX. passing data management requests to the data source and returning either answer sets or messages to the requestor. data representations. which enables you to explore DBMS catalogs and select the objects for which you wish to create synonyms. The option to create the synonym becomes available only after the adapter is successfully configured. Describing and Accessing Data Overview Obtaining a Synonym Reference: How an Adapter Works You can generate synonyms using the Developer Studio Create Synonym tool. the adapter: Translates the request to the applicable DML. It is the adapter that manages the synonym creation process. Windows. To perform these functions. The tool prompts for all the information it needs to create a synonym for a particular data source and stores the generated synonym on the server. OpenVMS. Passes the request to the data source for processing. and answer set retrieval. i5/OS. Adapters provide solutions to product variations. message processing. For related information. functionality. The Create Synonym tool is fully described in Accessing Data and Creating Synonyms on page 19.1. as a result. Adapters are available for many data sources. Returns results or error conditions to the client application for further processing.

16 WebFOCUS . Ways to Enhance a Synonym The following are some of the attributes you might want to add to the synonym to enhance your data access and reporting capabilities. To do this. including multilanguage variations.What You Can Do With a Synonym What You Can Do With a Synonym Once you have generated a synonym. When you use the Synonym Editor. Add virtual columns (DEFINE fields) and columns for aggregated values (COMPUTE fields). In many instances. Change the format of fields (for example. the configured adapter and the generated synonym are all you need to access your data and create reports and graphs. Add group definitions for data sources that support groups. we cannot guarantee that code which is altered manually will be syntactically correct. Add dimensions for OLAP analysis. the Synonym Editor. Add meaningful titles and descriptions. If you make changes to the generated synonym. Note: If you are comfortable working directly with code. you may wish to enhance the synonym in order to implement particular capabilities that are supported in the WebFOCUS data description language. you can use a second data description tool. the size of an alphanumeric field or the format of a date field). Apply security rules for fields and values to ensure that user access is based on Information Builders data source security (DBA) specifications. the Synonym Editor validates your entries and displays messages if they violate the underlying syntax of the data description language. The graphical tool displays all viewable and editable attributes of the synonym components. We strongly recommend that you use the text editor as a viewing tool. see the Describing Data With WebFOCUS Language manual. While the text editor does some error checking. you can open the synonym components in a text editor. For detailed information about the underlying syntax. Add filters to specify data selection criteria. and to make your enhancements through the graphical Synonym Editor interface. You can: Create a cluster Join view by linking available synonyms to create a multisegment (multitable) file for reporting. there is no need to know the data description language. However. you can report against the synonym using all of the Developer Studio reporting tools.

Although the look and feel of the Reporting Server Console is different from the Developer Studio interface. you can access alternative tools on the Reporting Server Console (also called the Web Console) from Developer Studio. How an Application Uses a Synonym Synonyms are stored separately from the associated data source. Define parent and child hierarchies for cube data sources such as SAP BW and Essbase. Creating business views of your data. if that type of data source requires an Access File. and reads the Master File for the data source named in a request. and z/OS manual.1. The Synonym Editor is fully described in Using the Synonym Editor on page 73. Your application uses a synonym to interpret the data source in the following way: 1. Windows. The data source contents are interpreted based on the information in the synonym. 3. locates. the options on the corresponding tools are largely identical. Describing and Accessing Data Overview Create business views of the metadata in order to limit the fields available to any retrieval request that references the business view and to group fields together based on their roles in an application. and perform a wide range of other server-related tasks. Alternative Tools on the Reporting Server Console If you prefer to work in a thin-client Web environment. and creating synonyms are described briefly in Accessing Data and Creating Synonyms on page 19 and extensively in the Adapter Administration for UNIX. Adding dimensions for OLAP analysis. The Reporting Server Console enables you to configure adapters. such as SAP BW and Essbase. create and enhance synonyms. 2. Procedures for accessing the Reporting Server Console. It locates and reads the data source(s). It identifies. a few options that are currently supported in Developer Studio are not supported on the Web Console at the present time. These include: Defining hierarchies for cube-based data sources. i5/OS. Describing Data With Graphical Tools 17 . OpenVMS. It locates and reads the Access File for the data source named in the request. configuring adapters and remote servers. However.

Alternative Tools on the Reporting Server Console 18 WebFOCUS .

Often. if the synonym you need does not exist on the server. Topics: Configuring Adapters and Remote Servers in Developer Studio Creating Synonyms in Developer Studio Defining a Remote Server in the WebFOCUS Client Communication File Describing Data With Graphical Tools 19 . your application must be able to access the data and understand how the data is organized. and reporting can begin at once. an authorized server or application administrator can create it directly from Developer Studio using the Create Synonym tool. your application reads a synonym. which is required by many data sources. includes the real name and location of the data source. To obtain this information.WebFOCUS 2 Accessing Data and Creating Synonyms Before you can create a procedure that reports against a data source. which generally consists of two files: A Master File that describes the data for WebFOCUS reporting. An Access File that contains additional information needed by WebFOCUS to access data. This information. a synonym already exists on the server. However. This file contains field names and formats for the columns in the data source. The synonym also contains an alias for the data source.

where you can access data and develop applications directly on a remote WebFOCUS Reporting Server using Developer Studio tools. as well as several configuration variations that affect your selection and use of these tools. Project-area options for data access and development are described in the Developer Studio Application Development Getting Started manual and all aspects of Managed Reporting administration are described in the Managed Reporting Administrator's Manual. Note that the procedures for accessing data and creating synonyms for use in the Projects and Managed Reporting environments are similar to those described in this chapter for WebFOCUS Environments.Configuring Adapters and Remote Servers in Developer Studio Configuring Adapters and Remote Servers in Developer Studio In this section: Configuring the Application Path Showing Only Applications in Path Data Access Configuration Variations Managing Adapter Configurations Configuring Adapters in Developer Studio This chapter focuses primarily on the WebFOCUS Environments. Data Servers area of the Developer Studio Explorer. The chapter describes the graphical tools that enable you to access data and create metadata. 20 WebFOCUS .

Data Servers area of the Developer Studio Object Explorer.2. The default WebFOCUS Reporting Server (named EDASERVE) is created during installation and is displayed in the Data Servers area. The folder lists the applications you have access to and the resources (files) stored in these applications. Describing Data With Graphical Tools 21 . Accessing Data and Creating Synonyms The image below displays the WebFOCUS Environments. The Data Servers area displays each WebFOCUS Reporting Server that the WebFOCUS Client can access and permits development against multiple Reporting Servers. which may be configured on any supported platform (as shown in the above image). The Data Servers folder is always accessible from the Developer Studio Object Explorer.

drive:\ibi\apps by default). For organizational purposes. these application files are displayed in virtual folders labeled HTML Files. you can hide the virtual folders from the Object Explorer toolbar. and Other. An Applications folder beneath each WebFOCUS Reporting Server displays the directories based on the Application Root directory (APPROOT) for that WebFOCUS Reporting Server (on Windows. For this example. For details on how. see Data Access Configuration Variations on page 26. you can map an application that is not under APPROOT (but resides elsewhere in the file system) to be accessible as a virtual application. you must first set up your environment to be able to create synonyms (Master and Access Files) and access the associated data on a remote WebFOCUS Reporting Server. and where to create this metadata. such as FOCUS data sources. 22 WebFOCUS . HTML files. The virtual folders appear this way by default.Configuring Adapters and Remote Servers in Developer Studio In the previous image. However. a server called FLATIRON (UNIX Dev WF Reporting Server) is shown with its Applications folder expanded. Procedures. The mapped application is displayed for use. Maintain File. You can create and manage metadata. The Data Servers area gives you access to the file resources on all WebFOCUS Reporting Servers in your environment. if you wish. Any directory located under APPROOT appears under the Data Servers Applications folder. You can also perform operations on GIF images and other files. when. notice that several remote servers have been added. In addition. Master Files. procedures. If you are developing applications using a remote WebFOCUS Environment. and WebFOCUS StyleSheets. along with the applications that are physically under APPROOT.

2. Accessing Data and Creating Synonyms Configuring the Application Path How to: Configure the Application Path While working in the WebFOCUS Environments area of Developer Studio you can configure the Application Path for a Reporting Server if you have the required user privileges. Describing Data With Graphical Tools 23 . The Application Configuration dialog appears as shown in the following image. Select the In Path check box for the Configuration Path you want to set. Procedure: How to Configure the Application Path 1. You can change the Application Path search order by moving the selected application up or down. The following options are available in the Application Configuration dialog. click on it to expand the Applications folder and from the Applications folder right-click and select Configure Application Path. 2. Select the Reporting Server you want to configure from the Data Servers area.

Create directory. Create. If APPLOCK is set on the server. 4. The Test button performs a test against the Application Path and provide file statistics. Rename will be disabled. Press OK to save changes and return to the Application Configuration dialog. if it does not exist. provide an application name in the Mapping Name field. 24 WebFOCUS . Delete. you will see only applications that you are allowed to access and in addition other commands such as New Application. Click on the Data Server to expand the Applications folder and from the Applications folder. When the Create New Mapping dialog appears.Configuring Adapters and Remote Servers in Developer Studio The Preview button displays the syntax of the Application Path statement that will be created. Showing Only Applications in Path How to: Show Only Applications in Path By default Developer Studio displays all applications available for the Reporting Servers based on Reporting Servers APPROOT directory configuration. To create a new mapped application. Procedure: How to Show Only Applications in Path You can select to view only applications that are in the Reporting Servers Application Path by selecting a server under the Data Servers area. press the New Mapping button. Click Save to exit and save changes. Append directory to Application. Provide a location of the mapped application. the option to configure the Application Path will not be available. 3. 1. In this case. You may select the option. You can also select the option. The New Mapping button enables you to create a mapped application.

Rename will be disabled. Describing Data With Graphical Tools 25 . The applications set in the Application path will be displayed.2. Delete. right-click on the Applications folder and select Show All Applications. To see all available applications. Create. the options to control how applications are displayed is not available. 3. If APPLOCK is set on the server. Right-click and select Show Applications in Path as shown in the following image. Accessing Data and Creating Synonyms 2. In this case you will see only applications that you are allowed to access and in addition other commands such New Application.

26 WebFOCUS . see Configuring Adapters and Remote Servers in Developer Studio on page 20.Configuring Adapters and Remote Servers in Developer Studio Data Access Configuration Variations How to: Access the Create Synonym Tool Access the Create Synonym Tool From Developer Studio Reporting Tools If you are working on the platforms served by Developer Studio (UNIX. For details. An adapter enables an application to access a data source. if you wish to report against data in an Oracle database. Configuring adapters. This process involves configuring adapters. and so on. you need to configure the Adapter for Microsoft SQL Server. Windows. you need to configure the Adapter for Oracle. and then creating the required synonyms. Tip: Authorized administrators who prefer to work in a thin-client environment can complete these tasks from the Reporting Server Web Console. adding remote servers if necessary. i5/OS. see Using the Reporting Server Web Console for Data Access and Synonym Preparation on page 63. you can use the Developer Studio Create Synonym tool to set up access to your data. Both approaches edit the same underlying server files. so it does not matter which you use. An adapter must be configured on each Reporting Server that accesses the corresponding type of data. Each type of data source requires its own adapter to properly convert data or application requests into native statements and return optimized answer sets to the requesting program. and z/OS). which is accessible from the Developer Studio Object Explorer toolbar. For more information. OpenVMS. To access Microsoft SQL Server data. For example. which enables you to create the synonyms you need to access and read your Oracle data.

as represented in the image below. Accessing Data and Creating Synonyms Adding remote servers to your server configuration (if needed). named server (for example. The following are typical configurations. In order to understand when this step is required. a remote server has no role in your configuration.2. some of the data that applications need to access resides on another server or servers. often referred to as remote servers. which is visible in and accessible from the Data Servers area. it is useful to start by understanding when it is not required. This permits application development and administration and metadata management directly against the individual remote Reporting Servers. sites require that each remote server be available as a distinct. once adapters are available on the default WebFOCUS Reporting Server. where a default Reporting Server is automatically available on your local machine. (The same is true if you are working in the Projects area from a stand-alone Developer Studio installation. If you have configured adapters and your data is directly accessible from your default WebFOCUS Reporting Server.) Remote servers are required in the following situations: At many sites. With this setup. For the most frequently used remote server setup. you can create the required synonyms. FLATIRON and HERMES as previously shown in Object Explorer illustrations). Describing Data With Graphical Tools 27 .

For example. if a self-service application resides on the FLATIRON UNIX server. For details about adding servers to the WebFOCUS Client configuration. Only then can you perform operations directly on those servers. you can access the WebFOCUS Administration Console directly from Developer Studio. This includes creating synonyms and using Developer Studio tools to work with application files (synonyms. To expedite the client-side remote server configuration. or you may want to take advantage of the Developer Studio graphical tools to work with application files on a Mainframe server. HTML files.Configuring Adapters and Remote Servers in Developer Studio This modular server configuration provides great flexibility for in-place development on various types of application resources using Developer Studio tools. you may want to edit some of its components (maybe a procedure or an HTML file) directly on that server. see How to Add a Remote Server to the WebFOCUS Environment on page 66. In this situation. organized by application under each remote server. and so on). 28 WebFOCUS . you must add the servers to your default Reporting Server configuration. such as PDS_SRV1 or USS_SRV2. procedures. but you must also specify the same servers in your WebFOCUS Client configuration because that is what adds the distinct server names to the Data Servers folder.

require configuring the adapter needed to create those synonyms. some of the data that applications need to access resides on another server or servers. procedures. you can use Developer Studio tools to work with various types of application resources (Master Files. which are accessible through the default WebFOCUS Reporting Server. If that is not the case. you must configure the adapters and generate the synonyms. It is important to note that in this setup the remote servers do not appear in the Data Servers folder. that in order to use the data on each of these remote servers. organized for your convenience in virtual folders under each application. and so on). EDASERVE) can communicate with the remote servers and access the data stored there. HTML files. however. Accessing Data and Creating Synonyms Keep in mind. In another common remote server implementation. they are not exposed as separate servers in Developer Studio. Sometimes they are already available there.2. Once your default Reporting Server (for example. Creating synonyms for use by your applications in any supported environment. you must first create synonyms for the data accessed by the remote servers. which may. The synonyms you create are stored in your Reporting Server repository. you must add each remote server to your default Reporting Server configuration before you can create synonyms that point to tables on the remote servers and report against the combined data (which can be of different types and even on different platforms). This assumes. the appropriate adapters and synonyms must exist on those servers. however. Describing Data With Graphical Tools 29 . Since they can only be accessed through the default Reporting Server. In this case. in turn. as defined by APPROOT. but if not. as described later in this chapter. that the required synonyms already exist on the remote servers.

Procedure: How to Access the Create Synonym Tool To launch the Create Synonym tool from the WebFOCUS Environments area of the Explorer: 1. expand Data Servers. Using synonyms allows an object to be moved or renamed while allowing client applications to continue functioning without modification. If you wish to use the data source in multiple applications. The only modification required is a redefinition of the synonym on the server. Expand your WebFOCUS Environment (for example. For details. expand the project. and right-click the Master Files folder for the application in which you wish to access the data source. The synonyms define unique names (or aliases) for each table. view. or other type of object that is accessible from the server. They also provide support for extended metadata features of the server. or have not yet created your application. expand the server. a corresponding Access File. and right-click the Master Files folder. you can use the baseapp application. Synonyms are useful because they hide the underlying location and identity of the data source from client applications. where resources can be stored for sharing and access by other applications. 30 WebFOCUS .Configuring Adapters and Remote Servers in Developer Studio For each data source the server will access. expand an application. expand the Applications folder. which represent the server metadata. Appropriate synonyms must be available on the server where the data resides. Tip: If you are developing from the Projects area of the Explorer. FLATIRON . The result of creating a synonym is a Master File and. you must create a synonym that describes the structure of the data source and the server mapping of its data types. such as virtual fields and additional security mechanisms. usually.UNIX Dev WF Reporting Server). then proceed as described. see Creating Synonyms in Developer Studio on page 48.

Accessing Data and Creating Synonyms 2. Describing Data With Graphical Tools 31 . Select New and then Synonym.2.

multidimensional. Your first task is to configure an adapter in order to be able to access a relational. or other type of data source. Note: If any adapters have already been configured for the server they will be listed under the Configured folder.Configuring Adapters and Remote Servers in Developer Studio The Create Synonym tool opens. no adapters are available. By default. 32 WebFOCUS .

Configured. Describing Data With Graphical Tools 33 . we are assuming that no adapters are available. when Developer Studio is installed on its own. the Configured folder displays a Remote Servers folder that contains EDASERVE. This folder lists the data adapters that you can configure on the WebFOCUS Reporting Server platform.2. or both. Available. This folder contains any data adapters or remote servers that are already configured. In this instance. you can use this window to start configuring an adapter. Depending upon your needs. the default WebFOCUS Reporting Server plus any other remote Servers that may be configured with your environment. Expand the Available folders icon. select the required adapter and press Configure as shown in the following example. adding a remote server. You can use the Configured folder to add new connections and create synonyms. By default. Accessing Data and Creating Synonyms 3.

1.Configuring Adapters and Remote Servers in Developer Studio Procedure: How to Access the Create Synonym Tool From Developer Studio Reporting Tools When building a report. 34 WebFOCUS . as show in the image below. you can access the Create Synonym Tool directly from any of the Developer Studio reporting tools when you want to report against a synonym that is not available in the list. To launch the Create Synonym tool from Developer Studio reporting tools: Click Create New from the Open dialog box.

Accessing Data and Creating Synonyms Click Create New from the WebFOCUS Table List dialog box.2. the Create New button will not appear for developers without Data Server privileges. This restriction does not apply to the full edition of Developer Studio. as shown in the image below. Describing Data With Graphical Tools 35 . The Data Server privilege is optional for Developers and standard for Content Managers and Managed Reporting Administrators. Note: When accessing a Developer Studio Tool in the Managed Developer Edition.

or from the Projects area. the new synonym appears in the list of available synonyms. 2. You can then select it and continue to create your report request. Data Servers area. Continue using the tool as described in this chapter. you can manage Adapters by performing the following task.Configuring Adapters and Remote Servers in Developer Studio The Create Synonym Tool opens. see Configuring Adapters and Remote Servers in Developer Studio on page 20. For more information. When you have completed the synonym creation process. 36 WebFOCUS . Managing Adapter Configurations How to: Manage Adapter Configurations While working from the WebFOCUS Environments.

2. The Manage and Configure Adapter dialog appears. Describing Data With Graphical Tools 37 . Accessing Data and Creating Synonyms Procedure: How to Manage Adapter Configurations 1. right-click EDASERVE. Expand your WebFOCUS environment.. then right-click and select Manage Adapters. and select Manage Adapters. select the root folder Projects on. For the Projects area...

Click Configure.Configuring Adapters and Remote Servers in Developer Studio 2. The Adapter Configuration dialog appears as shown in the following image. 3. 38 WebFOCUS . Select the adapter that you want to configure.

Security. and default database. Server. Click OK when the Confirm prompt appears.2. 4. 5. Click Configure. This dialog enables you to define connection parameters for the adapter including Connection Name. Describing Data With Graphical Tools 39 . Accessing Data and Creating Synonyms An MS SQL Server adapter is issued for this configuration example. profile.

40 WebFOCUS .Configuring Adapters and Remote Servers in Developer Studio A dialog appears to inform you that the adapter was successfully added to configuration.

some adapters may require you to configure your environment before adding them. see the Adapter Administration for UNIX. Configuring Adapters in Developer Studio How to: Configure an Adapter in Developer Studio Add a Remote Server in Developer Studio If your machine has access to your data sources. OpenVMS.cfg server files.prf and edaserve. Accessing Data and Creating Synonyms From the Manage and Configure Adapters dialog you can also manage existing adapter connections. delete connections. Windows. and z/OS manual. add connections. To determine if this is required for an adapter you wish to configure. When you configure an adapter. i5/OS. and create synonyms. change properties. However. you can configure adapters to access data directly. information is added to the edasprof. test connections.2. Describing Data With Graphical Tools 41 .

7. 9.. 1. Click Test to test the connection. 2. If you typed the correct connection parameters.. sample data should appear. Test.. 1. 8. Delete. Procedure: How to Add a Remote Server in Developer Studio From the Projects area. Click Cancel to exit the tool. The Adapter Configuration dialog opens. When you open the Manage and Configure Adaapters dialog the following options appear when you select a configured adapter: Create Synonym. Or press Create Synonym to proceed and create synonyms for the configured adapter.. If the test fails. choose Properties. right-click on the root folder Projects On. Add Adapter. and select Manage Adapters. A message from the Reporting Server confirms that the adapter has been added to your configuration.Configuring Adapters and Remote Servers in Developer Studio Procedure: How to Configure an Adapter in Developer Studio From the Projects area. Expand the Available folders icons to select from the list of available adapters and select an adapter to configure. 42 WebFOCUS . click the connection. 3. and adjust your information accordingly. and select Manage Adapters. 4. 5. When sample data appears. right-click on the root folder Projects On. 6. Click Configure. and Properties buttons appear. Complete the connection information for your adapter. Expand the Configured folder in the Manage and Configure Data Adapters window of the Create Synonym tool. Click the Configure button to add the selected adapter. click Close.

Accessing Data and Creating Synonyms 2. Select Remote Servers and choose Add connection.2. Describing Data With Graphical Tools 43 .

It must begin with a letter and cannot be more than eight characters. but cannot be the same as any other server. HOST PORT HTTP_PORT 44 WebFOCUS . not 8100. This is normally one more than the base TCP port. The default is normally 8121. Specify the HTTP port for the server. Complete the fields as follows. Basic Parameters NODE Description Type a name by which you will refer to the server. The name is your choice. 3. The default is normally 8120. Specify the host name or IP address for the server.Configuring Adapters and Remote Servers in Developer Studio A window appears containing fields to define the connection. not 8101. Specify the base TCP port for the server.

If you entered a user. If the server is not on Windows and runs with security ON.2. For a trusted connection. user password domain DESCRIPTION If security is set to Explicit. where the current logged on user ID is passed to the server. you can specify the domain where the user ID is defined. Explicit. Passes your Windows user ID and password to the server when a connection is made. This description displays in the WebFOCUS front-end tools. providing an explicit user ID and password is required to create synonyms. provide a password. Trusted. This option requires that the server be started with security off. Describing Data With Graphical Tools 45 . enter a specific user ID. For a server on Windows. Windows only). The user ID and password received from the client application are passed to your data source at connection time. Password Passthru. Passes the user ID and password you provide. type a description for the node. Accessing Data and Creating Synonyms Basic Parameters SECURITY Description Specify how a user should log on to the remote server: IWA (Integrated Windows Authentication. Optionally.

click the Advanced tab and specify the SERVICE NAME. Note: Encryption is not supported for the PIPE protocol.Configuring Adapters and Remote Servers in Developer Studio 4. Servicename is optional. enables you to easily select and combine ciphers. DES for 56-bit fixed-key Data Encryption Standard. If servicename is provided. Advanced. HTTP_SSL Defines whether the Secure Sockets Layer protocol is used in the Web Console listener of the remote server. When connecting to a Unified Server. IBCRYPT for a user-defined algorithm. Only 0 and DES are supported for the HTTP protocol. This option provides the following ciphers: 3DES. as required. and other parameters. COMPRESSION Activates data compression in a data transfer between the client and server. and RSA key lengths. and the following modes: ECB and CBC. Enter: 0 for no compression. 1 for compression on. it must match the value of SERVICE in the service block of the server. Advanced Parameters SERVICE NAME Description CLIENT (servicename) Defines how to send outbound communications to a remote server. modes. 46 WebFOCUS . AES 128. Enter: 0 if no SSL is used in the connection to the Web Console. Key is 512-bit RSAencrypted. Enter: 0 for no encryption. ENCRYPTION Defines the encryption. AES 256. AES192. 1 if SSL is used in the connection to the Web Console.

sample data should appear. the following options appear when you select a configured remote server: Create Synonym. A message indicates that a new server was added. 0 for no wait. that the client will wait for a TCP connection response from the server. and provide an explicit user ID and password. 6. Test. choose Properties. 9. If the test fails. MAXWAIT Defines the time. Click Save when you have provided your parameter values. If the remote server is started and you typed the correct connection parameters. your next step is adding the remote server to your WebFOCUS Client configuration. Proceed to Defining a Remote Server in the WebFOCUS Client Communication File on page 65. The listing of servers in this location is controlled by the WebFOCUS Client and implemented through the WebFOCUS Administration Console. Click Cancel to exit tool or Create Synonym to continue and create synonyms for the new remote server. 8. in seconds. Accessing Data and Creating Synonyms Advanced Parameters CONNECT_LIMIT Description Defines the maximum time. Your next step depends on your objectives and your server configuration: If you wish to make the new remote server visible in and accessible from the Data Servers folder as a distinct named entity. in seconds. 7. When you open the Manage and Configure Adapters dialog. 5. Describing Data With Graphical Tools 47 . click the server.2. Click Close. Enter: -1 for an indefinite wait. Click Close. Delete. Click Test to test the connection. Then click Save and try the test again. that the client will wait for a response from the server: -1 indicates indefinite timeout. and Properties. 10.

Tip: If you are developing from the Projects area of the Explorer.Creating Synonyms in Developer Studio If your objective is to access data on the remote server through your default server. possibly. and right-click the Master Files folder for the application in which you wish to access the data source. Proceed to Configuring Adapters in Developer Studio on page 41 and then Creating Synonyms in Developer Studio on page 48. If you wish to use the data source in multiple applications. expand an application. where resources can be stored for sharing and access by other applications. Whenever you are ready. you can use the baseapp application. your WebFOCUS Client configuration (as described in Data Access Configuration Variations on page 26). FLATIRON (UNIX Dev WF Reporting Server). 48 WebFOCUS . and. you must configure and create them. you can use the Create Synonym tool to create synonyms for the data sources you need to access. If not. then proceed as described. expand the project. expand the server. you must determine if the appropriate adapter and required synonyms already exist on the remote server. and right-click the Master Files folder. expand Data Servers. Expand your WebFOCUS environment (for example. Creating Synonyms in Developer Studio In this section: Using the Reporting Server Web Console for Data Access and Synonym Preparation How to: Create a Synonym in Developer Studio Refresh Synonyms Delete Synonyms Reference: Synonym Creation Parameters for Microsoft SQL Server Synonym Creation Parameters for Stored Procedures The point at which you begin to create synonyms will depend on your adapter. to launch the Create Synonym tool from the WebFOCUS Environments area of the Explorer: 1. Reporting Server. Procedure: How to Create a Synonym in Developer Studio If it is not already open. or have not yet created your application. expand the Applications folder.

2. Accessing Data and Creating Synonyms 2. Select New and then Synonym. The Create Synonym tool opens. 3. In the first window, you can choose any configured Data Adapter or any Remote Server that has been added to the default Reporting Server. Note that when you are creating a synonym through a Remote Server, the remote server should already contain the required synonyms and the corresponding adapters.

The server configuration, indicated by the server profile, determines which adapters and servers appear. In this example, the Adapter for Microsoft SQL Server is configured. If you have configured remote servers, they will appear expanded in the Remote Server folder. 4. Select the server or adapter that you configured and click OK. A window opens in which you can enter additional information about the data source you wish to access. Important: The options in this window vary depending on the type of adapter or server you are using. To access the pertinent information for your adapter directly from Developer Studio, choose WebFOCUS Reporting Server Console from the Command menu. The Server Console opens. Click Help on the menu bar, select Contents and Search, expand the Adapters topic in the Table of Contents pane, and look for the adapter for which you wish to create the synonym. The relevant synonym creation parameters are fully defined.

Describing Data With Graphical Tools

49

Creating Synonyms in Developer Studio The following example is for accessing an adapter for Microsoft SQL Server.

After you complete this window, the data source or server is queried to determine the metadata you can use to create synonyms. For a relational database, this is usually a list of tables or views. This window lets you filter the results so there are fewer tables from which to choose. Optionally, choose whether both Tables and Views should be returned. By default, both are checked. For some data sources, you can select to generate synonyms for other object types, for example, Stored Procedures. If you do, the remaining input parameters will vary slightly. 5. For some data sources, you have the option to choose a database or other parameter. In this Microsoft SQL Server example, select the appropriate database or choose Use current database. You will be able to choose from the database tables when this window is complete. 6. Optionally, check Filter by owner/schema and object name to filter the results based on owners or table prefixes. This limits the list of tables returned from the remote data source and makes it easier to choose the data for which you want to create synonyms. If you do not include selection criteria, the entire list of tables is displayed. 7. Click Next.

50

WebFOCUS

2. Accessing Data and Creating Synonyms The top of the Create Synonym window now displays additional fields you can use to refine your synonym. Remember that the parameters vary depending on the type of adapter or server you are using.

The bottom of the Create Synonym window provides a list of tables for which you can create synonyms. To choose all, select the check box to the left of Default synonym name.

Describing Data With Graphical Tools

51

Creating Synonyms in Developer Studio 8. Click Create synonym. The synonym is created and a confirmation window appears. Once again, note that the window may vary depending on the type of adapter or server you are using.

The synonyms are created in the selected application directory. In this example, the default application, baseapp, is used. 9. Click Close.

52

WebFOCUS

A Synonym candidate can be any file that contains only one valid SQL Query and does not contain endof-statement delimiters (". you can further restrict your search by choosing check boxes for listed objects.2. Select a database from the Select database drop-down list. Choosing External SQL Scripts from the drop-down list enables you to represent SQL SELECT statements as synonyms for read-only reporting. Views. Views. for which Use current database must be checked." or "/") and comments. based on Tables. do one of the following: Check Use current database to use the database that has been set as the default database. which lists all databases in the current DBMS instance. or External SQL Scripts. Accessing Data and Creating Synonyms Reference: Synonym Creation Parameters for Microsoft SQL Server The following table describes the synonym creation parameters for Microsoft SQL Server. Before selecting a database. see Location of External SQL Scripts in this chart.) Describing Data With Graphical Tools 53 . (This does not apply to Informix SE. and any other supported objects. For related information. uncheck it. Depending on the adapter. Database selection To specify a database from which you can select a table or other object. if Use current database is checked. Parameter/Task Restrict object type to Description Restricts candidates for synonym creation based on the selected object types: Tables. External SQL Scripts.

Owner/Schema. %ABC to select all procedures whose names end with the letters ABC. inserting the wildcard character (%) as needed at the beginning and/or end of the string. For example. or end. middle. Object name.Creating Synonyms in Developer Studio Parameter/Task Filter by owner/schema and object name Description Selecting this option adds the owner/schema and object name parameters to the screen. Type a string for filtering the selection. Type a string for filtering the procedure names. %ABC% to select tables or views whose owner/schema contain the letters ABC at the beginning. %ABC to select tables or views whose owner/schema end with the letters ABC. enter: ABC% to select all procedures whose names begin with the letters ABC. or end. inserting the wildcard character (%) as needed at the beginning and/or end of the string. 54 WebFOCUS . For example. %ABC% to select all procedures whose names contain the letters ABC at the beginning. middle. enter: ABC% to select tables or views whose owner/schema begin with the letters ABC.

Accessing Data and Creating Synonyms Parameter/Task Location of External SQL Scripts Extension Description If you specify External SQL Scripts in the Restrict object type to field. In the Extension field. The generated Access File references the location of the SQL script in the DATASET attribute. enter: /QSYS. For example. Describing Data With Graphical Tools 55 . and z/OS HFS: In the Location of External SQL Scripts field. the adapter issues native API calls to obtain a list of elements in the select list and builds the Master File with a field for each element. The following entry illustrates this method: In the Location of External SQL Scripts field. During synonym generation. enter the extension of the script files to filter the list of candidates. You can enter this value explicitly or leave the input box blank. On i5/OS you can use alternative IFS naming conventions to access library members. specify the physical directory location of the file that contains the SQL Query.sql When a WebFOCUS report is created. which contains the full path.LIB/MYSRC.2. Select Application Select an application directory. including the file name and extension to the file containing the SQL Query. i5/OS IFS.FILE The Extension is understood to be MBR. DATASET=/ul/home2/apps/report3.LIB/MYLIBRARY. The following standard naming conventions apply for UNIX. the SQL Query is used to access data. The default value is baseapp. these additional fields are displayed.

select the Overwrite existing synonyms check box. The order of retrieval is based on the size (cardinality) of the table. To specify that this synonym should overwrite any earlier synonym with the same fully qualified name. For example. Smaller tables are read first. Dynamic columns Prefix/Suffix If you have tables with identical table names. Note that the resulting synonym name cannot exceed 64 characters. leave prefix and suffix fields blank. Customize data type mappings Overwrite existing synonyms Default synonym name To change the data type mappings from their default settings. The resulting multitable synonym describes all of the foreign key relationships for the table. To assign a different name. If this option is selected. select the Dynamic columns check box. To specify that the Master File created for the synonym should not contain column information. If the cardinality of the tables to be used in the application are dynamic. This column displays the name that will be assigned to each synonym. If all tables and views have unique names. The customizable mappings are displayed.Creating Synonyms in Developer Studio Parameter/Task Cardinality Description Select the Cardinality check box to reflect the current cardinality (number of rows or tuples) in the table during metadata creation. it may not be beneficial to choose this setting. replace the displayed value. if you have identically named human resources and payroll tables. Cardinality is used for equi-joins. select this check box. 56 WebFOCUS . assign a prefix or a suffix to distinguish them. assign the prefix HR to distinguish the synonyms for the human resources tables. With foreign keys Select the With foreign keys check box to include within this synonym every table related to the current table by a foreign key. column data is retrieved dynamically from the data source at the time of the request.

which describes any OUT parameters and INOUT parameters in OUT mode. one for each set of values. Describing Data With Graphical Tools 57 . If there are no IN parameters or INOUT parameters in IN mode. To select specific tables. which describes any IN parameters and INOUT parameters in IN mode. The ease with which you can process. and INOUT parameters in OUT mode) as well as the answer set. you can use a reporting tool to execute a procedure and report against its output parameters and answer set. Reference: Synonym Creation Parameters for Stored Procedures For data sources that support stored procedures. if users can execute the stored procedure using three different sets of input parameter values. and display output parameters and the answer set. the segment describes a single dummy field. Therefore. A synonym describes the parameters and answer set for the stored procedure. you need to generate a separate synonym for each set of input parameter values that will be provided when the procedure is executed at run time. Among the benefits of this method of executing a stored procedure are: The retrieval of output parameters (OUT parameters.2. A synonym includes the following segments: INPUT. For each synonym simply provide a representative set of the input parameter values necessary to return that answer set structure. you can create one synonym for each answer set structure. OUTPUT. For example. you need to generate three synonyms. and are certain which range of input parameter values will generate each answer set structure returned by the procedure. select the check box to the left of the Default synonym name column heading. Accessing Data and Creating Synonyms Parameter/Task Select tables Description Select tables for which you wish to create synonyms: To select all tables in the list. select the corresponding check boxes. Other methods of invocation retrieve only the answer set. using TABLE and other reporting tools. input parameters refers to IN parameters and to INOUT parameters in IN mode. format. Note: If you know the internal logic of the procedure. The first step is to create a synonym for the stored procedure you wish to report against. An answer set structure may vary depending on the input parameter values that are provided when the procedure is executed. Unless noted otherwise.

Parameter/Task Restrict object type to Filter by owner/schema and object name (for DB2. middle. this applies to all platforms except i5/OS) Description Select Stored Procedures. %ABC% to select tables or views whose owner/schema contain the letters ABC at the beginning. For example. one for each answer set. Type a string for filtering the procedure names. %ABC to select tables or views whose owner/schema end with the letters ABC. enter: ABC% to select all procedures whose names begin with the letters ABC. inserting the wildcard character (%) as needed at the beginning and/or end of the string. Type a string for filtering the selection. For example. or end. middle. 58 WebFOCUS . the segment is omitted. %ABC to select all procedures whose names end with the letters ABC. or end. the segment is omitted. %ABC% to select all procedures whose names contain the letters ABC at the beginning. Object name. ANSWERSETn. The following chart describes the parameters used to create the synonym. Selecting this option adds the owner/schema and object name parameters to the screen.Creating Synonyms in Developer Studio If there are no OUT parameters or INOUT parameters in OUT mode. inserting the wildcard character (%) as needed at the beginning and/or end of the string. Owner/Schema. If there is no answer set. enter: ABC% to select tables or views whose owner/schema begin with the letters ABC.

Type a string for filtering the table. For example. Type a string for filtering the Library (or DB2 Collection). %ABC% to select all whose names contain the letters ABC at the beginning. For example. Accessing Data and Creating Synonyms Parameter/Task Library Object Name (i5/OS only) Description To avoid the return of an extremely large and potentially unmanageable list. which defaults to the stored procedure name. %ABC to select tables or views whose owner IDs end with the letters ABC. %ABC% to select tables or views whose owner IDs contain the letters ABC at the beginning. The name of the synonym. %ABC to select all whose names end with the letters ABC. inserting the wildcard character (%) as needed at the beginning and/or end of the string. view. middle. or end. Select Select a procedure. Object name. middle. views. You can only select one procedure at a time since each procedure will require unique input in the Values box on the next synonym creation pane. or end. or object names. The default value is baseapp. or objects whose names begin with the letters ABC. enter: ABC% to select tables or views whose owner IDs begin with the letters ABC.2. always supply a value for Library or Object Name: Library. Select an application directory. inserting the wildcard character (%) as needed at the beginning and/or end of the string. enter: ABC% to select all tables. Name Select Application Describing Data With Graphical Tools 59 .

Overwrite existing synonyms Customize data type mappings To specify that this synonym should overwrite any earlier synonym with the same fully qualified name. 60 WebFOCUS . select this check box. Note that the resulting synonym name cannot exceed 64 characters. i5/OS. see Data Type Support in the chapter for your adapter in the Adapter Administration for UNIX. assign a prefix or a suffix to distinguish their corresponding synonyms. For information about them.Creating Synonyms in Developer Studio Parameter/Task Prefix/Suffix Description If you have stored procedures with identical names. OpenVMS. If all procedures have unique names. select the Overwrite existing synonyms check box. To change the data type mappings from their default settings. and z/OS manual. The customizable mappings are displayed. leave the prefix and suffix fields blank. Windows.

However. and timestamp parameters must have values entered in an ISO format. while you must check the parameter box. If the procedure you selected has input parameters (IN parameters and/or INOUT parameters in IN mode). Accessing Data and Creating Synonyms Parameter/Task Values Description Select the check box for every parameter displayed for the specified procedure. Note the following before you enter parameter values. Describing Data With Graphical Tools 61 . only one synonym needs to be created and you can leave the Value input blank for synonym creation purposes. and are certain that it always produces the same data structure. Any date. If a Value is required. Specify the same input parameters that will be provided when the procedure is executed at run time if it is a procedure that requires explicit values. enter it without quotation marks. date-time. you will be prompted to enter values for them. Follow these guidelines: Explicit input values (and separate synonyms) are required when input parameter values cause answer sets with different data structures. the need for an explicit Value entry depends on the logic of the procedure and the data structures it produces. which vary depending on the input parameters provided. you may not need to enter a value. In this situation. Therefore. Explicit input values are not required when you know the internal logic of the procedure.2.

Choose Refresh Synonym to recreate the Master File. CONNECTION=ITarget. description. $ SEGMENT=INPUT. USAGE=I11. and one answer set containing four variables. $ SEGMENT=ANSWERSET1. ACTUAL=I4. USAGE=HYYMDs. MISSING=ON. $ SEGMENT=OUTPUT. SUFFIX=SQLMSS. ALIAS=OrderDate. PARENT=INPUT. 62 WebFOCUS . 2. STPRESORDER=0. $ FIELDNAME=SHIPPEDDATE.dbo. ACTUAL=A5.Creating Synonyms in Developer Studio Example: Synonym for Microsoft SQL Server Stored Procedure CustOrders The following synonym describes a Microsoft SQL Server stored procedure with one input parameter. ALIAS=P0000. usage. The action also synchronizes the Master File with the table on which the synonym is based. ACTUAL=HYYMDs. USAGE=A5. MISSING=ON. In the WebFOCUS Environments folder. ALIAS=RequiredDate.CustOrders. Right-click a synonym (Master File). virtual field. and not supported for FOCUS files. $ FIELDNAME=@RETURN_VALUE. You can refresh synonyms from either the Data Servers area under the WebFOCUS Environments folder or from the Projects area. 1. ALIAS=ShippedDate. $ SEGNAME=OUTPUT. In the Projects area. ACTUAL=I4. USAGE=I11. $ The Access File for the synonym is: SEGNAME=INPUT. Note: Refresh is not applicable to Cube data sources at the current time. $ Procedure: How to Refresh Synonyms Refreshing a synonym enables you to update field information while preserving the original synonym title. ACCESS_PROPERTY=(NEED_VALUE). USAGE=HYYMDs. USAGE=HYYMDs. MISSING=ON. ALIAS=OrderID. one output parameter. SEGTYPE=S0. ACTUAL=HYYMDs. SEGTYPE=S0. Master Files are listed within an application in the Data Servers. STPNAME=Northwind. ACTUAL=HYYMDs. $ SEGNAME=ANSWERSET1. Master Files are listed in a Master Files folder under a project name. ALIAS=P0001. Applications area. $ FIELDNAME=REQUIREDDATE. STPRESORDER=1. $ FIELDNAME=ORDERID. MISSING=ON. The Master File for the synonym is: FILENAME=CUSTORDERS. PARENT=INPUT. and DBA information. SEGTYPE=S0. $ FIELDNAME=@CUSTOMERID. $ FIELDNAME=ORDERDATE.

see the Server Console help system or the following manuals: Server Administration for UNIX. add remote servers. You can use the Server Console as an alternative to the Developer Studio tools to configure adapters. the local. In addition. You are asked to confirm the deletion. OpenVMS. 2. Note: This console is sometimes referred to as the Web Console or the Reporting Server Console. and z/OS. default WebFOCUS Reporting Server normally runs with security OFF. and z/OS and Adapter Administration for UNIX.2. Using the Reporting Server Web Console for Data Access and Synonym Preparation How to: Access the Reporting Server Web Console A server administrator. Accessing Data and Creating Synonyms Procedure: How to Delete Synonyms Master Files and Access Files are removed from the server when you delete a synonym. For a full understanding of configuration options and server capabilities. i5/OS. or an application administrator who has been granted these privileges. and create synonyms. Windows. can configure and manage WebFOCUS Reporting Servers through the Reporting Server Web Console. For Developer Studio installations that allow stand-alone development. i5/OS. Click Yes to delete or No to cancel. Right-click the synonym you want to delete and select Delete. OpenVMS. 1. Describing Data With Graphical Tools 63 . Windows. and the user who installed Developer Studio is the default administrator. many other configuration options are available through the Server Console.

4. Open the Reporting Server Web Console from Developer Studio by selecting its icon from the Object Explorer toolbar or opening the following page in a Web browser: http://hostname:port#/webconsole The Server Console opens in your Web browser. 2. expand folders on the right. 3. and click your adapter type to bring up a form for adding the data adapter. click New Adapter. click Help on the menu bar and choose Contents and Search. To access the Server Console help. click Metadata on the menu bar. 64 WebFOCUS . select the remote server or adapter on the right. and complete the forms that follow. click New Synonym. Expand the Adapters folder in the Table of Contents. Note: You may need to use Internet Explorer to properly view the help. To create a synonym through the Server Console.Creating Synonyms in Developer Studio Procedure: How to Access the Reporting Server Web Console 1. click Data Adapters on the menu bar. On the expanded menu bar. To add an adapter through the Server Console. and review the information for your adapter. On the expanded menu bar.

you must add the remote server to your WebFOCUS Client configuration. procedures in the Report Painter. the listing of servers in this location is controlled by the WebFOCUS Client and implemented through the WebFOCUS Administration Console. you can access data and perform development directly against the named remote server. and edit those files as if you were working on your local machine. in their respective virtual folders. Except for the default server (for example. That is. Describing Data With Graphical Tools 65 . and HTML files in the Report Painter. When the Administration Console opens. EDASERVE). you can open synonyms in the Synonym Editor. which is visible under Data Servers. Proceed as described in How to Add a Remote Server to the WebFOCUS Environment on page 66. Once you add the remote server to your WebFOCUS Environment. Procedure: How to Open the WebFOCUS Administrative Console From Developer Studio 1. 2. These Reporting Servers can also be used by Managing Reporting if that environment is deployed in your organization. Select the WebFOCUS Environment you are working with. Click the WebFOCUS Administration Console icon on the Object Explorer toolbar. Data Servers folder as a distinct. log in to WebFOCUS. which updates the WebFOCUS Client communication file (odin. For example. 3. for development purposes. and you wish to make that remote server visible in and accessible from the WebFOCUS Environments. you can use a variety of Developer Studio tools to access your application files. named entity. Accessing Data and Creating Synonyms Defining a Remote Server in the WebFOCUS Client Communication File How to: Open the WebFOCUS Administrative Console From Developer Studio Add a Remote Server to the WebFOCUS Environment Change a Remote Server Node If you have configured a WebFOCUS Reporting Server elsewhere in your enterprise to access your data.2.cfg).

e. If this is a z/OS server. but cannot be the same as any other node name. 4. Determines how WebFOCUS connects to the WebFOCUS Reporting Server. this node will function as a stand-alone server. 2. Enter the following required parameters: a. Type the same port number that was specified during installation. Port number for the HTTP listener. proceed to step 7. The New Node window opens. the name must begin with a letter and cannot be more than eight characters. Port number for the TCP listener.Defining a Remote Server in the WebFOCUS Client Communication File Procedure: How to Add a Remote Server to the WebFOCUS Environment 1. 6. you must include a qualifier. If you specify: Client. this is the primary node that will be used to distribute workload to alternate servers. Cluster. proceed to step 6. Specify the Node class (Client. HOST. When the WebFOCUS Client accesses this server. it will use this name. In addition. CLASS. HTTP_PORT. The default port is 8120. c. CLM Processing. The name is your choice. specify the name by which you will refer to the server. Click Reporting Servers and then Remote Services. the Cluster Manager node monitors server performance statistics and sends the request to the best available server for processing. Host name or IP address of the server. or CLM Processing). This is normally the second consecutive port that the server uses. PORT. If you selected CLM Processing in step 4. Click New. b. 3. SECURITY. The following are possible SECURITY values: 66 WebFOCUS . If you selected Client in step 4. It can also be used as an alternate server within a cluster configuration. Click Next. 5. d. In the NODE field. The default HTTP port is 8121. If you selected Cluster in step 4. Cluster. proceed to step 8.

This option enables an end-to-end single sign-on solution from the desktop to WebFOCUS. created on SAP Enterprise Portal. from WebFOCUS to the Reporting Server. PTH. Enables you to specify a user ID and password to be used for all connections to the Reporting Server.cfg file does not contain a SECURITY keyword. HTTP Basic. DBMS). You should only select this option when your Web tier is performing Basic Authentication so that the user Base64 encoded ID and password will be available in the request header. LDAP. the WebFOCUS Reporting Server must run in security OPSYS mode. A user ID may come from IBI_REPORT_USER on the console Client Settings. SAP Ticket. Describing Data With Graphical Tools 67 . There are additional setup requirements for WebFOCUS and Microsoft Active Directory that are described in Technical Memo 4647: Configuring Single Sign-on to the WebFOCUS Reporting Server Using Kerberos. from a WebFOCUS Client Node Profile. For example: Authorization Basic amx0XHdmdXNlcjp3ZnVzZXIx To verify that the Authorization header is available to WebFOCUS. Is the initial value for new nodes and represents the traditional behavior. to the Reporting Server which validates it using the SAP security API. Reporting Server pane. WebFOCUS passes along the MYSAPSSO cookie of the user. as shown in the following image. or from the user WF_COOKIE if a Reporting Server sign-on has taken place. When using this option. Enables customers using WebFOCUS Open Portal Services in SAP Enterprise Portal to achieve single sign-on through WebFOCUS to a Reporting Server configured with the Data Adapter for SAP. How the server processes explicit connections depends on its security setting (OFF. These credentials are then used to make an explicit connection to the WebFOCUS Reporting Server. Service Account. click the Diagnostics menu on the WebFOCUS Administrative Console and select HTTP Request Info. OPSYS. Kerberos. WebFOCUS makes an explicit connection to the Reporting Server with whatever user ID and password it has available for the request. Configures WebFOCUS to extract the user ID and password from the Authorization header. In this case. where the odin. Accessing Data and Creating Synonyms Default. and from the Reporting Server to supported relational DBMS systems.2. Configures WebFOCUS to pass the Kerberos ticket for the user to the WebFOCUS Reporting Server.

employing the server RESTRICT_TO_IP setting so that only a particular WebFOCUS client can connect to the server). including Windows. In this scenario. This option is useful when no password is available for the user. the service account overrides any other credentials that may be presented to WebFOCUS for this Reporting Server node. 68 WebFOCUS . The server GETUSER subroutine will always return the user ID that started the server. PTH. then trusted connections will be accepted without authentication by Reporting Servers on any platform. The server edaprint. In this configuration the connecting user appears in the server edaprint.log file and is returned by the server GETUSER and CNCTUSR subroutines. and controls can be placed on the server to ensure that connections from unauthorized clients are rejected (for example. and the server GETUSER subroutine shows the user ID that started the server.cfg file. which makes it possible to use operating system permissions and the trusted option for DBMS adapters in order to restrict file and data access. If the server runs in the PTH or OFF security modes. the connecting user ID must be valid on the server operating system and the Reporting Server cannot run on Windows. and LDAP modes provided that the server trust_ext setting is enabled. When defined. Enables you to connect to the Reporting Server with only a user ID. Trusted.log file and is returned by the server CNCTUSR subroutine. the connecting user appears in the server edaprint.Defining a Remote Server in the WebFOCUS Client Communication File The service account credentials are encrypted and stored in the SECURITY keyword of the odin. When the server runs in LDAP mode the connecting user must be found in the LDAP directory before the connection is accepted. The report agent runs in the security context of the connecting user.log file and CNCTUSR subroutine will reflect the connecting user ID. Trusted connections are also supported by servers running in security OFF. If the server runs in security OPSYS mode.

cookie_name1. Note: HTTP Cookie and Header names must not contain commas or colons. Developer Studio Metadata tools. the WebFOCUS script variable and Web server HTTP variable settings are displayed. the certificate must be configured in the Java environment in which the WebFOCUS Client is installed. COMPRESSION. If you are using a self-signed certificate to enable HTTPS communication with a WebFOCUS Reporting Server. This enables HTTPS communication between the Reporting Server and the following WebFOCUSClient tools: WebFOCUS Administration Console. Select the option that will be used to retrieve the connected user. -SET &CONNECT_USER -SET &AGENT_USER = -TYPE Connect User -TYPE Report Agent = CNCTUSR('A30'). Accessing Data and Creating Synonyms The following lines in a report request are useful to determine connection behavior. You can also specify the following optional parameters: Security Object. Enables encrypted communication between the WebFOCUS Client and the WebFOCUS Reporting Server HTTP listener. cookie_name2. header_name2. This option must be selected. an administrator can specify one or more HTTP Header names and/or Cookie names as follows: COOKIE . since these are reserved delimiters. For example. such as the Synonym Editor and Create Synonym tool. as shown in the following image. Describing Data With Graphical Tools 69 . For example. Note: Trusted connections are not supported by servers running in security DBMS mode. Turns on data compression. For any security option. GETUSER('A30'). Codes are: 0 (off) and 1 (on). is: &CONNECT_USER runs as: &AGENT_USER When you select Trusted. HEADER .Specify each HTTP Cookie name separated by a comma. HTTP_SSL.2.Specify each HTTP Header name separated by a comma. header_name1. if the HTTP listener of the server is configured to use SSL.

b. The New Cluster Node window opens. Enter the following required parameters: a. DESCRIPTION.<row wait>]. In addition. if encryption is set manually outside of the console using the odin. UDP Port number. This description displays in the WebFOCUS front-end tools. Note: Triple DES and IBCRYPT are not supported under the HTTP protocol or for communication to and from the MVS server. <query wait>[. Time is in seconds. The first number is the return time for any row. which is used when Cluster is specified). -1 is the default value. PORT. The IP address of the Reporting Server where the Cluster Manager is configured. Number of seconds the client holds the pending connection. ALTERNATE. CONNECT_LIMIT. 8. Select one of the following options from the drop-down list: 0 = off DES = 168-bit 3DES = 512-bit 3DESx = 1024-bit IBCRYPT = user defined IBCRYPT DLL is loaded. Sets data encryption ability and the cryptography symmetric method is used. Optional description for the CLM Processing node. The New CLM Processing Node window opens. DESCRIPTION.cfg file. proceed to Step 8 (and skip Step 7. Description for the WebFOCUS Reporting Server node. 70 WebFOCUS . Select the servers to be included in the cluster. Enter the following required parameters: a. 7. This is useful in a cluster deployment to avoid a lengthy delay of failover response. Description for the cluster.Defining a Remote Server in the WebFOCUS Client Communication File ENCRYPTION. b. Time the client waits before timeout. DESCRIPTION. HOST. The second number (optional) is the return time for rows beyond the first row. Because you specified Client in Step 4. Other possible values are 0 (no wait) and -1 (infinite wait). the console displays it as a static value and it cannot be modified using the console. MAXWAIT. c.

see Technical Memo 4665: Distributing Workload Across Clustered WebFOCUS Reporting Servers. theWebFOCUS Administration Console indicates that the IBI_REPORT_SERVER is the default node. Click one of the following buttons: Modify. Displays the settings for the selected node. Tip: More advanced cluster functionality can be configured using the Reporting Server Web Console. and z/OS manual. OpenVMS. Accessing Data and Creating Synonyms You can add multiple CLM hosts and ports by clicking Add.2. 9.wfs file or request URL contains an IBIC_server setting. You can select the Set as Default Server Node check box to specify that the node is the default WebFOCUS Reporting Server. For more information. To remove a host and port. A check box is added next to each new host and port combination. which enables you to remotely manage your server environment. Describing Data With Graphical Tools 71 . see the Server Administration for UNIX. These settings are written to ibi\WebFOCUS\client\wfc\etc\node. Click Save. select the associated check box and click Remove. You can also click Save As to save these settings for another specified node that will be added to the ibi\WebFOCUS\client\wfc\etc\odin.wfs file. Server Console.cfg file. i5/OS. even though it is no longer the default. Note: You can select the Sort alphabetically check box to sort a list of multiple servers. This button only appears if you have more than one node defined. If the site. Enables you to override WebFOCUS default settings for a specific WebFOCUS Reporting Server node. Deletes the selected node. Note that even if you check Set as Default Server Node. this can be overridden if an IBIC_server is set in site. it will override the IBI_REPORT_SERVER parameter. Remove. You will receive a message asking for you to confirm the deletion. Procedure: How to Change a Remote Server Node 1. where node is the node you selected in Step 2. 2. The node will be written as the IBI_REPORT_SERVER parameter value in the cgivars. Profile. Windows. Select the node you want to change. Click Reporting Servers and then Remote Services.wfs or a node profile. enabling you to make changes. Displays the WebFOCUS Reporting Server Console. For details. In this case.prf. 3.

Defining a Remote Server in the WebFOCUS Client Communication File 72 WebFOCUS .

WebFOCUS 3 Topics: Using the Synonym Editor This chapter describes the Synonym Editor and how you may use it to view and edit synonyms. Using the Synonym Editor for Cube Data Sources Creating Business Views Adding Virtual Columns (DEFINE) in a Synonym Creating Filters in a Synonym Adding Computed Fields (COMPUTE) in a Synonym Storing the Number of Repetitions of a Repeating Field in a Virtual Field Defining Attributes and Creating Expressions for Custom Fields Adding Group Fields in a Synonym Applying Database Administrator Security Introduction to Synonym Editor Synonym Editor Layout Viewing and Editing Synonym Attributes Setting Up Multilingual Titles and Descriptions Enhancing Synonyms Using the Modeling View Viewing Data Profiling Characteristics Creating Cluster Joins Defining Dimensions for OLAP Analysis Describing Data With Graphical Tools 73 .

Text View Tab Synonym Editor . Text View. Synonym Editor Layout Reference: Synonym Editor .Column/Field Pop-up Menu Synonym Editor . and modify.Format Options Dialog . Modeling View.Access File Text View Tab The Synonym Editor is available from Developer Studio and provides the following views that enable you to view and manage synonyms: Segment and Field. Field View.Synonym Editor Options Dialog .Options Dialog Preference Options Dialog .Introduction to Synonym Editor Introduction to Synonym Editor A synonym consists of a set of attributes that describe the data source.Segment and Field View Tab Synonym Editor .Main Attributes Synonym Editor Toolbar Synonym Editor .Modeling View Tab Synonym Editor . view. which enables an adapter to access and interpret the corresponding data. It provides the metadata for a data source.Segment Pop-up Menu Synonym Editor . Segment View.Column Management Options Dialog .Field View Tab Synonym Editor . The Synonym Editor provides a graphical interface that enables you to work with synonyms and perform tasks such as create.Segment View Tab Synonym Editor . 74 WebFOCUS . and Access File Text View tabs.Run Options Synonym Editor .

Note: The attributes available depend on the type of synonym. Using the Synonym Editor Reference: Synonym Editor .3. The following image is an example of an SQL data source with a key column selected. In this case. and Modeling View tab shows a hierarchy of segments and columns on the left with the attributes and values of the selected item in the Properties windows that displays by default in the lower-right side of the tool. or DBA) can be resized. Describing Data With Graphical Tools 75 . Segment View tab.Main Attributes The Segment and Field View tab. Note: Information about the attribute that has focus is displayed at the bottom of the attribute list. an explanation of the FIELDNAME attribute appears. The Properties window and the other available windows (Business View. Field View tab. Dimension Builder. or hidden by the available toolbar icons. positioned in different areas.

Key Column. Filter. Indicates a Master File filter. Virtual Column (DEFINE). Indicates the native DBMS has an index for quick retrieval of values for this field. The icon is dimmed. Note: This type of segment is applicable for FOCUS data sources. Indicates a unique segment in a FOCUS/FDS or XFOCUS synonym. The root or parent segment appears first in the tree. Column. It provides information about the file name used and the application it resides in.Synonym Editor Layout The following objects may appear in the tabs. see Adding Virtual Columns (DEFINE) in a Synonym on page 157. Index Column. General icon used to indicate synonyms. Indicates a segment in a synonym. Segment. Indicates a virtual or cross-referenced segment. Indicates a virtual or defined column. Object Function Synonym. visible on top of the Segment and Field View tab. Unique Segment (FOCUS/FDS and XFOCUS only). 76 WebFOCUS . Indicates a general column. For more information about virtual columns. Virtual Segment (Cross-Referenced). Indicates a key column.

Note: Icons that have a shortcut overlay. certain toolbar buttons may be inactive. Using the Synonym Editor Object Function Compute field. This option is enabled when you select Options from the Tools menu. Style. click the check box option.3. Support Extended Option in Synonym Editor. Group. click the check box option. In Options dialog. Indicates a computed field. In Options dialog. Button Definition Saves the edits made to the synonym. click the check box option. This option is enabled when you select Options from the Tools menu. a dimmed arrow shortcut icon in the lower-left corner of the icon. Therefore. Reference: Synonym Editor Toolbar The Synonym Editor toolbar contains buttons that provide quick access to commonly performed functions. This option is enabled when you select Options from the Tools menu. Support Extended Option in Synonym Editor. Support Extended Option in Synonym Editor. In Options dialog. Enables you to print the current screen view. Describing Data With Graphical Tools 77 . Saves the edits made to the synonym to a new file (Save As). Sort Object. indicate that fields or segments are referenced and do not exist in the Synonym that is being edited. The behavior of the button is determined by the selected object.

Adds a Master File filter . Adds a group. This option is dimmed. Note: You would only use this approach if you are coding a new Master File . see Creating Filters in a Synonym on page 161. Adds a COMPUTE field. For more information about filters. This tool creates a synonym and includes it as a segment in the synonym from which the tool was launched. Enables you to add segments through the metadata import by using the Create Synonym tool. as you would for a FOCUS data source. For more information about groups. see Adding Group Fields in a Synonym on page 179. Enables you to add segments manually. see Adding Virtual Columns (DEFINE) in a Synonym on page 157. Deletes the selected item. For more information about computed fields. For more information about virtual columns. 78 WebFOCUS . Adds a virtual column (DEFINE) field.Synonym Editor Layout Button Definition References segment from an existing synonym. see Adding Computed Fields (COMPUTE) in a Synonym on page 164. Adds a column field. assigning values to segment attribute fields in the Synonym Editor. Enables you to add segments from an existing synonym by using the Select Synonym dialog box.

you may customize field names. Enables DBA data source access. titles. see Creating Business Views on page 149. Describing Data With Graphical Tools 79 . For more information about Business Views. and descriptions. Properties describes the attribute. Using the Synonym Editor Button Definition Adds field/value security DBA. For more information about DBA security. Enables you to view and refresh sample data for the object. Inserts a variable to the segment.3. Dimension Builder enables parent/child hierarchy. see Applying Database Administrator Security on page 185. In addition. Enables you to create a Business View and create a custom Master File that can use selected fields from the original synonym.

Reference: Preference Options Dialog . 80 WebFOCUS .Options Dialog When you click Tools from the main menu and select Options. Support extended option in Synonym Editor If selected. and a transformation with db_lookup.Synonym Editor The Synonym Editor user preferences include using the application name with the synonym.Synonym Editor Layout Reference: Synonym Editor . The Synonym Editor settings page has the following fields/options: Use application directory name with synonym If selected. showing parent segments in the Join Editor and enabling multiple parentage when joining tables. an application directory name will be used when selecting a synonym name for both referencing to an existing synonym. the Options dialog appears as shown in the following image and enables you to set preferences and customize the look of Synonym Editor. both the Sort objects and Styles folders appear when editing a synonym. supporting the extended option.

or includes. controls whether or not columns in parent segments are displayed in the Join Editor for a cluster join or a synonym that references. Reference: Options Dialog .3.Format Format user preferences include settings. Colors and Fonts. colors. The Format settings window has two sections. Show multiple parentage in Synonym Editor If selected. and fonts for the Synonym Editor interface. Describing Data With Graphical Tools 81 . other synonyms. Using the Synonym Editor Show parent segments in Join Editor If selected. The Colors section has the following fields/options: Colors list box Allows you to set colors for connector lines in process flows. The Format settings window is available from the Tools menu by selecting Options. allows creation of joins with multiple fact tables.

The settings apply to all column-related dialog boxes.Synonym Editor Layout Unconditional Line Color changes the color of connectors in data flows and unconditional connectors in process flows. The Fonts section has the following fields/options: Category list box Allow you to set the font for text in the process flow workspace. Failed Line Color changes the color of the Failed connector in process flows. Custom Line Color changes the color of the custom connector in process flows. joins. column selection. Color A drop-down menu of available colors. 82 WebFOCUS . Selected Object Text Color changes the color of the object name when you mouse over it in process flows. Reset colors to defaults Restores the default colors. You can also set the column display order. and sorts. reports. Reference: Options Dialog . OK Line Color changes the color of the OK connector in process flows. Font Launches a dialog box for changing font settings.Column Management Column Management user preferences enable you to select which columns to display on the grids for transformations. Reset font to defaults Restores the default fonts. text views and log views.

The default settings are shown. or Description.3. Column Name Display Strategy Controls the information that appears in trees and grids. The Column Management settings window has the following fields/options: Customize column display Lists columns that can be added to the grid using the check boxes. Not all columns are on every grid. If no Title or Description exists. The available options are Name. the display will default to the Name. Describing Data With Graphical Tools 83 . Using the Synonym Editor The Options window is available from the Tools menu by selecting Options. Title. Type Is the type of object in an application directory. The following columns can be added: Expression Is the expression for the column.

SCD Type Is used for processing slowly changing dimensions. Description Is a description or comments about the column. Table Is the synonym that contains the column. 84 WebFOCUS .Run Options Run Options user preferences include determining the number of rows to retrieve when sampling data. Note: You can change the display order of the columns by moving them up or down using the arrows. Title Supplies a title to replace the column name that is normally used in reports. Field Type Indicates that a field is an index (I) and/or is read-only. or the real column name for a DBMS synonym.Synonym Editor Layout Length Is the column length. Alias Assigns an alternative name for a column. Reference: Options Dialog . You can also change the Column Name Display Strategy to control what appears in trees and grids. Nulls Indicates whether the column can contain null data. Format Is the type and length of a column data as stored. Scale Is the maximum number of digits to the right of the decimal.

Maximum number of columns for test reports Sets the number of columns retrieved to produce sample data when testing transformations or SQL.3. The default is 50. Using the Synonym Editor The Options window is available from the Tools menu by selecting Options. The default is to retrieve all columns (with a highest value setting of 999999). The Run Options settings page has the following fields/options: Maximum number of rows for test reports Sets the number of rows retrieved to produce sample data when testing transformations or SQL. Describing Data With Graphical Tools 85 .

There are seven report formats available: Default: Formats numeric and date columns based on edit options in the synonym. The following image is an example of an SQL data source with the root segment selected. Excel: Produces the report in Excel format. Reference: Synonym Editor .Synonym Editor Layout Test reports default format Sets the format of reports for retrieving sample data when testing transformations or SQL. Active Report: Produces an HTML Active Report designed for offline analysis. The default is Default. the following pop-up menu appears. HTML: Produces the report in HTML format. PDF: Produces the report in PDF format. Unformatted: Does not apply formatting to numeric and date columns. 86 WebFOCUS .Plain Text: Produces the report in plain text format.Segment Pop-up Menu When you right-click a segment in the Synonym Editor. HTML .

Segment Via Metadata Import Enables you to create and add a new synonym to the current synonym through the Create Synonym tool. Compute Inserts a calculated value to the file. If you subsequently make changes to the source synoym. Filter Inserts a filter to the segment. the current synonym will not reflect those changes. Define Inserts a virtual or defined to the segment. Group Inserts a group column to the segment. Describing Data With Graphical Tools 87 . If you subsequently make changes to the source synonym. Variable Variable name for access file parameter. Copy of Segment from Existing Synonym Adds a static copy of an existing synonym to the current synonym. Segment Manually Inserts a synonym that must be coded manually. Using the Synonym Editor The following options are available: Insert Enables you to insert one of the following: Reference to Segment from Existing Synonym The reference is a pointer to the source synonym. Field Inserts a general column to the segment.3. re-opening the current synonym will reflect those changes.

Delete Deletes the segment.Synonym Editor Layout Data Profiling Provides the characteristics of the data for a segment. The following image is an example of the sample data that appears for a segment. and so on. Join Properties Opens the Join Editor so that you can specify how the selected segment is joined to the parent segment. This can assist when performing Joins. Rename Enables you to rename the segment. Data Profiling is available from the right-click context menu for all columns in the Master File hierarchy tree. Sample Data with parent key Displays sample data for the selected segment joined to the parent segment. Sample Data Displays sample data in the workspace for the selected segment or synonym. Note: Sample data is a great way to test the synonym for field data and to view the type of records returned. testing connectivity to data sources. 88 WebFOCUS . Sample data is available throughout the Synonym Editor toolbar.

Variable Variable name for access file parameter. the following pop-up menu appears in the Segment and Field View tab. Using the Synonym Editor Reference: Synonym Editor . Filter Inserts a filter to the segment. The following options are available: Insert Enables you to insert one of the following: Field Inserts a general column to the synonym. Define Inserts a virtual or defined column to the synonym.3. The following image is an example of an SQL data source with a column selected. Group Inserts a group column to the synonym. Describing Data With Graphical Tools 89 .Column/Field Pop-up Menu When you right-click a column in the Synonym Editor. Compute Inserts a calculated value to the file.

Synonym Editor Layout Impact Analysis Displays an Impact Analysis report for the particular column in the workspace. The following image is an example of the sample data that appears for a column. This can assist when performing Joins. Map External XML Maps external XML found in a text field. Data Profiling Provides the characteristics of the data for a column. Month. Note: Decompose Date is visible for date fields. Note: Sample data is a great way to test the synonym for field data and to view the type of records returned. and Quarter fields. see Analyzing Metadata and Procedures on page 201. Decompose Date Decomposes date fields into virtual columns representing Year. Map Internal XML Maps internal XML found in a text field. testing connectivity to data sources. and so on. For detailed information on Impact Analysis. Sample Data Displays sample data in the workspace. 90 WebFOCUS . Day. An Impact Analysis report identifies the procedures that access a Master File or field within a Master File. Data Profiling is available from the right-click context menu for all columns in the Master File hierarchy tree.

3.Segment and Field View Tab The Segment and Field View tab shows the fields that the synonym contains. Reference: Synonym Editor . Describing Data With Graphical Tools 91 . Rename Allows you to rename the column. The following image is an example of a Microsoft SQL Server data source in the Segment and Field View tab. Using the Synonym Editor Delete Deletes the column.

The following image is an example of a Microsoft SQL Server data source in the Segment View tab.Synonym Editor Layout Reference: Synonym Editor .Segment View Tab The Segment View tab shows the segments that the synonym contains. 92 WebFOCUS .

Field View Tab The Field View tab shows a table with the available fields. Describing Data With Graphical Tools 93 . Using the Synonym Editor Reference: Synonym Editor .3. The following image is an example of a Microsoft SQL Server data source in the Field View tab.

Name. enables users to click on each column to sort. From this menu. The row can also customize visible columns by right-clicking the row and selecting Customize as shown in the following image. a user is also given an option that enables them to switch views. and Nulls. Description. Format Expression. The same menu displays when you right-click in an empty space. 94 WebFOCUS .Synonym Editor Layout The row below the toolbar menu which includes the sort options.

Modeling View Tab The Modeling View tab shows a graphical representation of the synonym.3. you are presented with tasks permitted in this view. Use the Modeling View to define dimensions for OLAP analysis. see Enhancing Synonyms Using the Modeling View on page 110. For more information about the Modeling View. create cluster joins. Describing Data With Graphical Tools 95 . and add or edit segments. Using the Synonym Editor Reference: Synonym Editor . In the Modeling View. for example. view join properties. Insert a Segment and Auto Arrange available synonyms. when you right-click in an empty space. The following image is an example of an SQL data source in the Modeling View.

You can print the Master File code by selecting Print from the File menu.Text View Tab This view opens the synonym in the editor. 96 WebFOCUS . The following image is an example of a Microsoft SQL Server data source in the Text View tab.Synonym Editor Layout Reference: Synonym Editor . perform search operations and even make changes.

3. Procedure: How to View and Edit Synonym Attributes To view and edit synonym attributes: 1. The following image is an example of an SQL data source in the Access File Text View tab. and making changes. Viewing and Editing Synonym Attributes How to: View and Edit Synonym Attributes Reference: File Attributes Summary Segment Attributes Summary Column/Field Attribute Summary The Synonym Editor enables you to view and edit the attributes of a synonym. Note: You can print the Master File code by selecting Print from the File menu. if necessary. performing search operations. open a synonym by double-clicking a Master File from the Master Files folder. which is used to access the database.Access File Text View Tab The Access File Text View tab shows the description of the Access File for a synonym. Describing Data With Graphical Tools 97 . Using the Synonym Editor Reference: Synonym Editor . From the Projects or Data Servers area.

and Nulls are viewable in the hierarchy with the columns. the Synonym Editor opens to the last view used. The following image is an example of an SQL data source with a key column selected. Note: The attributes available depend on the type of synonym. use the corresponding attribute fields on the right-hand side of the Synonym Editor. To edit these values. you cannot edit any value field that is highlighted gray. Description. In addition. the field may appear in red text. 98 WebFOCUS . Save changes by clicking Save from the File menu. 3. You can change the attribute values by typing in new values or by using the drop-down menus and check boxes. Therefore. Note: The values for Format. with the attributes and values of the selected item on the right. Expression.Viewing and Editing Synonym Attributes By default. if a change does not have proper syntax or format applied. Messages and warnings appear if you try to save a file that contains an error. the Segment and Field View tab shows a hierarchy of segments and columns on the left. Note: The Synonym Editor does not let you make any changes that would render the Master File unusable. 2.

In this case. an explanation of the SUFFIX attribute appears. Describing Data With Graphical Tools 99 . Reference: File Attributes Summary The following image is an example of an SQL data source with the synonym file name selected. Note: If you close the Synonym Editor without saving your changes. To close the Synonym Editor.3. select Close from the File menu or click the control button in the upper-right corner. Note: Information about the attribute that has focus is displayed at the bottom of the attribute list. you are prompted to do so. Using the Synonym Editor 4.

For example. including the extension and the location of the data file.Viewing and Editing Synonym Attributes Synonyms can have the following file attributes: General SUFFIX Identifies the type of synonym or data source. FDEFCENT Defines the default century value. 100 WebFOCUS . For example. 19xx. Remarks are displayed along with the file name during reporting. Note: Use the default setting (0) unless you wish to retrieve data from a earlier century. REMARKS Enables you to include descriptive information at the file level and specify multiple language descriptions for the synonym. 19xx. DATASET Identifies the physical location of the data source to be used in the file name. FYRTHRESH Defines the base years. Note: Use the default setting (0) unless you wish to retrieve data from a earlier century. see Setting Up Multilingual Titles and Descriptions on page 107. specifying a century number for handling crosscentury dates. For more information about multilingual descriptions. to represent the lowest year to which the century value applies (FDEFCENT). Note: The attributes available depend on the type of synonym.

3. Describing Data With Graphical Tools 101 . Note: Information about the attribute that has focus is displayed at the bottom of the attribute list. Using the Synonym Editor Reference: Segment Attributes Summary The following image is an example of an SQL data source with a segment selected. In this case. an explanation of the SEGMENT attribute appears.

A segment instance can have more than one field that makes up the key.Viewing and Editing Synonym Attributes Segments in a synonym can have the following attributes: General SEGMENT Is the name of the segment. so you can use that field as the key. Once a segment is encrypted. 102 WebFOCUS . Records are sorted in a data source by key fields. Note: SEGSUF is the data source type of a segment and any descendants it might have. For example. ENCRYPT Check this box to scramble field values in the current segment in order to protect it from unauthorized examination. Enter the number of key fields that you want to use for sorting. Keys. Note: You must assign a DBA password to the file before setting the Encrypt option on. SEGTYPE Specifies the type or relationship that a segment has to its parent and indicates which of the segment fields are key fields. For details. where that type differs from the SUFFIX value. That is. see Encrypting and Decrypting a Master File on page 199. You must then turn the Encrypt option on before adding any records. no two employees can have the same employee ID number. that value will not be encrypted. two or more field values may be used to distinguish records. SEGSUF SEGSUF is used when part of the data source being described by the Master File is of a different data source type than that declared for the entire structure. Identifies the segment type and sorting options from the Type drop-down list. Tip: Because there is a loss of processing efficiency when data is encrypted. Type. and in what order they are sorted. encryption should be used selectively. If you add a record to a segment before setting the Encrypt option on. you can remove encryption only if you remove the segment and recreate it without turning the Encrypt option on.

3. CRSEGNAME Is the name of the cross-referenced segment. KEYORDER Identifies the logical sort sequence of data by the primary key. CRFILENAME Is the name of the cross-referenced data source. Adapter Specific Note: Adapter Specific fields are shown if an Access File component has been generated with the synonym. For more information about multilingual descriptions. KEYS Identifies how many columns constitute the primary key. Describing Data With Graphical Tools 103 . as well as the table name. For some synonyms. It may contain the owner ID. CONNECTION Indicates the adapter connection name used. DBSPACE Identifies the storage area in which the table resides. CARDINALITY Defines the number of records that were found in the original data source when the synonym was created. it must also contain the data source name. TABLENAME Identifies the table or view. CRKEY Identifies the common join field for the cross-referenced segment. see Setting Up Multilingual Titles and Descriptions on page 107. WRITE Specifies whether write operations are allowed against the table. Using the Synonym Editor Miscellaneous DESCRIPTION Contains a description or comments about the segment.

and required otherwise. In this case. 104 WebFOCUS . an explanation of the FIELDNAME attribute appears.Viewing and Editing Synonym Attributes PERSISTENCE Specifies the type of table persistence and related table properties. Reference: Column/Field Attribute Summary The following image is an example of an SQL data source with a key column selected. Note: The attributes available depend on the type of synonym. This is optional for database management systems that support volatile tables. Note: The attributes available depend on the type of synonym. Columns in a synonym can have the following attributes: General FIELDNAME Is the name of the column. Note: Information about the attribute that has focus is displayed at the bottom of the attribute list.

Alpha variable. ACCEPT Specifies criteria for validating data. see Setting Up Multilingual Titles and Descriptions on page 107. set leading zeroes. ACTUAL Describes the type and length of data as it is actually stored in the data source. or DateTime (Timestamp) format. USAGE Describes the data type and format for the column for usage or display. Miscellaneous DESCRIPTION Contains a description or comments about the column or field. Options enables you to set how negative integers appear.3. Date. Decimal Packed. Time. are available if the Usage field is set to Date. Using the Synonym Editor ALIAS Assigns an alternative name for a column or the real column name for a DBMS synonym. if no transaction value is supplied. DateTime (Timestamp). print blank for zeroes. Note: Additional attributes. and Binary Large Object. Describing Data With Graphical Tools 105 . TITLE Supplies a title to replace the column name that is normally used in reports and enables you to specify multiple language titles for the column or field. Float. Type enables you to set a value for the field as Alpha fixed. Use these attributes to enter the century and year threshold values for the column or field. see Setting Up Multilingual Titles and Descriptions on page 107. Integer. set the appearance or suppression of commas. Double. MISSING Controls how null data is handled. DEFCENT and YRTHRESH. OR enables you to specify an acceptable value. Length enables you to set the character length. set percentage signs. and select currency symbols. Time. Text. that is. For more information about multilingual titles. For more information about multilingual descriptions.

FIND enables you to supply file and field names to instruct WebFOCUS where to search for a data source and for a list of acceptable values. or to use it with the FML Painter. INTERNAL defines a column that does not appear in sample data or in the list of available columns. range. You supply the field name of the data field for which the validation criteria are being assigned. You can check the Index check box to index the FIELDTYPE. This setting is useful for columns that are automatically assigned a value by the RDBMS.Viewing and Editing Synonym Attributes FROM-TO enables you to specify a range of acceptable value fields. FIND is not supported when developing a Master File. Note: FIELDTYPE=R indicates a read-only column. WITHIN Contains the name of a field to be included in a dimension. AUTHRESP defines a column that describes the result of an authentication operation. and the field name of the target data field that contains the validation criteria. in the Maintain environment. Property Sets the Property for the field. Restricts the field from showing in any of the Field Lists in the reporting tools. Select By defines a column by value. or multivalues. Reference Enables you to reference another data source. the file name of the target FOCUS data source where the field can be found. These WITHIN statements are added to the synonym through the Dimension Builder to OLAP-enable FOCUS files and relational tables. NEED_VALUE defines a column that requires a value to access the data. Note: FIND is only available for FOCUS data sources and does not apply to OLAPenabled Master Files. Correct response values must be provided in the ACCEPT attribute (using the OR predicate if more than one value is acceptable). ACCESS_PROPERTY Specifies access options for the column data. 106 WebFOCUS . Note also that. This enables you to perform OLAP analysis using the OLAP Control Panel. FIELDTYPE Identifies an indexed column.

. 3. The Multilingual Titles dialog box is available from the Remarks. From the Projects or Data Servers area. Click the browse (. click a column from the Master File hierarchy of columns on the left. or custom field from the Master File hierarchy of fields on the left. The Multilingual dialog box opens.) button at the end of the value field for either Remarks. These descriptions appear in the specified language in reports generated against the synonym. 2. and description in multiple languages.3. The corresponding attributes and values appear on the right. Title. The Master File opens to the Segment and Field View tab in the Synonym Editor. double-click the Master File or select Edit in Synonym Editor from the File menu. To add multilingual text: For Title. click a column. caption. HELPMESSAGE Appends a help message to a column. For Descriptions. Note: The attributes available depend on the type of synonym. Using the Synonym Editor AUTHTOKEN defines a column that contains a response token to be passed as an input value to the operation to be executed. Title. or Description. For Remarks. click the root level of the Master File (application/filename) on the left. Procedure: How to Set Up Multilingual Titles and Descriptions 1. Describing Data With Graphical Tools 107 . USE_STYLE Note: The attributes available depend on the type of synonym.. and Description attribute value fields in the Synonym Editor. Setting Up Multilingual Titles and Descriptions How to: Set Up Multilingual Titles and Descriptions You can open a synonym in the Synonym Editor and provide text for the title. segment.

5. choose the language in which you want the remarks (descriptions) and/or titles to be displayed. 108 WebFOCUS . Click Add.Setting Up Multilingual Titles and Descriptions 4. From the Specify Titles/Descriptions for different languages drop-down list.

3. Type a description or title in the Text field. 6. Using the Synonym Editor The selected language is added below the default language (which is determined by your code page selection). Describing Data With Graphical Tools 109 .

or delete additional titles or descriptions. You may add. You may also double-click the title. Select the title or description and click Edit. Click OK to close the Multilingual Titles dialog box. Use the Modeling View to define dimensions for OLAP analysis. and add or edit segments. To close the synonym.Enhancing Synonyms Using the Modeling View 7. see Defining Dimensions for OLAP Analysis on page 134. view join properties. 9. 8. Select another language from the drop-down list. To delete a specified title: a. create cluster joins. 110 WebFOCUS . Manually type a title or description name. Click Save from the File menu to save the synonym. To edit an existing specified title or description: a. Type a title or description for the field. Note: The Modeling View is not available for Cube data sources. For more information about using the Dimension Builder in the Modeling View. b. Select the title or description and language to be deleted. edit. Enhancing Synonyms Using the Modeling View How to: Enhance Synonyms Using the Modeling View Edit Synonyms Using the Modeling View Reference: Modeling View Pop-up Menu Join Editor Dialog Box The Synonym Editor Modeling View tab provides a visual presentation for the synonym for which positioning is preserved and stored in the Access File. 10. b. b. c. Click Add. select Close from the File menu or click the control button in the upper-right corner. Click Delete. To add an additional language: a.

3.3. Note: You would only use this approach if you are coding a new Master File. This tool creates a synonym and includes it as a segment in the synonym from which the tool was launched. 2. Click the Modeling View tab. Right-click a segment in the workspace. The Synonym Editor opens. The Synonym Editor Modeling View tab opens in the workspace. as you would for a FOCUS data source. 4. Insert Copy of Segment from Existing Synonym enables you to add a table as a segment from an existing synonym. Insert segments through one of the methods listed: Insert Reference to Segment From Existing Synonym adds an existing synonym as a segment to the current synonym. Describing Data With Graphical Tools 111 . The following pop-up menu appears. From the Projects or Data Servers area. Insert Segment Via metadata import enables you to add segments by using the Create Synonym tool. open a synonym by double-clicking a Master File from the Master Files folder. Insert Segment Manually enables you to add segments manually to the current synonym. 1. Using the Synonym Editor Procedure: How to Enhance Synonyms Using the Modeling View Use the Modeling View to enhance a synonym by adding a segment.

Right-click a segment icon. Join All (default) is shown by a double arrow and Join Unique is shown as a single arrow. Procedure: How to Edit Synonyms Using the Modeling View To edit synonyms using Modeling View: 1. Note: Join options are not available for FOCUS files. 2. there are two additional options for linking tables. open a synonym by double-clicking a Master File from the Master Files folder. 112 WebFOCUS .Enhancing Synonyms Using the Modeling View 5. In addition. Tip: You may also right-click a file icon and select Join Properties from the context menu. The Synonym Editor opens. 3. when creating a cluster join. From the Projects or Data Servers area. Click the Modeling View tab. Optionally. you can double-click the arrowed lines between tables to open the Join Editor dialog box and determine how the tables are linked.

Select Insert then Reference to Segment From Existing Synonym from the pop-up menu. Using the Synonym Editor A pop-up menu appears. Describing Data With Graphical Tools 113 . Note: Options for adding segments are also available from the icons above the workspace. providing options for adding segments. To insert a segment from an existing synonym: a.3.

Synonyms displayed in this dialog are based on the Reporting Servers APP Path configuration. create a synonym. 114 WebFOCUS . The segment is added to the synonym. Columns can be customized and sorted. Click a synonym and click Select.Enhancing Synonyms Using the Modeling View The Select Synonym dialog box opens. This method enables you to launch the Create Synonym tool. To insert a segment via metadata import: a. and incorporate it as a new segment in the synonym from which you initiate the import. b. Select Insert then Segment via Metadata Import from the pop-up menu.

Describing Data With Graphical Tools 115 . as the following example demonstrates. Using the Synonym Editor b.3. you are first presented with the Adapter dialog where you can select a configured adapter connection to continue or configure a new adapter. When this option is selected. if necessary.

Enhancing Synonyms Using the Modeling View The following image is an example of a screen that appears where you provide information for the connection parameters. 116 WebFOCUS .

The segment is added to the synonym. Select Insert then Segment Manually. To insert a segment manually: a. Using the Synonym Editor The following image is an example of a screen that enables you to select tables to create synonyms. Attributes for the new segment(s) can be modfied in the Modeling View tab through the Properties window or from the other views. The segment is added to the Modeling View and a default field is created. b.3. Describing Data With Graphical Tools 117 . using a default segment name.

118 WebFOCUS .Enhancing Synonyms Using the Modeling View The following image shows a synonym which has had several segments added in the Modeling View tab.

The following image shows the resulting Access File Text View. Describing Data With Graphical Tools 119 . Using the Synonym Editor The following image shows the resulting Text View.3.

Enhancing Synonyms Using the Modeling View

Reference: Modeling View Pop-up Menu
When you right-click a synonym or segment in the Synonym Editor Modeling View tab, the following pop-up menu appears.

The pop-up menu has the following options: Toggle Changes the view from a file icon to a table view, which enables you to see columns, sample data, and sample data parent keys.

Tip: You may also double-click a file icon to open the table view. Double-click the table to close the table view, or click the X button from the toggle toolbar to close. Join Properties Provides access to the Join Properties window. Note: Join options are not available for FOCUS files. Data Profiling Provides the characteristics of the data for a segment. Sample Data Displays sample data in the workspace. Sample Data with parent key Displays sample data with parent key in the workspace.

120

WebFOCUS

3. Using the Synonym Editor Insert Reference to Segment from Existing Synonym enables you to reference an existing synonym as a segment to the current synonym. Copy of Segment from Existing Synonym copies an existing synonym to the current synonym. Segment via Metadata Import enables you to create a new synonym through the Create Synonym tool and add it to the current synonym. Segment Manually inserts a segment to the current synonym, that must by coded manually. Delete Deletes the segment. Rename Enables you to rename the segment.

Describing Data With Graphical Tools

121

Enhancing Synonyms Using the Modeling View

Reference: Join Editor Dialog Box
When you select Join Properties from a segment in the Synonym Editor Modeling View tab, the Join Editor dialog box appears. The Join Editor dialog box contains Left and Right Source Columns, Join Type, and Join Condition options. Use the left and right source columns to create join maps and view sample data.

Note: Join options are not available for FOCUS files.

122

WebFOCUS

3. Using the Synonym Editor

Viewing Data Profiling Characteristics
In this section: Data Profiling a Synonym or Segment Data Profiling a Single Column Data Profiling provides data characteristics for the columns in a synonym. You can display the characteristics for all the columns in a synonym or segment, or for an individual column. For alphanumeric columns, Data Profiling provides the segment, format, count of distinct values, total count, patterns count, maximum, minimum, and average length, minimum and maximum values, and number of nulls. Patterns count shows the number of patterns found in each alphanumeric column. For numeric columns, Data Profiling provides the segment, format, count of distinct values, total count, maximum, minimum, and average values, and number of nulls. Data Profiling for an individual column provides access to Statistics, Patterns, Values, and Outliers reports.

Data Profiling a Synonym or Segment
How to: View Data Profiling for a Synonym or Segment Data Profiling provides information on all the columns in a synonym or segment. You can also drill down to the Values or Patterns reports for an individual column from a synonym or segment Data Profiling report. Note: Data Profiling is also available from the Metadata pane by right-clicking a synonym.

Procedure: How to View Data Profiling for a Synonym or Segment
To view the Data Profiling information for a synonym or segment: 1. Open the synonym in the Synonym Editor by double-clicking it from the Metadata pane or right-clicking it and selecting Open in Synonym Editor. By default, the Synonym Editor opens to the last view used. 2. Right-click the synonym or segment name and select Data Profiling. The Data Profiling information displays in the workspace. The last four columns are shown below the rest of the information for illustrative purposes only. The actual report runs across the workspace.

Describing Data With Graphical Tools

123

maximum. the Statistics report provides the segment. you can click a column name or patterns count (for alphanumeric columns) to drill down to the Values or Patterns reports. Values shows unique values and their percents. count of distinct values. Outliers shows the ten highest and lowest distinct values and their counts. minimum and maximum values. format. All printable special characters are represented by themselves. 3. Data Profiling a Single Column How to: View Data Profile Statistics View Data Profile Patterns View Data Profile Values View Data Profile Outliers Data Profiling for an individual column provides access to four reports: Statistics shows the same information as a Data Profile report for a synonym or segment. Procedure: How to View Data Profile Statistics To view the Statistical Data Profiling information for a single column: 124 WebFOCUS . count of distinct values. format. minimum. an "A" represents any uppercase letter. print the report. For numeric columns. and an "a" represents any lowercase letter. and number of nulls. copy data as text. respectively. the Statistics report provides the segment. a "9" represents a digit. total count. and unprintable characters are represented by an "X". and number of nulls. For alphanumeric columns. patterns count. and average length. and special characters. maximum. Optionally. This is a partial Values report produced by clicking a column name. minimum. as well as counts and their percents. shows patterns of letters. which is only available for alphanumeric columns. digits.Viewing Data Profiling Characteristics You may use the Data Profiling Results toolbar to view server messages. and export the report. and average values. For pattern analysis. total count. These reports are available by right-clicking a column in the Synonym Editor and selecting Data Profiling. Note: Data Profiling is also available from the Metadata pane by right-clicking a synonym. Patterns.

select Patterns from the Data Profiling submenu. and an "a" represents any lowercase letter. Right-click a column and.3. an "A" represents any uppercase letter. the Synonym Editor opens to the last view used. select Values from the Data Profiling submenu. All printable special characters are represented by themselves. The Values Data Profiling information displays. and special characters. To view the Patterns Data Profiling information for a single column: 1. Open the synonym in the Synonym Editor by double-clicking it from the Metadata pane or right-clicking it and selecting Open in Synonym Editor. 3. Procedure: How to View Data Profile Values Data Profile Values shows unique values. digits. Using the Synonym Editor 1. respectively. the Synonym Editor opens to the last view used. Open the synonym in the Synonym Editor by double-clicking it from the Metadata pane or right-clicking it and selecting Open in Synonym Editor. Right-click a column and. To view the Values Data Profiling information for a single column: 1. select Statistics from the Data Profiling submenu. you can click a column name or patterns count (for alphanumeric columns) to drill down to the Values or Patterns reports. This is only available for alphanumeric columns. as well as counts. By default. Describing Data With Graphical Tools 125 . 2. By default. By default. For pattern analysis. Procedure: How to View Data Profile Patterns Data Profile Patterns shows patterns of letters. Optionally. 2. The Patterns Data Profiling information displays. Open the synonym in the Synonym Editor by double-clicking it from the Metadata pane or right-clicking it and selecting Open in Synonym Editor. and unprintable characters are represented by an "X". the Synonym Editor opens to the last view used. a "9" represents a digit. The Statistical Data Profiling information displays in the workspace. Right-click a column and. 2.

if they exist. The Master File that is created combines the fields of the joined tables within a single file. By default. Right-click a column and.Creating Cluster Joins Procedure: How to View Data Profile Outliers Data Profile Outliers shows the 10 highest and lowest distinct values. Note: Outliers produce a maximum of 10 highest and lowest distinct values. Optionally. the Synonym Editor opens to the last view used. 126 WebFOCUS . select Outliers from the Data Profiling submenu. Open the synonym in the Synonym Editor by double-clicking it from the Metadata pane or right-clicking it and selecting Open in Synonym Editor. and so on. The Cluster Join Tool enables you to create a Star Schema which consists of a fact table referencing a number of dimension tables. you may join a DB2 table and an Oracle table. You can create cluster joins by using the Modeling View of the Synonym Editor. To view the Outliers Data Profiling information for a single column: 1. The total number of tables that you can add to the tool is 64 (using 63 joins). Multiple fact tables can be used by selecting the option to support multiple parentage in Synonym Editor from the Synonym Editor Options window. For example. which results in a new Master File that has a maximum of 64 segments. Procedure: How to Create a Cluster Join by Enhancing Existing Synonyms Use the Modeling View to enhance an existing synonym by adding a segment. The Outliers Data Profiling information displays. The Access File from the combined file contains information about the actual location of the data sources and the Join information. It also shows how the tables are linked. 2. Use cluster joins to create new views in the metadata by linking together physical tables and easily report against the new view or structure. Creating Cluster Joins How to: Create a Cluster Join by Enhancing Existing Synonyms Create a Cluster Join Using a New Synonym Cluster joins enable you to create a new file structure by linking existing synonyms of two or more relational tables using the same or mixed data sources. you can also create a view that has more than one fact table.

3. From the Projects or Data Servers area. Select a synonym to be inserted and click Select. The Synonym Editor opens. open a synonym by double-clicking a Master File from the Master Files folder. 2.3. The Synonym Editor Modeling View tab opens in the workspace. Insert tables (segments) through one of the methods listed: a. Describing Data With Graphical Tools 127 . Click the Modeling View tab. The following pop-up menu appears. Right-click a segment in the workspace. Select Insert then Reference to Segment From Existing Synonym. 4. Using the Synonym Editor 1.

128 WebFOCUS . This tool creates a synonym and includes it as a segment in the synonym from which the tool was launched. When this option is selected.Creating Cluster Joins Note: Use this method if you are creating a cluster join with an existing table or synonym. you are first presented with the Adapter dialog where you can select a configured adapter connection to continue or configure a new adapter. if necessary. Inserting a Segment using Metadata Import enables you to add segments by using the Create Synonym tool. b. Tip: Click Save As from the Modeling View File menu if you want to modify the original synonym.

3. Using the Synonym Editor The following image is an example of a screen that appears where you provide information for the connection parameters. Describing Data With Graphical Tools 129 .

Creating Cluster Joins The following image is an example of a screen that enables you to select tables to create synonyms. The selected synonyms will be created and added to the Modeling View. 130 WebFOCUS .

5. Inserting a Segment Manually enables you to insert segments manually. Describing Data With Graphical Tools 131 . Note: Use this method if you are coding a new Master File. and do not appear. The only way to view these options are by using relational tables. Using the Synonym Editor Note: Use this method if you are creating a cluster join and need to use a synonym that does not exist. as you would for a FOCUS data source.3. The segment is added in the Modeling View. Note: These join options are not available. This option enables you to create the synonym and continue to create the cluster join. Right-click the arrowed lines between tables to view the join options. for FOCUS tables. assigning values to segment attribute fields in the Synonym Editor. c.

from which you can determine how the tables are linked. You may: Create Inner. Combine records from the selected tables by mapping source columns.Creating Cluster Joins Join All indicates a multiple instance (one-to-many) type of join. At run time. Join Properties opens the Join Editor dialog box.Outer. at most. one matching record in the cross-referenced file. Inner Joins. each host record can have many matching records in the cross-referenced file. Tip: Click Save As from the Modeling View File menu if you do want to modify the original synonym. Join Unique indicates a single instance (one-to-one) type of join. Note: Outer joins are subdivided into Left Outer Joins. each host record has. or Cross Joins. Note: Join All is the default option. At run time. Use the Tree and Text View tabs of the Synonym Editor to view or edit the details of these tables (segments). 132 WebFOCUS . or Cross Joins.

3. Enter a unique file name in the File name field. The Synonym Editor opens. Click Open. select New. then Synonym via Synonym Editor. Click the Modeling View tab. The Add Master File dialog box opens. 5. 4. 2. Right-click a Master Files folder. Describing Data With Graphical Tools 133 . Using the Synonym Editor Procedure: How to Create a Cluster Join Using a New Synonym Another way to create a cluster join is to start with an empty synonym: 1.3. Right-click in the workspace and select from one of the available options to start building the new view.

The Dimension Builder works with relational and FOCUS data sources. Procedure: How to Add a Parent/Child Hierarchy 1. OLAP enables you to drill down or roll up on hierarchical data. 134 WebFOCUS . pivot fields from columns to rows (or vice versa). From the Synonym Editor. It is not relevant to data maintenance projects. The Synonym Editor provides tools to create OLAP hierarchies and dimensions. You OLAP-enable the Master File by using the Synonym Editor to create dimension(s) at the field level and associate fields with each dimension. click the Modeling View tab. Using the Dimension Builder in the Synonym Editor Modeling View How to: Add a Parent/Child Hierarchy Delete a Dimension Add Levels to the Hierarchy Reference: Dimension Builder Toolbar The Dimension Builder enables you to create logical views based on enterprise data (relational or legacy data sources) for multidimensional analysis without manually editing metadata. and slice-and-dice information by filtering or querying data sources based on specified criteria thresholds. Note: OLAP is a reporting facility.Defining Dimensions for OLAP Analysis Defining Dimensions for OLAP Analysis In this section: Using the Dimension Builder in the Synonym Editor Modeling View Synonyms can be modified to support Online Analytical Processing (OLAP).

Right-click the dimension and select Parent/Child from the Add Hierarchy submenu. Using the Synonym Editor Enable the Dimension Builder by selecting Dimension Builder from the toolbar or Tools menu. The Mandatory Properties for Parent/Child Hierarchy dialog box appears. Note: If the Dimension Builder is not visible. 2. Describing Data With Graphical Tools 135 . Note: You may also select this option by clicking the Add Parent/Child Hierarchy button from the Dimension Builder toolbar. ensure that Dimension Builder is selected from the Synonym menu.3.

Click OK to close the Mandatory Properties for Parent/Child Hierarchy dialog box. 6.Defining Dimensions for OLAP Analysis 3. The Mandatory Properties are added to the Dimension Builder. 4. 5. or view sample data for the dimension. 136 WebFOCUS . Repeat Step 3 for the Caption and Parent hierarchy properties. view properties. Use the right-click menu to rename the dimension. Select a field from the Field Tree and click Assign to assign a Unique ID for the hierarchy.

Procedure: How to Add Levels to the Hierarchy This process enables you to edit an existing Master File. Right-click the file icon in the Modeling View to toggle to Table View. 1. Use the right-click menu to rename the dimension or keep the default name. and create and modify dimensions. add tables (for non-FOCUS Master Files). Describing Data With Graphical Tools 137 . Tip: You may also double-click a file icon to open the Table View. 2. sample data. A level is added to the hierarchy. or click the Delete button from the Dimension Builder toolbar. From the Synonym Editor. 3. Procedure: How to Delete a Dimension To delete a dimension. The Table View appears in the Modeling View.3. Click Save from the File menu to save the dimension. which enables you to see columns. and sample data parent keys. Using the Synonym Editor 7. click the Modeling View tab. right-click a dimension and select Delete. Select the Add Levels Hierarchy button from the Dimension Builder toolbar.

Defining Dimensions for OLAP Analysis 4. Using the Columns tab of the Table View, drag and drop selected fields to the Dimension Builder hierarchy folder.

You may also drag and drop fields to and from other hierarchies using the Dimension Builder. 5. Click Save from the File menu to save the dimension. The dimension is saved and stored in the Master File.

Reference: Dimension Builder Toolbar
You can access the following commands from the Dimension Builder toolbar. Button Definition Adds a level hierarchy. Enables you to create a parent/child hierarchy and assign mandatory properties for the hierarchy. Deletes the selected item. Enables you to view and refresh sample data for the selected field. Enables you to switch back to properties in the Segment and Field View tab of the Synonym Editor.

138

WebFOCUS

3. Using the Synonym Editor

Using the Synonym Editor for Cube Data Sources
How to: Edit Field Names and Titles Edit Titles for Multiple Languages Delete Measures, Dimensions, or Parent/Child Hierarchies Create Virtual Measures With COMPUTE Fields Reference: Cube View Tab Objects The Synonym Editor enables you to make further modifications to your Cube synonym definitions. The Cube synonym is displayed in the Cube View tab. If you select a component of the synonym, its properties appear in the right pane.

You can use the Synonym Editor to: Edit field names and titles for measures, properties, and variables. You may also edit the field prefix for the defined fields.

Describing Data With Graphical Tools

139

Using the Synonym Editor for Cube Data Sources Edit titles for multiple languages, delete titles, and add titles for additional languages if you are using code page UTF-8. Delete measures, dimensions, or parent/child hierarchies. View the USAGE and ACTUAL formats and change the USAGE display format for the field. Change an internal attribute value. Change the access property for variables. Change the field prefix used to create the field names, mandatory property names, and DEFINE field names generated for parent/child hierarchies by the Synonym Wizard. Create virtual measures (this is implemented with COMPUTE fields in the Master File). The following image is an example of a Cube data source in the Synonym Editor.

Note: The Synonym Text View tab and the Access File View tab are identical for all types of data sources. For more information about these tabs, see Synonym Editor - Text View Tab on page 96 and Synonym Editor - Access File Text View Tab on page 97.

140

WebFOCUS

3. Using the Synonym Editor

Reference: Cube View Tab Objects
The following objects appear on the Cube View tab. Object Description Characteristics. Contains the Properties and Hierarchies folders. Optional variable. Mandatory variable that is not satisfied (selection criteria has not been created). Mandatory variable that is satisfied (selection criteria has been created). Measure. Hierarchy. Attribute. Represents a leaf node in a parent/child hierarchy. A leaf node is a member of a hierarchy that does not have any children. Represents Level 1 in a level hierarchy. Represents Level 2 in a level hierarchy. Represents Level 3 in a level hierarchy. Represents Level 4 in a level hierarchy. Represents Level 5 in a level hierarchy. Represents Level 6 in a level hierarchy. Represents Level 7 in a level hierarchy. Represents Level 8 in a level hierarchy.

Describing Data With Graphical Tools

141

Represents Level 14 in a level hierarchy. Represents Level 15 in a level hierarchy.Using the Synonym Editor for Cube Data Sources Object Description Represents Level 9 in a level hierarchy. the Synonym Editor opens to the last view used. Note: You may also right-click the synonym and select Edit in Synonym Editor. Note: The attributes available depend on the type of synonym. Represents Level 16 in a level hierarchy. Represents Level 10 in a level hierarchy. From the Projects or Data Servers area. Represents Level 12 in a level hierarchy. open a synonym by double-clicking a Cube Master File from the Master Files folder. 2. 142 WebFOCUS . Represents Level 11 in a level hierarchy. Select an attribute from the Cube View tab. For more information about other standard objects that may appear in the Synonym Editor. Represents Level 13 in a level hierarchy. By default.Main Attributes on page 75. see Synonym Editor . Procedure: How to Edit Field Names and Titles To edit field names and titles: 1.

you cannot edit any value field that is highlighted gray. Click Save to save the synonym. Title. or CAPTION value field on the right-hand side of the workspace. Therefore. 3. 6. open a synonym by double-clicking a Cube Master File from the Master Files folder. Using the Synonym Editor 3. Select an attribute from the Cube View tab. The edits are updated instantaneously in the Cube View tab.3. TITLE. located on the far right of the TITLE or CAPTION value field. By default. 2. To close the synonym. or Caption by typing in the value field. Describing Data With Graphical Tools 143 . 4. the Synonym Editor opens to the last view used.. Note: The Synonym Editor does not let you make any changes that would render the Master File unusable..) button. Click the FIELD NAME. From the Projects or Data Servers area. select Close from the File menu or click the control button in the upper-right corner. 5. Manually edit the Field Name. The Multilingual Titles dialog box opens. Click the browse (. Procedure: How to Edit Titles for Multiple Languages To edit the title for multiple languages: 1.

The attribute is deleted from the Cube View tab. or parent/child hierarchies: 1. Dimensions. To close the synonym.Using the Synonym Editor for Cube Data Sources 4. You may also double-click the title. Right-click and select Delete from the context menu. or Parent/Child Hierarchies To delete measures. Procedure: How to Delete Measures. 2. Type a description for the title field. 4. or delete a title for this field. 6. b. 5. To edit an existing specified title: a. edit. From the Projects or Data Servers area. open a synonym by double-clicking a Cube Master File from the Master Files folder. select Close from the File menu or click the control button in the upper-right corner. Select the attribute name that you want to delete. b. 7. 5. Click OK to close the Multilingual Titles dialog box. c. To close the synonym. Select the title and language to be deleted. To add an additional language for the title: a. Manually type a title name. select Close from the File menu or click the control button in the upper-right corner. By default. Select the title and click Edit. dimensions. Click Save from the File menu to save the synonym. 3. 144 WebFOCUS . Click Delete. To delete a specified title: a. You may add. Click Save to save the synonym. b. Click Add. Select a language from the drop-down list. the Synonym Editor opens to the last view used.

open a synonym by double-clicking a Cube Master File from the Master Files folder. Describing Data With Graphical Tools 145 . Using the Synonym Editor Procedure: How to Create Virtual Measures With COMPUTE Fields To create virtual measures with COMPUTE fields: 1.3. 2. From the Projects or Data Servers area. the Synonym Editor opens to the last view used. Select the Measures folder from the Cube View tab. By default.

4.Using the Synonym Editor for Cube Data Sources 3.. 5. The Compute Calculator opens. You may type a descriptive title for the measure (COMPUTE) in the Title input field. From the Compute Calculator.) button at the right of the TITLE and DESCRIPTION value fields to specify multiple language titles.. click the browse (. Right-click and select Add Measure from the context menu. 146 WebFOCUS . Tip: From the Synonym Editor. type a name for the column in the Column input field.

Click OK to close the Value Selection dialog box and return to the Relational Expression tab. 7. To delete an expression. or Use the Relational Expression tab to build the expression. From the Relational Expression tab. The Value Selection dialog box opens. Describing Data With Graphical Tools 147 . 8. f. e. Relation.) button at the right of the Value input field. c.3. Using the Synonym Editor 6. Note: Parameters are not supported. You may select the Check expression and Sample Data buttons. click in the row number column of the expression that you are deleting. The filter is added to the Relational Expression tab. Select from the available values and use the arrows to add or remove values. The expression is removed from the Relational Expression tab.. located on the top right of the Compute Calculator. a. use the drop-down lists to select the filter Column. The expression is added to the value field. double-click a column or variable from the Columns/Variables tab on the right side of the Compute Calculator. Click OK to close the Compute Calculator and return to the Synonym Editor. b. d. Click the browse (. to verify that the expression is valid and to view sample data for the filter. and Type. where you can add the expression value. right-click and select Delete selected row(s).. Use the Expression tab and the calculator buttons to build the expression for the Measure (COMPUTE field). To add another filter.

) button at the right of the EXPRESSION value field to relaunch the Compute Calculator. Title... you may do so directly from the Synonym Editor or you may click the browse (. or Expression.Using the Synonym Editor for Cube Data Sources Note: To edit the Compute. 148 WebFOCUS .

3. Using the Synonym Editor

Creating Business Views
How to: Create a Business View Using the Synonym Editor Alternatively Create a Business View Using the Synonym Editor Reference: Usage Notes for Business Views Using a Business View Master File By defining a Business View of a Master File, you are creating an alternative view of the Master File and can limit the fields available or create a subset of fields from the original Master File. Fields can be grouped into meaningful folders and field names, titles, and descriptions can be customized for each Business View. The Business View points to its underlying Master File, and all of the actual field and security information comes from the original Master File when the Business View is used in WebFOCUS tools (such as Joins and Defines) and in reports. Fields in a Business View are organized into folders. Each folder contains a group of fields. The fields in a folder can come from different segments in the original Master File. The Business View may contain existing fields and can include existing custom fields for DEFINE, COMPUTE, and Filters. Custom fields are associated with a specific segment in the original Master File and are subject to the same rules as real fields. A report can reference fields from multiple folders if they all lie along a single path in the original Master File. The Business View Master File is stored as if it were a real Master File. However, it has no SUFFIX attribute. As of release 7.7 the Business View can be saved within the real Master File or it can be saved as a new file by including fields from the real Master File or by referencing the real Master File. If a Business View is created and saved in the real Master File, the Business View becomes the active view when the file is used for reporting. If you do not want to turn your real Master File into a Business View it is recommended that you save the Business View using a different name or preferably start by creating a new Master File/synonym by selecting New then Synonym in the Synonym Editor option. Insert a reference to a segment from an existing synonym and then continue to build the Business View. Note: Impact Analysis searches Business Views in addition to FOCUS procedures. This enables you to see if changes in the original Master File will impact fields used in the Business View. For detailed information on Impact Analysis, see Analyzing Metadata and Procedures on page 201. You may create a Business View for an existing Master File by using the Synonym Editor.

Describing Data With Graphical Tools

149

Creating Business Views

Procedure: How to Create a Business View Using the Synonym Editor
1. From the Projects or Data Servers area, navigate to the Master Files folder where you want to create the Business View. 2. Right-click the Master Files folder and select New then Synonym in the Synonym Editor. 3. Provide a unique name for the new file and press Open. 4. While in the Segment and Field View tab of the Synonym Editor, right-click on the file name in the upper-left corner and select Insert then Reference to segment from Existing Synonym. 5. From the Select Synonym Window select the synonym for which you want to create a Business View. For FOCUS multisegment files you have the option to select the segment you want to reference. The referenced file is added to the new synonym and its fields are visible in the left frame. 6. Select Business View from the Tools menu to open the Business View Properties dialog. Note: A Business View Master File may contain only one root folder.

The Properties bar on the bottom of the Business View window shows information for the selected fields and folders. Tip: Use the Properties bar to change the title, descriptions or field names. Items that cannot be edited are grayed out.

150

WebFOCUS

3. Using the Synonym Editor 7. From the Business View window, right-click on the file name and select Create Default folder or New Folder. Default folder duplicates the file and segments that were available in the real Master File and you can reorganize the view as necessary. New folder will create root folder to which you can add fields from the real Master File by dragging and dropping fields from the left pane. You can create additional folders to create the structure you want. 8. To add additional folders for the Business View, right-click the Business View root folder that was created in the Business View window and select New Folder. Note: Multiple subfolders can be created and folders may be empty for organizational purposes. 9. Select fields from the Master File listed on the right and drag them to the appropriate folder on the left. Use Shift-click and Ctrl-click to select multiple fields. Note: If needed, fields may be duplicated and placed under multiple folders. The selected fields appear in the Business View Properties dialog.

10. Select Save or Save As from the File menu to save the Business View as a Business View Master File. Note: The Business View Master File may be saved in a different application than the main files.

Describing Data With Graphical Tools

151

Creating Business Views

Procedure: How to Alternatively Create a Business View Using the Synonym Editor
Information Builders recommends that you create a Business View using the Synonym Editor as the previous task outlined. The following, however, is an alternative way to create a Business View using the Synonym Editor. 1. From the Projects or Data Servers area, navigate to the Master Files folder where you wish to create the Business View and highlight the Master File to be altered. Note: You may create a Business View anywhere that you can select a Master File. 2. Double-click the Master File or select Edit in Synonym Editor from the File menu. The Master File opens to the Segment and Field View tab in the Synonym Editor. 3. Select Business View from the Tools menu. The Business View window opens. Note: A Business View Master File may contain only one root folder.

The Properties bar on the bottom of the Business View window shows information for the selected fields and folders. Tip: Use the Properties bar to change the title, descriptions or field names. Items that cannot be edited are grayed out. 4. From the Business View window, right-click on the file name and select Create Default folder or New Folder.

152

WebFOCUS

you will need to specify a DATASET in the Master File that points to the data file. Note: Multiple subfolders can be created and folders may be empty for organizational purposes. Using the Synonym Editor Default folder duplicates the file and segments that were available in the real Master File and you can reorganize the view as necessary. right-click the Business View root folder that was created in the Business View window and select New Folder. 5. 7. The selected fields appear in the Business View Tree tab. Note: If needed. Select fields from the Master File listed on the right and drag them to the appropriate folder on the left. the Business View will be saved inside the real Master File and the Business View will be visible when the Master File is opened in Reporting tools. Select Save or Save As from the File menu to save the Business View as a Business View Master File. fields may be duplicated and placed under multiple folders. Describing Data With Graphical Tools 153 .3. You can create additional folders to create the structure you want. If you use the Save option. When you use the Save As option and you are working with for FOCUS files. Use Shift-click and Ctrl-click to select multiple fields. 6. New folder will create root folder to which you can add fields from the real Master File by dragging and dropping fields from the left pane. To add additional folders for the Business View.

For example. The referenced file or the real Master File can create Defines. However. you can add DBA at the referenced file instance that is saved in the Business View file. East. Requests against a Business View cannot reference any fields or segments not in the Business View. operator against a Business View folder displays all of the fields in that folder. and other fields for use in the Business View. Select Close from the File menu to return to the Synonym Editor.Creating Business Views Note: The Business View Master File may be saved in a different application than the main files. South. All adapters for non-FOCUS data sources support retrieval requests against a Business View. 154 WebFOCUS . When creating a Business View using a referenced Master File. and West. as can occur when files are joined. All HOLD formats are supported against a Business View. the BELONGS_TO_SEGMENT attribute identifies which instance of the field name is being referenced in the Business View. Reference: Usage Notes for Business Views The detailed information about fields. such as USAGE and ACTUAL formats or indexes remain in the original Master File. When a Master File contains more than one field with the same name. not all of the fields in the real segment. Computes. a Direct SQL Passthru request is not supported against a Business View. Region can have empty folders called North. Business Views are not supported with data source maintenance commands such as Maintain or REBUILD. All information about Cluster Master Files remain in the original Master File. Business Views support alternate file views and fully qualified field names. 8. Filters. DBA attributes specified in the original Master File and are respected by the Business View. You can issue an SQL SELECT command against a Business View. The SEG. Folders can be empty for organizational purposes.

the table list does not show remarks in the Projects area. and titles will be retrieved from the original Master File. unless they are customized and a title and description is available through the Business View. Data Servers. This is also available in the Projects area. however. or Managed Reporting area: The Table list shows all available Master Files. The Remarks column shows a description from the original Master File unless the Business View file contains its own remarks. In the Projects.3. the field formats. including the Business Views. Using the Synonym Editor Reference: Using a Business View Master File When you use the Business View Master File with WebFOCUS tools and reports. descriptions. The following image is an example of a Business View Master File in the WebFOCUS Table List. that appears when creating a report in the Data Servers area. You may access the Business View Master Files from all development areas of Developer Studio. Describing Data With Graphical Tools 155 . that are available.

In the Managed Reporting Report Assistant: When using a Business View Master File with the Report Assistant. only fields from the Business View are shown in the Fields list. The following image is an example of a Business View Master File in the Report Painter. 156 WebFOCUS .Creating Business Views In the Report Painter: When using a Business View Master File in the Report Painter. only fields from the Business View are shown in the Fields list.

If the virtual column is a complex expression. Adding Virtual Columns (DEFINE) in a Synonym How to: Create a Virtual Column in a Synonym You may create a DEFINE field as a custom field in the Synonym Editor. such as a constant value. or a column name. Using the Synonym Editor The following image is an example of a Business View Master File in the Managed Reporting Report Assistant. you can type the value in the Expression field. Describing Data With Graphical Tools 157 . you can create the expression with the Virtual Column Calculator or just type it into the Expression field. Virtual columns (DEFINE fields) are available when the data source is used for reporting.3. a constant. If the virtual column is a simple expression. A virtual column can contain an expression. A custom field can be used in a request as though it is a real data source field.

From the Projects or Data Servers area. type a name for the column in the Column input field. Select Virtual Column from the Add submenu. Right-click a segment (or column) and click Add. 4. The Virtual Column Calculator opens. 2. open a synonym by double-clicking a Master File from the Master Files folder. you can test it by right-clicking the synonym and selecting Sample Data. 3. Procedure: How to Create a Virtual Column in a Synonym To create a virtual column in a synonym: 1. From the Virtual Column Calculator. The Synonym Editor opens. 158 WebFOCUS . or use the default define name.Adding Virtual Columns (DEFINE) in a Synonym Virtual columns are designated by the following icon: After creating a virtual column. Sample data appears in a separate dialog box.

Use the Expression tab and the calculator buttons to build the expression for the virtual column (DEFINE). The expression is added to the value field.. b. From the Relational Expression tab.3. The Value Selection dialog box opens. a. Tip: From the Synonym Editor.. or Use the Relational Expression tab to build the expression. Note: Parameters are not supported. Describing Data With Graphical Tools 159 . c. Relation.. Select from the available values and use the arrows to add or remove values. d. 6. You may enter a descriptive title for the virtual column (DEFINE) in the Title input field. click the browse (. and Type. use the drop-down lists to select the filter Column. Click OK to close the Value Selection dialog box and return to the Relational Expression tab. Using the Synonym Editor 5. Click the browse (.) button at the right of the Value input field..) button at the right of the TITLE and DESCRIPTION value fields to specify multiple language titles.

11.. Click Save from the File menu to save the synonym. You may select the Check expression and Sample Data buttons. Tip: You can click and drag the DEFINE field and move it to a different segment in the Segment and Field View tab. 160 WebFOCUS . f. 12. The expression is removed from the Relational Expression tab. located on the top right of the Virtual Column Calculator. you can use the WITH option to identify the logical home of the defined calculation. The filter is added to the Relational Expression tab. Title. 7.) button at the right of the EXPRESSION value field to relaunch the Virtual Column Calculator. To add another filter. to verify that the expression is valid and to view sample data for the filter. which also changes the segment association.Adding Virtual Columns (DEFINE) in a Synonym e. For more information about expressions and virtual column (DEFINE) attributes. You can allow all missing data. 8. see Defining Attributes and Creating Expressions for Custom Fields on page 172. you may do so directly from the Synonym Editor or you may click the browse (. You can also use the WITH option to move the logical home for the virtual column to a lower segment than it would otherwise be assigned (for example. 10. Specify the Missing Data options for columns that allow null data. Click OK to close the Virtual Column Calculator and return to the Synonym Editor. If no columns from the synonym are used in the expression or have been defined. or Expression. double-click a column or variable from the Columns/Variables tab on the right side of the Virtual Column Calculator. To delete an expression. where you can add the expression value. click in the row number column of the expression that you are deleting. to count instances in a lower segment). right-click and select Delete selected row(s). Note: To edit the Define. 9. To close the Synonym Editor.. select Close from the File menu or click the control button in the upper-right corner.

and sort data based on the conditions that you create. From the Filter Calculator. Describing Data With Graphical Tools 161 . Right-click a segment or field and select Filter from the Insert submenu. type a name for the filter in the Column input field. You can also use filters to perform other data checking and validation. From the Projects or Data Servers area.3. Power Painter. Filters are created under a specific segment and. double-click a synonym from the Master Files folder. by default. The Synonym Editor opens. Filters can also be created without segment association. The Filter Calculator opens. or right-click the synonym and select Edit in Synonym Editor. they have association with the selected segment. 2. and so on. Report Assistant. or use the default filter name. Procedure: How to Create Filters in a Synonym 1. 3. Using the Synonym Editor Creating Filters in a Synonym How to: Create Filters in a Synonym Filters are created in the Master File through the Synonym Editor and can be used in a Business View file or in reporting tools such as Report Painter.

click the browse (. b. Click the browse (. or Use the Relational Expression tab to build the expression. 5. a. 4. use the drop-down lists to select the filter Column.. Note: The Format field cannot be changed.) button at the right of the TITLE and DESCRIPTION value fields to specify multiple language titles. Note: Parameters are not supported with Master File Filters.) button at the right of the Value input field.. Tip: From the Synonym Editor. The Value Selection dialog box opens. From the Relational Expression tab.. Relation. You may enter a descriptive title for the filter in the Title input field.Creating Filters in a Synonym Note: It is recommended that filters have a descriptive name to help identify the filter action during reporting. 162 WebFOCUS . The Format field shows a default value of I1. and Type. c.. 6. Values for filters return 0 for false and 1 for true. Select from the available values and use the arrows to add or remove values. Use the Expression tab and the calculator buttons to build the expression for the filter.

e.) button at the right of the EXPRESSION value field to relaunch the Filter Calculator. double-click a column or variable from the Columns/Variables tab on the right side of the Filter Calculator. Note: To edit the Filter..3. you may do so directly from the Synonym Editor or you may click the browse (. Describing Data With Graphical Tools 163 . You may select the Check expression and Sample Data buttons.. Click OK to close the Value Selection dialog box and return to the Relational Expression tab. or Expression. To delete an expression. located on the top right of the Filter Calculator. click in the row number column of the expression that you are deleting. The filter is added to the Relational Expression tab. Title. To add another filter. The expression is removed from the Relational Expression tab. right-click and select Delete selected row(s). f. 8. Using the Synonym Editor d. to verify that the expression is valid and to view sample data for the filter. where you can add the expression value. The expression is added to the value field. 7. Click OK to close the Filter Calculator dialog box to return to the Synonym Editor.

10. You can also use the WITH option to move the logical home for the filter field to a lower segment than it would otherwise be assigned (for example. or it should be left empty to prevent errors. select Close from the File menu or click the control button in the upper-right corner. To close the Synonym Editor. to count instances in a lower segment). Click Save from the File menu to save the synonym. The procedure for adding a custom field is similar to the procedure used to add a Defined field.Adding Computed Fields (COMPUTE) in a Synonym 9. The filter is saved as part of the synonym. use the WITH drop-down list to select a blank segment. 164 WebFOCUS . Note: Computed fields from the Master File appear in the Windows versions of the Graph Assistant and in the Report Painter fields list. In addition. if no fields from the synonym are used in the expression or have not been computed. The Computed field is identified as the Master File Computed Field and is differentiated from the Defined fields and the other Computed Fields. Filters can also be created without segment association. you can use the WITH option to identify the logical home of the filter calculation. Note: If you are using a field that appears in multiple segments. Note: Filters are created under a specific segment and by default they have association with the selected segment. 11. Adding Computed Fields (COMPUTE) in a Synonym How to: Create a Computed Field in the Synonym Editor You may create a Computed field as a custom field in the Synonym Editor. To create a Filter without segment association. the WITH segment associated should be the lowest level segment.

6.. The Compute Calculator opens. You may enter a descriptive title for the computed field (COMPUTE) in the Title input field.) button at the right of the TITLE and DESCRIPTION value fields to specify multiple language titles.. Use the Expression tab and the calculator buttons to build the expression for the computed field (COMPUTE). 3. From the Projects or Data Servers area. Right-click a segment (or column) and click Insert. or use the default compute name. Using the Synonym Editor Procedure: How to Create a Computed Field in the Synonym Editor To create a computed column in a synonym: 1. click the browse (. 4. 5. From the Compute Calculator. Select Compute from the Insert submenu. Tip: From the Synonym Editor. 2. Describing Data With Graphical Tools 165 . type a name for the column in the Column input field.3. open a synonym by double-clicking a Master File from the Master Files folder. The Synonym Editor opens. or Use the Relational Expression tab to build the expression.

click in the row number column of the expression that you are deleting. d. where you can add the expression value. To delete an expression. The expression is removed from the Relational Expression tab. c. To add another filter. 8. Click OK to close the Compute Calculator and return to the Synonym Editor. use the drop-down lists to select the filter Column. 7..) button at the right of the Value input field. Relation. f. Click OK to close the Value Selection dialog box and return to the Relational Expression tab. 166 WebFOCUS . right-click and select Delete selected row(s). located on the top right of the Compute Calculator. e. to verify that the expression is valid and to view sample data for the filter. The filter is added to the Relational Expression tab. You may select the Check expression and Sample Data buttons. Click the browse (. From the Relational Expression tab. double-click a column or variable from the Columns/Variables tab on the right side of the Compute Calculator. The expression is added to the value field. and Type.Adding Computed Fields (COMPUTE) in a Synonym a. b. Note: Parameters are not supported. Select from the available values and use the arrows to add or remove values.. The Value Selection dialog box opens.

Specify the Missing Data options for columns that allow null data. you may do so directly from the Synonym Editor or you may click the browse (. Storing the Number of Repetitions of a Repeating Field in a Virtual Field How to: Specify an OCCURS Segment Using a Virtual Field Reference: Usage Notes for Using a Virtual Field With OCCURS The OCCURS attribute in a Master File describes repeating fields or groups of fields in a non-FOCUS data source. The repeating group of fields is described as a descendent segment in the Master File. 9. the number of repetitions can be derived from a field in the data source..3. or Expression. 10. Describing Data With Graphical Tools 167 . and the OCCURS attribute for that segment specifies how to determine the number of repetitions. To close the Synonym Editor. The number of repetitions does not have to be the same for every record instance. you can create a virtual field in the Master File that indicates the number of repetitions for each record and use that virtual field as the value of the OCCURS attribute. Title. Using the Synonym Editor Note: To edit the Compute.. Sometimes. 11. You can allow all missing data. Click Save from the File menu to save the synonym. For more information about expressions and COMPUTE attributes. see Defining Attributes and Creating Expressions for Custom Fields on page 172. select Close from the File menu or click the control button in the upper-right corner.) button at the right of the EXPRESSION value field to relaunch the Compute Calculator. In that case.

. DEFINE definefield/In = expression.$ FIELDNAME = rfield. SEGTYPE = segtype. 168 WebFOCUS . ACTUAL = rafmt. definefield Is the virtual field that indicates the number of repetitions of the repeating field or group of fields. expression Is a valid expression that derives the number of repetitions for each record instance. . segtype Is the SEGTYPE of the parent segment. ALIAS = ralias. ACTUAL = I4. osegname Is the name of the descendent OCCURS segment. USAGE = rufmt. PARENT = parent.Storing the Number of Repetitions of a Repeating Field in a Virtual Field Syntax: How to Specify an OCCURS Segment Using a Virtual Field SEGNAME = parent. SEGTYPE=S0. In Is the format of the virtual field that describes the number of repetitions.$ . rfield Is the name of a repeating field in the OCCURS segment. ralias Is the alias of a repeating field in the OCCURS segment.$ . SEGNAME = osegname. . [FIELDNAME = orderfield. . USAGE = In.$] where: parent Is the name of the parent segment. It must be an integer format. ALIAS = ORDER. OCCURS = definefield . This field must be defined in a segment that is an ancestor of the segment containing the repeating fields.

Describing Data With Graphical Tools 169 . but the record itself may not explicitly specify the month or quarter to which the data applies. The request: Counts the number of FICA deductions for each employee. For example. The number of repetitions will have to be derived from the length field created in the TABLE request. the identifying information for the employee. Using the Synonym Editor rufmt Is the display format for a repeating field in the OCCURS segment. rafmt Is the actual format for a repeating field in the OCCURS segment. Reference: Usage Notes for Using a Virtual Field With OCCURS The virtual field used as the OCCURS value cannot be redefined inside or outside of the Master File. The ORDER field associates a sequence number with each occurrence and is useful when the order of the repeating data is significant. The USAGE format must be integer and the ACTUAL format is I4. Note that the number of deductions will vary for each employee. Example: Using a Virtual Field With an OCCURS Segment The following request against the EMPLOYEE data source creates a fixed-format sequential file with a repeating field. Creates a calculated field that contains the length of all FICA deduction fields for each employee. and all FICA deductions for the employee. orderfield Is the name of an internal counter field that you can specify as the last field in the OCCURS segment.3. Creates a HOLD file in which each record contains the calculated length of the deduction fields for the employee. The part of the record that contains the deductions will constitute the OCCURS segment. the values may represent monthly or quarterly data.

2M. ACTUAL=A12.2M. USAGE=D12. $ FIELDNAME=DED_AMT. $ FIELDNAME=DED_AMT. ALIAS=E01. The Master File generated by the HOLD command lists 10 DED_AMT fields: FILENAME=OCCURS1 . USAGE=D12.2M. $ FIELDNAME=DED_AMT. $ FIELDNAME=DED_AMT. USAGE=D12. USAGE=D12. ALIAS=E03. ALIAS=E04. USAGE=I5.DED_AMT. USAGE=D12.2M. ALIAS=E05. USAGE=D12. $ FIELDNAME=DED_AMT.2M.2M. BY EMP_ID NOPRINT SUM DED_AMT BY EMP_ID NOPRINT ACROSS CTR NOPRINT WHERE DED_CODE EQ 'FICA' ON TABLE SET HOLDLIST PRINTONLY ON TABLE HOLD AS OCCURS1 FORMAT ALPHA END The OCCURS1 file has one record per employee with a variable number of DED_AMT fields. USAGE=D12. ALIAS=E11. ALIAS=E09. USAGE=A9.DED_AMT NOPRINT EMP_ID LAST_NAME FIRST_NAME CURR_SAL COMPUTE DEDLEN/I5 = 12 * CNT. ALIAS=E12. ALIAS=E08. ALIAS=E15.2M. USAGE=A10. $ SEGMENT=OCCURS1. The total length of the number of actual instances of DED_AMT is stored in the field named DEDLEN. ALIAS=E07. USAGE=D12. $ FIELDNAME=FIRST_NAME. ALIAS=E06. $ FIELDNAME=DED_AMT. ACTUAL=A10.Storing the Number of Repetitions of a Repeating Field in a Virtual Field The procedure to create the file with the repeating deduction field follows: DEFINE FILE EMPLOYEE CTR/I5 WITH DED_AMT = IF EMP_ID NE LAST EMP_ID THEN 1 ELSE LAST CTR + 1. $ FIELDNAME=DED_AMT. USAGE=A15. ALIAS=E13. $ FIELDNAME=DED_AMT. USAGE=D12. ACTUAL=A12. USAGE=D12. ACTUAL=A05. END TABLE FILE EMPLOYEE SUM CNT. ACTUAL=A12. ALIAS=E02. USAGE=D12. $ FIELDNAME=DED_AMT. ACTUAL=A12.2M.2M. $ FIELDNAME=LAST_NAME. ACTUAL=A15. $ 170 WebFOCUS . ACTUAL=A12. $ FIELDNAME=DEDLEN. $ FIELDNAME=DED_AMT. ACTUAL=A12. SUFFIX=FIX . SEGTYPE=S0. ACTUAL=A12. ACTUAL=A12. ACTUAL=A09. $ FIELDNAME=EMP_ID. $ FIELDNAME=CURR_SAL.2M. ACTUAL=A12. ALIAS=E10. ACTUAL=A12. ACTUAL=A12. ALIAS=E14.2M.

862.00 $18.75 $626.120.$ FIELDNAME=DED_AMT.200. USAGE=D12. ALIAS=E05.480. $ FIELDNAME=LAST_NAME. The ORDER field is not actually in the file. ACTUAL=A05. ALIAS=E03. ACTUAL=A12.500. only two employees are displayed on the report output: TABLE FILE OCCURS1 PRINT NUMOCC LAST_NAME CURR_SAL DED_AMT WHERE ORDER EQ 10 END Describing Data With Graphical Tools 171 .10 $247.480.000. ALIAS=E01.00 DED_AMT ------$64. Since every employee has at least one deduction.17 $100.00 $27.00 $21. $ FIELDNAME=CURR_SAL. $ FIELDNAME=EMP_ID.00 $29. SUFFIX=FIX . ACTUAL=I4 . ALIAS=E06. USAGE=A10. ALIAS=E02.00 $16. USAGE=D12. $ FIELDNAME=ORDER. every employee is represented on the report output: TABLE FILE OCCURS1 PRINT NUMOCC LAST_NAME CURR_SAL DED_AMT WHERE ORDER EQ 1 END The output is: NUMOCC -----10 8 4 8 1 8 4 1 5 7 4 10 LAST_NAME --------STEVENS SMITH JONES SMITH BANNING IRVING ROMANS MCCOY BLACKWOOD MCKNIGHT GREENSPAN CROSS CURR_SAL -------$11.00 $9.$ SEGNAME=DEDUCTION. $ FIELDNAME=FIRST_NAME. The DEFINE field named NUMOCC derives the number of occurrences from the DEDLEN field. ACTUAL=A09.3. It is an internal counter populated by WebFOCUS : FILENAME=OCCURS1 . $ The following request uses the ORDER field to select and print the first occurrence of the repeating field for each employee. OCCURS=NUMOCC.. Using the Synonym Editor You can edit the Master File to describe these repeating DED_AMT fields with an OCCURS segment.88 $52.00 $13.96 $519. SEGTYPE=S0. ALIAS=E04. $ DEFINE NUMOCC/I2 = DEDLEN/12. USAGE=I2 .780.00 $21. USAGE=A9. ALIAS=ORDER.00 $18.2M. USAGE=A15.062.62 $161.50 $631.67 $187.00 $26.700.94 $60. ACTUAL=A15.70 $444.40 If you print the tenth occurrence of the repeating field. PARENT=OCCURS1. USAGE=I5.100.2M.78 $317.00 $9. $ FIELDNAME=DEDLEN.000. ACTUAL=A10. ACTUAL=A12. $ SEGMENT=OCCURS1. SEGTYPE=S0.

Defining Attributes and Creating Expressions for Custom Fields The output is: NUMOCC -----10 10 LAST_NAME --------STEVENS CROSS CURR_SAL -------$11. The fields are available whenever you access the corresponding data source in a reporting tool. You can create a custom field in your synonym by adding a virtual column (DEFINE).33 $526.000.20 Defining Attributes and Creating Expressions for Custom Fields Reference: Custom Field Attributes Calculators for Custom Fields A custom field is a field whose value is not stored in the data source but can be calculated from the data that is there. and a Computed Field (COMPUTE). Master File filter (FILTER).00 $27. 172 WebFOCUS . You can define attribute values and create expressions for custom fields by using the Synonym Editor.00 DED_AMT ------$58.062.

Custom fields (DEFINE. Using the Synonym Editor Reference: Custom Field Attributes The following attributes may be available for custom fields (DEFINE. Note: This attribute only appears when a virtual Filter field is selected. COMPUTE) typically have the following attributes: General DEFINE Is the name of the virtual column. The following image is an example of an SQL data source with the virtual column (DEFINE) selected. Note: The attributes available depend on the type of synonym and the type of custom field selected. and COMPUTE) in the Synonym Editor. Note: This attribute only appears when a virtual column (DEFINE) is selected.3. Describing Data With Graphical Tools 173 . COMPUTE Is the name of the computed field. FILTER. FILTER. FILTER Is the name of the Master File filter field.

REDEFINES enables you to redefine or recompute a column whose name exists in more than one segment. EXPRESSION Is the calculation that creates the virtual column. Miscellaneous REDEFINES A DEFINE expression may not contain qualified field names. TITLE Supplies a title to replace the column name that is normally used in reports and enables you to specify multiple language titles for the virtual column. DESCRIPTION Contains a description or comments about the virtual column. the transaction value is supplied. Note: This attribute only appears for DEFINE custom fields and cannot be used by WebFOCUS. Note: This attribute only appears for DEFINE and COMPUTE custom fields. Allow Missing Data Allows missing data. If not. Note: This attribute only appears for DEFINE and COMPUTE custom fields. You can also use the WITH option to move the logical home for the virtual column to a lower segment than it would otherwise be assigned (for example. If not. Note: This attribute only appears for DEFINE and COMPUTE custom fields. All Allows all missing data. 174 WebFOCUS . you can use the WITH option to identify the logical home of the defined calculation. FORMAT Describes the data type and format for the virtual column. to count instances in a lower segment). the transaction value is supplied.Defining Attributes and Creating Expressions for Custom Fields Note: This attribute only appears when a virtual computed field is selected. WITH If no columns from the synonym are used in the expression or have been defined. WITHIN Contains the name of a field to be included in a dimension. Note: This attribute only appears for DEFINE and FILTER custom fields.

Begin Date/End Date indicates the date range for the row values. Other columns with a blank SCD type have no SCD processing done to them. Using the Synonym Editor These WITHIN statements are added to the synonym through the Dimension Builder to OLAP-enable FOCUS files and relational tables. Type I (overwriting history) designates columns whose database values are overwritten with new values. A null end date indicates that the row is current. Type II (preserving history) designates columns whose database rows are flagged as inactive or assigned an end date. New rows are inserted with the new values. Logical Key Field is the database key. Describing Data With Graphical Tools 175 . blank (non-key columns) indicates that database values are not changed.3. or to use it with the FML Painter. Note: The attributes available depend on the type of synonym. SCD Type Sets slowly changing dimensions. Note: This attribute only appears for DEFINE and FILTER custom fields. This option is only available for existing relational targets. A surrogate key is the first column in the table and has an SCD type of blank. Activation Flag indicates that the row is current. This enables you to perform OLAP analysis using the OLAP Control Panel.

Expression tab Location for typing an expression.) button at the right of the EXPRESSION value field in the Synonym Editor. The calculator has the following fields/options: Column Is the name of the object being created (virtual field. functions from the Functions tab. Columns/Variables tab Displays a hierarchical list of available source columns and System Variable folders that you can use in creating an expression. depending on the type of custom field that you are creating. and select values for your filter. You can add data source fields from the Columns/Variables tab.. click the browse (. Filter Calculator. 176 WebFOCUS . The selected calculator opens.Defining Attributes and Creating Expressions for Custom Fields Reference: Calculators for Custom Fields To launch the Virtual Column Calculator. filter.. choose the relation and type. and numbers and operators from the calculator as you type. Relational Expression tab Displays the expression building window from which you can add and delete columns. computed field). or Compute Calculator. Format Is the field format.

This tab lists the built-in functions that you can use to derive the value of a temporary field. the syntax FULL_NAME = LAST_NAME || ('. MICHAEL JONES. the expression FULL_NAME = FIRST_NAME | LAST_NAME would produce a column like the following: MICHAEL . SMITHSONJANE JONES || (double concatenation bar) Concatenates two values.3. suppressing the trailing blanks of LAST_NAME. For example. JANE . . and the result is then concatenated to LAST_NAME. if FIRST_NAME and LAST_NAME were both in A15 format. ' | FIRST_NAME) would produce a column like the following: SMITHSON. suppressing any trailing blanks in the first. The concatenation in the parentheses is done first (preserving the blank space after the comma). Function Assist button Enables you to specify parameters for the function through a dialog box when creating or editing a transformation. For example. . The following operators are available: | (single concatenation bar) Concatenates two values. . Calculator buttons Insert numbers and operators. Describing Data With Graphical Tools 177 . to construct the full name and insert a comma. . IF Establishes a conditional test. retaining any trailing blanks after the first one. Using the Synonym Editor Functions tab A function is a program that returns a value.

AND Returns the value TRUE if both operands are true. () Adds parentheses. 178 WebFOCUS . ** Raises a value to the specified power.Defining Attributes and Creating Expressions for Custom Fields THEN Specifies the action to perform if the result of a conditional test is TRUE. OR Returns the value TRUE if either operand is true. GT Returns the value TRUE if the value on the left is greater than the value on the right. NOT Returns the value TRUE if the operand is false. NE Returns the value TRUE if the value on the left is not equal to the value on the right. EQ Returns the value TRUE if the value on the left is equal to the value on the right. ELSE Specifies the action to perform if the result of a conditional test is FALSE. LE Returns the value TRUE if the value on the left is less than or equal to the value on the right. GE Returns the value TRUE if the value on the left is greater than or equal to the value on the right. LT Returns the value TRUE if the value on the left is less than the value on the right.

A->a Converts selected text to lowercase. A group field is created by two or more alphanumeric fields. Adding Group Fields in a Synonym How to: Add a Group Field to a Segment Add a New Field to a Group Field Add an Existing Field to a Group Field Delete a Group Field From a Segment Delete a Field From a Group Field Reference: Group Field Attributes For data sources that support groups. you can assign a unique name to multiple fields to create a group field. the group will not be visible. Check expression button Verifies the validity of the expression. Enter alphanumeric test values between the quotation marks. If you create a group field in the Maintain environment. Sample data button Produces sample data for the expression. A group field provides an efficient means for grouping similar or logically connected fields that will be accessed as a single unit. that is groups that are actual fields. physically next to each other. Using the Synonym Editor '' Inserts two single quotation marks.3. a->A Converts selected text to uppercase. as supported by VSAM. but do not warrant a separate segment. only the fields that make up the group will be visible. Note: In the Maintain environment group fields are supported in a Master File as long as they are not group keys. Describing Data With Graphical Tools 179 .

Adding Group Fields in a Synonym Procedure: How to Add a Group Field to a Segment 1. select Close from the File menu or click the control button in the upper-right corner. Optionally. 2. Specify the length. 5. 6. Type a name for the group in the GROUP field. To close the Synonym Editor. 9. The Synonym Editor opens. 10. open a synonym by double-clicking a Master File from the Master Files folder. 8. the decimal places (if applicable) and any display options for the group. From the Projects or Data Servers area. Note: The group option may not be available for some data sources. A group is added to the synonym and its attributes and values appear on the right.Index box if you want the group to be indexed. you can specify the TITLE and DESCRIPTION display options. Click the I . Right-click a segment (or column) and click Insert. Select Group from the Insert submenu. 4. Select the ACCESS_PROPERTY values to specify access options for the group data. 7. 180 WebFOCUS . Click Save from the File menu to save the synonym. Select the USAGE Type value for the group. 3.

3. Right-click the group field to which you want to add a new field and select Insert. Using the Synonym Editor Procedure: How to Add a New Field to a Group Field 1. 2. Supply the required information for the group field. Click the field you want to add to the group field. Procedure: How to Add an Existing Field to a Group Field 1. While holding the left mouse button down. see Viewing and Editing Synonym Attributes on page 97. Describing Data With Graphical Tools 181 . For more information about field attributes. Select Field from the Insert submenu. 2. A field is added to the group and its attributes and values appear on the right. The field is added to the group field. 3. drag the field and drop it on the group field name.

182 WebFOCUS . Click No to delete the group and all of the fields within the group. Click Cancel to close the Confirm Delete dialog box and return to the Synonym Editor. A confirmation appears stating that all fields/columns within the group will be deleted. 2.Adding Group Fields in a Synonym Procedure: How to Delete a Group Field From a Segment 1. Right-click the group and select Delete. Procedure: How to Delete a Field From a Group Field Right-click the field. then select Delete. Click Yes to delete the group and move the fields (within the group) under the root segment of the synonym.

If you create a report.3. TITLE Supplies a title to replace the group name that is normally used in reports and enables you to specify multiple language titles for the group. Describing Data With Graphical Tools 183 . Using the Synonym Editor Reference: Group Field Attributes Group fields in a synonym can have the following attributes: General GROUP Is the name of the group. ALIAS Assigns an alternative name for a group. the group name appears as a column heading unless you have specified an alternate title for the group. Aliases cannot be used as column titles.

Restricts the field from showing in any of the Field Lists in the reporting tools. then the group field must be alphanumeric and 40 characters long (A40). This setting is useful for columns that are automatically assigned a value by the RDBMS. An index is an internally stored and maintained table of data values and locations that enhance the performance of data retrieval. Select By defines a column by value. see the Creating Reporting Applications With Developer Studio manual. select the Index check box when you add a field and before you add the data. Indicates that a selection is needed in the report request (WHERE condition). bubble help shows the field name (column title). ACCESS_PROPERTY Specifies access options for the column data. FIELDTYPE Identifies an indexed group. each 20 characters long (A20). You can index the values of a field to enhance data retrieval performance. NEED_VALUE defines a column that requires a value to access the data. range. Note: FIELDTYPE=R indicates a read-only column. but the combined total of indices and segments cannot exceed 64. The group field is always alphanumeric.Adding Group Fields in a Synonym USAGE Contains the format for the group field. 184 WebFOCUS . Since the group field is made by concatenating together several other fields. INTERNAL defines a column that does not appear in sample data or in the list of available columns. however. A Master File can have several associated indexes. If you do not include a description. you will have to use the Rebuild Index option to create the index. only one value should be defined for selection in the report request. Miscellaneous DESCRIPTION Contains a description or comments about the group. To do so. regardless of the fields that make it up. Tip: You can turn on the index after adding data to a field. For example. Field descriptions also appear as bubble help in OLAP-enabled reports. if the group field has two alphanumeric fields in it. The description displays in Field lists and on the status bar. the Synonym Editor determines what this format needs to be. or multivalues: If Value is checked. For information on displaying bubble help in OLAP-enabled reports.

fields. Note: The attributes available depend on the type of synonym. Database Administrator Level. Fields. Note: You cannot specify a Database Administrator (DBA) password during the Create Synonym process. Applying Database Administrator Security In this section: Selecting the Type of Access Restricting Access to Segments. Describing Data With Graphical Tools 185 . Once a user password has been established. and Noprint on page 191. The user password represents a user who has access to that data source. The DBA has unlimited access to the Master File and data source and can set up or change security restrictions for individual users. You specify the DBA and user passwords for the data source. write. For more information. or field values. You must use the Synonym Editor. If Multivalues is checked. see Encrypting and Decrypting a Master File on page 199. multiple values are allowed for selection in the report request. security can be maintained at two different levels. For each data source. you can apply the same restrictions to multiple users. and Noprint Deleting a DBA or User Password Encrypting and Decrypting a Master File How to: Set Up Security for the Database Administrator Set Up Security for the User Reference: DBA Guidelines DBA Properties Dialog Box You can secure Master Files on a file-by-file basis. Using the Synonym Editor If Range is checked. When you specify a user password. you must also set at least the type of file access: read. see Restricting Access to Segments. Field Values. For more information. read/write. Fields. a range selection should be defined in the report request. or update. Only the Database Administrator can encrypt (scramble) or decrypt (unscramble) a data source. You specify the Database Administrator (DBA) password for the data source. User Level.3. Field Values. Security for each user can be further limited by restricting access to segments.

must enter a password to get access to the data source. 186 WebFOCUS . Procedure: How to Set Up Security for the Database Administrator 1. delete it. The DBA Properties dialog box opens. select all. You can change this value. You can also specify a separate DBA file that contains DBA security restrictions. you can delete their security. When the DBA or user no longer needs access to the data source. you can right-click and use the edit options to undo. the Database Administrator must be aware of certain DBA guidelines. paste. Before adding any type of security to a data source. In the Synonym Editor. or add users to specify file restrictions. the Database Administrator. button 2. See DBA Guidelines on page 187. Note: When the password is created and the cursor is in that field. or user. A default DBA password will be created for the Master File. cut. Right-click in the file name in the DBA window and select Insert then DBA. click DBA from the Synonym menu or click the DBA from the Synonym toolbar. or delete the password. copy.Applying Database Administrator Security When security is specified.

field. right-click on the DBA icon to insert user restrictions or specify a DBA file. No segment. user access to the field data will be unnecessarily restricted. or Noprint. 3. and Access Restrictions options are activated. Select the type of access: Read. 4. In the DBA Properties dialog box. The Database Administrator can change any type of security restriction. If they are in error. All groups of cross-referenced data sources must have the same security restrictions. or Update. or field value restrictions may be specified at the Database Administrator level. Using the Synonym Editor Procedure: How to Set Up Security for the User 1. that user will receive a message. Once you add a user you can continue to insert file access restrictions by right-clicking on the user field and selecting insert. Access levels affect the fields users can access. Specify the type of restriction for each option: Restriction to Field. Write. Click OK to save the Master File with the user password and restrictions. It is particularly important to check field values to make sure they do not contain errors. 5. The User in File. Segment. Read/Write. File Access. Note: The Same Restriction option is activated when there are multiple users. If a user does not have access rights. Value. the Database Administrator should conduct thorough testing of every restriction before the data source is used. You must have a DBA password to encrypt and decrypt or restrict existing data sources. Once security restrictions have been applied. The Database Administrator must consider what commands each user will need. Note: The option to insert users or file name is not active until you enter a DBA password. 2. Reference: DBA Guidelines You can ensure that the security restrictions you place on Master Files are correct by adhering to the following guidelines: Every file with access limits must have a DBA password.3. The Database Administrator should have unlimited access to the data source and all cross-referenced data sources. Describing Data With Graphical Tools 187 .

Other Master Files can use the DBA security restrictions in this Master File. DBA FILE Select the name of the Master File that contains your DBA security restrictions. DBA password This displays the DBA password and enables you to change it.Applying Database Administrator Security Reference: DBA Properties Dialog Box The following options are available from the DBA Properties dialog box when the DBA password is selected. controls the access rights of other users. and has encryption privileges. The DBA has full access to the data source and the corresponding Master File. This is the password of the DBA who will be creating and maintaining the current data source. See Encrypting and Decrypting a Master File on page 199. 188 WebFOCUS .

Field. Access Restrictions User is the user name written to the Master File. Same When the file access is selected. Restrict is an option for File access restriction. the segment or field name). Restrictions: Segment. This option is used to add data source-specific restrictions to the current data source. Choose Field to grant access to all or individual fields. Fields. File Access For user access select one of the following options: Choose Read for full viewing rights. Choose Segment to grant access to all or individual segments. Choose Noprint to specify fields you do not want to display in a report. Access is the type of access restriction. It includes a FILENAME attribute for the selected Master File. Choose Value to limit access to values that meet a test condition. Noprint. Choose READ/WRITE for both of the above. Field Values.3. Choose UPDATE to permit changes to field values. Value. Choose WRITE to permit additions or changes to the data source. continue to select the field/value restriction. The FILENAME attribute in the referenced Master File must be the same as the FILENAME attribute in the DBA section of the current data source. See Restricting Access to Segments. Choose Same to apply the same restrictions as other users that are already setup. Using the Synonym Editor FILENAME Select the name of the Master File to which user security will be applied. Describing Data With Graphical Tools 189 . Insert Users Enter the names of users whose access rights will be granted for the current data source. Value for which to restrict access. and Noprint on page 191. Name is the name of the Master File component selected (for example.

WRITE. If you want to impose additional limitations you can restrict access to segments. fields. as shown in the following image. Allows the user only to read (to view) the data source. Allows the user to read and write to the data source. UPDATE. The type of file access can be specified in the File Access group on the DBA Properties dialog box. the user will have the specified access to the entire data source. Allows the user only to write (add or to make changes) to the data source. 190 WebFOCUS . there are four file access options: Read. The type of file access determines what a user can do to the entire data source: If you specify only the type of file access. See Restricting Access to Segments. the type of file access and access restrictions options are available.Applying Database Administrator Security Selecting the Type of Access When you assign a user password. READ/WRITE. You must specify at least the type of access the user is permitted to have for the data source. Field Values. and Noprint on page 191. Fields. Allows the user to update (make changes to) existing field values. In this group. and/or field values.

Field. Describing Data With Graphical Tools 191 . fields. and/or value. or Value. such as segment. and Noprint fields in a Master File by specifying access restrictions for a user. Using the Synonym Editor Restricting Access to Segments. field values. Right-click the file access restriction and select the Segment. Field Values. Segment. Fields. When you specify what is to be restricted. You specify the type of access for individual segments or all segments.3. field. you can then specify the type of access that will be restricted. and Noprint You can restrict access to segments. or Noprint option from the Context menu.

Applying Database Administrator Security The following image illustrates how a user can change a segment name. 192 WebFOCUS .

Using the Synonym Editor Field. You specify the type of access for individual fields or all fields.3. Describing Data With Graphical Tools 193 .

194 WebFOCUS .Applying Database Administrator Security The following image illustrates how a user can change the field name selected.

Using the Synonym Editor Value. You specify the type of access (read or write) and the test condition.3. Describing Data With Graphical Tools 195 . The user is restricted to using only those values that satisfy the test condition.

Applying Database Administrator Security The following image illustrates how to change a field name used in a value field. 196 WebFOCUS .

Describing Data With Graphical Tools 197 .3. Using the Synonym Editor The following image illustrates how to create a condition. This dialog is presented after pressing the ellipsis next to the value field.

If you specify Noprint for a field. If you delete the user based upon whom you have assigned security restrictions for other users. 198 WebFOCUS . You can also specify not to display the data in that field using Noprint. you must reset security restrictions for all users attached to the user you deleted. select the user name in the Add Users box. Procedure: How to Delete a User Password 1. Right-click and select Delete or press Delete on the keyboard. Deleting a DBA or User Password How to: Delete a User Password Delete a DBA Password You can delete a DBA password or security for a user when it is no longer needed. the data will appear as blanks for alphanumeric format or zeros for numeric format whenever the user tries to retrieve it. 2.Applying Database Administrator Security Noprint. On the DBA Properties dialog box.

button from Describing Data With Graphical Tools 199 . When you encrypt Master Files. 3. 1. click DBA from the Tools menu or click the DBA the Synonym toolbar. right-click and select Delete or press Delete on the keyboard. The values for the selected segment appear in the right pane.3. From the Synonym Editor Segment and Field View tab. Procedure: How to Encrypt a Master File 1. Before you can encrypt or decrypt any Master File. From the DBA Password box. All security information is removed. you must specify the DBA password. The DBA Properties dialog box opens. Decrypting unscrambles the contents to its readable state. 2. Using the Synonym Editor Procedure: How to Delete a DBA Password Deleting a DBA password will delete all user security for that data source. you can decrypt it. If you do not specify a DBA password. Encrypting and Decrypting a Master File How to: Encrypt a Master File Decrypt a Master File You may use the Encrypt and Decrypt attributes from the Synonym Editor to scramble and unscramble some or all of the contents of a data source. they are secure from unauthorized examination. select a segment from the Master File hierarchy (left pane). you will not be able to encrypt or decrypt. Encryption at the data source level scrambles the entire contents of that Master File so it is unreadable. When you encrypt a Master File. In the Synonym Editor. Create and save the Master File with the DBA password.

Click Save from the File menu to encrypt the Master File. 200 WebFOCUS . 5. 2. Select the ENCRYPT check box. Click Save from the File menu to decrypt the Master File. At the encrypted segment level in the Master File hierarchy. clear the ENCRYPT attribute.Applying Database Administrator Security 4. Procedure: How to Decrypt a Master File 1.

and how to view Data Profiling for the columns in a synonym.WebFOCUS 4 Analyzing Metadata and Procedures This chapter describes how to analyze procedures using Impact Analysis. Topics: Analyzing Procedures With the Impact Analysis Tool Viewing Data Profiling Characteristics Describing Data With Graphical Tools 201 .

it searches files based on the application path of the reporting server. 2. and select Impact Analysis from the context menu. When Impact Analysis is launched from the Synonym Editor or Business Views. Data Servers. The Impact Analysis tool is accessible from the Projects. This enables you to see if changes in the original Master File will impact fields used in the Business View. The Impact Analysis tool enables you to analyze data. save reports. Note: You can launch Impact Analysis from the interface or from within the tools in the Synonym Editor and Business Views. double-click the Master File or select Edit in Synonym Editor from the File menu. For more information about Business Views. right-click. and Managed Reporting areas of Developer Studio and is supported for Windows. From the interface. Select the Synonym File name. 1. or a column field. it searches files based on the application path of the reporting server. The Master File opens to the Tree View tab in the Synonym Editor. UNIX. Procedure: How to View Impact Analysis Results From the Synonym Editor When you launch Impact Analysis from within the Synonym Editor. see Creating Business Views on page 149. From the Projects or Data Servers area. 202 WebFOCUS . This tool helps you analyze the potential impact of modifying or deleting Master Files or fields. and z/OS configurations. control search criteria.Analyzing Procedures With the Impact Analysis Tool Analyzing Procedures With the Impact Analysis Tool How to: View Impact Analysis Results From the Synonym Editor Use the Impact Analysis Tool From the Interface You can use the Impact Analysis tool to generate a report that identifies the procedures that access a specific Master File or field within a Master File. and interactively open and edit procedures based on search results. it enables you to select applications or domains to be searched. Impact Analysis searches Business Views in addition to FOCUS procedures.

From the Projects or Data Servers area. Note: You may also select Impact Analysis from the right-click context menu of a Master File. and export the report. Note: Impact Analysis is also available from the Business View tab. The Impact Analysis tool opens with the New Report tab displaying the selected (Master) File Name and default Search Paths. 4. Procedure: How to Use the Impact Analysis Tool From the Interface 1. This interface enables you to select applications or domains to search. 5. You may use the results toolbar to view server messages. highlight a Master File and select Impact Analysis from the File menu. 3. print the report. Analyzing Metadata and Procedures The following image shows the context menu used to launch the Impact Analysis tool. Describing Data With Graphical Tools 203 . The Impact Analysis results are displayed in a report spreadsheet. Click Close from the File menu to close the Impact Analysis results window and return to the Synonym Editor. Click Save from the File menu to save the Impact Analysis results.4. copy data as text.

Click Analyze to display a report in the Impact Analysis Result pane. Note: You can also delete search paths by highlighting a search path and clicking the Delete icon above the Search Paths area. 204 WebFOCUS . 4. click the ellipsis button to the right of the Field Name search field and double-click a field name in the Master File pop-up box. to search for procedures in directory paths not listed by default in the Search Paths pane. perform one of the following: For the Master File you selected when opening the tool. click the ellipsis button to the right of the File Name search field and select a different Master File in the Open dialog box that opens. it will be searched by default.) For a different Master File. (Go to the next numbered step. 3. For a single field within a Master File. add more search paths by clicking the folder icon above the Search Paths area and selecting one or more folders in the Browse for Folder dialog box that opens. Optionally. after you select the desired Master File. To search for all procedures that access a specific Master File or field.Analyzing Procedures With the Impact Analysis Tool 2.

You have options to edit procedures. and are saved in the following default directory (unless you specify a different location): drive:\ibi\DevStudioreleasenumber\bin 5.xml Information is appended to this file as new analysis reports are performed.4. Analyzing Metadata and Procedures The following image shows the New Report tab of the Impact Analysis dialog box populated with File Name search criteria. print the report. and a report displayed in the Impact Analysis Result pane. Exported reports are XML-formatted. multiple Search Paths. and delete reports. Click the Saved Reports tab to access all previously created reports. import previously exported reports. All Impact Analysis reports are automatically saved in the following XML-formatted file: drive:\ibi\DevStudioreleasenumber\bin\IARepository. have an . You have options to view reports. and export a report. Describing Data With Graphical Tools 205 .IAR extension. delete an item in the report.

see Accessing Data and Creating Synonyms on page 19. For more information about configuring the adapter. maximum. You can also drill down to the Values or Patterns reports for an individual column from a synonym or segment Data Profiling report. minimum. format. Data Profiling a Synonym or Segment How to: View Data Profiling for a Synonym or Segment Data Profiling provides information on all the columns in a synonym or segment. Procedure: How to View Data Profiling for a Synonym or Segment To view the Data Profiling information for a synonym or segment: 1. and number of nulls. For numeric columns. maximum. Values. total count. minimum. minimum and maximum values. total count.Viewing Data Profiling Characteristics Viewing Data Profiling Characteristics In this section: Data Profiling a Synonym or Segment Data Profiling a Single Column Data Profiling provides data characteristics for the columns in a synonym. Patterns. and number of nulls. Patterns count shows the number of patterns found in each alphanumeric column. count of distinct values. The Synonym Editor opens to the Tree View tab. format. open a synonym by double-clicking a Master File from the Master Files folder. From the Projects or Data Servers area. Data Profiling provides the segment. count of distinct values. Data Profiling for an individual column provides access to Statistics. and average length. Data Profiling provides the segment. For alphanumeric columns. You can display the characteristics for all the columns in a synonym or segment. patterns count. or for an individual column. Note: Data Profiling is not available if your adapter is not configured correctly. and Outliers reports. 206 WebFOCUS . and average values.

The Data Profiling information displays in the workspace. Optionally. Analyzing Metadata and Procedures 2. copy data as text. Describing Data With Graphical Tools 207 . you can click a column name or patterns count (for alphanumeric columns) to drill down to the Values or Patterns reports. and export the report. respectively. You may use the Data Profiling Results toolbar to view server messages. print the report.4. Right-click the synonym or segment name and select Data Profiling. 3.

Data Profiling a Single Column How to: View Data Profile Statistics View Data Profile Patterns View Data Profile Values View Data Profile Outliers Data Profiling for an individual column provides access to four reports: 208 WebFOCUS . All printable special characters are represented by themselves.Viewing Data Profiling Characteristics This is a partial Values report produced by clicking a column name. and unprintable characters are represented by an "X". a "9" represents a digit. The image below is an example of an address column. an "A" represents any uppercase letter. For pattern analysis. and an "a" represents any lowercase letter.

minimum. and average values. and average length. the Statistics report provides the segment. format. patterns count. For numeric columns. maximum. total count. and number of nulls. For alphanumeric columns. as well as counts and their percents. and special characters. and number of nulls. minimum and maximum values. total count. Outliers shows the ten highest and lowest distinct values and their counts. count of distinct values.4. These reports are available by right-clicking a column in the Synonym Editor and selecting Data Profiling. digits. format. which is only available for alphanumeric columns. Values shows unique values and their percents. shows patterns of letters. Patterns. the Statistics report provides the segment. maximum. Analyzing Metadata and Procedures Statistics shows the same information as a Data Profile report for a synonym or segment. Describing Data With Graphical Tools 209 . minimum. count of distinct values.

The image below is an example of an address column. From the Projects or Data Servers area. and an "a" represents any lowercase letter. Procedure: How to View Data Profile Statistics To view the Statistical Data Profiling information for a single column: 1. an "A" represents any uppercase letter. 210 WebFOCUS . The Synonym Editor opens to the Tree View tab. open a synonym by double-clicking a Master File from the Master Files folder. and unprintable characters are represented by an "X".Viewing Data Profiling Characteristics The Patterns report shows the number of patterns found for each alphanumeric column. All printable special characters are represented by themselves. For pattern analysis. a "9" represents a digit. Clicking on a patterns count displays the actual patterns.

3. Analyzing Metadata and Procedures 2. respectively. The Statistical Data Profiling information displays in the workspace. Describing Data With Graphical Tools 211 . Optionally. Right-click a column and select Statistics from the Data Profiling submenu. you can click a column name or patterns count (for alphanumeric columns) to drill down to the Values or Patterns reports.4.

To view the Patterns Data Profiling information for a single column: 1. digits. select Patterns from the Data Profiling submenu. open a synonym by double-clicking a Master File from the Master Files folder. 2. and special characters. From the Projects or Data Servers area. This is only available for alphanumeric columns. Right-click a column and. as well as counts. 212 WebFOCUS .Viewing Data Profiling Characteristics Procedure: How to View Data Profile Patterns Data Profile Patterns shows patterns of letters. The Synonym Editor opens to the Tree View tab. The Patterns Data Profiling information displays.

open a synonym by double-clicking a Master File from the Master Files folder. Describing Data With Graphical Tools 213 . and an "a" represents any lowercase letter. an "A" represents any uppercase letter. All printable special characters are represented by themselves. Procedure: How to View Data Profile Values Data Profile Values shows unique values. a "9" represents a digit. Right-click a column and. The Synonym Editor opens to the Tree View tab.4. 2. select Values from the Data Profiling submenu. Analyzing Metadata and Procedures For pattern analysis. From the Projects or Data Servers area. and unprintable characters are represented by an "X". To view the Values Data Profiling information for a single column: 1.

Right-click a column and. From the Projects or Data Servers area. 2.Viewing Data Profiling Characteristics The Values Data Profiling information displays. select Outliers from the Data Profiling submenu. 214 WebFOCUS . To view the Outliers Data Profiling information for a single column: 1. The Synonym Editor opens to the Tree View tab. Procedure: How to View Data Profile Outliers Data Profile Outliers shows the 10 highest and lowest distinct values. open a synonym by double-clicking a Master File from the Master Files folder.

Analyzing Metadata and Procedures The Outliers Data Profiling information displays.4. if they exist. Describing Data With Graphical Tools 215 . Note: Outliers produce a maximum of 10 highest and lowest distinct values.

Viewing Data Profiling Characteristics 216 WebFOCUS .

you can rebuild the corresponding data source using a graphical Rebuild utility. Topics: Creating a FOCUS Data Source Rebuilding a Data Source Describing Data With Graphical Tools 217 . see Using the Synonym Editor on page 73. For details about creating a Master File.WebFOCUS 5 Adding Data and Rebuilding FOCUS Data Sources If you choose to create a Master File schema before the corresponding FOCUS data source has been created. you will need to create and populate the FOCUS data source before you can use it in reports or other requests. If you modify a Master File.

4. The . After you populate the data source. 5. 3. FOCUS creates an empty data source (. 218 WebFOCUS . you must also create a corresponding empty data source that will hold the data for the fields defined in the Master File. or a Maintain request. After creating the empty data source. From the Projects or Data Servers area in Developer Studio. This data source is saved in the application directory.foc file is stored in the application directory. and select Synonym via Synonym Editor from the New menu. In the Add Master File dialog box. Click Yes to create an empty FOCUS (. right-click the Master Files folder. Click Close from the File menu. Create and save the synonym. Procedure: How to Create a Data Source 1. type a file name and click Open. you can use it in conjunction with the Master File in a report request.foc) in the background.Creating a FOCUS Data Source Creating a FOCUS Data Source How to: Create a Data Source When you save a Master File. you can load data into it with a MODIFY request. The Master File opens to the Modeling View tab in the Synonym Editor. 2.foc) data source file.

Adding Data and Rebuilding FOCUS Data Sources Rebuilding a Data Source In this section: Rebuilding a Disorganized File Rebuilding the Index Checking the Integrity of a Data Source How to: Use the Rebuild Utility Reference: Rebuild Dialog Box The Rebuild tool provides a number of useful project management utilities. 2. Choose Utilities from the Command menu. then choose Rebuild from the cascading menu. rebuild indexes. Select a Rebuild option. and check the integrity of data sources. Describing Data With Graphical Tools 219 . Rebuild enables you to restructure data sources. Note: You can only use this utility with FOCUS data sources. Procedure: How to Use the Rebuild Utility To open the Rebuild dialog box: 1. The Rebuild dialog box opens.5. see Rebuild Dialog Box on page 220 and the individual procedures for each of the Rebuild options. For more information.

Select specific segment instances to include in the data source. Index a field Builds or rebuilds the index for the specified field. Select specific segment instances for inclusion in the data source based on selection criteria you supply. Rebuilding a Disorganized File This option in the Rebuild dialog box enables you to: Restructure and optimize a FOCUS data source after data has been added or deleted. if you specify the following selection criterion: INVOICE_DATE GT 990101 FOCUS will omit invoices earlier than 99/01/01 from the rebuilt data source. 220 WebFOCUS . Only data that meets the selection criteria is included in the rebuilt data source. For example. Use this option to index an additional field that was not originally specified as an index field. Filename Contains the name of the data source to rebuild. based on record selection criteria you specify. or to change the index for a field. Selection Criteria Specifies selection criteria for rebuilding a disorganized data source and reorganizing a data source to fit a new Master File. and Rebuild from the Utilities cascading menu to display the Rebuild dialog box. The Rebuild dialog box has the following fields and options: Rebuild a disorganized file This option can be used to perform the following functions: Re-optimize a FOCUS data source after a large amount of data has been added or deleted. See Checking the Integrity of a Data Source on page 222. it displays a message.Rebuilding a Data Source Reference: Rebuild Dialog Box Choose Utilities from the Command menu. Check the integrity of a file Checks the structural integrity of a data source. See Rebuilding the Index on page 221. or click the Browse button to open a dialog box and select the data source. Type a data source name in the Filename box. If FOCUS encounters an error during the check.

4. select the field to be indexed. see the Describing Data With WebFOCUS Language manual. you must use the Rebuild utility after you index a field. After you index a field you must rebuild the index. Altering the Master File does not actually create the index. Describing Data With Graphical Tools 221 . To index all the fields designated as index fields in that data source. The first step is to alter the Master File to indicate that the field should be indexed. type an asterisk (*) in the Field to Index box. select Index a field. or Open and edit the Master File as text in the Text Editor. 3. In the Rebuild dialog box.5. you specify the fields that you want indexed. type a data source name or click Browse and select a data source from the list. For instructions on indexing a field as text. Procedure: How to Rebuild the Index 1. See How to Rebuild the Index on page 221. see the Describing Data With WebFOCUS Language manual. and then click the I . you may need to index an additional field that was not originally specified as an index field. type the name of the field you want to index. In the Filename box. In the Field to Index box. Procedure: How to Index a Field After Data Is Entered From the Synonym Editor. To do this. Adding Data and Rebuilding FOCUS Data Sources Rebuilding the Index How to: Index a Field After Data Is Entered Rebuild the Index When you first create a Master File in the Synonym Editor. Click OK. For more information on indexing fields. creating an index for all specified fields. The Rebuild utility rebuilds the data source. 2. Sometimes. after data is entered.Index check box under the FIELDTYPE attribute.

Checking the integrity of a Master File performs the following essential tasks: It checks all pointers in the data source. there is a second method of checking file integrity. If you have reason to believe that there is damage to your data source. you can check the integrity of the Master File. it logs a message for you. it recovers as much of the data source as possible. You should then attempt to recover as much of the data source as possible or restore it from backup. see the Describing Data With WebFOCUS Language manual. In this way. Procedure: How to Check the Structural Integrity of a FOCUS Data Source In the Rebuild dialog box. Checking the Master File integrity will occasionally fail to uncover structural damage. select Check the integrity of a file. Although checking the integrity reports on a good deal of data that would otherwise be lost. If the Rebuild utility encounters an error during the check. This method uses the ? FILE and TABLEF commands. it displays a message and attempts to branch around the offending segment or instance.Rebuilding a Data Source Checking the Integrity of a Data Source How to: Check the Structural Integrity of a FOCUS Data Source It is rare for the structural integrity of a FOCUS data source to be damaged. 222 WebFOCUS . Structural damage will occasionally occur. during a disk drive failure or if an incorrect Master File is used. For more information. however. though results from checking the integrity indicates otherwise. Should it encounter an error. it is important to remember that frequently backing up your FOCUS data sources is the best method of preventing data loss. In this situation.

48. 63 creating a Business View 152 creating Business Views in Developer Studio 149 creating filters 161 creating FOCUS data sources 217. 110 creating synonyms in Access Files 19 creating synonyms in Master Files 19 creating synonyms in Server Console 64 Describing Data With Graphical Tools 223 . 64. 152. 62. 155 creating synonyms 15. 133 clusters 66 column management 83 column/field attribute summary 104 columns in relational tables 14 Compute calculator 176 computed fields 164 computed fields in Synonym Editor 164 configuring 66 configuring adapters 41 create new button 34 Create Synonym tool 34. 48. 191 accessing data sources 64 accessing Server Console 64 adapters 41 adding a computed field (COMPUTE) in virtual fields 165 adding a remote server 42 adding a remote server to server configuration 42 adding existing field to group field 181 adding group fields 179 adding new field to group field 181 adding nodes to files 66 all columns 123. 63. 218 creating logical views 134 creating passwords 186. 154.WebFOCUS Index A Access File Text View tab 97 Access Files 14. 124. 17. 187 C changing nodes 71 Check utility 222 CLM Processing 66 cluster joins in Synonym Editor 126. 19 access restrictions 190. 187 B Business View Master File 155 Business Views 149. 206. 208 Application Path (APP PATH) 22 Applications node 22 APPROOT setting 22 assigning passwords in DBA (database administration) 186.

143. 218. 198. 190. 14. 199 DBA (database administration) 185. 14. 17 data sources 13. 206 data security 185. 198 DBA Properties dialog box 188 decrypting Master Files 199 DEFINE field for OCCURS 167 deleting a field from group fields 182 deleting dimensions 137 deleting dimensions or parent/child hierarchies 144 deleting group field from segment 182 deleting measures 144 deleting passwords 198 dimensions 137 E editing field names and titles 142 editing Master Files 137 editing titles for multiple languages 143 encrypting Master Files 199 F field values 191 Field View tab 93 fields 14. 210. 206. 187. 208. 219. 64. 213. 17 data profiling 123. 144. 142. 14. 17 Filter calculator 176 filters 161 FOCUS data sources 217. 186. 220 G group field attributes 183 224 WebFOCUS . 14. 64 data adapters 41 data descriptions 13. 186. 199 Data Servers folder 22 data source descriptions 13. 137. 185. 124. 138 Dimension Builder toolbar 138 D data access 41. 187.Index creating temporary fields 165 creating virtual columns in Synonym Editor 158 creating virtual fields 165 creating virtual measures with COMPUTES 145 Cube data sources in Synonym Editor 139. 202. 191. 203 file attributes summary 100 file descriptions 13. 125. 198. 214 data profiling in synonyms 123. 212. 145 Cube View tab in Synonym Editor 141 deleting synonyms 63 deleting synonyms with Create Synonym tool 63 describing data sources 13. 191. 14 describing files 14 Developer Studio 149 Developer Studio Business Views 149 Dimension Builder 134. 190. 126.

Index I identifying procedures in fields 202. 19. 137. 97. 214 reporting against Sybase ASE stored procedure 57 restricting access to data 190. 186. 191 restricting access to data sources 191 restricting access to field values 191 Describing Data With Graphical Tools 225 . 47. 66. 220 Rebuild tool 219 rebuilding FOCUS data sources 219. 203 Impact Analysis 202. 96. 220 rebuilding indexes 221 recreating synonyms 62 recreating synonyms with Create Synonym tool 62 refreshing synonyms 62 M Master Files 14. 71 remote servers and the WebFOCUS Client 65 reorganizing FOCUS data sources 220 O OCCURS repetitions in a DEFINE field 167 OLAP 134 OLAP dimensions 134 outliers 126. 208 patterns 125. 110. 198 pattern columns 124. 97 L launching from Developer Studio 65 layout in Synonym Editor 74 leaf nodes 141 profiles for specified servers in nodes 71 projects 14. 222 Master Files in Business View 155 Modeling View tab 95. 198. 187. 199. 71 remote server configuration 65 remote servers 41. 134 multilingual titles and descriptions in Synonym Editor 107 N new Master Files 133 nodes 65. 17 R read access to data sources 190 read/write access to data sources 190 Rebuild dialog box 219. 203. 17. 186. 202. 212 printing Master Files 96. 203 indexing fields 221 P parameters 66 passwords 185. 187. 203 identifying procedures in Master Files 202. 42. 66. 185.

66 WebFOCUS Client 65 WebFOCUS Environments 22 WebFOCUS Environments and remote servers 65 write access to data sources 190 T temporary fields 165 226 WebFOCUS . 212. 96. 110.Index S securing data 185. 126. 62 synonym attributes 97 synonym attributes in Synonym Editor 97 Synonym Editor 73. 210 stored procedures 57. 102. 100. 91 segment attributes summary 102 Segment View tab 92 Server Console 63. 183. 198. 91. 139. 64 single column 124. 145. 74. 186. 179. 62. 202 Synonym Editor toolbar 77 synonyms 19. 199 security in data sources 185 Segment and Field View tab 75. 199 securing data in Master Files 185. 104. 123. 62 testing adapter connections 41 testing connections to adapters 41 testing connections to remote servers 41. 47 Text View tab 96 U usage notes in Business Views 154 V validating Master Files 222 values for data profile 125. 75. 48. 95. 152. 210. 126. 186. 134. 173. 176. 213. 165. 213 viewing and editing synonym attributes 97 Virtual Column calculator 176 virtual field attributes 173 virtual field for OCCURS 167 virtual fields 165 W Web Console 63 WebFOCUS Administration Console 65. 214 statistics 124. 187. 77. 198 security 198. 63. 143. 125. 158. 107. 187. 133. 74. 206 synonyms describing stored procedures 57. 164. 188. 172. 141. 182. 190. 191. 142. 97. 110. 57. 92. 161. 93. 181. 144.

You can contact us through the following methods: Mail: Documentation Services .WebFOCUS Reader Comments In an ongoing effort to produce effective documentation. Please use this form to relay suggestions for improving this publication or to alert us to corrections. Identify specific pages where applicable. Inc. the Documentation Services staff at Information Builders welcomes any opinion you can offer regarding this manual.html Fax: E-mail: Web form: Name: Company: Address: Telephone: Email: Comments: Date: Information Builders. NY 10121-2898 (212) 967-0460 books_info@ibi.Customer Support Information Builders.informationbuilders. New York. NY 10121-2898 Describing Data With Graphical Tools Version 7 Release 7 (212) 736-4433 DN4501000. Two Penn Plaza New York.com http://www.com/bookstore/derf.0510 . Two Penn Plaza.

.A.Describing Data With Graphical Tools Creating Reports With Version 7 Release 7 WebFOCUS Language Version 7 Release 6 Information Builders Two Penn Plaza New York. NY 10121-2898 Printed on recycled paper in the U.S.

Sign up to vote on this title
UsefulNot useful