procedure for layout tool demo: - taylor...

Magnify: Finding Waldo Has Never Been This Easy

Kishor Rao and Mona Baker

Information BuildersInformation Builders Summit 2016 User Conference

June 13 - 17, 2016

Author: Kishor Rao and Mona BakerCompany: Information Builders

Presentation Title: Magnify: Finding Waldo Has Never Been This EasyPresentation Abstract: Anyone can write a SQL query. What happens if you have unstructured content you want to query against? Magnify provides seamless search capabilities against various data sources, with links to any application, report, or URL. Come to our session to see how easy it is to load and access your data.

ContentsSection 1 Magnify Search Features.......................................................................................................................4Section 2 Modify and Run Load Procedure to Create New Search Index..........................................................19Section 3 Verify Results Using the Magnify Console.........................................................................................27Section 4 Create a New Collections File.............................................................................................................30Section 5 Explore the Magnify Search Features Using the New Index..............................................................33Extra Credit : How to Add A Synonym................................................................................................................35

Business Need:

IBI Tech Summit has many events, presentations and labs. The goal is to help you find specific sessions that are relevant for you using our Magnify search tool. You can also easily view credentials of the speakers and more information on the actual session.

Magnify: Finding Waldo Has Never Been This Easy of 42 5/5/2023Copyright © 2016 Information Builders

Let’s Start The Lab!To start, we need to log in to WebFOCUS,

1. From the Tool bar, bring up a browser. Your desktop has Chrome and IE11 so pick your favorite.

2. Login in to WebFOCUS.

User Name admin Password admin


3. Select Century Sales Search from the favorites bar.

Note: The URL is http://localhost:8080/ibi_apps/search?collections=collections_century.xml&clearcache=1&proxyreload=1

This url contains special operations needed to clear the last search criteria and create your new search criteria. There parameters are for administrative and testing purposes only.

DO NOT USE THIS IN PRODUCTION. This command allows you to reload your new magnify collections and stylesheets changes without having to recycle the Application Server. This is a technique that is helpful during your development phase.

1. clearcache: When set to 1 will clear the collections index.

2. proxyreload: When set to 1 refreshes the style sheet to reflect changes without restarting the application server.


Section 1 Magnify Search Features

Step 1 Type camera in the search box and click the Search button.

Step 2 Review results of the search.


1. TitleEvery search result has a title which is a string that uniquely identifies the item. It can be a combination of one or more fields.

2. Category TreeSearch results can include specific attributes for categorization. These are typically high-level groups when aggregated. In the instance of demographics, this could include gender, nationality, and age range.

3. Search BodyWhen a user searches for specific terms, the terms are matched against a master index generated from the searchable content. This can include any structured or unstructured database field or document.

4. Additional LinksThese links provide access to similar results, business intelligence reports, or other related information.

5. Other DetailsAdditional information can be appended to the search result to display an image, date, or other information.


Search results shows the time it took to retrieve the information and the number of records returned.

Step 3 Select Word Cloud: visual view of the most frequently found words.


Step 4 Select Century Electronics to go to Home Page.


Step 5 Enter camera and click the Search button.

Step 6 Click on the Source System and Country Categories from the Category Tree on the left. Ref: The steps to build this tree will be shown in section 3.

Helpful hint: To be successful, you need three criteria: a business perspective, somebody who is very familiar with the data and a developer to code this.

The tree has defined categories and related items under each category. The number next to each item is the number of search results. The red dot denotes the category item with the most number of results in that specific category.


Step 7 Click on the pie icon to see a visual representation of your results.

Step 8 Select Tabular view.

Tabular view shows search result in an Active Technologies report, which provides the ability to sort, filter, calculate and chart the results.


Step 8A. Click the arrow to the left of Region. The dropdown box (in grey) will appear.

Step 8B. Select Chart Pie Region from the dropdown list.


Step 8C. Review the output from the Active Report.

Step 8D. Select a piece of the pie.


Step 9 Select Sort by query score.This setting can identify popular or frequently used items. The calculation is based on the percentage of your result compared to the total amount relative to the category.

