Skip to main content

i4scada Knowledge Base

Studio Project Tutorials

Abstract

Our i4scada Studio Project Tutorials are only available for viewing on this site. Take a peak on how to configure your Database, Alarming and Logging system.

Using Studio on high resolution screens
Abstract

Check out this tutorial to learn how to adjust your view when using a high-DPI device, such as 4K or higher resolution monitors.

When using a high-DPI device such as a 4k and higher resolution monitors, one may encounter Studio scaling issues (e.g.: elements are too small or too large, compared to the rest of the desktop). To resolve this issue, organize the following settings:

  1. Install i4scada application.

  2. Go to This PC > Local Disc (C) > Program Files (x86) > i4scada > Studio.

  3. Scroll until reaching the Studio application.

  4. Click-right on the Studio icon and select the Properties option from the contextual menu.

    Studio_properties_select.jpg

    Studio Properties

  5. In Studio Properties window switch to the Compatibility TAB.

    Compatibility.jpg

    Studio Compatibility

  6. Click on the Change high DPI settings button.

    Change_high_DPI_settings.jpg

    Change High DPI settings button

  7. A new window is opened, which features the high DPI settings for the Studio application. Mark the "Override high DPI scaling behaviour" checkbox and select the "System" option from the "Scaling performed by" drop-down list.

    Setting.jpg

    Override High DPI scaling

  8. To preserve all the changes, click the OK button. The high DPI settings for the Studio program window is closed.

  9. Select the Apply button, and consequently click the Ok button, in the Studio Properties window.

Create a new Studio Database
Abstract

Check out this step-based tutorial to learn how to create a new Database and to configure a Connector, in the i4scada Studio application.

As a first step towards working with i4scada Studio is to create your own Database. Follow up the below described steps, in order to create a new Database, in i4scada Studio:

  1. Open the i4scada Studio

  2. The login dialog is opened. Fill in your credentials (if you are a new user and made no changes during i4scada installation, the default user name is "sa" and the password is "webfactory"). 

    Studio_login.jpg
  3. Select the [New Database] option from the Database drop-down list.

  4. The New Database dialog is opened allowing the user to fill in the Database name and if needed to change the Database path.

    New_DB.jpg
  5. Press the button New to start generating the new Database.

  6. Once the Database is prepared, press the Login button.

  7. The i4scada Studio is opened. An information window pops-up asking the user to confirm if the new database should be set as Default or not. 

    Info_dialog.jpg
  8. For current use case we shall set the New database as default, hence button Yes will be selected. 

  9. Under the "Signals" section click right on the Server List node. 

  10. The Server contextual dialog is displayed. Select the option New Server.

    New_Server.jpg
  11. A new Server node is added, under Server List. We shall name the new Server "." as for the current use case the Server runs on same machine as the i4scada Studio. 

  12. Select the Server node and click-right. Select the option Browse Server from the contextual menu. 

    Browse_server.jpg
  13. The Browse Server dialog pops-up. Select the Connector for your new Database and click the button Update

    Select_server.jpg
  14. The Connector node is added to the list view. 

    connector_added.jpg
  15. Click-right on the Connector node and select the option New group, from the contextual menu.

    New_Group.jpg
  16. A new sub-node is generated, representing the Group. By default, the name is set to Group1. More groups can be created, by repeating step 15.

    Group1.jpg
  17. Next, we need to add some Signals to Group1. Click-right the respective node and select the option Browse Connector, from the contextual menu. 

    Browse_Connector.jpg
  18. The Browse Connector dialog is opened. Select the desired Connector Signals. Signals can be also added one by one, by selecting them in the list and clicking the Add button, or collectively selected via the Select all button and Add

    Browse_connector_dialog.jpg
  19. Once the desired Signals have been added to Group1, these are listed and can be further managed. 

    List_of_signas.jpg
  20. Signals management can be organized in the Signal Details panel. More details can be found in the article Edit Signals in the Signal Details panel.

Create new Alarming configurations
Abstract

i4scada Studio application provides the means to create your own Alarming structure. Open this article for a step-based tutorial.

