Integrator has been extensively updated since its first release at 12.0; some of the developments noted below were first introduced in the Schematics Update Release at 12.0.SP6.8.
13.1 New Integrator Object Method
Integrator link information stored on CYMLNK elements consists of references to schematic and 3D 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()
Note: This method should be used only when all of the schematic and design databases, holding elements that have been linked, are current on the MDB.
13.2 Electrical connections
When building an equipment with a template, Integrator will try to match schematic electrical connections to 3D electrical connections within the template. It already does this for nozzles which are matched on BORE, but for ELCONNs it now tries to match on CATREF. Details are included in the updated Integrator User Guide Section 5.4.1 Building Equipment.
13.4 Selector Rules
Quotes are no longer required in selector rules for long STYPs as Integrator will automatically include quotes for text selectors. For example, a rule with SCSTYP OF source operating on an SCVALV with SCSTYP PTFE-LINED will generate Choose with STYP |PTFE-LINED|.
13.5 Improved Links Administration
Integrator no longer automatically creates a Link World. Project administrators a re recommended to create a separate Design Reference database to hold links, and then use the new Manage Links dialogue, available from the Integrator > Settings menu. This can be used to create and manage Link Worlds in the appropriate database, including consolidating links from separate databases.
Manage Links is also available with the new Compare/Update Utility.
For More Information, please refer to the Integrator User Guide sections 4.7.16, 5.2 and 5.3.
13.6 Configuration Rules Extensions
Integrator‟s Project Configuration Explorer is now shared with the Compare/Update Utility, and so can hold rules for comparing elements between design, schematic and engineering databases. A Rule Set holds all the Rule Groups for a particular pairing of database types. For example, the sample configuration has a default Rule Set for comparing Design database content against Schematic database content. You can add Rule Sets for other combinations of database types, e.g. schematic and engineering, for use with Compare/Update.
Top level Rule Groups now have a source type which is the type of element for which they will be applied (in place of the condition setting type of source).
For More Information, please refer to the Integrator User Guide section 6.5.5.
13.7 Example Macro
Some users may prefer to use a macro to run the comparison. The example macro below compares all schematic equipment and pipelines that appear on a particular diagram:
-- File: compare macro for user guide.pmlmac
-- Initialise Integrator
!!integratorInit()
-- Collect schematic equipment and pipelines that appear on this drawing
!scgroup = |/Piping_Diagrams|
!sctypes = |SCEQUI SCPLIN|
!diagExp = |name of diaref eq '/A1-51-2003'|
!sccoll = object COLLECTION()
!sccoll.scope(!scgroup.dbref())
!sccoll.types(!sctypes.split())
!sccoll.filter(object expression(!diagExp))
-- Integrator compare method needs array of strings
!comlist = ARRAY()
do !element values !sccoll.results() !comlist.append(!element.ref.string()) enddo
-- Set report direct to file and do compa re
!!integrator.setreportvisible(false)
-- View the report unless running in non graphics mode if (not istty) then
!file = object FILE('c:\mac\compareReport.xml') if (!file.exists()) then
!!integrator.openreport() endif
endif endhandle endif
13.8 Simplified Selection of Configurations *12.1.SP4*
A simplified selection is now provided for end users to select an appropriate Configuration. For example, a basic check may be used early in a project when you just need to check for the existence of matching items and whether they are in the correct specification, whereas a full check may be needed as the data matures.
End users can no longer define Comparison Categories or set Comparison Options. These have been moved out of the main menu and now form part of the administrator‟s scope. Instead, end users select from a list of Configurations defined by an administrator. Configurations are shared across the project but each user‟s selection is preserved across sessions.
For more information, please refer to section 4.8 of the Integrator User Guide.
13.9 Administrative Flexibility with Configurations *12.1.SP4*
Integrator now allows an administrator to setup multiple Configurations for use on the project. For Integrator, an administrator is either a free user or a member of team CUADMIN (this team is also used by Compare/Update). End users can no longer view the Configuration Explorer.
Within the Configuration Explorer you can now define multiple sets of Compare Colours, Comparison Categories, and Rule Sets, and combine selections of these into Configurations. It is the Configurations that are then available to end users.
End users always access the default configuration file (ProjectConfiguration.xml in the appropriate project folder) so you need to save to this file to make any changes available to the project. Administrators can work with any filename, since any project configuration file opened in the Configuration Explorer becomes their current file. Thus you can test using a different file and save to the default filename when ready to deploy the changes.
Note: The administrator‟s current file is remembered across sessions.
The Project Defaults section has additional fields for the default Configuration, Colours, Category and Rule Set (these will be used if an appropriate selection cannot be identified).
A new Configurations section is where you create individual Configurations and allocate their Colours, Categories and Rule Sets. The Comparison Options have also moved here.
You can now define multiple sets of Compare Colours.
The Comparison Categories settings have moved inside the Configuration Explorer.
The configuration file can now hold many different Rule Sets with source SCHE and target DESI.
Integrator can still work with older configuration files but some tools are provided to assist upgrade. You can import user defined Comparison Categories into the Configuration Explorer (because these are user specific, you will only get those that you yourself have previously defined for this project).
You can import Rule Sets from old configuration files, thus allowing you to combine the contents of multiple files into one new file and removing the need to rename configuration files.
For more information refer to section 6 of the Integrator User Guide.
13.10 Changes to PML Methods *12.1.SP4*
New PML methods are provided to select a particular configuration file, to get the list of Configurations defined in the current file, and to select a Configuration. Other methods return the names of the current Configuration, Compare Colours, Category and Rule Set.
The methods setComparisonCategory, getReportCheckPosition,
setReportCheckPosition, getCompareNoHierarchy, setCompareNoHierarchy and compareStrictlyLimited have been deprecated and will now return an error if called.
A new PML method is provided to allow individual objects to be coloured on the Diagram Viewer. This could be used, for example, to colour the diagram according to user defined criteria such as status values.
For more information refer to section 7 of the Integrator User Guide.
13.11 Information for Comparison Categories *12.1.SP4*
The behaviour of the Compare Report in response to Comparison Category settings has been changed.
When a category of difference is switched off, relevant rows in the Compare Report lower Data panel will no longer be shown.