Introduction

Understand form widgets administration activities

Last published at: July 27th, 2024

The form widgets administration activities are managed from this UI. Navigate to Administration - Form widgets menu option. 

 

Select the category drop-down list. The form widgets are categorized as ALL or specific to their feature function, as shown in the following UI. The widget categories are sorted alphabetically. The total number of widgets is mentioned in the brackets. 

 

Select ALL categories to view the form widgets sorted alphabetically in a table. Each row contains the widget icon, name, description, help documentation link, and validation status. Use the search box to narrow down the results. Use the column selector to add or remove columns to the table. 

 

Create a form widget.

The Admin User can create a new custom form widget by navigating to the Administration—Form Widgets—Actions—Create menu option. 

 

The Create menu option provides a UI that requires information to create a form widget. Click on the Validate button to validate the step inputs. Click on the Create button to create the new process step. 

 

The new custom form widget is available in the table by category.  

 

Edit form widget information

Search and select the step name from the table displayed. Navigate to the Actions—Edit menu option. The widget information is provided for modification, as shown below. NOTE: Any widget modifications that fail validation shall set back the existing form definitions. 

 

For example, the form widget display name can be changed here. Click on Update to confirm the changes. 

 

The widget icon can be changed by uploading the icon file here. New inputs can be added here. The input fields and their data type can be modified here. The hierarchy of the fields can be ordered by drag-and-drop. The input fields can be configured as required here. 

 

The widget events and style attributes can be configured here. 

 

Search form widgets

Select a category from the dropdown list to view the widgets belonging to the category. You can type the widget name in the search box to filter, as shown below. 

 

Copy a form widget

Search and select the widget name from the table displayed. Navigate to the Actions—Copy menu option. A popup window will appear. Provide the new widget name. Click on the COPY button to confirm the action. The new widget will be created and listed in the category. 

 

Remove / Auto Detect a widget.

The form widget can be removed and configured again when necessary. Search and select the widget name from the table displayed. Navigate to Actions - Remove menu option. 

 

An alert notification prompts you to confirm the changes.

 

The form widget is removed successfully. 

 

Navigate to Utils - Auto Detect menu option. A new tab is displayed.

 

The form widgets are introduced when FlowWright is updated by a patch release. These widgets may be new or modified with feature enhancements. The widgets (including those removed) are displayed in the table after auto-detect.  Select the widget to configure manually. Repeat the configuration for all widgets in the table if necessary.

 

The configured widget is now available for use. 

 

View With Errors

View form widgets that have failed configuration. Navigate to View - With Errors menu option. The widgets that have failed validation are listed in the table, as shown in the image below.  

 

View usage

Select the widget category from the dropdown list. Then, navigate to the View—Usage menu option. As shown below, usage information is provided for all widgets.  

 

View forms Used by / Not used by 

Search and select the widget from the table. Then, navigate to the View—Forms—Used by / Not used by menu option. 

 

The application executes a background task to list all form definitions using this widget. A notification is sent to the user when the job is completed. Likewise, a list of form definitions not using this widget is also generated by selection. 

Upon job completion, a notification (including email) is sent to the user.

 

Navigate to Notifications and select the “View all Notifications” button. The notifications will be rendered in a new tab. 

 

Select the appropriate notification and click on the pop-out icon to view it. 

 

The list of process definitions or workflows using this decision step is a popup window. Select the process definition hyperlink to view the definition in detail.

 

The email notification is delivered to the user's mailbox. 

 

Not used widgets

Navigate to View - The widgets menu option is not used. 

 

The application executes a background task to list all form definitions not using this widget. The user is notified when the job is completed. 

 

Export a widget

Search and select the widget name from the table displayed. Navigate to the Export—XML menu option. The widget information is exported/downloaded as an XML file for sharing within the FlowWright environment. Select the SQL menu option to download the SQL insert steps as a file. 

 

Import a widget

Navigate to the Import—XML menu option to import the widget into a FlowWright environment. Select the XML file from the local folder and click on Import to accept the changes.  

 

Auto Detect 

Navigate to the Utils—Auto Detect menu option to identify new form widgets and modified widgets that need to be manually configured for your FlowWright environment. 

 

The auto-detect feature opens on a new page. The table lists the widgets by name, namespace, and DLL path configuration. Select the widget row and click on the Manage - Configure menu option. The widget shall be configured manually. Use “Select all records” to configure more than one widget row in the table. 

 

An alert notification confirms the successful widget configuration. 

 

Auto Detect from DLL

Navigate to the Utils—Auto Detect from the DLL menu option to identify new and modified custom widgets that need to be manually configured for your FlowWright environment. 

 

Select the custom widget DLL from the drop-down list. Click on SELECT to confirm the action. The widget will be configured manually. An alert notification will confirm the successful widget configuration. 

 

Auto Detect from Directory

Navigate to the Utils—Auto Detect from Directory menu option to identify new and modified custom widgets that need to be manually configured for your FlowWright environment. 

 

Select the directory from the drop-down list. Click on SELECT to confirm the action. The widget will be configured manually. An alert notification will confirm the successful widget configuration. 

 

Update Master Scripts

When new form widgets are configured, each widget comprises a Javascript code file. These code files must be updated for the forms to function. By selecting the “Utils→Update master scripts” menu item, the master script file will be rebuilt.

 

An alert notification confirms the successful action. 

 

Globalize a widget

This feature allows you to globalize the form widget resources. Search and select the widget name from the table displayed. Navigate to the Utils—Globalize—Selected Widget menu option. As another option, you can globalize all widgets. 

 