Defining an alarming structure for your i4scada Project can be organized as described below:

  1. Open the i4scada Studio

  2. Log into your database 

    Tip

    Read also the Create a new Studio Database tutorial. 

  3. Once the Server, Connector, Group, and Signals have been defined, we can proceed to the Alarming section of i4scada Studio. 

    Alarming_section.jpg
  4. Click-right on the Alarm Groups node and select the option New, from the contextual menu.

  5. A new Alarm Group is listed. Name the new Alarm group and provide (if desired) its translations.

    Alarm_Gr.jpg
  6. Press the button Save to preserve changes done. 

  7. Proceed to the Alarm Types node and click-right on it. Select the contextual menu option New.

  8. A new Alarm type is added to the list view allowing you to define a custom name, set it to Automatic alarm acknowledgement and introduce translations (if desired). 

    AlarmType.jpg
  9. Press the button Save to confirm and preserve your changes.

  10. Next, click-right on the Alarm Conditions node. Select the contextual menu option New.

  11. A new Alarm Condition is added to the list view allowing you to define a custom Name and Criteria. Based on the selected criteria further settings can be organised. More details about Alarm conditions can be found in article i4scada Studio Alarming.

    Condition1.jpg
  12. Select the Save button to preserve your settings. 

  13. Click-right on the Alarms node and select the contextual menu option New

  14. The Signal Browser window is opened. Select the desired Signal for your new Alarm and click the OK button.

    Signal_browser.jpg
  15. The new Alarm is added to the Alarm list view. By clicking on the new Alarm, the Alarm details panel is made visible, at the bottom of the list. For more details read also the Alarm Properties article. 

  16. To preserve your Alarm click the button Save.

Create new Log conditions
Abstract

Define the Log conditions needed for your i4scada Studio Project right now, by following the steps provided by this article.

This tutorial will guide you through the needed steps for creating a new log condition.

  1. Open the i4scada Studio

  2. Go to the Logging section and right-click on the Log Conditions node in the tree menu or inside the log conditions view and select New.

    New_log_conditions.jpg
  3. Name your new log condition.

  4. Select the desired Log Mode. This is the criteria that will trigger the logging if the conditions are met. Depending on the selected Log Mode, choose one of the following selections:

    • Select the Log Interval, when using the Time Triggered, Mean Value or Counter Mean Value log modes. This is the time interval between two value logs. If you select N/A, logging will be disabled if this condition is used for any log.

    • Select the Log Constant, when using any constant value dependent log mode. This constant value will be used for comparison by the selected log mode.

    • Select the Signal Value 2 signal, when using any signal value dependent log mode. This signal's value will be used for comparison by the selected log mode.

    • Select the Report Interval, when using the Mean Value or Counter Mean Value log modes. This time span is used for calculating the average value that will be logged at the end of the time span.

  5. Store the new log condition using the Save button.

    Log_conditions_list.jpg
Create new Logs
Abstract

Wondering how to create your own i4scada Log definitions? Check out this tutorial and get closer to a fully defined Studio project!

To create new signal log definitions, organize the following steps:

  1. Open the i4scada Studio.

  2. Go to the Logging section and right-click on the Logging node in the tree menu or inside the logging view and select New.

    New_log.jpg
  3. The Signal Browser window pops up. Select the desired Signal(s) and click the OK button.

    Signal_browser.jpg
  4. The new Log is added to the list view. By selecting it, the Logging details panel is made visible, at the bottom of the list. More details about the tabs General, Compression, and Exception can be found in the article i4scada Logs.

    listed_logs.jpg
  5. Under the General tab activate the new log, so that it's taken into account by the i4scada Server.

  6. Name your new log using the Log Tag field.

  7. Enter the number of days to keep the log before purging, using the Max Days option. The logged values reaching this specified age will be deleted. "0" means this condition is not used for deleting logged values.

  8. Enter the maximum number of logs to be stored, using the Max Numbers option. Once this number is reached, the oldest logged value will be deleted when a new one is stored. "0" means this condition is not used for deleting logged values.

  9. Enter the name of the database where the logs will be stored, using the Log Database field. If no database is specified, the logs will be stored in the default log database.

  10. To enable access via IoT Hub, check the IoT enabled checkbox.

    TAB_general.jpg
  11. Switch to the Compression tab. To add Compression, select the algorithm "Swinging Door" from the drop-down list. 

  12. Organize the Compression settings by adding Deviation, Maximum Time Interval , and Minimum Time Interval.

    TAB_compression.jpg
  13. Switch to the Exception tab. To add Exceptions select the algorithm "DeadBand" from the drop-down list. 

  14. Organize the Exception settings by adding DeviationMaximum Time Interval , and Minimum Time Interval.

    TAB_exception.jpg
  15. Store the new log condition using the Save button.

Retrigger Alarm until Condition is met
Abstract

Learn how to retrigger an Alarm until the defined Condition is met, without duplicating that Alarm. Reduce the number of Alarms in your system.

For a better understanding of this tutorial, let's imagine the following situation:

For the food in your refrigerator to stay fresh for as long as possible the refrigerator temperature should hover right around 2° - 3° C. In case the refrigerator door remains open, by mistake, the temperature will raise. In case the door is not closed in due time, the temperature keeps on increasing. What if we have an Alarm set, to ensure that the temperature in your refrigerator is maintained within the optimum range?

