Difference between revisions of "UI Action Config"
m |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{UBIK Studio}} provides a mechanism to custom [[Workflow| Workflows]] that are be executed after the user performed an action. This action is a trigger for the workflow, and the object he performed the action with, is handed over (as input parameter) for the workflow. |
UI (user interface) Action configuration objects are used to configure these Workflows that should be executed after the user performs a certain user action. | UI (user interface) Action configuration objects are used to configure these Workflows that should be executed after the user performs a certain user action. | ||
You can find the standard UI Configuration objects in the "System.Main.Settings" namespace. | You can find the standard UI Configuration objects in the "System.Main.Settings" namespace. | ||
| − | |||
== Configuration == | == Configuration == | ||
Use the Namespace, Name and Description property of the UI Configuration objects to organize your objects. | Use the Namespace, Name and Description property of the UI Configuration objects to organize your objects. | ||
| − | |||
== Action key == | == Action key == | ||
| Line 17: | Line 15: | ||
{{Hint|It is suggested to structure your configurations object wisely and define several configs for the same Action!}} | {{Hint|It is suggested to structure your configurations object wisely and define several configs for the same Action!}} | ||
| − | |||
| − | |||
== Workflows == | == Workflows == | ||
| − | You can define the workflows that are executed for the configuration object via a | + | You can define the workflows that are executed for the configuration object via a relation [[SYSREL_UIACTION_WORKFLOW]]. |
=== Properties for the Relation === | === Properties for the Relation === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{| class="wikitable" | width = "50%" | {| class="wikitable" | width = "50%" | ||
| − | |||
|- | |- | ||
! Property!! Description | ! Property!! Description | ||
| − | |||
|- | |- | ||
| Enabled||you can enable/disable the execution for every single workflow without removing it from the relation | | Enabled||you can enable/disable the execution for every single workflow without removing it from the relation | ||
| − | |||
|- | |- | ||
| AdminRights||this Checkbox indicates whether the user needs Admin - Rights to execute the workflow. As the user has not switched to Admin mode, the workflow is ignored. | | AdminRights||this Checkbox indicates whether the user needs Admin - Rights to execute the workflow. As the user has not switched to Admin mode, the workflow is ignored. | ||
| − | |||
|- | |- | ||
| Configured Name Rule|| Refer to the Name Rule Configuration object you need to pass to the workflow. | | Configured Name Rule|| Refer to the Name Rule Configuration object you need to pass to the workflow. | ||
| − | |||
|- | |- | ||
|} | |} | ||
| − | |||
== Parameters == | == Parameters == | ||
| − | Define the trigger parameters for the | + | Define the trigger parameters for the action via the parameter relation [[SYSREL_UIACTION_PARAMETER]]. |
=== Parameter Key === | === Parameter Key === | ||
| Line 62: | Line 46: | ||
* DragDropSource | * DragDropSource | ||
| − | {{Attention|As it is not possible to create a relation to one object more often then once, you have to use DragDropSource in the case you want to use this object as well as | + | {{Attention|As it is not possible to create a relation to one object more often then once, you have to use DragDropSource in the case you want to use this object as well as DragSource and as DropTarget!}} |
Keys without any action are: | Keys without any action are: | ||
* UserParameter_01 to UserParameter_05 | * UserParameter_01 to UserParameter_05 | ||
| − | |||
| − | |||
=== Evaluation Type === | === Evaluation Type === | ||
The evaluation type indicates whether the related Metaclass and all its derivates are the object you want to perform the action with (evalutation type = Metaclass) or whether you want to perform the action with all instances of the given Metaclass (evaluation type = instances). | The evaluation type indicates whether the related Metaclass and all its derivates are the object you want to perform the action with (evalutation type = Metaclass) or whether you want to perform the action with all instances of the given Metaclass (evaluation type = instances). | ||
| − | [[Category:Workflow]] | + | == See also == |
| + | * [[UI_ACTION]] | ||
| + | |||
| + | [[Category:Workflow|UI ACTION CONFIG]] | ||
Latest revision as of 12:26, 2 September 2016
UBIK® Studio provides a mechanism to custom Workflows that are be executed after the user performed an action. This action is a trigger for the workflow, and the object he performed the action with, is handed over (as input parameter) for the workflow.
UI (user interface) Action configuration objects are used to configure these Workflows that should be executed after the user performs a certain user action. You can find the standard UI Configuration objects in the "System.Main.Settings" namespace.
Contents
Configuration
Use the Namespace, Name and Description property of the UI Configuration objects to organize your objects.
Action key
The action key defines for which UI Action the configuration object is defined for. Supported actions are:
- Click
- Doubleclick
- Drag and Drop
 | It is suggested to structure your configurations object wisely and define several configs for the same Action! |
Workflows
You can define the workflows that are executed for the configuration object via a relation SYSREL UIACTION WORKFLOW.
Properties for the Relation
| Property | Description |
|---|---|
| Enabled | you can enable/disable the execution for every single workflow without removing it from the relation |
| AdminRights | this Checkbox indicates whether the user needs Admin - Rights to execute the workflow. As the user has not switched to Admin mode, the workflow is ignored. |
| Configured Name Rule | Refer to the Name Rule Configuration object you need to pass to the workflow. |
Parameters
Define the trigger parameters for the action via the parameter relation SYSREL UIACTION PARAMETER.
Parameter Key
The parameter Key defines the type of the criterion. It is important to set the correct parameter key to get the expected behavior.
Moues Click Parameter Keys are:
- Click Target
Drag&Drop Parameter Keys are:
- Drag Source
- Drop target
- DragDropSource
 | As it is not possible to create a relation to one object more often then once, you have to use DragDropSource in the case you want to use this object as well as DragSource and as DropTarget! |
Keys without any action are:
- UserParameter_01 to UserParameter_05
Evaluation Type
The evaluation type indicates whether the related Metaclass and all its derivates are the object you want to perform the action with (evalutation type = Metaclass) or whether you want to perform the action with all instances of the given Metaclass (evaluation type = instances).
