Indexing the Course File

Reference: Engine Parameters

This section provides steps to review data and identify how fields will be used for search in order to build a WebFOCUS procedure to create Magnify index libraries.

1. Create a procedure to review all available data.
2. In App Studio, create an application pointing to the sample directory, ibisamp, if not already created.
3. In the ibisamp application, create a new procedure, as shown in the following image.
   
4. In the Procedure View panel, create a Report object.
   1. Right-click anywhere in the Procedure View panel select New and then click Report from the context menu, as shown in the following image.
      

      The Select Data Source dialog opens, as shown in the following image.

      
   2. Select the course.mas Master File and click Finish.
   3. Double-click the CRSELIST segment to add all the fields to the report canvas, as shown in the following image.
      
   4. Click Save from the Quick Access Toolbar, as shown in the following image.
      

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

      
5. Specify a name for your procedure (for example, courses_all.fex) and click OK.
6. Click Run from the Quick Access Toolbar, as shown in the following image.
   

   The report runs and is displayed in a browser window.

7. Identify fields to assign to the Magnify Category Tree, as shown in the following image.
   

   Note: Usually fields that make high-level groupings, typically those used as BY fields, make good categories. Although numerical values, like price, usually do not make good categories as is, they make excellent categories when converted to a range.

8. Identify fields to make searchable from the Magnify search interface, as shown in the following image.
   

   Note: Searchable fields tend to be those that are alphanumeric strings, IDs, or any other data that is to be matched to searched terms.

9. Close the browser window that is running the report.
10. Close the Report canvas and the Procedure View panel.

Create a procedure to transform the data into search content.

1. In the ibisamp application, create a new procedure, as shown in the following image.
   
2. In the Procedure View panel, create a Define object.
   1. Right-click anywhere in the Procedure View panel select New and then click Define from the context menu, as shown in the following image.
      

      The Select Data Source dialog opens, as shown in the following image.

      
   2. Select the course.mas Master File and click Finish.
3. In the Define dialog that opens, create fields to enrich the data, as defined in the table below.
   1. Add each define attribute using the Field, Format, and Value information shown in the table, as shown in the following image.
      
   2. Confirm that there are no errors by clicking the Check button.
   3. Create the next Defined field by clicking the New button.
   4. Repeat for each field listed below.

      Note: You can copy and paste Field, Format, and Value information from the table below into their respective places in the Define dialog.

      Field	Format	Value	Purpose
      SYSSOURCE	A25	'School Courses'	Hard-coded category value.
      TUITION_RANGE	A50	IF COURSE.CRSELIST.TUITION LT 1000 THEN '1. Under 1K' ELSE IF COURSE.CRSELIST.TUITION LT 2000 THEN'2. 1K-2K' ELSE '3. Over 2K'	Granular data rolled up into a range.
      SEARCHTITLE	A2000	'<b>Course Name:' | COURSE.CRSELIST.CTITLE |'('|COURSE.CRSELIST.COURSECODE ||')</b>'	Text shown as the search result main title.
      TITLE_URL	A2000	'/ibi_apps/WFServlet?' || 'FXK=' || COURSE.CRSELIST.COURSECODE ||'&'||'IBIF_ex=courses_detail' ||'&'|| 'IBIAPP_app=magnify_courses'	The main drill-down link for the main title of the search results. In this case, a BI report passing the course code.
      LINK_DISPLAY_NAME1	A2000	'Search Other Department Courses'	Additional drill-down text.
      LINK_URL1	A2000	'ibi_apps/search' ||'q='|| COURSE.CRSELIST.SOURCE	Additional drill-down link.
      LINK_DISPLAY_NAME2	A2000	'All Courses in this Subject'	Additional drill-down text.
      LINK_URL2	A2000	'/ibi_apps/WFServlet?' || 'FXK=' || COURSE.CRSELIST.CLASSIF ||'&'||'IBIF_ex=courses_similar' ||'&'|| 'IBIAPP_app=magnify_courses'	Additional drill-down link.
      HARDCODED	A50	'schools course'	Additional searchable content not originally found with the data.

      For more information, see Indexing Using FORMAT MAGNIFY Command.

      Note: The URL value being referenced for the TITLE_URL and Link_URL2 fields does not exist. Therefore, when executed, the links for the main title link and second additional link of the search results will not drill down to a valid webpage.

   5. Close the Define dialog by closing the Define tab, as shown in the following image.
      
4. In the Procedure View panel, create a Report object.
   

   The Select Data Source dialog opens, as shown in the following image.

   

   Select the course.mas Master File and click Finish.

