i4SCADA Knowledge Base

SmartEditor Recipe Manager tutorials

Abstract

These tutorials cover the basics of creating Recipe Definitions and Recipes, aligning them with Signals and applying filter and tables.

Create an i4SCADA Recipe Manager Project
Abstract

For an easy guide to set up and publish an i4SCADA SmartEditor Recipe Manager project, open this tutorial and follow the steps.

To design and publish a simple i4SCADA Recipe Manager project, follow the steps below:

  1. Open the i4SCADA SmartEditor with Administrative privileges.

    Important

    This in an important step as without the Administrative privileges, the i4SCADA SmartEditor will not be able to publish the project to Internet Information Service (IIS).

    Open_SE.jpg
  2. By default, a new project is opened and ready to use.

  3. Add the i4-core extension to the project page. To add the extension on the project page you can simply drag and drop it, into the desired position.

    Important

    The i4-core extension will not be visible at run-time. The scope of it is to handle the connection between your visualisation and the i4SCADA Server. Without it, the communication with the Server is not possible!

    i4-core.jpg
  4. Next, we need the wf-recipe-manager extension. This extension will enable the Recipe Manager, at run-time. Drag and drop the extension on the page.

    wf-recipe-manager.jpg

    Tip

    Make sure that the wf-recipe-manager extension width and height will fit the page content, at run-time.

  5. Open the i4SCADA Service Manager and start the i4SCADA Server.

    Start_Service_Manager.jpg
  6. Return the i4SCADA SmartEditor project and click on the toolbar button Publish.

    publish_recipe_manager.jpg
  7. The Publish to Web Site window is opened. Select the Publish button.

    Publish_project.jpg
  8. The HTML output is generated and the publishing is done. The message"Successfully published!" is displayed.

    Project_published.jpg
  9. Open the published website in the browser. The Recipe Manager is visible.

    Recipe_Manager_at_runtime.jpg
Create a securitized i4SCADA Recipe Manager Project
Abstract

Secure your i4SCADA Recipe Manager project by following the steps provided by this step-based tutorial.

Present tutorial will guide you through the necessary steps to design, publish and view a Recipe Manager project containing security settings, as well.

  1. Check your custom Database, in i4SCADA Studio and make sure that at least one active user is available.

    Admin_user_available.jpg
  2. Open the i4SCADA SmartEditor with Administrative privileges.

    Important

    This in an important step as without the Administrative privileges, the i4SCADA SmartEditor will not be able to publish the project to Internet Information Service (IIS).

    Open_SE.jpg
  3. By default, a new project is opened and ready to use.

  4. Add the i4-core extension to the project page. To add the extension on the project page you can simply drag and drop it, into the desired position.

    Important

    The i4-core extension will not be visible at run-time. The scope of it is to handle the connection between your visualization and the i4SCADA Server. Without it, the communication with the Server is not possible!

    i4-core.jpg
  5. Next, we need the wf-user-login / wf-user-basic-login extension. This extension will enable the user access in the project, at run-time. Drag and drop the extension on the project page.

    wf-user-login.jpg
  6. Add the wf-recipe-manager extension. This extension will enable the Recipe Manager, at run-time. Drag and drop the extension on the page.

    wf-recipe-manager_and_login.jpg

    Tip

    Make sure that the wf-recipe-manager extension width and height will fit the page content, at run-time.

  7. Open the i4SCADA Service Manager and start the i4SCADA Server.

    Start_Service_Manager.jpg
  8. Return the i4SCADA SmartEditor project and click on the toolbar button Publish.

    publish_recipe_manager.jpg
  9. The Publish to Web Site window is opened. Select the Publish button.

    Publish_project.jpg
  10. The HTML output is generated and the publishing is done. The message"Successfully published!" is displayed.

    Project_published.jpg
  11. Open the published website in the browser. The Login button and the Recipe Manager are visible.

    published_securitized_Recipe_Manager.jpg
  12. Click on the Login button. A dialog pop-us up where the Username and Password can be added. Fill in Username and Password.

    Login_recipemgr.jpg
  13. Click the LOGIN button.

  14. Project is opened and the selected user is logged in.

Create an i4SCADA Recipe Project
Abstract

Set up an i4SCADA SmartEditor Recipe visualization, by following the easy steps available only in this article.