Step 9A Select camera and select Product Catalog from the Collection Dropdown list.

Step 9B Open the Word Cloud and select zoom. Then select Sort by query score.


Step 10 Select Sort by date.

Search results based on the date that the data was entered into the Magnify search engine. This helps you get the most recent data first.

Step 11 Select Sort by relevance.

This is the default sort criteria. Results are sorted from the most relevant appearing first, through to the least relevant. The scoring (ranking) of documents, is determined by the Magnify Search Engine. Basically the more times a query term appears in a document relative to the number of times the term appears in all the documents in the collection, the more relevant that document is to the query.


Step 12 Select Facetcounts on. This affects the Category Tree Only.

Facet Count controls the number of records counted in the category tree.Facet Counts ON: Displays count for all records found in the entire index. Facet Counts OFF: Displays count for those items returned to the user (respecting set limit).

Step 12A Click on Source System and Country. The default is facetcounts off.

Step 12B Toggle facetcounts off (this turns facetcounts on).


We will now explore a few different search types. Note: the addendum has the full explanation for each type.

Step 13 Click the logo to go to the home page for Magnify Search.

Step 14 Test Exact Match. Enclose the search criteria in double quotation marks.

Step 14A Type in “DVD Player” in the search box. (Exact Match requires the double quotes)

Step 14B Type in DVD Player in the search box.

Without exact match, results are different. There are Customer Profiles for the exact match but none for the open search (which will search on DVD and Player but not “DVD Player”).


Step 15 Test Fuzzy Match. Using the tilde (~) to search for similar spellings.

Type Camra~ into the search box and click the search button.

Step 16 Test the Wildcard. Using the asterisk (*) Type rec* and hit the Search button.

Note the different results (Records, Receipt, Recorder…)


Step 17 Collections Dropdown.Ref: we will show you how to build this in Section 4.

The collections file is used to organize search information.

This is helpful to limit search capabilities to different sections of your organization. This is also helpful for performance as it limits the search to the collection you know is applicable.

In the following steps we will select different categories. Note the different number of records returned for our search criteria – camera - when searching under the different categories.


Step 18 Select Product Reviews from Category list and search for camera.Note: 8 records are returned.

Step 19 Select Product Catalog from Category list and continue to search on camera.. Note: 5 records are returned.

Step 20 Please close your browser before starting the next session.


Section 2 Modify and Run Load Procedure to Create New Search Index

Step 1 Open App Studio.Locate the icon on your desktop and double click.

Step 2 Click on the Environment Tree and then navigate to the mag_summit folder.

localhost Data Servers EDASERVE Applications mag_summit


Step 3 Right click on the procedure load_summit_data.fex and select Open in Text EditorNote: This can all be done using Report Painter but we will go into code for this lab.

The following procedure will open:


Step 4 Run the procedure without making any changes.o Click the Blue Arrow to run from the Quick Menu Bar.


Step 5 Output Analysis: review the output. After reviewing the output, you can close the report window.Important Note: This is the data that will be loaded into the Magnify Search Engine.

Before proceeding with the lab steps, let’s review the procedure that loads the index.

In the load procedure you will see the data source name. This is the index name.

We can see the code that created the Category (C) and Search (S) Fields.

We created 4 Category Fields.


That code is what creates the categories in the Category Tree.

We created 9 search fields:


Step 6 Navigate to the following section of the code (line 40).

Note the statement that is commented out:


ON TABLE PCHOLD FORMAT MAGNIFY AS KEY

Step 7 Uncomment that statement by removing the -* on line 40.

Step 8 Save your changes.Right click on AS and select Save.


Step 9 Run the procedure again.Click the Blue Arrow to run from the Quick Menu Bar.

Your results will look like this. However, this is expected behavior since there is no output to display on the screen. The next steps in this lab will verify that the data was loaded to the Magnify index.


Step 10 Minimize App Studio.


Section 3 Verify Results Using the Magnify Console

