Load Single Form
- Last UpdatedNov 15, 2023
- 2 minute read
Load a required form in a custom page to customize your business application.
To load a form in a custom page
-
Create a custom page using the Single Form Custom Page Template in the [AVEVA Work Tasks Installed Path]\AVEVA\Work Tasks\BPMUITemplates\Default\NextGenForms\ folder.
-
Edit the custom page using an HTML editor to add a form by replacing the placeholders with the Repository Name, User ID, Form Name, Form Version, and Form ID as follows:
var appName = "Forms Repository"; // Repository Name – Case Sensitive value should be provided
var userId = "skeltalist::326E19DC-A292-49A0-B8A0-B8E62A9F3F27"; // Repository Provider with the User ID separated by the “::”
var formName = "TestForm"; // Form Name – Case Sensitive value should be provided
var formVersion = "1"; // Form Version
var formId = "bb48516f-d69f-43ce-99f3-aa6e39d70281"; // Form ID – should be in small case letters
Note:
- appName is the Repository Name and is a case sensitive value.
- userId is the internal User ID in the form of Repository Provider Instance Name and the User Id separated by the “::”.
- formName is the Form Name, which needs to be shown in the custom page and is a case sensitive value.
- formId is the Form GUID, which needs to be shown in the custom page and should be in small case letters.
To access forms parameters in a custom page
To access form parameters in a custom page, refer Setting Form Parameters
To access a form in a custom page placed in a folder other than NextGenForms
If the custom page is not placed in the folder relative to the AVEVA Work Tasks installed path, [AVEVA Work Tasks Installed Path]\AVEVA\Work Tasks\BPMUITemplates\Default\NextGenForms\..,then declare the following constant with the variables defined while loading and accessing forms in a custom page.
Also, the value depends on the location of the custom page and is a relative path. Consider the custom page to be in the path [AVEVA Work Tasks Installed Path]\AVEVA\Work Tasks\BPMUITemplates\Default\Repository\Site\.. The below line of code should be added before the “var appName …” code.
skelta.serverUrl = "../../NextGenForms/";
We also need to update the Javascript and CSS file references in the custom page code as below (listed few references below as an example):
<script type="text/javascript" src="../../Common/JavaScripts/spin.min.js"></script>
<script type="text/javascript" src="../../NextGenForms/app/Skelta.min.js"></script>
<script type="text/javascript" src="../../NextGenForms/js/date.min.js"></script>
<link rel="stylesheet" href="../../NextGenForms/css/SkeltaForms.min.css" />
<link rel="stylesheet" href="../../CommonUXControls/StyleSheet/se.ui.min.css" />
To access a Pop-Up Form in a custom page
If the custom page is not placed in the folder relative to the AVEVA Work Tasks installed path, <AVEVA Work Tasks Install Path>\BPMUITemplates\Default\NextGenForms\..,then declare the following constant with the variables defined while loading and accessing forms in a custom page.
The value is pre-fixed while opening the PopupForm HTML page to create a relevant relative path. Also, the value of the constant depends on the location of the custom page.
Consider the custom page to be in the path [AVEVA Work Tasks Installed Path]\AVEVA\Work Tasks\BPMUITemplates\Default\Repository\Site\.. The below line of code should be added before the “var appName …” code.
skelta.forms.constants.popupFormContants.HtmRelativePath = "../../NextGenForms/";
skelta.serverUrl = "../../NextGenForms/";