In order to create an i4SCADA SmartEditor Recipe project, please follow the below described steps:

  1. Open the i4SCADA SmartEditor with Administrative privileges.

    Important

    This in an important step as without the Administrative privileges, the i4SCADA SmartEditor will not be able to publish the project to Internet Information Service (IIS).

    Open_SE.jpg
  2. By default, a new empty project is opened and ready to use.

  3. Add the i4-core extension to the project page. To add the extension on the project page you can simply drag and drop it, into the desired position.

    Important

    The i4-core extension will not be visible at run-time. The scope of it is to handle the connection between your visualization and the i4SCADA Server. Without it, the communication with the Server is not possible!

    i4-core.jpg
  4. Next, we need the wf-recipe extension. This extension will enable the Recipe at run-time. Drag and drop the extension on the page.

    wf-recipe.jpg

    Tip

    Make sure that the wf-recipe extension width and height will fit the page content, at run-time.

  5. Open the i4SCADA Service Manager and start the i4SCADA Server.

    Start_Service_Manager.jpg
  6. Return the i4SCADA SmartEditor project and click on the toolbar button Publish.

    Publish.jpg
  7. The Publish to Web Site window is opened. Select the Publish button.

    Publish_project.jpg
  8. The HTML output is generated and the publishing is done. The message"Successfully published!" is displayed.

    Project_published.jpg
  9. Open the published website in the browser. The Recipe is visible.

    Published_Recipe_project.jpg
Create a securitized i4SCADA Recipe Project
Abstract

Check out this tutorial and learn how to set up a securitized i4SCADA SmartEditor Recipe project, in just a few steps.

Present tutorial will guide you through the necessary steps to design, publish and view a Recipe project containing security settings, as well.

  1. Check your custom Database, in i4SCADA Studio and make sure that at least one active user is available.

    Admin_user_available.jpg
  2. Open the i4SCADA SmartEditor with Administrative privileges.

    Important

    This in an important step as without the Administrative privileges, the i4SCADA SmartEditor will not be able to publish the project to Internet Information Service (IIS).

    Open_SE.jpg
  3. By default, a new project is opened and ready to use.

  4. Add the i4-core extension to the project page. To add the extension on the project page you can simply drag and drop it, into the desired position.

    Important

    The i4-core extension will not be visible at run-time. The scope of it is to handle the connection between your visualization and the i4SCADA Server. Without it, the communication with the Server is not possible!

    i4-core.jpg
  5. Next, we need the wf-user-login / wf-user-basic-login extension. This extension will enable the user access in the project, at run-time. Drag and drop the extension on the project page.

    wf-user-login.jpg
  6. Add the wf-recipe extension. This extension will enable the Recipe, at run-time. Drag and drop the extension on the page.

    wf-recipe-manager_and_login.jpg

    Tip

    Make sure that the wf-recipe extension width and height will fit the page content, at run-time.

  7. Open the i4SCADA Service Manager and start the i4SCADA Server.

    Start_Service_Manager.jpg
  8. Return the i4SCADA SmartEditor project and click on the toolbar button Publish.

    Publish.jpg
  9. The Publish to Web Site window is opened. Select the Publish button.

    Publish_project.jpg
  10. The HTML output is generated and the publishing is done. The message"Successfully published!" is displayed.

    Project_published.jpg
  11. Open the published website in the browser. The Login button and the Recipe are visible.

    Login_and_Recipe.jpg
  12. Click on the Login button. A dialog pop-us up where the Username and Password can be added. Fill in Username and Password.

    Login_credentials.jpg
  13. Click the LOGIN button.

  14. Project is opened and the selected user is logged in.

Create a new Recipe Definition
Abstract

It is time to start working with the i4SCADA SmartEditor Recipe Manager and set up a new Recipe Definition. Check out this tutorial!

