Integrator Object Methods

The method signatures for Build, Compare, Link and Unlink are shown below. These correspond to the interactive operations described in the Main Table Context Menu in Main Table Menu. The string arguments can be a name like /MyName or a reference like =123/45678. If duplicate names are used, it is best to always use reference numbers to avoid confusion. The array arguments are arrays of strings of the same format.

!!integrator.build(!Name is STRING)

!!integrator.build(!Names is ARRAY)

!!integrator.compare(!Name is STRING)

!!integrator.compare(!Names is ARRAY)

!!integrator.link(!Name1 is STRING, !Name2 is STRING)

!!integrator.unlink(!Name is STRING)

!!integrator.unlink(!Names is ARRAY)

The following methods get or set the current project configuration file, get the list of Configurations defined in the current file, and get or set the selected Configuration:

!!integrator.projectConfigurationFile()

!!integrator.projectConfigurationFile(!Filename is STRING)

!!integrator.getConfigurations()

!!integrator.configuration()

!!integrator.configuration(!Name is STRING)

The following methods return the Names of the Compare Colours, Comparison Category and rule set for the currently selected Configuration:

!!integrator.compareColours()

!!integrator.compareCategory()

!!integrator.compareRuleset()

By default the Compare Report is generated to the screen. Suppress the output to screen with this method (typically used in non-graphics mode):

!!integrator.setReportVisible(false)

Integrator will maintain the current compare report in a temporary file during the session. Use the following method to save a permanent report file.

!!integrator.setReportPath('c:\reports\rep.xml')

If the pathname of the report file has been specified as shown above, then the report can be viewed in the Compare form using the following command (note that this command cannot be used in non-graphics mode).

!!integrator.openReport()

The following method opens and colours all diagrams referenced by the last comparison. In non-graphics mode it does not display anything but holds the coloured views in memory pending save to pdf file.

!!integrator.openAllReferencedDiagrams()

The following method saves the side-by-side compare details from the last comparison to Excel. Default filetype is xlsx.

!!integrator.saveAsExcel(!filename is STRING)

The following method returns the array of diagram page names in the form <Diagram Name> Page- <Page Number>, for example A0-01-2012-0001 Page-1, for the last comparison.

!!integrator.diagramlist() is ARRAY

The results of the above method can be used in conjunction with the diagram viewer method (see below) to return a Diagram Page object and then save the coloured diagram page to a pdf file of the same name.

!list = !!integrator.diagramlist()

do !page values !list

!diagramPage = !!mmViewer.diagramPage(!page)

!diagramPage.saveAsPDF(!page)

enddo

The following methods have been provided to set flags to auto-link matched elements and auto-update attributes:

!!integrator.setCompareAutoLinkMatches(!Flag is BOOLEAN)

!!integrator.setCompareAutoUpdateAttributes(!Flag is BOOLEAN)

If these are set true then the next use of the compare method will perform these functions.

Integrator link information stored on CYMLNK elements includes references to the linked elements. It is possible during project execution for these references to become invalid when elements are deleted. A method is provided to clean up CYMLNK elements with invalid references.

!!Integrator.validateLinks()

Caution:
This method should be used only when all of the databases holding elements that have been linked are current on the MDB.

The following method can be used to clear the Integrator 3D graphical view drawlist:

!!integratorSupportHandler.intdrawlist().removeall()