APOGEE Graphics Importer Overview

The APOGEE Graphics Importer conversion tool allows you to import and convert Insight graphics to use in the management station. Graphics that have been exported out of the Insight Management workstation, and reside in a Graphics folder locally, can be imported. Each graphic has a folder that contains an .XML file with all the information about the graphic, associated data points, controls, and links. This information is then used during the import process to associate the controls with the management station Symbols from the BA_Device_APOGEE_Graphics HQ_1.gms library, and then generates a Desigo CC graphic (.CCG) that is viewable and editable in the Graphics Viewer and the Graphics Editor.

For a list of the controls and how the attributes and links associated with the graphic are converted, see the section Support and Limitations When Converting APOGEE Graphics.

Prerequisites

To import the APOGEE Graphics, there are several tasks you must perform prior to importing to the management station.

  • You will need to export the Insight graphics out of the Insight database, using the Desigo CC Export Utility and Commissioning Tool in online mode. The exported graphic files are stored in a Graphics folder, ready for import into the management station.
  • If you have restored your Insight database, you must have copied your files from the CT "Jobs" folder to your default database folder.
  • The APOGEE Graphics extension module is installed. This is done either during a Desigo CC installation, or if the software is already installed, you can run the installation wizard again, and just install the extension module. The supporting library: BA_Device_APOGEE_Graphics HQ_1.gms/ is included in the installation. This library contains the Symbols that are associated with the APOGEE graphic controls during the import process and added to the final graphic that is generated in Desigo CC.
  • The APOGEE Driver has been created and installed.
  • You have created a Symbols folder in the System Settings > Libraries > L4-Project > Common > Common > Common_Data_Project_1 folder. Otherwise, during the import you will be prompted to create a Symbols folder. If a Symbols folder does not exist, the Symbols are not imported.

Export Folder File Structure

Once you have extracted your APOGEE graphics out of Insight using the Desigo CC Export Utility, a Graphic folder containing all the exported graphics is generated.

The following file structure applies for the exported graphics:

Graphics – This is the root folder that contains one folder for each graphic exported out of the Insight database.

  • Individual graphic folder using the graphics name – This folder contains all the information and graphics related to the graphic, as follows:
    • XML file that contains all the data pertaining to the graphic
    • A .PNG version of the graphic that is used as a thumbnail for use with Desigo CC
    • Folder for each graphic attribute or controls, such as Background, Pictures, Animation, Links, and so on. For example, if an APOGEE graphic has a background and animation associated with it, the graphic will have two subfolders: one Background, and one Animation folder.
    • Each attribute folder contains the graphic in the original file format, such as Micrografx™, .DSF, IMG, .GIF, and so on.

Graphics Import Conversion Tool

The conversion tool allows you to import your exported APOGEE Insight graphics into specified Desigo CC Graphics folders. The import tool is in the Management View > System Settings > Conversion Tools directory.

From the APOGEE Graphics tab, the Graphics Folder Selector allows you to navigate to the directory that contains the graphics for import. Once selected, the graphics display in the APOGEE Graphics tab and you can specify which Graphics folder to import them into. If a folder is not selected for a graphic, then the graphic is imported to the Graphics root directory.

When you save the above selections, the migration of the APOGEE Insight graphics is initiated. Upon completion a status message displays for each graphic, indicating if the import was successful, failed, or partially successful. If the import of was a success, a Desigo CC graphic (.CCG) is created and automatically displays in your Application view, Graphics folder. The Symbols, however, display in the System Settings > Libraries > L4-Project > Common > Common > Common_Data_Project_1.

Status Messages

When you import an APOGEE graphic using the Graphics Importer conversion tool, there are three status messages you may see related to the import of a particular graphic: Failed, Migrated with Errors, or Not Migrated. To view what the errors are, navigate to the Graphics Import log: GMSMainProject > _[DefaultProject] > Temp > GraphicsImportLog.

Information
NOTE:

All parent-child linked graphics must be selected for either the parent or the child graphic to be included in the import operation.