When the temperature reaches 3° C, the Alarm is triggered. But what if no one closes the door soon enough and the temperature is increased up to 5° C? Having the "Always trigger alarm" feature activated, will ensure that the alarm is reraised, each time the value is outside the established range. By this, you will not need to set up an Alarm for each of it's potential erroneous states.

To reduce the number of Alarms in your i4scada Project, check out this step-based tutorial, describing the Preparation of the Alarm, Testing it's behavior, and Combining the Alarm retriggering feature with a Suppression Interval.

Note

The present tutorial uses the Demo Database of Studio project and the Signals associated with it.

Preparing the Alarm
  1. Create a new Studio Database, as described here.

  2. Create new Alarming Configurations, as described in this tutorial.

    1. Set the Alarm Condition Criteria to Out of Range option.

    2. Set the value Constant "2" and the Constant to "3".

    3. Assign a Signal to your Alarm (e.g. Buffer 1).

    4. Make sure that the Always trigger alarm check-box is set.

      Always_trigger_alarm_option.jpg
  3. Define a new Log Condition, as explained in this tutorial.

    1. Set the Log Mode to option "Only on change, when signal value > constant value".

    2. Set the Log Constant to value "2".

  4. Define a new Log, as described here.

    • Assign the new Log to the same Signal, as the previously created Alarm (e.g. Buffer 1).

  5. Make sure that all your settings have been saved.

Testing the behavior

Further on let's check the behavior of the above i4scada Studio Alarm:

  1. Open the i4scada Service Manager and start the i4scada Server.

    Scada_Server_ON.jpg
  2. Open the i4scada Test Center and add your Signal there, for further processing. (e.g. Buffer 1)

    Tip

    Check out the i4scada tutorial for more details.

  3. The i4scada Test Center tool displays the Signal current value and allows you to change it. In our current UC, the value of the Signal is "0".

    Test_Center.jpg
  4. Open the i4scada Activity Analyzer tool and press the Start toolbar button.

    Start_Activity_Analyzer.jpg

    Tip

    Check out the i4scada tutorial for more details.

  5. Multiple messages are now written in the Activity Analyzer.

  6. Return to the Test Center tool and write the Signal value "4".

    Value_4.jpg
  7. Check the lines registered in the Activity Analyzer tool. Based on the defined Condition, the value "4" is outside the range. Hence, the Alarm will be stopped and immediately triggered.

    Gone_and_Come_for_4.jpg
  8. Let's assume that the value of the Signal starts to increase up to value "5". To test this behaviour, write value "5" in the i4scada Test Center.

  9. Check the lines registered in the Activity Analyzer tool. As the Condition is no longer met the Alarm is again stopped and automatically retriggered.

    Value_5.jpg
  10. In case the Signal value is corrected to meet the Condition, the Alarm will be stopped.

    Value_2.jpg
The Suppression Interval

For a better outcome, the "Always trigger alarm" feature can be combined with the Alarm Suppression Interval, as follows:

  1. Go to i4scada Studio application and open the Alarming section.

  2. Select your Alarm and go to the Alarm details panel.

  3. In the General TAB set the Suppression Interval to value 30 seconds.

    Suppression_interval.jpg
  4. Save your changes and restart the i4scada Server, under the Service Manager Tool.

  5. Go to Test Center and change the Signal value from "2" to "4".

  6. As the Alarm Condition considers value "4" to be outside the range, the Alarm will be triggered. However, the Suppression Interval feature will wait for 30 seconds, before triggering the Alarm.

    Value_4_with_suppression_set.jpg
  7. If the Signal value returns back within the Condition range, the Suppression Interval will no longer wait for 30 seconds, but will stop the Alarm immediately.

    Value_two_with_suppression.jpg

Note

The Suppression Interval role is to allow the Signal of the Alarm to return within the Condition range, hence avoiding a large amount of running Alarms.

Triggering Alarms with Regex condition criteria
Abstract

Wondering how to create your own i4scada Alarm condition - Regex? Check out this tutorial and get closer to a fully defined Studio project!

Regex (Regular expressions) provides a powerful, flexible, and efficient method for processing text. The extensive pattern-matching notation of regular expressions enables you to quickly parse large amounts of text to find specific characters patterns; validate text to ensure that it matches a predefined pattern; extract, edit, replace or delete text substrings, or add extracted strings to a collection in order to generate a report.

Note

