User Guide


Skip to end of metadata
Go to start of metadata

The MarketWide Administration Utility lets you configure advanced settings for MarketWide, such as adding/removing databases, drilldowns, lookups, and picklists.

After installation, you can configure MarketWide for users with the MarketWide Administration Utility, available from the MarketWide main window. This utility lets you specify databases, picklists, lookups, and other helpful features. MarketWide stores these settings in the catalog. The rest of this section discusses how to use the MarketWide Administration Utility to configure MarketWide.

Topics

The MarketWide Catalog

MarketWide makes use of a catalog to preserve information about databases, table names, and field names required for using each server, in addition to features such as picklists and lookups. The catalog is created during installation, but any work done to the catalog takes place in the MarketWide Administration Utility. The catalog is saved on the host machine, and every time users access it when launching MarketWide, they receive the most current catalog, including all updates and administrative changes.

Each time an Administrator makes changes to the catalog, a temporary work catalog is created where edits can be made so that it does not interfere with the primary catalog. After changes are completed, the Administrator must save the working catalog by clicking Save. If you leave the MarketWide Administration Utility, you will be asked if you want to save the catalog. Once you have made all the changes to the catalog, you must commit the catalog to replace the primary catalog with your saved work catalog.

To commit the catalog, click the Commit button () on the AdminUtility toolbar. You must have saved a working catalog before committing that catalog. The changes will only affect users upon launching MarketWide, where they will receive the newest version of the catalog. If a user is currently on MarketWide when a new catalog is committed, they will be prompted to download the new catalog.

If you elect to save your changes without committing, the next time you launch the MarketWide Administration Utility, you will receive a message that asks if you would like to continue with the previously saved changes, or drop all uncommitted changes and start over.

To Commit the Catalog

  1. After making changes to the catalog, click Save ().
  2. Once you have saved a working catalog, click Commit () and Close.

The AdminUtility Menu and Toolbar

The AdminUtility toolbar provides quick access to commonly used commands in AdminUtility. Click the icon once to carry out the action represented by that icon.

Icon

Description

Menu Equivalent

Allows you to commit the changes you have made and update the catalog.

File > Commit

Saves changes without committing them to the catalog.

File > Save

Exits the MarketWide Administration Utility.

File > Exit

Depending on which folder is selected, allows you to delete properties from the right pane.

Edit > Delete

Allows you to refresh all databases, owners and tables.

Edit > Refresh

Opens the Manage Table Filters dialog box.

Edit > Manage Table Filters

Opens the Add Drilldown dialog box.

Edit > Add Drilldown

Opens the Add Lookups dialog box.

Edit > Add Lookup

Opens the Add Picklist dialog box.

Edit > Add Picklist

--

Opens the Manage All Fields dialog box.

Edit > Manage All Fields

--

Opens the AdminUtility Help files.

Help > Admin Utility Help

Print Formats

MarketWide supports the standard print formats available in Microsoft Excel.

For your convenience, this section contains definitions of the print format characters and examples of common print formats.

Character

Description

#

A hash symbol represents a whole number.

0

A zero means you want to display insignificant zeros if a number has fewer zeros than specified in the format.

%

Adding the percent sign to a print format displays the number as a percentage of 100.

$

Adding the dollar sign to a print format displays numbers preceded by the dollar sign.

,

Inserts a comma as a thousand separator.


Examples of Common Print Formats

To Display...

As...

Use this Format...

2500

2,500

#,###

1.2

1.200

#.00

.224

0.2

0.#

25.99

$25.99

$#.00

0.3796

38%

0%

0.3796

37.96%

0.0%

To Enter Default Print Formats

  1. Click the Print Formats () icon.
  2. In the Data Type Print Formats dialog, enter the necessary format for each Data Type in the Format column. MarketWide supports the standard print formats available in Microsoft Excel.
  3. After making changes to the catalog, click Save ().
  4. Once you have saved a working catalog, click Commit () and Close.

