Context IDs are provided by target applications and non-target browser-based applications as identifiers for individual screens. They can be used in conjunction with in-application support to provide context-sensitive help. In-application support allows the user to use SmartHelp or the target application's Help menu to launch topics that correlate to the current screen. The Player then launches the topic at the specified screen, rather than at the beginning of the topic. 


For target applications, the Developer automatically acquires the unique context ID for a screen when the content is recorded. This creates an ExactMatch Context ID type. For non-target browser-based applications, a Context ID can be generated. This generated Context ID is called a SmartMatch Context ID type and cannot be edited. When you record an application screen, the Context ID type is set in the Type field on the Context ID dialog box. Recording non-target applications that are not browser-based, creates blank Context IDs.


Note: You cannot edit Context IDs for the Start/End, Decision, Explanation, and No context frames. Context IDs created when recording browser-based applications have a context type of SmartMatch can not be edited. If the application screen changes, you must recapture the context to change the context ID.


The Context ID dialog box has five columns:


Name: A user-friendly name for the value. It can be any text. For unsupported applications, the default value for this field is Context ID. For supported applications, the caption for the value is captured and placed in this field.


Value: The value of the context ID.


ID: Allows you to indicate a specific part of the Context ID for search purposes. It can be used as a grouping mechanism. It is a required field, and it must be unique.


ID as Prefix: When deselected, allows the search engine to ignore the prefix. For unsupported applications, this field must be false.


Searchable: Indicates whether the Context ID information for the frame is indexed. If it is not indexed, you will not be able to use it to integrate context-sensitive help. The default is true.


The Context ID dialog box differs for supported target applications vs. non-supported applications. Supported target applications have information in all five columns, and may have multiple rows for a single frame. Non-supported applications simply display Context ID in the Name column.


You can add new rows to the bottom of the grid. This allows you to provide additional context values or to fix a corrupt context ID. You can also delete rows as necessary. All editing is done inside the grid itself; simply click the cell you want to edit.


Note: You can add the Context IDs field to document outputs by customizing the document format publishing projects. See Customize Document Formats for more information on customizing document output.


To enter or modify a context ID for the current frame:

  1. On the Edit menu, choose Context IDContext ID.
     
  2. Click in the cell you want to edit, and change text as necessary.
     
  3. Click Add context to add a row at the bottom of the grid.
     
  4. Click Delete selected context to delete the selected row.
     
  5. Click OK to save your changes or Cancel to exit without saving.

Table of Contents