The present tutorial uses the Demo Database of the Studio project and the Regex alarm condition.

  1. Open the i4scada Studio.

  2. Log into your database.

    Tip

    Read also the Create a new Studio Database tutorial.

  3. Once the Server, Connector, Group, and Signals have been defined, we can proceed to the Alarming section of i4scada.

    Alarming_section.jpg
  4. Add a new Alarm Group. For more details about Alarm Groups, please visit the dedicated article, here.

    alarm_group.jpg
  5. Proceed to the Alarm Types node and add a new Alarm Type. For more details, please visit the dedicated article, here.

    alarm_types.jpg
  6. A new Alarm type is added to the list view, allowing you to define a custom name.

  7. Next, click right on the Alarm Conditions node. A new Alarm Condition is added to the list view allowing you to define a custom name.

    alarm_conditions.jpg
    1. Set the name of the Alarm Condition.

    2. Select the Criteria - Signal value matches Alarm constant (regex).

    3. Choose a Constant (string).

      Tip

      For this tutorial, we have used the Constant (string) (?i)^.*(critical|error|blocking).*$.

    4. Make sure that all your settings have been saved.

  8. Create a new Alarm. For more details please visit the dedicated article, here.

    1. Set the name of your new Alarm.

    2. Add your previously created Alarm Group, Type, and Condition.

    3. Set a string Signal.

    4. Make sure that all your settings have been saved.

  9. Open the i4scada Service Manager and start the i4scada Server.

    Scada_Server_ON.jpg
  10. Open the i4scada Test Center and add your string Signal there, for further processing.

    Tip

    Check out the i4scada tutorial for more details.

  11. The i4scada Test Center tool displays the Signal current value and allows you to change it. In our current UC, the value of the signal is "error".

    error_alarm.jpg
  12. Open the i4scada Activity Analyzer tool and press the Start toolbar button.

    Start_Activity_Analyzer.jpg

    Tip

    Check out the i4scada tutorial for more details.

  13. Multiple messages are now written in the Activity Analyzer.

  14. Return to the Test Center tool and write the Signal value "error". Based on the defined condition, the alarm is triggered.

    error.jpg
  15. Return to the Test Center tool and write the Signal value "eror"

  16. Check the lines registered in the Activity Analyzer tool. Based on the defined Condition, the value "eror" stops the alarm.

    alarm_eror.jpg
  17. Return to the Test Center tool and write the Signal value "critiCalwarningabc 12". Based on the defined condition, the value "critiCalwarningabc 12" is matching the Criteria, and the alarm will be again triggered.

    criticalwarning.jpg

Tip

Regex expressions provide a flexible method for processing string signal values, allowing you to match large amounts of texts to the alarm condition criteria. As exemplified in the above tutorial, having the Regex pattern "(?i)^.*(critical|error|blocking).*$" defined for the alarm condition will check the signal values, and each time the 3 keywords "critical", "warning", "error", are matched, an alarm will be triggered.

For more details about .NET regular expressions, please check the article, here. You can also use this online tester to check your Regex expressions.

Manage Project Translations
Abstract

Are you working with multilingual users? Check out how to ensure the i4scada Studio project translations, by following these steps!

The present article will guide you through a set of tutorials helping you to manage your Studio project translations. Additional information about the Translations section can be read in article i4scada Studio Translation.

Setting up Languages
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected. 

  3. The Languages panel displays the list of available languages. By default, only Deutsch and English are available. Deutsch is set as Active and Default.

    List_of_languages.jpg
  4. Activate the English language, by marking the Active check-box as true. 

    English_language_set_as_Active.jpg
  5. Change the default language from Deutsch to English, by marking the Default check-box as true. 

    English_language_set_as_Default.jpg
  6. Right-click on the Languages node in the tree menu or inside the languages view and select the option Add new language.

    Add_new_language.jpg
  7. The Add language dialog pops-up. The list of languages available for your i4scada Studio project is displayed. The Language list is alphabetically ordered.

    Add_language.jpg
  8. Use the horizontal scroll bar to locate the desired language and press the button Add

    French_language_added.jpg
  9. Once added in the i4scada Studio, the language can be enabled or disabled by checking the Activate check-box, and set as default language by checking the Default check-box.

  10. To delete a language from your Studio project, click-right inside the languages view and select the option Remove language

    Remove_language.jpg
  11. The language is removed from the list view. 