An alert notification prompts you to confirm the changes.

 

An alert notification confirms the changes.

 

Form Widget Request 

Navigate to Support - Request Item to ask the FlowWright support team for any enhancements or challenges noticed. 

 

Provide the necessary details so the request can be emailed to the product team. 

 


Multi-Tenant  Form Widgets Administration.

The multi-tenant UI looks like the one below, with features similar to those of a single tenant and a dedicated menu for multi-tenant administration functions.  

 

Select a form widget from the table and click on the MultiTenant menu as below. Here, you can do multiple operations based on the widget selection. 

 

Send To feature.

The feature sends a widget to a selected tenant or all tenants. 

Select a form widget from the table and click on the MultiTenant menu, as shown below. Then, select the Send To—Selected Tenant menu option. 

 

A popup window is displayed for configuration. Select the tenant(s) from the drop-down list. The selected tenants are arranged comma-separated in the display box. Click on the Send button to confirm. 

 

Click OK to confirm on the Send Form Widget popup window. 

 

The selected form widget is sent to the tenant and configured. A confirmation message is displayed in the top right-end corner. 

 

You can also send the selected form widget to all tenants by navigating to the Send To—All Tenants menu option.  

 

Send Category feature.

The feature sends a widget category to a selected tenant or all tenants. 

You can select the category from the drop-down list below. Each category displays the count of form widgets associated with it.  

 

To navigate to the widget categories page, click on the Form Widgets - Categories menu option. 

 

The Form Widget Categories page is rendered as below. Here, you may use the Actions menu to Create, Rename, Remove, and Update Globalization for widget categories. 

 

On the Form Widgets page select the Category from the drop-down list. Next, select the MultiTenant - Send Category - Selected Tenants menu option. 

 

A popup window is displayed for configuration. Select the tenant(s) from the drop-down list. The selected tenants are arranged comma-separated in the display box. Click on the Send button to confirm. 

 

Click OK to confirm on the Send Form Widget popup window. 

 

The selected widget category is sent to the tenant and configured. A confirmation message is displayed in the top right-end corner. 

 

You can also send the selected category to all tenants by navigating to the Send Category—All Tenants menu option. 

 

View Tenants feature.

The feature displays a list of tenants configured with the widget. 

Select a form widget from the table and click on the MultiTenant menu, as shown below. Then, select the View Tenants menu option. 

 

The pop-up window below displays the list of tenants using the form widget. After verifying, click the Close button. 

 

Missing Form Widgets for Tenants feature.

The feature displays a list of widgets missing for a selected tenant. 

On the Form Widgets page navigate to the MultiTenant - Missing Form Widgets for Tenants menu option. 

 

A popup window is displayed for configuration. Select the tenant from the drop-down list. A table lists the form widgets that need to be configured. You may select all or necessary ones by using the checkboxes.  Click on the Configure button when ready. The missing widgets shall be configured on the tenant, and a confirmation message will be displayed in the top right-end corner. 

 

Remove the Form Widget feature.

The feature helps remove a form widget from the selected tenant. 

Select a form widget from the table and click on the MultiTenant menu, as shown below. Then, select the Remove Form Widget - Selected Tenants menu option. 

 

A popup window is displayed for configuration. Select the tenant(s) from the drop-down list. The selected tenants are arranged comma-separated in the display box. Click on the Send button to confirm. 

 

Click OK to confirm on the Remove Form Widget popup window. 

 

The selected widget category is removed from the tenant. A confirmation message is displayed in the top right-end corner. 

 

Update Master Script for Tenants feature.

The feature updates the master script for the page functions of a selected tenant. 

On the Form Widgets page navigate to the MultiTenant - Update Master Script - Selected Tenants menu option. 

 

A popup window is displayed for configuration. Select the tenant(s) from the drop-down list. The selected tenants are arranged comma-separated in the display box. Click on the Send button to confirm. 

 

Click OK to update the master script in the popup window. 

 

The master scripts for the tenant are updated.  A confirmation message is displayed in the top right-end corner. 

 

You can also update the master scripts to all tenants by navigating to the All Tenants menu option. 

 

Globalize Form Widget for Tenants feature.

The feature globalizes the selected widget of a selected tenant. 

Select a form widget from the table and click on the MultiTenant menu, as shown below. Then, select the Globalize Form Widget - Selected Tenants menu option.

 

A popup window is displayed for configuration. Select the tenant(s) from the drop-down list. The selected tenants are arranged comma-separated in the display box. Click on the Send button to confirm. 

 

Click OK to confirm on the Globalize Form Widget popup window. 

 

The form widget is globalized for the selected tenant.  A confirmation message is displayed in the top right-end corner. 

 

You can also globalize the form widgets to all tenants by navigating to the All Tenants menu option. 

 

Globalize All Form Widgets for Tenants feature.

The feature globalizes all form widgets of a selected tenant. 

On the Form Widgets page navigate to the MultiTenant - Globalize all Form Widgets - Selected Tenants menu option. 

 

A popup window is displayed for configuration. Select the tenant(s) from the drop-down list. The selected tenants are arranged comma-separated in the display box. Click on the Send button to confirm. 

 

Click OK to confirm on the Globalize all Form Widget popup window. 

 

All the form widgets are globalized for the selected tenant.  A confirmation message is displayed in the top right-end corner. 

 

You can also globalize all the form widgets to all tenants by navigating to the All Tenants menu option.