Using iFIX Pictures With Portal PDF
Using iFIX Pictures With Portal PDF
Using iFIX Pictures With Portal PDF
Version 6.0
OCTOBER 2018
Disclaimer of Warranties and Liability
The information contained in this publication is believed to be accurate and reliable. However, General Electric Com-
pany assumes no responsibilities for any errors, omissions or inaccuracies. Information contained in the publication is
subject to change without notice.
No part of this publication may be reproduced in any form, or stored in a database or retrieval system, or transmitted
or distributed in any form by any means, electronic, mechanical photocopying, recording or otherwise, without the
prior written permission of General Electric Company. Information contained herein is subject to change without
notice.
Trademark Notices
All other product names and marks identified throughout this book are trademarks or registered trademarks of their
respective companies. They are used throughout this book in editorial fashion only. No such use, or the use of any
trade name, is intended to convey endorsement or affiliation.
No part of this publication may be reproduced in any form, or stored in a database or retrieval system, or transmitted
or distributed in any form by any means, electronic, mechanical photocopying, recording or otherwise, without the
prior written permission of GE. Information contained herein is subject to change without notice.
We want to hear from you. If you have any comments, questions, or suggestions about our documentation, send them
to the following email address:
[email protected]
Table of Contents
Before Starting 2
Export Pictures 5
To export a picture: 7
Importer Log 8
Data Control 11
Grid Control 12
ListBox Control 12
ComboBox Control 12
Example Scenario 14
Additional Scenario 14
Index 17
iFIX pictures can be used in Real-Time Information Portal displays without having to entirely recreate the
pictures as Portal displays. First, in iFIX, an export utility is used. The export utility converts iFIX pictures to
a common format that can then be imported into Portal. The main purpose of the export/import process is
to maintain visual integrity of the iFIX picture, and additionally, it captures animations, data source defin-
itions, and simple commands, where there are direct equivalents in Portal. Using this method, you can
speed the process of creating Portal displays based on existing content from iFIX.
Before Starting
Before using the iFIX export/Portal import utility, ensure that the following are installed (as a minimum
requirement):
The following sections provide a breakdown of the iFIX elements that are supported for exporting as Portal
displays.
l Bitmaps supported with the exception of the `transparent' feature. If transparent bitmaps are
imported, the images may not display correctly in Portal.
l Graphic Connections
All of a shape's default and custom connection nodes are exported as bitmaps, and are described
so that you can understand which objects are connected to each other. Each connected node on an
object (e.g., a rectangle) has a corresponding connected node on the connector object (e.g., a line
connector). The bitmaps of the two connected nodes should be located in the same place; however,
pixel rounding errors can cause the bitmap locations to no longer match. Therefore, each con-
nected node is fully described to provide more information to tell you which objects are connected.
l Groups
l Buttons
l Basic Animations Color, Position, Visibility, Size, Fill, Scale, and Rotation
Text and Datalink objects function differently in iFIX and Portal when fill percentage animation is
applied to a group. In iFIX, a Datalink or text object in a group participates in the fill percentage
animation set for the group; in Portal, the Datalink or text object in a group does not participate in
the fill percentage animation. For example, in iFIX, if the fill animation of the group is zero, the tex-
t/datalink does not appear. In Portal, however, if the fill animation of the group is zero, the tex-
t/datalink does appear.
l Fonts font style will match if the font exists on the Portal client machine.
l Picture sizes will be an exact match if screen resolutions are the same. If screen resolutions are dif-
ferent, picture size is based on absolute pixels.
l ActiveX objects:
l Text Box (Microsoft Forms 2.0)
l List Box (Microsoft Forms 2.0)
l Combo Box (Microsoft Forms 2.0)
l Charts Historical (GE Historian) and Real-time charts.
IMPORTANT: You must pre-configure your data source for GE Historian before you can import an .SVG file
with GE Historian information into Portal.
Export Pictures
The Export Pictures dialog box allows you to export the selected picture files to the specified location.
Export Location
Specifies the location that the selected pictures will be exported to. You can create a new location that is
one, non-existent, folder deeper.
The default export location is "C:\Program Files (x86)\GE\iFIX\PIC\ExportFiles\". You can create only one
new folder to follow the ExportFiles folder; for example, "C:\Program Files (x86)\GE\iFIX\PIC\Ex-
portFiles\MyExportFiles\".
Picture Location
Files of Type
Select All
Deselect All
Invert Selection
Use this button to change your file selection to the opposite. For example, if you have only the first picture
file in the list selected, clicking this button will change the selection so that all of the files are selected
except the first one.
Select this check box to indicate that existing export files, in the same export location, will always be over-
written when you perform a new export.
Export
Click this button to export the selected picture files to the specified location.
Cancel
Click this button to close the Export Picture dialog box without saving any of your changes.
The basic process of converting iFIX pictures for use in Portal displays is as follows:
1. In iFIX, use the Export Picture utility to export the pictures/tag groups. The pictures/tag groups are
converted to a new format (.svg or .xtg respectively).For more information, referto the Exporting
iFIX Pictures section.
2. In Portal, use the Import utility to import the converted files. See Importing iFIX Pictures into Portal.
3. To examine the import process in detail, look at the importer log. See Importer Log for more inform-
ation.
4. Configure or run the imported pictures using Portal.
After the export has completed, if you need to move the files to a new location, select all files with the
extensions .svg, .xtg, .xml, and .png, along with all sub-folders that have the name of the exported pictures.
NOTE: When exporting pictures that reference a Historian server, make sure that you export the pictures from the
View/SCADA node that they run on. Pictures that reference a Historian data source via an 'alias' may not ref-
erence the correct server after being exported.
To export a picture:
1. In Classic view, on the iFIX WorkSpace toolbar, click the Export Picture button.
If you do not see the Export Picture button:
a. From the WorkSpace menu, choose Toolbars.
b. From the Toolbars list, select Utilities. The toolbar appears with the Export Picture button.
-Or-
In Ribbon view, on the Applications tab, in the Utilities group, click Utilities, and then click Export Pic-
ture.
2. On the Export Picture dialog box, choose a location for the files to be exported to. You can either
type the location into the Export location box, or click the Browse button and select the folder from
the directory tree.
3. Select the location of the files to be exported. You can either type the location into the Picture loc-
ation box, or click the Browse button and select the folder from the directory tree. When you select
the location, all the exportable files appear in the list below.
NOTE: If you are exporting files to a remote location, you must use a mapped network drive. For instance,
you can not export files to \\MYServer\Program Files\Proficy\Proficy iFIX\PIC\ExportFiles\ directly. Instead,
map to that location and use the mapped drive in the export location.
4. From the Files of type drop-down list, select the type of files that will be exported (Picture and/or
Tag group files). The file list changes to reflect your file type choice.
5. From the list of files, select the ones that you want exported:
l Click the file you want to export. You can hold down the Ctrl or Shift key and click additional
files if necessary.
- Or -
l To select all files, click the Select All button (click the Deselect All button if you want to
deselect all files).
6. If applicable, select the Always overwrite existing export files check box.
7. Click the Export button to export the selected files.
NOTE: Export log files will be created for every picture and tag group file that is exported. These log files are loc-
ated in the export directory you have chosen.
After importing, if the import fails or there are warnings, you will receive a message, and affected files
appear as follows:
1. In Portal, make sure you are in Configure mode (click the Configure button on the main toolbar if
you are in Run mode).
2. From the File menu, choose Import Display. The Import dialog box appears. All files available for
import are listed. Available files are files that are in the following location:
C:\Program Files\Proficy\Portal\webapps\infoAgentSrv\ImportFiles
3. If you want to see exported picture files only, or exported tag group files only, from the Files of Type
drop-down list, select the specific type of file. The list of files changes depending on your selection.
4. Select the files that you want to import.
l Select the check box beside each file you want to import. If necessary, you can click the
Invert Selection button to switch all selected/deselected files.
- or -
l If you want to select all files, click the Select All button (click the Deselect All button to
deselect the selected files if necessary).
5. Select the Automatically Overwrite Duplicate Files check box if necessary. If you select this check
box, you will not be notified when a file has been overwritten by an imported file with the same
name. If this check box is cleared, files that exist will not be overwritten, and the import will con-
tinue for the other selected files.
6. Click the Import button. You will receive a message stating the import has completed. Click OK on
the message.
7. If you want to view logs for the import, click the Show Logs button. A log report is shown for each
imported file. For more information on the importer log file, see Importer Log.
NOTE: If an import of multiple files is cancelled, and there are files that were not processed, they will appear light
gray in the list.
Importer Log
After importing an iFIX picture, you can view the log file to see the results of the import. To see the log file,
click the Show Logs button on the Import dialog box immediately after the import has completed.
l Performance Messages this section will include information such as warnings for the number of
objects supported by the importer. You will see a warning if any of the following limits are
exceeded during an import:
l Other Messages this section steps through the import process in order. This can be especially use-
ful when troubleshooting. The types of messages (levels) you will see are info, warning, and error.
VisiconX objects are part of iFIX and are used for displaying data from and connecting to relational data
sources via OLE DB providers.VisiconX is a suite of the following four ActiveX objects:
l Data Control
l Grid Control
l ListBox Control
l ComboBox Control
The iFIX WorkSpace is the container for the objects. The Data Control connects to a relational database.
The Grid, ListBox, and ComboBox Controls display the data retrieved by connecting to the Data Control
through object-to-object animation.
The following illustration depicts how VisiconX works within the iFIX WorkSpace. In the following figure,
each Data Control is configured to access an OLE DB data provider.
l Data Control 1 animates the Grid Control, which displays the retrieved data in a spreadsheet-like
format.
l Data Control 2 animates the ListBox Control.
l The ListBox Control animates the query property defined in the SQL Select statement of Data Con-
trol 1, which in turn filters the data displayed in the Grid Control.
Portal has much of the same functionality and is used for building similar types of applications, through
there is no direct match-up between VisiconX and Portal components. The following table shows the map-
ping of VisiconX components into equivalent Portal functionality.
The first two dialog boxes of the VisiconX data control provide the information needed to configure the
data source connector.
The Provider tab identifies the data source. To configure the data source connector requires the ProgID of
the selected provider. In the case of the selected Historian OLE DB Provider, the ProgID is IhOLEDB.iHis-
torian. Connection to the data source is managed at the server and is not configurable. The author of the
OLE DB provider should define the ProgID in the provider documentation.
The Database tab provides the other details of the OLE DB connection string. These map into the URL for
the jadoZOOM ADO bridge JDBC driver provided. The format of this URL when used for OLDBD con-
nections is as follows:
jdbc:izmado:Provider=ProviderName;Server=ServerName;Database=DatabaseName;[property=value;]
Where:
User name and Password directly map to the data source configuration, while options for password
prompting and use of Windows integrated security are configured per user or role.
The final Record Source tab allows configuration of the data returned. The drop-down list roughly cor-
responds to the schema definition in Portal, by selecting either tables, SQL commands, or stored pro-
cedures. Refer to the following for details:
In general the simple case of connecting the ADORecords property of a Data control to the ADORecords
property of the Grid control to have the grid provide a data bound display of the record set, is the equi-
valent of a Portal Grid component connected to an equivalent SQL statement. Other applications using dif-
ferent properties and methods need to be evaluated individually to determine equivalent functionality.
ListBox Control
The VisiconX ListBox control is equivalent to the Portal ListBox control. While both items perform similar
tasks, specific functionality varies between the two.
In general the simple case of connecting the ADORecords property of a Data control to the ADORecords
property of the ListBox control to have the list box provide a data bound display of the record set is the
equivalent of a Portal ListBox connected to an equivalent SQL statement. Other applications using different
properties and methods need to be evaluated individually to determine equivalent functionality.
ComboBox Control
The VisiconX ComboBox control is equivalent to the Portal ComboBox control. While both items perform
similar tasks, specific functionality varies between the two.
In general the simple case of connecting the ADORecords property of a Data control to the ADORecords
property of the ComboBox control to have the combo box provide a data bound display of the record set is
the equivalent of a Portal ComboBox connected to an equivalent SQL statement. Other applications using
different properties and methods need to be evaluated individually to determine equivalent functionality.
The following sections describe scenarios that may be common to your import/export process, and
provide optimization tips to help with the conversion of iFIX pictures to Portal displays.
If a data source in an iFIX picture or tag group file uses "THISNODE" (local node aliasing), the import will cre-
ate an iFIX data source with the logical node name set to THISNODE.
In iFIX, tag substitutions for data sources do not require that the data server is specified. In Portal, how-
ever, data source substitutions that do not specify the data server are interpreted as string data rather
than as data sources.
To import tags that use data source substitutions you must ensure that the fully qualified name is specified
for tag groups. To do this, in the iFIX Tag Group Editor, click the Get Full Name button for all tag groups that
use partial names (and save).
When data sources reference data servers that are not installed on the iFIX node, the import into Portal
will not be successful. For example, if an iFIX picture is developed on an iFIX node with animations data
sources that point to a data server on the same node, and then the picture is exported to another iFIX node
that does not have that data server, animations referencing the data server will not be imported.
NOTE: Data servers are added to the iFIX node through the Data Server Installer.
To avoid this, it is recommended that as part of your import planning you synchronize the names of the
existing data sources as much as possible. The easiest solution to the previous scenario is to use the Data
Server Installer in iFIX to rename LNX to RSL, and then to use the iFIX WorkSpace's advanced search and
replace to fix the references.
Additional Scenario
Starting with iFIX 3.5, a dataserver available to workspace may be run on another machine using DCOM.
The OPC data source for Portal does not use DCOM to communicate with remote servers. The connector
itself is used remotely (see the Configuring a Remote OPC/PI/CIMPLICITY Server topic in the Portal online
help for more information) . Since the importer will be unable to create a remotely configured data source,
the data source that will be created will be local. If the OPC server is not installed it will not work, and you
will need to edit the data source in the Administration application before it can serve data.
It is recommended that as part of your import planning you pre-create any remote (DCOM) data servers in
the iFIX WorkSpace. The created data sources should have a logical name that matches the data server
name in the iFIX system.
For example, in iFIX, a system has a DCOM data server [example name: IDS] looking at OPCSERVER_DS on
a remote computer - RE_MACHINE. In order to have pictures that reference the remote server import cor-
rectly, and have available data without modifications, the following actions must be performed:
1. Install the RIF server on the RE_MACHINE. Refer to the Configuring a Remote OPC/PI/CIMPLICITY
Server topic in the Portal online help for more information.
2. Configure a server for the remote OPC data source in the RIF Configurator. Refer to the RIF Con-
figurator online help for more information.
3. In Portal, create a new OPC data source, remote to RE_MACHINE, referencing the information from
step 2 named IDS.
After completing these steps, when an import takes place, IDS will be used, and data will be avail-
able.
When an iFIX picture is exported, username and password information is not exported. After the picture is
imported in Portal, if security credentials are required, you must add this information to the appropriate
FIX data source in the Portal Administration application.
If this is the case, you will receive warnings in the import log stating that the default information has been
used.
To correct this, in the Portal display, open the symbol file and configure the data source accordingly. For
more information on how to do this, see the Symbols and iHistorian Data Sources topics in the Portal
online help.
You may encounter memory errors while attempting to import either one very large file, or a series of
files. If this occurs, you will receive a message stating that there has been a memory error. Any files that
were selected for import but not processed appear light gray in the list. It is recommended that you restart
your web browser after receiving this error.
5. Click OK twice to save your changes and close the Java control panel.
When the import is complete, remove the -Xmx256m.
NOTE: In some extreme cases, the import will never return (that is, the Import utility is unresponsive). If this occurs,
cancel the import, restart your browser, and follow the same steps to prevent the problem (see previous bullet
points).
For example, the text in a picture is 22-point font when the screen resolution is set to 1289x1024. If auto-
scaling is enabled, and the same picture is displayed with a screen resolution of 1024x768, the text
appears as 16-point font. When the picture is exported on a system with the resolution set to 1024x768,
however, the text object is exported as 22-point font (no scaling).
After importing an iFIX picture, you may notice that a text or datalink object with a background color is not
centered correctly with respect to the background of the object.
This is due to a difference in the way iFIX and Portal handle positioning. In iFIX, objects are centered ver-
tically with respect to the background of the object. In Portal, the objects are in line with the top of the back-
ground (not centered vertically).
After importing an iFIX picture, you may notice that a pie object does not maintain the same shape it had in
the iFIX picture.
This occurs when a pie object (with a wedge style) is resized in iFIX. In Portal, the ability to draw the flatter
ellipse for the arc wedge does not exist, and therefore the importer cannot set the arc radius to match the
same in iFIX.
export pictures 5
importer log 8
importing pictures 7
VisiconX objects 10
importing tags 13