Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Recipe Management

Customize What is Shown in the Web Client

  • Last UpdatedMay 15, 2024
  • 5 minute read

Using a browser control with the typical AVEVA Recipe Management URL allows you to show the normal web client within the AVEVA InTouch HMI. However, you may want to show only the Execution view or even a subset of the Execution view. You would use the flexible execution component to do this.

You embed the flexible execution component in another application's window, such as an AVEVA InTouch application window. The component is still web-based and is driven by customizing the URL. In general, all the functionality of the Execution detail pages is available, but the functionality can be customized by passing various URL query parameters. The action bar is not available for the summary pages. The following are the key points:

  • The base URL brings up the typical summary view. The base URL is: https://<hostname>/RecipeManagement/index_exec_comp.cshtml.

    NOTE:
    - If the SSL Certificate used by AVEVA Recipe Management is Issued to Fully Qualified Domain Name (FQDN), the URL will be https://<myserver.mydomain.com>/RecipeManagement/index_exec_comp.cshtml
    - Specify the port number if you have not configured the server with the default port number 443. For example, https://<myserver.mydomain.com>:<portnumber>/RecipeManagement/index_exec_comp.cshtml
    - In the new URL, the product name RecipeManagerPlus is changed to RecipeManagement.

  • The component operates with the summary and detail view or just the detail view. You can further customize the detail view to restrict functionality and use less screen space.

  • It is similar to the web application in functionality but removes the header and menu.

  • Optional arguments can be passed to the URL to control features. You can substitute a short name for the full argument name in the URL. For example, the AVEVA InTouch HMI only supports 131 characters in a URL.

Argument Name

Short Name

Default

Description

EquipmentName

en

(no default)

If specified, the detail view appears. The summary view is not available and there is no Back button.

AllowEditParameter

aep

true

If set to false (or 0), the Edit button is not available in the grid.

ShowActionBar

sab

true

If set to false (or 0), the action bar with the Assign Formula, Download Formula and History buttons is not available.

ShowDetails

sd

true

If set to false (or 0), the Equipment details page is not available. If the user is on summary page and show details (sd) is set to false then the user can navigate to the Equipment details page and can also see the details and the back button will also be available.

ShowEquipmentParameters

sep

true

If Show Equipment Parameters (sep) is set to false (or 0), the Equipment Parameter grid is not available in the details page.

ShowFormulaParameters

sfp

true

If set to false (or 0), the Formula Parameter grid is not available in the details page.

ShowProcedure

sp

true

If Show Procedure (sp) is set to false (or 0), the Procedure tab is not available in the execution details page.

ShowRecipeControls

src

true

If set to false (or 0), all the action buttons for Recipe and Formula are not available.

ShowCapabilityControls

scc

true

If set to false (or 0), all the action buttons for Capability are not available.

AllowViewHistory

avh

true

If set to false (or 0), the History option is not available even if there are Formula downloads and the current user has permission to view reports.

ShowGlobalAlert

sga

true

If set to false (or 0), the global alert icon with the operator action required count is not available on the top right side of the page.

Important:

  • If only one of the options Show Equipment Parameters, Show Formula Parameters, and Show Procedure is set to true, tab controls will not be available, and only one page is shown.

  • If users assign a Formula to the Equipment, the tab controls will not be available because only one page, Equipment Parameters, is shown.

  • If users have the necessary privileges, they can perform all operations except assign Formula in the SFC full screen.

  • Users cannot adjust the height of the SFC panel and the grid panel when the Recipe is under execution. They can only collapse and expand the grid view panel.

  • If users open the user interface by providing the Equipment name in the URL, the global count is the total number of Capabilities waiting for acknowledgment in that Equipment. In the Operator Actions slide-in window, only Capabilities waiting for acknowledgement in that Equipment are shown. The Navigate to Execution Summary button is not available in this case.

User privileges also enable or disable features. For more information, refer to the Working with Security chapter.

Example 1

This URL shows the details of a specific equipment.

#Explorer1.Navigate("https://<hostname>/RecipeManagement/index_exec_comp.cshtml?en=EQ_001");

782535

Example 2

This URL hides the action bar and equipment details.

#Explorer1.Navigate("https://<hostname>/RecipeManagement/index_exec_comp.cshtml?en=EQ_001&sab=0&sd=0");

782536

Example 3

This URL hides the action bar, equipment details, equipment parameters, formula parameters, and global action bar.

#Explorer1.Navigate("https://<hostname>/Recipe Management/index_exec_comp.cshtml?en=EQ_001&sab=0&sd=0&sep=0&sfp=0&sga=0");

782537

Example 4

This URL hides the recipe and capability controls.

#Explorer1.Navigate("https://<hostname>/RecipeManagement/index_exec_comp.cshtml?en=EQ_001&src=0&scc=0");

782538

Example 5

This URL hides the history control.

#Explorer1.Navigate("https://<hostname>/RecipeManagement/index_exec_comp.cshtml?en=EQ_001&avh=0");

782539

Example 6

This URL hides the Equipment details.

#Explorer1.Navigate("https://<hostname>/RecipeManagement/index_exec_comp.cshtml?en=EQ_001&sd=0");

782543

Example 7

This URL hides the Equipment Parameters, Formula Parameters, and Procedure tabs.

#Explorer1.Navigate("https://<hostname>/RecipeManagement/index_exec_comp.cshtml?en=EQ_001&&sep=0&sfp=0&sp=0");

790211

Viewing the Capability Instructions or Documents

You can view the instructions or documents for a Capability which are configured for a Capability instance in a Procedure.

The View Document option is available when you click the Capability instance in the Procedure. Clicking the View Document button displays the instructions in the sliding window. You can have the View URL option in a new tab depending on the configuration.

790212

Viewing History

If Formulas have been downloaded to Equipment previously or a Recipe is executed and you have permission to view reports, when you access the Execution page the History icon is visible. You can click the icon to navigate to the Equipment page to view information about the previous downloads or the Recipe execution. Click the back button to return to the Execution page.

TitleResults for “How to create a CRG?”Also Available in