To create a new Recipe Definition follow up the below steps:

  1. Open a published Recipe Manager project, in your favorite browser.

  2. Switch from Recipe to Recipe Definition, in the toolbar drop-down list.

    Select_Recipe_definition.jpg
  3. Click the toolbar button Add.

    Add_Recipe_Definition_button.jpg
  4. The Add recipe definition window pops up. Fill in the Name of your new Recipe Definition.

    Add_recipe_Definition_window.jpg
  5. Click the Apply button. The Add recipe definition window is closed and the new created Recipe Definition is loaded automatically.

  6. Click the Add recipe definition item button.

    Add_item_to_recipe_def.jpg
  7. The Select Signal window pops up.

  8. Select the Group from the drop-down list.

    Select_Recipe_Def_Group.jpg
  9. Select the Signal(s) from the list or start typing a part of the desired signal name in the respective field.

    Select_Recipe_Def_Signal.jpg
  10. Once Group and Signal(s) have been selected click the Apply button.

  11. The Select Signal window is closed. The selected Recipe Definition item(s) can be seen in the Signals list.

  12. Press the toolbar button Save to preserve the Recipe Definition.

    Save_Recipe_Def.jpg
Create a new Recipe
Abstract

Open this tutorial and follow the provided steps, to create a new Recipe in your i4SCADA SmartEditor project.

Creating a Recipe, in the Recipe Manager, can be done by following the below described steps:

  1. Open your published Recipe Manager project, in your favourite browser.

  2. Switch (if needed) from Recipe Definition, to Recipe, in the toolbar drop-down list.

    Recipe_drop-down.jpg
  3. Click the Add toolbar button.

    Add_Recipe_button.jpg
  4. The Add Recipe window pops up.

  5. Fill in the Name for the new Recipe.

    Recipe_Name.jpg
  6. Select the desired Recipe Definition to clone it's items, for the new Recipe.

    Clone_items_from_recipe_Def.jpg
  7. Press the Apply button to save the new Recipe.

  8. The Add recipe window is closed and the new created Recipe is loaded in the manager, along with all it's defined details.

    New_Recipe.jpg
  9. Press the toolbar button Save to preserve the new Recipe.

    Save_Recipe.jpg
Load Recipe Definition / Recipe
Abstract

Check out these easy steps guiding you to load a Recipe Definition or a Recipe, in your i4SCADA SmartEditor project.

The existing Recipe Definitions and Recipes can be loaded for further changes, as follows:

  1. Open a published Recipe Manager project, in your favorite browser.

  2. By default, no Recipe or Recipe Definition are loaded.

  3. While the Recipe Manager toolbar drop-down is set to Recipe, click the Load button.

    Load_Recipe.jpg
  4. The Load Recipe window pops up. List of all available Recipes is displayed.

    Load_Recipe_lits.jpg
  5. Select the desired Recipe and click the green Load button.

    Select_Recipe_to_be_loaded.jpg
  6. Press the Close button. The Load recipe window is closed and the selected Recipe is successfully loaded.

    New_Recipe.jpg
  7. Switch from Recipe to Recipe Definition, in the toolbar drop-down list.

    Select_Recipe_definition.jpg
  8. Click the Load toolbar button.

    Load_Recipe_Definition.jpg
  9. The Load recipe definition window pops up. List of all available Recipe Definitions is displayed.

    Load_Recipe_Def_window.jpg
  10. Select the desired Recipe Definition and click the green Load button.

  11. Click on the Close button.

  12. The Load recipe definition window is closed and the loaded Recipe Definition is visible in the manager.

    Recipe_Definition_loaded.jpg
Edit a Recipe Definition
Abstract

Update your i4SCADA SmartEditor Recipe Definitions in a few easy steps, by following the information provided by this article.

It is possible to edit a Recipe Definition, by organizing the below steps:

  1. Open a published Recipe Manager project, in your favourite browser.

  2. Switch from Recipe to Recipe Definition, in the toolbar drop-down list.

    Select_Recipe_definition.jpg
  3. Click the Load toolbar button.

    Load_Recipe_Definition.jpg
  4. The Load recipe definition window pops up. List of all available Recipe Definitions is displayed.

    Load_Recipe_Def_window.jpg
  5. Select the desired Recipe Definition and click the green Load button.

  6. Click on the Close button.

  7. The Load recipe definition window is closed and the loaded Recipe Definition is visible in the manager.

    Recipe_Definition_loaded.jpg
  8. Once the Recipe Definition is loaded, the toolbar button Edit is activated.

    Edit_Recipe_Def.jpg
  9. Click on the Edit button.

  10. The Edit recipe definition name window pops up.

  11. Update the new of the selected Recipe Definition, as desired and click the Apply button.

    Updated_Recipe_Def.jpg
  12. Click the Save toolbar button to preserve the updates.

    Second_Save_Recip_Def.jpg