We will now verify the new index using the Magnify Console.

Step 1 Bring up a new browser and select the WebFOCUS BI Portal from favorites.

Step 2 The WebFOCUS Welcome page shows. Select Administration Magnify Console


Step 3 Select Index Monitor under Diagnostics.

? Does this match what you are seeing in your environment?


Section 4 Create a New Collections File

The collections file configures how Magnify processes, matches, and organizes search information. This is helpful to limit search capabilities to different sections of your organization. This is also helpful for performance as it limits the search to the collection you know is applicable.

Magnify collections are organized and styled by files in the config\magnify folder. Note the drop down box on the Magnify Search Screen (see screen shot above – you should also see this in your lab environment).

Step 1 Please click on Summit Search in the favorites bar. What do you see in the Collections dropdown list?


Add the new collections to the dropdown box

Note: This can all be done using Report Painter but we will go into code for this lab.

Step 1 Navigate to the following directory: D:\ibi\WebFOCUS81\config\magnify\en

Step 2 Open the en_stylesheet.xslt file in Notepad++.

There are 2 changes that need to be made in this file:

1. collections_descriptions : this is the name that is visible on the screen. This information gets updated when the lucene index folder is updated with the new index (summit_agenda).

2. collections_values : these are the values stored in the index

Step 3 We will first modify the collections_descriptions

Note. There is a collections_completed.xml included in your folder if you do not want to type in the changes to the code below so you can continue following this lab. To use this completed file

> delete the original collections.xml > rename collections_completed.xml to collections.xml

In the <xsl:choose> section, look for the <xsl:otherwise> xml node (around line 43)

It should look like this: <xsl:otherwise>Default Collection,</xsl:otherwise>

To add two new labels that will display in the dropdown list, Type in the following to add Summit Agenda and Cars


<xsl:otherwise>Default Collection,Summit Agenda,Cars,</xsl:otherwise>

Step 9 We will now modify the collections_values.

Note. There is a en_stylesheet _completed.xslt included in your folder if you do not want to type in the changes to the code, you can continue following this lab by using the updated file.To use this completed file

delete the original en_stylesheet.xslt rename en_stylesheet _completed.xslt to en_stylesheet.xslt.

In the <xsl:choose> section, look for the <xsl:otherwise> xml node (around line 52)

It should look like this: <xsl:otherwise>default_collection,</xsl:otherwise>

To add two new labels that will display in the dropdown list, Type in the following to add summit_agenda and cars

<xsl:otherwise>Default Collection,summit _agenda,cars,</xsl:otherwise>


IMPORTANT: You MUST have a comma at the end otherwise this will not work as expected.

Step 10 Save the en_stylesheet.xslt and close the file.

Section 5 Explore the Magnify Search Features Using the New IndexStep 1 Bring up a browser.

Login in to WebFOCUS.

User Name admin


Password admin

Step 2 Select Summit Search from Favorites.

Step 3 Select Summit Agenda from the Collections Drop Down box.


? What did we do so that Summit Agenda and Cars appears in this dropdown box?

Step 4 Type Waldo in the search box.

? What did you find? Try the drilldowns to get more information on the session and the presenters.

Step 5 Search for your favorite presenter or topic using the robust Magnify search functionality.


Extra Credit : How to Add A Synonym

Step 1 Enter IBI as the search criteria under Summit Agenda.

Step 2 Enter Information Builders and notice the difference in results.

We want to get all Information Builders information returned when searching for IBI. Step 3 Select the WebFOCUS BI Portal from the favorites bar.


Step 4 Navigate to the Magnify ConsoleSelect Administration Magnify Console

Step 5 Select Configuration Files


Step 6 Select Search Term Synonym Expansion

Step 7 Type in ibi,information builders


Step 8 Save the changes.Note: The Save changes from highlighted to un-highlighted after save.

Step 9 Select Summit Agenda from the favorites bar.

Step 10 Search for IBI.

Note the results.


Congratulations! You found Waldo! Q&A


procedure for layout tool demo: - taylor...

Documents