Drilldowns

Drilldowns allow you to right-click an item of interest on any MarketWide screen and view more information about the item. In short, drilldowns typically provide quick access to commonly wanted information. There are three integrated drilldowns in MarketWide, but you can have any number of custom drilldowns built from stored procedures using Rexx scripts. The three drilldowns are the Customer Information Report, the Field Information Drilldown, and the Frequency Distribution Drilldown.

There are similarities and differences between the Customer Information report, Field Information drilldown and Frequency Distribution drilldown:

Customer Information Report

  • The database administrator must complete the Customer Key setup prior to running the report.
  • The report option is available from the main MarketWide window using the Reports a Customer Information option.

Field Information Drilldown

  • The database administrator attaches the integrated stored procedure to the MarketWide catalog.
  • The drilldown option is available from any MarketWide output window.

Frequency Distribution Drilldown

  • The database administrator attaches the integrated stored procedure to the MarketWide catalog.
  • This drilldown is only available as a right-click menu option from fields in the right pane of the SQLManager window.
  • The drilldown is run by performing calculations on selected fields using Analyzer, MarketWide's data analysis program.

To Add a Drilldown

  1. Click on the Drilldowns
  2. Right click and select Add (Drilldown 
  3. Click the Add button to select a table. 
  4. From the Drilldown Field drop-down menu, select one of the common fields that were found across your selected tables. The Attach to Fields menu will be filled in for you. 
  5. Finally, give your new Drilldown a name. This name will appear in MarketWide when you right-click on your selected Drilldown field. 
  6. Click OK to save your changes. 
  7. After making changes to the catalog, click Save ()
  8. Once you have saved a working catalog, click Commit () and Close.

Expressions 

The Expression Editor allows you to create and save string, mathematical, and date expressions for use in reports in all MarketWide programs. 
When using the Expression Editor, you have two options for creating expressions:

    • You can use the Expression Wizard option where the Expression Editor takes you step by step through expression creation.
    • If you already know the syntax of your expression, you can use the Advanced Expression Editor option to skip the wizard screens and enter the syntax directly.


The next sections address both the wizard and advanced expression building options. 

The Expression Wizard

The Expression Wizard systematically prompts you for all the information needed to create an expression. Furthermore, the wizard is especially handy because it alleviates the need to know the exact syntax required to build expressions on your database.

For example, suppose you want to create an expression to calculate the interval between two date fields. SQL Server databases uses the expression datediff(dd, date1, date2), while other servers simply use date1 – date2. To save you the trouble of remembering database-specific syntax, the Expression Wizard constructs a universal expression, which can be interpreted by any relational database.

Option

Description

General

Allows you to name your expression and enter in a description.

Return Type

Indicates the Expression type

Attaches To

Allows you to choose whether to attach the expression to a server, table, or field.

Attachment Names

Displays a list of available servers, databases, owners, tables, or fields, depending on which attachment type you select.

Type

Allows you to indicate whether you are creating an expression to calculate a Character, Numeric, Decimal, or date/time value.

Function

Lists the functions available based on the type of expression you select. A description of the highlighted function appears at the top of the screen.

Function Descriptions

Displays a brief description of the Function selected

Parameters

What the selected expression is affecting and to what extent.

Parameter Description

Displays a brief description of the Parameter selected

Auto Attach to Joins

If checked it will include the expression in any joins where the attachment method applies.

To Create an Expression Using the Expression Wizard

  1. Right click on the Expressions ( ) icon and choose Add Expression ()
  2. Select an expression Type and Function.
  3. Choose an Attachment Type and select Attachment Names.
  4. Enter a value for each parameter as follows:
    • For constant values: Type in the value in the expression Value column.
    • For field values: Click the Fields button to open the Select Field dialog. Highlight a field in the Available Fields list. Choose OK to confirm your selection.
  5. Enter a title in the Title field and a description in the Description field and select OK.

To Create an Expression Using the Advanced Expression Editor

  1. Right click on the Expressions ( ) icon and choose Add Expression ()
  2. Select the Advanced tab at the bottom of the Wizard.
  3. Choose an Attachment Type and select Attachment Names.
  4. Type your expression.
  5. Enter a title in the Title field and a description in the Description field and select OK.

To Edit an Expression

  1. Click on the Expressions ( ) icon.
  2. In the right pane, highlight the expression you wish to edit.
  3. Right click and select Edit.
  4. Make your changes.
  5. Click OK to save your changes.

To Delete an Expression

  1. Click on the Expressions ( ) icon.
  2. In the right pane, highlight the expression you wish to edit.
  3. Right click and select Delete.
  4. Click OK if you are sure you would like it deleted.

Table Filters

Table filters allow you to hide or display tables based on criteria placed on table names, even though users may have permission to access them. This can be quite helpful if your database has internal system tables that you do not want users to see. The table filters option can be accessed from the main MarketWide AdminUtility window, under the server name in the Table Filters folder. You can assign filters on a global, database or owner level.

Note

  • You can enter wild cards in any of the following fields: 'Database', 'Owner', and 'Table'. The wildcard sign (%) is used to indicate a string of one or more characters.
  • You can enter multiple Includes. For example, to display tables belonging to owners Joe and Bob, enter two filters, one with Owner set to Joe and the other with Owner set to Bob. Set filter type to Include on each.

To Add a Table Filter

  1. Click on the Table Filters () icon.
  2. Right click and select Manage Table Filters
  3. In the Filter Type column, you can opt to use an Include or Exclude for the filter. The include will display the tables that meet your criteria; the exclude will hide tables that meet your criteria.
  4. Enter filter criteria in the Database, Owner, or Table field. The wildcard sign % is used to indicate a string of one or more characters.
  5. When you enter filter criteria in the last empty row, a new row is automatically inserted.
  6. Click OK to save your changes.
  7. After making changes to the catalog, click Save ().
  8. Once you have saved a working catalog, click Commit () and Close.

To Edit a Table Filter

  1. Click on the Table Filters () icon.
  2. Highlight the filter you would like to edit.
  3. Right click and select Manage Table Filters.
  4. Make your changes.
  5. Click OK to save your changes.

To Delete a Table Filter

  1. Click on the Table Filters () icon.
  2. Highlight the filter you would like to edit.
  3. Right click and select Manage Table Filters.
  4. Highlight the filter you would like to delete and click the Delete () icon.
  5. Click OK to save your changes.

Field Properties

After adding databases, you can begin to create some of the user-friendly features MarketWide provides for users. You can add properties to fields such as aliases, descriptions, picklists, lookups, print formats, and composite fields. You can also specify whether the field is suitable to group and perform arithmetic on. For example, with these options, you can prevent a user from specifying a date field as a dimension or from trying to calculate a sum or average of account numbers.

To Add or Edit Field Properties

  1. Click on the All Fields () icon...
  2. Right click and select Manage All Fields.
  3. Type an alias next to the field in the Alias column if you would like this name displayed to users rather than the actual field name.
  4. Add a description of the field in the Description column.
  5. To assign a picklist to a field, click in the Picklist column next to the field and use the drop-down list to select a picklist.
  6. To assign a lookup to a field, click in the Lookup column next to the field and use the drop-down list to select a lookup.
  7. To add a print format, type an entry in the Format column.
  8. If you wish to make a field unavailable for use as dimensions and/or arithmetic functions, uncheck the box in the Dimensions and/or Arithmetic columns next to the field to deselect them.
  9. Click the checkbox in the Reference column if the field is a reference to a file outside of MarketWide.
  10. Click the checkbox in the Composite column if the field will be parsed for data when creating a solicit file.
  11. Click OK to save changes and exit the dialog.

Note

  • You can print fields and their properties, or copy and paste values from another location (such as Excel).
  • Marking a field as read only is valid only when you also assign a picklist or lookup to that field.