Translating Signal Groups
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected. 

  3. Switch to the  Signal Groups tree node.

  4. The list of available Signal Groups is displayed.

    Signal_Groups_node.jpg
  5. By double clicking in Default Text, Deutsch, English or other languages cells, free textual information can be added.

    Signal_Group_translation_added.jpg
  6. Click-right inside the Signal Groups view and select the option Visible languages.

    Visible_languages.jpg
  7. The Set visible languages window is opened.

    Set_visible_languages_window.jpg
  8. Un-mark Deutsch language and click the button OK.

  9. The Signal Groups list view is updated. Deutsch language is no longer visible.

    Deutsch_gone.jpg
  10. Click-right inside the Signal Groups view and select the option Export text translations / Export all text translations

    Export_text_translations.jpg
  11. The Save As dialog is opened allowing you to insert a name and a location for the XML file

  12. The Export text translations window is displayed allowing you to follow up the export task in a progress-bar.

    progress_bar.jpg
  13. Once the progress bar reaches 100%, the Export XML file is made available in the designated location.

  14. Click-right inside the Signal Groups view and select the option Import text translations.

    Import_text_translations.jpg
  15. The Open window pop-up allowing you to select the desired XML file for import. Select the import file.

  16. The import starts and it's progress can be followed up in Import text translations window, after pressing the Import button.

    Import_running.jpg
  17. Once the progress bar reaches 100% the import is finished. 

  18. Click-right inside the Signal Groups view and select the option Column width.

  19. Select the desired Column width method, choosing between Auto fit and Fit to page.

    column_width.jpg
  20. Based on the selected method the column width is updated. 

  21. The organized changes do not require further saving. Translations and actions are automatically preserved.

Translating Signals
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected. 

  3. Switch to the Signals tree node.

  4. The list of available Signals is displayed.

    Signals_list.jpg
  5. By double clicking in Default Text, Deutsch, English or other languages cells, free textual information can be added.

    Signals_translations.jpg
  6. Click-right inside the Signals view and select option Visible languages.

    Sign_Visible_langs.jpg
  7. System opens the Set visible languages window. 

    Set_visible_languages_window.jpg
  8. Un-mark Deutsch language and click the button OK.

  9. The Signals list view is updated. Deutsch language is no longer visible.

    Sign_only_EN.jpg
  10. Click-right inside the Signals view and select the option Export text translations / Export all text translations

    Sign_EXP_all.jpg
  11. The Save As dialog is opened allowing you to insert a name and a location for the XML file

  12. The Export text translations window is displayed allowing you to follow up the export task in a progress-bar.

    progress_bar.jpg
  13. Once the progress bar reaches 100%, the Export XML file is made available in the designated location.

  14. Click-right inside the Signals view and select the option Import text translations.

    Import_Signals.jpg
  15. The Open window pop-up allowing you to select the desired XML file for import. Select the import file.

  16. The import starts and it's progress can be followed up in Import text translations window, after pressing the Import button.

    Import_running.jpg
  17. Once the progress bar reaches 100% the import is finished. 

  18. Click-right inside the Signals view and select option Column width.

  19. Select the desired Column width method, choosing between Auto fit and Fit to page.

    Sign_col_width.jpg
  20. Based on the selected method the column width is updated. 

  21. The organized changes do not require further saving. Translations and actions are automatically preserved.

Translating Discrete Values
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected. 

  3. Switch to the Discrete Values tree node.

  4. The list of available Discrete Values is displayed.

    Discrete_values_list.jpg
  5. By double clicking in Default Text, Deutsch, English or other languages cells, free textual information can be added.

    DiscVal_trans.jpg
  6. Click-right inside the Discrete Values and select option Visible languages.

    DiscVal_Visible_lang.jpg
  7. System opens the Set visible languages window. 

    Set_visible_languages_window.jpg
  8. Un-mark Deutsch language and click button OK.

  9. The Discrete Values list view is updated. Deutsch language is no longer visible.

    DiscVal_no_DE.jpg
  10. Click-right inside the Discrete Values view and select the option Export text translations / Export all text translations

    DiscVal_Export.jpg
  11. The Save As dialog is opened allowing you to insert a name and a location for the XML file

  12. The Export text translations window is displayed allowing you to follow up the export task in a progress-bar.

    progress_bar.jpg
  13. Once the progress bar reaches 100%, the Export XML file is made available in the designated location.

  14. Click-right inside the Discrete Values view and select the option Import text translations.

    DiscVal_Imp.jpg
  15. The Open window pop-up allowing you to select the desired XML file for import. Select the import file.

  16. The import starts and it's progress can be followed up in Import text translations window, after pressing the Import button.

    Import_running.jpg
  17. Once the progress bar reaches 100% the import is finished. 

  18. Click-right inside the Discrete Values view and select the option Column width.

  19. Select the desired Column width method, choosing between Auto fit and Fit to page.

    DiscVal_Colwidth.jpg
  20. Based on the selected method the column width is updated. 

  21. The organized changes do not require further saving. Translations and actions are automatically preserved.

