Show only results for:











ReportAdapter for SmartPlant® Electrical

ReportAdapter for SmartPlant® Electrical is designed to export a SmartPlant Electrical database into a Microsoft Access file, containing one table per task. The extraction of all data can be done without any knowledge of SmartPlant Electrical specific report creation. Plant breakdown structure filters can be used for extraction.

Prerequisites

  • Supported operating systems:

  • Microsoft Windows XP

  • Microsoft Windows Server 2003

  • Microsoft Windows Vista

  • Microsoft Windows 7 or later

  • Intergraph SmartPlant Electrical 2007 SP 1 or later

ReportAdapter for SmartPlant® Electrical requires SmartPlant Electrical licence seat on a SmartPlant Licence Server.

Setting up ReportAdapter for SmartPlant® Electrical

Extracting Data

Start ReportAdapter for SmartPlant® Electrical and select your plant from the combo box:

The plant breakdown structure of the selected plant will be displayed in the Plant breakdown structure filter field. Check the parts of the plant breakdown structure that shall be included during extraction.

Browse with the () button to select a location or type in the path and filename to create a Microsoft Access database file in which the results will be shown.

All the settings are stored automatically in the configuration file which is found under Tools → Settings.

Start the process by clicking the Extract button.

If the specified Access database already exists. A message box will appear whether to overwrite the existing file or not. In case of overwriting it, a backup of the existing file (.bak) is created first. A possibly existing backup file will be overwritten with the new backup.

To modify or add new attributes to the resulting Access database see “Configure Attributes”.

Configure attributes

ReportAdapter for SmartPlant® Electrical does not contain a predefined set of attributes which are reported by default. After starting the program for the first time, customer has to define and configure by his own. No database specific or programming knowledge is required.

Attributes are configured by task (Wiring, Electrical, PowerDistribution, ...). From the left side (Available attributes) user can access the attributes from SmartPlant® Electrical. The right side (Used attributes) contains the already predefined attributes. Drag the desired attributes from the left side to the right side or check them and use the > button. Drag from right to left or use the < button to remove attributes from the Used attributes list. A maximum of 230 attributes per task can be selected. If this number is exceeded the task will get a red font colour.

The display name of every attribute and the name of the originating table are shown on tooltips.

Press OK to finish the configuration.

The changes will be applied on the next extraction.

Additional SQL statements

Create additional SQL statements

SQL statements to extend standard output tables with user defined attributes or to perform some other tasks (like creating additional tables, queries) can be defined using Tools → Additional SQL statements. They will be executed automatically after the extraction process has been completed.

The additional SQL statements can be typed in the Additional SQL statements to be processed after extraction field. They have to look like the following examples:

SQL1=ALTER TABLE Equipment ADD COLUMN [MyAttribute] VARCHAR(255)

SQL2=UPDATE [Equipment] SET [MyAttribute] = 'Test'

Tables that can be used in the queries are those that will be created during extraction. Additional tables (if needed) have to be copied before extraction to the Template.mdb database which can be found in the application folder.

Use query builder

The included query builder can assist to create the SQL statements. Create a new statement with the Add button and add one of the Available SQL query templates to it. Add query or double-click on a list item will add the query at the cursor position or replace the selected text.

The Available SQL query templates look like:

UPDATE [%TABLE1%] SET [%TABLE1%].[%COLUMN1%]=

When the template is used, the %TABLE1% and %COLUMN1% fields will be filled with the table name and column name selected in the %TABLE1% and %COLUMN1% fields.

The %TABLE1% and %COLUMN1% fields are filled from the Access database defined for extraction output, which also includes the tables from Template.mdb. This means, the fields are only filled after the extraction was performed once.

With the Show hidden tables field checked, all tables of the database can be selected to build the query. If it is not checked, only tables that will be displayed in UniversalReporter are available and tables created for internal use are hidden.

Create new SQL query template

User defined SQL query templates can be created. To add a new template, click the Add button and enter the template name.

Fill in the text of SQL statement and the Placeholders for Tables and columns to be used by query textboxes by using the %TABLE"1% and %COLUMN1% buttons.

User defined templates can be deleted or modified using the Remove or Edit buttons.

The SQL text boxes support syntax highlighting.

Settings

All program settings (selected tasks, attributes and plant breakdown structure filters) are stored automatically for each plant in the configuration file located by default in the user profile folder. The location of the configuration file can be changed by using menu Tools->Settings.

Load settings from file

To import settings into the plant configuration file use menu “File->Load settings from file”.

The location of the plant configuration file is not affected, only the content of the file will be overwritten.

Save settings to file

To export the settings from the plant configuration file use menu “File->Save settings to file”.

The location of the plant configuration file is not affected.

Content of result database

When extraction process has finished, resulting database in Microsoft Access is available in the specified location. The database contains the configured tasks and attributes. Some key attributes (e.g. SP_ID, SP_PLANTGROUPID) are extracted independent of being configured or not. These are needed for internal use.

Command line mode

The ReportAdapter for SmartPlant® Electrical can be used from the command line to automate the extraction out of SmartPlant Electrical data.

To get the ReportAdapter batch mode help, type in the installation path of ReportAdapter followed by “\El ReportAdapter.exe” /?, e.g.

C:\>“C:\Program Files\CAXperts\El ReportAdapter\El ReportAdapter.exe” /?

"El ReportAdapter.exe" [/config config_file.ini] [/output output_file.mdb]

/config config_file.ini

 Path and filename of the configuration file which contains the settings for the extraction related to the plant to process. Configuration includes tasks, attributes and plant breakdown attribute filter.

/output output_file.mdb

 Path and filename of the output database.