Support Import

The User Actions pane
Library_Designer_PR_2a1.PNG

3. Through this pane's toolbar you can Create User Actions, Delete existing User Actions, Edit a User Action’s Parameters, Edit the Name and Description of the User Action itself or simply Highlight in the pane's treeview, whichever User Action is currently in development.

Library_Designer_PR_2a2.PNG

As you can see the pane’s main viewport contains a treeview of all the Library’s User Actions. Left-clicking the expand/collapse symbol next to the branches of the graphical element will allow you to access (via double-click) their Input or Output Parameters.

Clicking the Create New User Action 53-the-user-actions-pane-2.png will open the Create New User Action Dialog Box.

create-ua.png

This is comprised of two text fields that give you the opportunity to define the name of the Action along with a short description of its functionality.

It is important to understand that the information you ‘ll enter here will be displayed in the Action’s Properties Dialog Box every time anyone is attempting to use this User Action.

inap-text-ua.png

However you should also be aware that you can change this information anytime you want via the Edit User Action Data (fourth from the left on the toolbar).

Clicking the Delete User Action 53-the-user-actions-pane-3.png Button will result in the opening of a Possible Loss of Work alert box.

loss-of-work.png

This is warning you against any action that might result in unintentional data loss, clearly specifying the name of the User Action you are about to delete.

The Action to be Deleted can be highlighted either through the respective Workspace Tab or the Tree View in the viewport.  

Library_Designer_PR_2a3.PNG

Clicking the Edit User Actions Parameter Data 53-the-user-actions-pane-4.png Button will result in the opening of the Edit ‘Name-of-the User-Action’ Parameters dialog box.

edit-uap.png

This box is very important as it is inviting you to define the input and output parameters of your Action.

Input and Output Parameters are what's allowing your User Action to communicate with anyone's using it. You can think of them as plugs, that allow your Action to accept or transmit data.

These Parameters can be of any type of data, from Boolean to a Folder but also do not have to be a single value of predefined type; it can be a list of General Values, Softomotive's keyword that allows variables to be defined as the program runs. However it should be clear that whether a single or a list, the value(s) have to be of the same type.

ptype.png

What is important to understand is how this interface allows you to enter or remove Input or Output Parameters:

input-ua.png

To add an Input Parameter click the blue/white plus sign and then select the menu item of your choice in order for the rest of the form to become available for filling.

You can use the minus sign next to the plus in order to remove any of your UA's Parameters, as long as your Library is not Published!

In general, you should have in mind that adding or removing Parameters from a Library that is published is prohibited as this might interfere with the smooth operation of Processes that already use this specific User Action.

If you must add or remove Parameters in a published UA, you are well advised to create a new one since changes in published User Libraries take effect immediately after restarting (closing-reopening) your Process Studio facility.  

Unless you use these little blue/white signs in order to add or remove Parameters, you'll be unable to complete the development of your User Library.

The Help Text you have the opportunity to set here, will be the content of the characteristic info-bubble by the side of any Action's Input or Output Parameter:

Library_Designer_PR_2a4.PNG

The Screenshot above is from the Properties of the predefined Launch New Internet Explorer Action. Let's see how the Message: "Wise men know themselves to be fools but fools think that they are wise" would be displayed on the Properties box of a custom made UA:

Library_Designer_PR_2a5.PNG

You can find more info on how to do that along with many design tips and best practices on this guide’s An Example on User Libraries .

Clicking the Edit User Action Data 53-the-user-actions-pane-5.png Button will result in the opening of the Edit ‘Name-of-the User-Action’ dialog box.

Library_Designer_PR_2a6.PNG

This box is allowing you to edit the information you have previously entered with Create New User Button (first from the left on the same Toolbar).

Clicking the Highlight Currently Active User Action 53-the-user-actions-pane-6.png Button will simply highlight the User Action we are currently working with in the Workspace, in the pane’s treeview. This feature can be useful if the Library contains numerous Actions.