Translating Extended Alarm Properties
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected. 

  3. Switch to the Extended Alarm Properties tree node.

  4. The list of available Extended Alarm Properties is displayed.

    ExtAtrPr_list.jpg
  5. By double clicking in Default Text, Deutsch, English or other languages cells, free textual information can be added or updated.

  6. Click-right inside the Extended Alarm Properties and select the option Visible languages.

    ExtAlarmPr_Visible_lang.jpg
  7. The Set visible languages window is opened.

    Set_visible_languages_window.jpg
  8. Un-mark Deutsch language and click the button OK.

  9. The Extended Alarm Properties list view is updated. Deutsch language is no longer visible.

    ExtAlarmPr_German_gone.jpg
  10. Click-right inside the Extended Alarm Properties view and select the option Export text translations / Export all text translations

    ExtAlarmPr_Export.jpg
  11. The Save As dialog is opened allowing you to insert a name and a location for the XML file

  12. The Export text translations window is displayed allowing you to follow up the export task in a progress-bar.

    progress_bar.jpg
  13. Once the progress bar reaches 100%, the Export XML file is made available in the designated location.

  14. Click-right inside the Extended Alarm Properties view and select the option Import text translations.

    ExtAlarmPr_Import.jpg
  15. The Open window pop-up allowing you to select the desired XML file for import. Select the import file.

  16. The import starts and it's progress can be followed up in Import text translations window, after pressing the Import button.

    Import_running.jpg
  17. Once the progress bar reaches 100% the import is finished. 

  18. Click-right inside the Extended Alarm Properties view and select the option Column width.

  19. Select the desired Column width method, choosing between Auto fit and Fit to page.

    ExtAlarmPr_Colwidth.jpg
  20. Based on the selected method the column width is updated. 

  21. The organized changes do not require further saving. Translations and actions are automatically preserved.

Translating Alarm Groups
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected. 

  3. Switch to the Alarm Groups tree node.

  4. The list of available Alarm Groups is displayed.

    AlarmGr_list.jpg
  5. By double clicking in Default Text, Deutsch, English or other languages cells, free textual information can be added or updated.

    Group_1.jpg
  6. Click-right inside the Alarm Groups and select the option Visible languages.

    AlarmGr_Visible_lang.jpg
  7. The Set visible languages window is opened.

    Set_visible_languages_window.jpg
  8. Un-mark Deutsch language and click the button OK.

  9. The Alarm Groups list view is updated. Deutsch language is no longer visible.

    AlarmGr_DE_gone.jpg
  10. Click-right inside the Alarm Groups view and select the option Export text translations / Export all text translations

    AlarmGr_Export.jpg
  11. The Save As dialog is opened allowing you to insert a name and a location for the XML file

  12. The Export text translations window is displayed allowing you to follow up the export task in a progress-bar.

    progress_bar.jpg
  13. Once the progress bar reaches 100%, the Export XML file is made available in the designated location.

  14. Click-right inside the Alarm Groups view and select the option Import text translations.

    AlarmGr_Import.jpg
  15. The Open window pop-up allowing you to select the desired XML file for import. Select the import file.

  16. The import starts and it's progress can be followed up in Import text translations window, after pressing Import button.

    Import_running.jpg
  17. Once the progress bar reaches 100% the import is finished. 

  18. Click-right inside the Alarm groups view and select the option Column width.

  19. Select the desired Column width method, choosing between Auto fit and Fit to page.

    AlarmGr_Colwidth.jpg
  20. Based on the selected method the column width is updated. 

  21. The organized changes do not require further saving. Translations and actions are automatically preserved.

Translating Alarm Types
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected. 

  3. Switch to the Alarm Types tree node.

  4. The list of available Alarm Types is displayed.

    AlarmType_list.jpg
  5. By double clicking in Default Text, Deutsch, English or other languages cells, free textual information can be added or updated.

    AlarmType_trans.jpg
  6. Click-right inside the Alarm Types and select the option Visible languages.

    AlarmType_Visible_lang.jpg
  7. The Set visible languages window is opened.

    Set_visible_languages_window.jpg
  8. Un-mark Deutsch language and click the button OK.

  9. The Alarm Types list view is updated. Deutsch language is no longer visible.

    AlarmType_DE_gone.jpg
  10. Click-right inside the Alarm Types view and select the option Export text translations / Export all text translations

    AlarmType_Export.jpg
  11. The Save As dialog is opened allowing you to insert a name and a location for the XML file

  12. The Export text translations window is displayed allowing you to follow up the export task in a progress-bar.

    progress_bar.jpg
  13. Once the progress bar reaches 100%, the Export XML file is made available in the designated location.

  14. Click-right inside the Alarm Types view and select the option Import text translations.

    AlarmType_Import.jpg
  15. The Open window pop-up allowing you to select the desired XML file for import. Select the import file.

  16. The import starts and it's progress can be followed up in Import text translations window, after pressing the Import button.

    Import_running.jpg
  17. Once the progress bar reaches 100% the import is finished. 

  18. Click-right inside the Alarm Types view and select the option Column width.

  19. Select the desired Column width method, choosing between Auto fit and Fit to page.

    Alarmtype_Colwidth.jpg
  20. Based on the selected method the column width is updated. 

  21. The organized changes do not require further saving. Translations and actions are automatically preserved.

