Importing Data into Operator10/Synexus

The Operator10/Synexus Import Utility (ImportUtility.exe) allows seamless integration of data from other applications into the Operator10/Synexus database, and may be used to import data to multiple Facilities. The utility must be run from the directory where the Operator10/Synexus Application (Operator10.exe) is located. It runs transparently, and can be run without interaction from the user. Basic information and all errors are recorded in the "Import.log" file.

 Default Usage:

The following information relates to the default usage of the ImportUtility.exe application:

  • The data import file must named using the following file extension .imp.
  • The data import file must be stored in the Database directory.
  • The notes import file must be named using the following file extension .impnote.
  • The notes import file must be stored in the Database directory.

Custom Usage:

To make use of custom settings, edit the Database Properties for Import Settings. The following information is provided in order to customize the usage of the ImportUtility.exe application:

  • Import files path: - the path used by the ImportUtility to find and access files for importing; set this path by clicking the [...] button.
  • Extension for import data files: - the custom file extension used by the ImportUtility to seek out data import files (Examples: .txt, .csv, .imp, etc.).
  • Extension for import notes files: - the custom file extension used by the ImportUtility to seek out notes import files (Examples: .note, .notes, .impnote, etc.).

The Import Utility will read through the default database directory or the defined custom directory and process all files matching the .imp/.impnote (default) or user-defined file extensions. Users will now benefit from the ability to process multiple incoming files from LIMS, SCADA, Historian and other exported data files.

Data Import - File Structure:

Each line in the data file must either be:

 Blank

A comment, beginning with a semicolon ( ; ) or tab

A data line consisting of:

A Date

A space and a Time (optional)

A comma (,) or tab

A Facility ID

A comma (,) or tab

A Location

A comma (,) or tab

A Parameter

A comma (,) or tab

A Data value

optionally, if the Data value is numeric:

A comma (,) or tab

A DataType number (See the Data help topic for more information about data types and equivalent values.)

 NOTES:
 - There should be NO spaces before or after commas.
- Imported data fields may be enclosed in double (") or single (') quotes.
- All portions of the line must be valid in order for the import to succeed.
- The Date may be in any of the supported OP10 date formats.
- The Data value may be a numeric value, or a Less Than, Greater Than, Alpha Code, etc.

Example #1:

The following line:

 09/01/00,001,Plant If,Flow MGD,1.600

 imports a numeric daily data value of 1.6 into the Facility referenced as '001', using Location 'Plant If' and Parameter 'Flow MGD'.

 Example #2:

 The following line:

 09/01/00 10:00,001,Plant If,Flow MGD,1.600

 imports a numeric hourly data value of 1.6 into the Facility referenced as '001', using Location 'Plant If' and Parameter 'Flow MGD'.

Example #3:

 The following line:

 09/01/00,001,Plant Ef,BOD,2,2

 imports a numeric daily data value of <2 (data type = '2', or less-than) into the Facility referenced as '001', using Location 'Plant Ef' and Parameter 'Flow MGD'. (See the Data help topic for more information about data types and equivalent values.)

Data Notes Import - File Structure:

A secondary data file named "OP10Note.impnote" may be imported into the Operator Notes database as Data Notes (QuickNotes). It must also reside in the License directory. Each line in the note file must either be:

Blank

A comment, beginning with a semicolon ( ; ) or tab

A data line consisting of:

A Date

A comma (,) or tab

A Facility ID

A comma (,) or tab

A Location

A comma (,) or tab

A Parameter

A comma (,) or tab

A Note (1 through 2000 characters)

NOTE:
 - Use a backslash character "\" to represent any ends of lines within the Note field.
- Imported data fields may be enclosed in double (") or single (') quotes. Use quotes to enclosed notes which contain commas (,) in order to allow for proper import into database. Non-enclosed notes containing commas will cause the import utility to fail for the entered notes.

Example #1:

 The following line:

 09/01/00,001,Plant If,Flow MGD,"This is a data note.\This is a new line in my data note."

 imports a quick note into the database for the Facility referenced as '001', using Location 'Plant If' and Parameter 'Flow MGD'.

ImportUtility.exe Usage:

The Operator10 Import Utility must be aware of the server and database to which the user will be importing data. This information can be provided in several ways:

  • Manually: When running ImportUtility.exe as an application, i.e. double-clicking the application file ImportUtility.exe, a prompt for the Database/Facility window will appear and users are required to select a server and database from this window. The utility will then begin the import.
  • Command line: When creating a shortcut or running the import from a command line prompt, users may include the server and database in the command line as follows: C:\Program Files (x86)\AllMax Software\Wastewater\ImportUtility.exe "localhost,WASTEWATER"

    In the above example the command-line parameters of localhost (server name) and WASTEWATER (database name) are provided to ensure correct import.
  • via Scheduling: When using the Setup Schedules option (Tools ribbon, Scheduling group, [Setup Schedules] button), server and database information is automatically included when the import is scheduled.
  • Automatically: When a user calls the Import Utility from within a running Operator10 application, the program is aware of the current database and server on which the database is located. Call the Import Utility from the Tools ribbon, Import/Export Data group, [Import] button, then [Import Now].
  • Browse for Import Files: Users may process one file at a time as desired utilizing the Browse for Import Files functionality. Go to the Tools ribbon, choose [Import], then [Browse for File] to browse for file(s) for import into the database.

 NOTE: Browse for Import Files will allow users to select files matching the defined (or default) file extensions as found in the Database Properties section.