Knowledge Web Dialog

Accessing this Operation

This operation can be accessed by clicking Knowledge Web Dialog.

Describing this Operation

You can handle knowledge web dialog operations in the build time and in the run time environments.

Build Time

Once the operation is created, you can automatically generate default HTML and JavaScript (JS) files using the Generate Skeleton button. The implementation of those files are under your control so that you can customize the dialog according to your needs.

Make sure you have created the HTML and JS files to use them at runtime.

Run Time

At run time, the specified dialog is retrieved from the Know-how Apps Component defining the user app, and is launched, waiting for user interaction if necessary (depending on the dialog design). When the dialog is closed (for example when the user decides to click Close), the operation ends its operation and the sequence continues by running the operations that follow.

Using this Operation Interface

You can find information concerning the interface.


Name	Name attributed to the operation.
Comment	Comment attributed to the operation.


Content
	Load from resources > Web Page Name	Lets you load resources. Enter a web page name.
	Generate Skeleton	Click to generate a folder. Enter its name in Web Page Name. The folder generated is located in the OS-Independent runtime view. Two files are imported: IndexWebDialog.html main.js These two files are then exported to the DPC Runtime View folder. This folder contains IndexWebDialog.html and main.js.
	Enable runtime design tools	Check if you want this button extra buttons appear on the dialog Runtime to help the designer of the KAC application to modify the KAC Web Dialog
	Load from URL	When selected, specify the URL.
Dialog Options
	Minimum window width/height	Enables you to set the window size.
	Resizable window	Lets you decide if the window can be resized.
List of EKL Actions	Lets you add EKL actions to the operation. This is only useful if the content comes from resources as developers will be able to launch these EKL actions from the dialog. The designer of the app can add EKL actions by clicking on Add to open the EKL editor where: you can define the content of the EKL Action. This is similar to the Knowledge Language Behavior. Modify opens the browser for the selected EKL action, which allows you to modify the action. Delete deletes the selected EKL action from the table. Note: Give different names to your actions as these names will be used to identify and launch the actions.
List of EKL Actions		The parameters set in the Definition tab of the Knowledge Web Dialog correspond to the variables of this operation: WebPageName is the name of the folder containing the HTML and JS files. URL contains the name of the web page you want to load. DialogType equals 1 if you want to load a html page from resources and not if you want to load a URL. RunInTestMode is a Boolean. If set to `True`, runtime design tools are enabled. ResizableWindow is a Boolean. If set to `True`, the dialog window can be resized. WindowWidth and WindowHeight contain the values of the minimum window width and height of the web dialog window.

Increased Selection Accuracy of WebDialog Operations

The WebDialog interface is highly customizable and based on JavaScript (JS), HTML, and CSS technologies. Its increased customization capabilities offer an updated look and feel along with additional functionalities.

Table 1. Selecting PLM Types
Parameter	Description
PreSelectedFeature	Holds the pre-selected element when triggering the execution of the EKL action on the in-session event in CATIA. If the selection is valid,click it to validate the selection. If the selection is not valid, a symbol appears. The internal web dialog attribute isPointer on Object.
IsSelectableFeature	Holds the return value of the EKL script. It is used to communicate between the script execution and the CATIA selection command. The internal web dialog attribute isBoolean.

Note: You can select multiple features by clicking Shift + Features.

Enabling the WebDialog Selection

Begin by creating a Know-How App Component and instantiate a WebDialog operation. An EKL script should be added to the WebDialog to:

have better control over the selection
retrieve the current selected object in the PreSelectedFeature parameter
valuate the paramater IsSelectableFeature.

Recommendation: To facilitate the deployment of the application, create and edit the HTML, CSS, and JS files containing the WebDialog definition to embed in the resources of the component. They must be placed in the directories below:

Defining the WebDialog

In order to start and stop the selection, three methods have been added to the JS WebDialog API:

activateSelectionAgentWithFilter(multiSelInt, actionName)
multiSelInt is an integer that must be valued to 0 (mono-selection) or 1 (multi-selection), and actionName is a string indicating which EKL script must be used as a filter during the execution of the selection command.
desactivateSelectionAgent()
This method is used to stop the selection agent when the multi-selection is activated.
highlightObjectInTree(ObjectToHighlight)
Where ObjectToHighlight is the JS representation of a CATIA session object.

Once the steps above have been performed, you can deploy the new application containing the WebDialog.

Start the WebDialog, trigger the desired selection, and select in-session objects.
Select objects to add to a list or re-select to remove from the list. Click Shift+object to select multiple elements simultaneously.
Stop the selection using the WebDialog.

Note:

The WebDialog parameters used for storage are flushed on the CATIA session side. If you want to cross-highlight an object in the session from a selection in the WebDialog, send the highlightObjectInTree notification with the desired element as input. This element should be saved beforehand on the CATIA session side (for example, in a User attribute contained in the Type).