Chapter 5. Project Configuration

All back-end tasks shall be configured by IntegraXor Project Editor. Right click on *.igx file within the Windows Explorer and select 'Edit' to start the configuration work, Project Editor will be launched automatically.

Windows Explorer shell integration


The following convention applied in this document:

  • All changes must be saved, followed by restarting the task or tasks affected or the project itself, before the changes could take effect.

  • Most settings contain three essential columns, i.e. Name , Description and Enable checkbox. There might be different sets of additional column(s) depending on the task.

  • In setting, bold title (which corresponds to blue column header in configuration table in Project Editor) indicates the particular field or setting is mandatory, otherwise it is optional.

  • Italic text indicates that the particular field or setting is meant for system use only, no intervention required.

  • In script, remarks could be placed after two forward slashes //.

  • The settings shown in this document is merely a working example.

 Name Restriction

Every configuration table has a Name column. The following restrictions applied to this column:

  • The name should be unique.

  • The name should contain only alpha-numeric characters.

  • The name should NOT start with a number or a dot.

  • The name should start by letter or underscore.

  • Avoid using space, dash, mathematic, logical operators and all other symbols in name.

  • Try make it a valid JavaScript variable name to explot the power of Tag Expression.

  • Try to use only the 26 English upper or lower case characters and numbers.

 Sequence of Configuration

Although it is not a must to enter configuration data in sequence, it is our recommended best practice to enter configuration in the following sequence as layed out from top to bottom in Project Editor.

  • General - Setup project ID, logo and other settings specific to the project.

  • Timer - the engine of most, if not all task. As such the Timer in the template is preconfigured with some standard periods of time, like SEC01, SEC02, MIN01, MIN05, HR01, etc.. Add additional timer setting if the preconfigured timer does not meet the project requirement.

  • Tag - Setup how to communicate with I/O devices.

    • Port - Setup the communication interface, link or channel between I/O manager and devices. This is usually the serial port number or the IP address of the destination device.

    • Device - Setup the communication parameters specific to the device. This is usually the protocol, device ID and other device specific configuration.

    • Tag - Setup the parameters of each tag you want to read or write. This is usually the tag address, data type or other tag specific configuration.

  • Database - Setup how to communicate with databases. Database is used for Trending, Alarm and some user data.

  • Alarm - Setup the condition to trigger alarm. Alarm can only be configured after the relevant tag(s) is created.

  • The following tasks do not need to be configured in sequence, except script if it needs some tags to exist to make it relavant.

    • Output - Setup the channel to output messages to external parties.

    • Script - Setup complex actions to execute.

    • User - Setup security setting such as user, role and permission.