Translating Alarm Texts
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected. 

  3. Switch to the Alarm Texts tree node.

  4. The list of available Alarm Texts is displayed.

    AlarmText_list.jpg
  5. By double clicking in Default Text, Deutsch, English or other languages cells, free textual information can be added or updated.

    AlarmText_trans.jpg
  6. Click-right inside the Alarm Texts and select the option Visible languages.

    Alarmtext_Visible_lang.jpg
  7.  The Set visible languages window is opened.

    Set_visible_languages_window.jpg
  8. Un-mark Deutsch language and click the button OK.

  9. The Alarm Texts list view is updated. Deutsch language is no longer visible.

    Alarm_DE_gone.jpg
  10. Click-right inside the Alarm Texts view and select the option Export text translations / Export all text translations

    Alarm_export.jpg
  11. The Save As dialog is opened allowing you to insert a name and a location for the XML file

  12. The Export text translations window is displayed allowing you to follow up the export task in a progress-bar.

    progress_bar.jpg
  13. Once the progress bar reaches 100%, the Export XML file is made available in the designated location.

  14. Click-right inside the Alarm Texts view and select the option Import text translations.

    Alarm_Import.jpg
  15. The Open window pops-up allowing you to select the desired XML file for import. Select the import file.

  16. The import starts and it's progress can be followed up in Import text translations window, after pressing the Import button.

    Import_running.jpg
  17. Once the progress bar reaches 100% the import is finished. 

  18. Click-right inside the Alarm Texts view and select the option Column width.

  19. Select the desired Column width method, choosing between Auto fit and Fit to page.

    Alarm_Colwidth.jpg
  20. Based on the selected method the column width is updated. 

  21. The organized changes do not require further saving. Translations and actions are automatically preserved.

Shared Help Texts
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected.

  3. Switch to the Shared Help Texts

  4. The list of Shared Help Texts is displayed. To add new Shared Help Text click-right inside the list view and select option Add new symbolic name

    SharedTexts_add_simb_name.jpg
  5. A new text row is added to the list view. Double click on each cell, in columns Default Text, Deutsch and English, to add information. 

    Symbolic_Text_new.jpg
  6. Click-right the added Text and select the option Edit symbolic name.

    Edit.jpg
  7. Edit the textual information of the Shared Help Text.

  8. Click right the edited Text and select the option Remove symbolic name.

    Remove.jpg
  9. The Shared Help Text is deleted from the list view.

Translating Logs
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected. 

  3. Switch to the Logs tree node.

  4. The list of available Logs is displayed.

    Logs_list.jpg
  5. By double clicking in Default Text, Deutsch, English or other languages cells, free textual information can be added or updated.

    Log_trans.jpg
  6. Click-right inside the Logs and select the option Visible languages.

    Log_Visible_lang.jpg
  7.  The Set visible languages window is opened.

    Set_visible_languages_window.jpg
  8. Un-mark Deutsch language and click the button OK.

  9. The Logs list view is updated. Deutsch language is no longer visible.

    Log_DE_gone.jpg
  10. Click-right inside the Logs view and select the option Export text translations / Export all text translations

    Log_Exp.jpg
  11. The Save As dialog is opened allowing you to insert a name and a location for the XML file

  12. The Export text translations window is displayed allowing you to follow up the export task in a progress-bar.

    progress_bar.jpg
  13. Once the progress bar reaches 100%, the Export XML file is made available in the designated location.

  14. Click-right inside the Logs view and select the option Import text translations.

    Log_Import.jpg
  15. The Open window pop-up allowing you to select desired XML file for import. Select the import file.

  16. The import starts and it's progress can be followed up in the Import text translations window, after pressing the Import button.

    Import_running.jpg
  17. Once the progress bar reaches 100% the import is finished. 

  18. Click-right inside the Logs view and select the option Column width.

  19. Select the desired Column width method, choosing between Auto fit and Fit to page.

    Log_Colwidth.jpg
  20. Based on the selected method the column width is updated. 

  21. The organized changes do not require further saving. Translations and actions are automatically preserved.

Translation Texts
  1. Open the i4scada Studio

  2. Go to the Translations section. By default the Languages tree node is selected.

  3. Switch to the Translation Texts tree node. The list of Translation texts is displayed. 

    TransText_list.jpg
  4. Click-right inside the Translation Texts and select the option Suppress internally used names

    Suppress_internally_used_names.jpg
  5. The symbolic texts used internally by the system are hidden. List is now empty.

    Empty_symbolic_txts.jpg
  6. To re-populate the list with the Symbolic texts click-right inside the Translation Texts and select the option Suppress internally used names

    Symbolic_texts.jpg
