Custom Structure Compare Dialog Box

You can customize the structure compare dialog box. You need to write a custom JSP for this purpose. The custom dialog page must post the mandatory criteria fields and needed URL parameters to the structure compare report generator (emxStructureCompareReport.jsp).

This table lists the fields/parameters that can be passed:

HTML Form Element/URL Parameter Description Mandatory

compareBy

1 or more columns used to compare matched objects. The column names can be:

Passed as a comma-separated list in the URL Parameter compareBy

Posted as an HTML form element with the element name compareBy. Each form element must have this name and contain the unique values for that specific match.

Yes

expandProgram OR relationship

Same as for a structure browser: the relationship or expandProgram used to expand the objects being compared

Yes

level

The number of levels to expand the structure before initiating the comparison processing. The level can be:

Passed as the level URL Parameter

Posted as an HTML form element with the element name level.

Default=1.

No. If not passed, the structure is expanded by 1 level.

matchBasedOn

1 or more columns used to determine if children of Object 1 and Object 2 are matches. The matched column names can be:

Passed as a comma-separated list in the URL Parameter matchBasedOn

Posted as an HTML form element with the element name MatchBasedOn. Each form element must have this name and contain the unique values for that specific match.

Yes

objectId

The objectIds of the objects being compared. These ids can be:

Passed as a comma-separated list in the URL Parameter objectId (2 id's must be passed)

Posted as an HTML form element with the element name objectId.

Yes

reportType

The type of report to generate. The report type can be:

Passed as the reportType URL Parameter

Posted as an HTML form element with the element name reportType.

The possible values for the URL Parameter or form element are:

complete_summary (default)

difference_only

Unique_toLeft_Report

Unique_toRight_Report

Common_Report

No. If not passed, complete_summary is used.

table

The system table name to use in the compare report page. The table can be:

Passed as the URL Parameter table

Posted as an HTML form element with the element name table.

Yes

In general, you follow these steps to create a custom structure compare dialog:

  1. Clone the AEFStructureCompare command.
  2. Edit the href setting to call a custom JSP page instead of emxStructureCompare.jsp.
  3. Connect the cloned command to the needed toolbar. Make sure that the toolbar does not also have the AEFStructureCompare command attached to it.