The two error statuses generally indicate the following:

  • Failed – There is a problem with the graphic name, and nothing has been imported.
  • Migrated with Errors – Indicates that there was a partial import of the graphic file. Generally, the graphic image has been imported, but the data points have either not been found or, in the case of some EGO controls, truncated and will not display.
  • Not Migrated – The graphic has not been migrated. If any linked graphics are not selected for import, the parent graphic will not import as well.

Support and Limitations When Converting APOGEE Graphics

Once you have imported your APOGEE Insight graphics, you can view and use the graphics, along with the associated data points. Most Insight graphics features are fully supported in Desigo CC. However, there are some limitations. The table below lists the support and limitations in migrating APOGEE Insight graphics to a Desigo CC management station.

The font color and general color properties for Point Information Blocks are taken from the information contained in the Insight State Text tables for that control. If you want to change the color settings, you must either do so in the State Text tables in the Insight software, or, once you have imported the graphic, you can change the color settings in the Graphics Editor.

Insight Graphics Conversion – Support and Limitations

Insight Graphics Feature

Management Station Support

Backgrounds

  • Full conversion.
  • Micrografx Designer backgrounds from APOGEE are converted to a PNG format to display properly.
  • The converted PNGs cannot be modified using the Graphics Editor.

Information Blocks

  • Converted to include the same information that displays in Insight software.
  • Size and position maintained relative to the background.
  • Color changes for non-analog points based on Point Value, according to the Text Group associated with the associated object. For analog points, the color representing the NORMAL alarms state displays. The alarm status of the point is indicated.
  • Status changes display in the Graphics Status and Commands window.

Associated Points

  • Converted as a rectangle outline around the area where the Associated Point displayed on the original graphic.
  • Outline changes color based on Point Value according to the Text Group associated with the associated object.
  • Setpoints feature is not supported.
  • The management station does not support changing the background image of converted Insight graphics based on point conditions.

Analog Bars

  • Displays Input and Output.
  • Drag commands not enabled.
  • Uses Desigo CC commanding.

Arrow Controls

  • Angle support limited to
    • 90゚
    • 295゚
    • 360゚

Animation

  • Full conversion.
  • New Symbol created based on exported property values.
  • Digital, ENUM, or no point – default speed is set to zero. If more than one Digital or ENUM value exists, the faster speed is used.
  • Analog Animation – Default speed x1.5.
  • Animation speed is evaluated using a Discrete Evaluation.
  • Symbol size reduced by 2 pixels to compensate for the APOGEE borders not present in Graphics Editor.

Picture Controls

  • Full conversion.
  • New Symbol created based on exported property values.
  • Images in Symbol are stacked in the order that they display in the directory; from top to bottom.
  • Default Visibility is set to False, with a discrete evaluation based on the value of the point associated to the Symbol.
  • Analog values are set to True for Low and High value range. Top image is visible if there is more than one image for a value or value range.
  • Symbol size reduced by 2 pixels to compensate for the APOGEE borders that are not present in Graphics Editor.

Command Controls

  • Converted as Point Information Blocks.
  • Uses management station commanding.

Standalone Graphics Links

  • Converted as Stand–alone Graphics Links.
  • Saves as a Symbol with substitutions.

Alarm Associated Graphic Links

  • Converted as Stand–alone Graphics Links.
  • Uses standard alarm propagation.

Advanced Link

  • Links to files are maintained. Files are added as management station documents, if you are importing to an installed client. Links to files are not maintained if you are importing from a web client.
  • Links to web URLs are maintained. URLs are added as management station documents.
  • Links to applications supported by management station are maintained.
  • Links to field panel objects are maintained.
  • Management station object links are not maintained.

EGO Controls

  • Displays as Point Information Blocks with two visible properties in two columns: Object Name and Value.
  • The relative size of the control, that is, width and height, are maintained.
  • The font size of the properties is fixed at 8.5.
  • The following applies to what displays in each Point Information Block, depending on the original control:
    • If no data points are associated with the control - Point Information Block displays with no content and just the outline that is relative to the controls original size.
    • If the original control size is narrow, it may be too narrow to support two columns - Point Information Block only displays the Object Name properties in the management station.
    • If a large number of data points are associated with the control and exceeds the limited space (height) of original control size, the excess data points that don’t fit in the Point Information Block are truncated and listed in the following location: C:\Users\[logged in user]\AppData\Local\Temp.