5. Add fields to the Report canvas.
   1. In the Object Inspector, double-click the field name for all fields defined in the following table.
   2. Update the Column Title.
      • On the report canvas, select the added field.
      • Right-click and select Column Title, as shown in the following image.
        
      • Enter a new Column Title (case-sensitive), as shown in the table below.
      • Click OK.
   3. Repeat step 5b for each field listed in the following table.

      Field	Column Title (Case-Sensitive)	Purpose
      COURSECODE	MagnifyID	Unique identifiers (required)
      COURSECODE	WF_INDEX_UNIQUE_KEY	Unique identifiers (required)
      SYSSOURCE	C1_Source_System	Category
      SOURCE	C2_Department	Category
      CLASSIF	C3_Subject	Category
      TUITION_RANGE	C4_Tuition_Range	Category
      SEARCHTITLE	SearchTitle	Drill-down link information
      TITLE_URL		Drill-down link information
      LINK_DISPLAY_NAME1		Drill-down link information
      LINK_URL1		Drill-down link information
      LINK_DISPLAY_NAME2		Drill-down link information
      LINK_URL2		Drill-down link information
      DESCRIPTN1	S_DESCRIPTN1	Searchable content
      DESCRIPTN2	S_DESCRIPTN2	Searchable content
      DESCRIPTN3	S_DESCRIPTN3	Searchable content
      CTITLE	S_CTITLE	Searchable content
      COURSECODE	S_COURSECODE	Searchable content
      SYSSOURCE	S_SYSSOURCE	Searchable content
      SOURCE	S_SOURCE	Searchable content
      CLASSIF	S_CLASSIF	Searchable content
      HARDCODED	S_HARDCODED	Searchable content

      Note: The resulting column title dictates how the data will be used in the search interface.

      For more information, see Indexing Using FORMAT MAGNIFY Command.

   4. Click Save from the Quick Access Toolbar.

      The Save As dialog opens.

      Specify a name for your procedure (for example, courses_transform.fex) and click OK.

   5. Click Run from the Quick Access Toolbar.
   6. Review how the data is applied in their respective column titles, as shown in the following image.
      
   7. Close the browser window that is running the report.
   8. Close the Report canvas.
   9. Return to the Procedure View panel.

Update the procedure to feed data to the Magnify index library.

1. In Procedure View panel, create an Engine object.
   1. To create each Engine object, right-click anywhere in the Procedure View panel select New and then click Engine from the context menu, as shown in the following image. For a list of Engine objects, see Engine Parameters
      
   2. The ENGINE dialog box opens, as shown in the following image. Add each Engine attribute using the Engine, Connection, and SET parameters information in the Engine Parameters table.
   3. After each entry, click OK.
   4. Define each Engine object using the ENGINE dialog box (Engine, Connection, and SET parameters fields), as shown in the following image.
      

      For more information on the individual parameters that you must specify, see Engine Parameters.

      Note: If the MAGNIFY engine (case-sensitive) does not display in the list, you must type it in manually. In addition, for connections listed as no connection, you must select no connection in order to activate the SET parameter field. The preceding image shows an Engine entry.

2. In the Procedure View panel, create a Set object before the Define object and after the Engine objects.
3. Right-click in the Procedure View panel select New and then click Set from the context menu, as shown in the following image.
   

   The Set dialog opens, as shown in the following image

   
4. Under Available Settings, double-click ASNAMES.
5. Under Current Value, select MIXED.

   Note: You must set the ASNAMES setting to MIXED in order to preserve case-sensitivity. For more information, see Indexing Using FORMAT MAGNIFY Command.

6. Close the Set dialog by closing the Set tab, as shown in the following image.
   
7. Click Save and then click Run from the Quick Access Toolbar.
   1. Confirm that there were no errors.
   2. Confirm that raw data is modeled and enriched accordingly.
   3. Close the browser.
8. Change the output type in the Report object.
   1. Double-click the Report object to open the Report canvas.
   2. Click the Format tab.
   3. Select the Output Format drop-down.
   4. Expand the Unstyled formats menu and select Format Magnify (MAGNIFY), as shown in the following image.
      
   5. Click Save and then click Run from the Quick Access Toolbar.
   6. Confirm that there are no errors, such as the following.
      

      Note: If you receive an error message indicating that your Magnify server is not licensed for indexing, please contact your WebFOCUS Administrator. For more information on this error message, see Magnify Error Handling.

Once complete, review the search-based application generated.

1. Open a web browser.
2. Navigate to the Magnify search page:

   http://host:port/wfcontext_root/search

   where:

   host:port

   Is the machine name and port number where WebFOCUS is installed.

   wfcontext_root

   Is the WebFOCUS application root.

   Notes:

   • By default, this can be http://localhost:8080/ibi_apps/search. However, this link can vary based on your WebFOCUS configuration.
   • Sample or default URLs are for informational purposes only and may not resolve correctly, if at all.
3. Perform a search test by typing school in the Search box and clicking Search, as shown in the following image.
   
4. Review the results returned and search to identify how the data has been applied to the Magnify search interface.
5. Close the browser window.
6. Close the Report canvas.
7. Close the Procedure View panel.

MAGNIFY

MY_PC 'http://localhost:8080/
ibi_apps/saxfeed'

MAGNIFY

-- no connection --

BASEURL=http://localhost:8080/

MAGNIFY

-- no connection --

DATASOURCE=school_courses

MAGNIFY

-- no connection --

BATCHSIZE=5