Importing Alarms with Shared Help Texts
Abstract

Check out this tutorial and learn how to add shared help texts for alarms defined in XML, using a spreadsheet application.

The following tutorial will guide you through the process of adding shared help texts for alarms defined in XML, using a spreadsheet application (like Microsoft Excel).

The goal of this tutorial is to add shared help texts that will be automatically added in i4scada Studio when importing the alarm from the XML file.

Tip

The same workflow applies to HelpCauseText, HelpEffectText, and HelpRepairText.

The Shared Help Texts are help texts that can be shared by multiple alarms. To define a Shared Help Text in XML, a specific prefix must be used. The Shared Help Text prefix will help the i4scada Studio Studio to recognize the help texts as Shared Help Texts and automatically add them to the Studio's Shared Help Texts list.

Tip

The prefix must be added in front of the translations for each language.

The Shared Help Text prefix uses the symbolic name of the shared help text in the translations, which is "SharedName".

#SN:[SharedName]#

161000e760254c.jpg

Example 1

The above picture shows on the first line an alarm that has custom help texts. On the second line, the alarm with shared help texts is listed.

It is easy to see that the prefix of the shared help texts is formed from #SN:[, the symbolic text name of the help text, and ]#.

Important

In the XML file, the SharedName from the prefix used in the translations columns MUST match the SharedName from the Default HelpCauseText column. This is compulsory if using HelpEffectText and HelpRepairText too.

161000e7606467.jpg

Example 2

In the Example 2 image, the German translation DE_SharedCauseText is missing. In this case, the Studio will import the alarm with no translation for the German language for the shared help text. This method is used when translations are not needed for all languages.

Important

The shared help text prefix is needed even if no translation is available for a language!

When importing alarms with new shared help texts in Studio, the new shared help texts will be automatically saved in the shared help text list of the Studio.

Note

The same prefix can be found when exporting alarms with shared help texts from i4scada Studio.

Configuring the i4scada Server as OPC / OPC UA Server
Abstract

Sounds complicated, when it is not! Get your way through this easy step-based tutorial and get your i4scada Sever to behave as an OPC or OPC UA Server.

OPC is the interoperability standard for the secure and reliable exchange of data in the industrial automation space and in other industries.

OPC is a Client / Server based communication, where one or more Servers can get requests, send answers or updates to and from Clients. The modern version of the OPC is the OPC UA (Unified Architecture) which does not rely on OLE or DCOM technology from Microsoft and can be implemented on any other platform, such as Apple, Linux, or Windows. Unlike OPC, the OPC UA allows the possibility to use structures or models, which makes maintenance much easier.

In order to use the i4scada Server as an OPC or OPC UA Server the following steps need to be organized:

  1. Go to Windows Start and search for the Services Manager application.

    Services_Manager.jpg

    Search for Windows Services Manager

  2. Open the Windows Services Manager application.

  3. Browse among the listed services to find the i4scada WCS OPC Server or the i4scada WCS OPC UA Server.

    Note

    It is possible to connect both OPC and OPC-UA, to one single i4scada Server. However, one i4scada Server can either be used as an OPC Server or as an OPC UA Server, but not both at the same time, as one of the two Services will be inactive.

  4. Select the desired service and press the Start option.

    Start_service.jpg

    Start the i4scada Simulation OPC / OPC UA Server

  5. The service is started on a local computer. The progress can be followed up in the pop-up dialog.

    Progress_bar.jpg

    i4scada WCS OPC / OPC UA Server

  6. Next, open the i4scada Studio application, navigate to Server List and select the connector containing the signals.

  7. Select the signal(s) needed for the OPC Server.

  8. In the Signal Details panel, check the OPC enabled option.

    OPC_enabled_settngs.jpg

    The OPC enabled setting

  9. Finally, open the i4scada Service Manager and start the i4scada Server.

    i4SCADA_Service_Manager.jpg

    i4scada Server running

Organizing the above described steps will enable communication between the i4scada Server and the OPC / OPC UA Client.

Important

The communication between i4scada and OPC / OPC UA Client is enabled through endpoints with the following formats:

  • opc.tcp://ComputerName:62541/ServerName

  • http://ComputerName:62540/ServerName

The ServerName can be extracted from the Services Manager application, by clicking right on the desired Service and selecting the Properties option.

Properties.jpg

The Properties option

In the Properties dialog, the Service name can be extracted from the Tab General.

Service_name.jpg

The Service name