Edit a Recipe
Abstract

Check out this article and follow this step-based tutorial to change the settings of your i4SCADA SmartEditor Recipe.

Changes at level of Recipes can also be organised, as follows:

  1. Open a published Recipe Manager project, in your favorite browser.

  2. By default, no Recipe is loaded.

  3. Click the Load toolbar button.

    Load_Recipe.jpg
  4. The Load Recipe window pops up. List of all available Recipes is displayed.

    Load_Recipe_lits.jpg
  5. Select the desired Recipe and click the green Load button.

    Select_Recipe_to_be_loaded.jpg
  6. Press the Close button. The Load recipe window is closed and the selected Recipe is successfully loaded.

    New_Recipe.jpg
  7. Once the Recipe is loaded, the toolbar button Edit is activated.

    Edit_recipe.jpg
  8. The Edit recipe name window is opened.

  9. Update the Recipe name as desired and press the Apply button.

    Updated_Recipe.jpg
  10. The Edit recipe name window is closed and changes are applied.

  11. To preserve the changes click on the toolbar button Save.

    Second_Save_Recipe.jpg
Import a Recipe Definition / Recipe
Abstract

Check out this tutorial! You are just a few steps away from uploading Recipe Definitions or Recipes to your i4SCADA SmartEditor project.

Recipe Definitions and Recipes also allow the user with possibility to import files, as follows:

  1. Open a published Recipe Manager project, in your favourite browser.

  2. Select from the toolbar drop-down list either the Recipe or the Recipe Definition.

  3. Click on the Import toolbar button.

    Import_button.jpg
  4. The Import recipe / Import recipe definition window is opened.

    Import_window.jpg
  5. Click on the Select file button to browse for the import file.

    Tip

    The expected import format is .json.

  6. Once the file is selected, it's name and format will be visible in the Import recipe window.

    Json_file_loaded.jpg
  7. Click the Apply button to proceed with the Import.

  8. The import is processed in background. The imported Recipe / Recipe Definition will be automatically made available in the load lists.

    Imported_item.jpg
Export a Recipe Definition / Recipe
Abstract

Check out how to export via .json format a Recipe Definition or a Recipe, from your i4SCADA SmartEditor project.

To export a Recipe or a Recipe Definition, organise the below described steps:

  1. Open a published Recipe Manager project, in your favourite browser.

  2. Select from the toolbar drop-down list either the Recipe or the Recipe Definition.

  3. Click on the toolbar Load button.

    Load_Recipe.jpg
  4. Select the desired element to be loaded, from the list view.

    Load_Recipe_lits.jpg
  5. Once an element is available in the Recipe Manager view, the Export button becomes active.

    Export_button.jpg
  6. Click on the Export button

  7. A .json format file is automatically opened, in the browser.

    Export.jpg
Delete a Recipe Definition / Recipe
Abstract

Check out how to remove redundant or unneeded Recipe Definitions or Recipes, using the Delete function of the i4SCADA SmartEditor Recipe Manager project.

  1. Open a published Recipe Manager project, in your favourite browser.

  2. By default, no Recipe or Recipe Definition are loaded.

  3. Click on the Load toolbar button to add to the manager either a Recipe or a Recipe Definition.

    Load_Recipe.jpg
  4. As soon as a Recipe / Recipe Definition is loaded, the Delete toolbar button is activated.

    Delete.jpg
  5. The Delete recipe / Delete recipe definition window is opened.

    Delete_window.jpg
  6. Click the Yes button, to proceed with deletion.

  7. Recipe / Recipe definition is deleted.

Write a recipe
Abstract

Check out these steps guiding you how to write Recipes to the i4SCADA Server, using the respective functionality in i4SCADA SmartEditor Recipe Manager project.

To write recipe values in the server, follow the below steps:

  1. Open a published Recipe project, using your favorite browser.

  2. By default the Recipe viewer is opened. No Recipe is applied.

    Recipe_viewer.jpg
  3. Select the desired Recipe from the drop-down list.

    Select_recipe.jpg
  4. Click on the Write Recipe toolbar button.

    Write_recipe.jpg
  5. A confirmation message is displayed indicating that the Recipe was written to the Server.

    Recipe_written.jpg