RadixWare Programmer Guide/Definition Types/Application Definition Segment/Applied Blocks

From RadixWiki
Jump to: navigation, search

The following types of applied blocks are supported in the algorithm scheme editor:

Form Blocks

The form blocks are used to display various dialog forms to the user. All form blocks enable to define:

  • The code that will be executed before the form is displayed to the user.
  • The form header.
  • The operator to display the form to or the methods of operator automatic selection.
  • The form priority.
  • The operator and administrator roles.
  • A set of commands completing the form filling (OK, Cancel, etc.).
  • Constraints: it is possible to prohibit some of the standard operations in the form.
  • Time intervals: it is possible to specify the time interval within which the form must be filled by the operator.

The form can have the following states:

  • Future - the form to be filled in future.
  • Due - the form is ready to be filled. The form goes to this state when the period specified in the Due timer is over (the timers are set on the Delays page of the form editor).
  • Overdue - the form filling is overdue. The form goes to this state after the period specified in the Overdue timer is over (the timers are set on the Delays page of the form editor).
  • Expired - the form is expired. The form goes to this state after the period specified in the Timeout timer is over (the timers are set on the Delays page of the form editor).
  • Closed - the form is filled and closed.

The following form blocks are supported in the editor of the algorithm scheme:

Editor of Form Blocks

Editor of form blocks.png

The editor of form blocks contains the following pages:

  • Pre-Execute. The page is used to create a program code in the JML language; this code is executed before creating a form. The code is used to initialize the form parameter or perform some certain actions before creating a form.
  • Overdue-Execute. The page is used to create a program code in the JML language; this code is executed when the form goes to the Overdue state. For example, it can be used to create a warning informing that the form is outdated.
  • Post-Execute. The page is used to create a program code in the JML language; this code is executed after the form execution. The form can be executed by clicking the respective button or by the timeout (after the period specified in the Timeout timer is over).
  • Common Properties. The page is used to define the main attributes of a form.
  • Additional Properties. The page is used to define the additional attributes of a form.
  • Delays. The page is used to define the delay periods that influence the state and behaviour of a form.
"Common Properties" Page

The page contains the following parameters:

  • Title. The form title in all languages supported by the layer.
  • Header Title. The caption in the upper part of a form in all languages supported by the layer.
  • Footer Title. The caption in the lower part of a form in all languages supported by the layer.
  • Clerk auto select. The method of selecting the user that will own the form by default. Available values:
    • None. The form is not assigned to a certain user. If this value is selected and the Clerk parameter is not defined, the form can be captured by any user that has the respective rights.
    • ProcessOwner. The form is assigned to the user who owns the process.
    • Suitable. The form is assigned to the user who has the rights to work with this form and a minimum number of forms to be filled in.
    • ActiveSuitable. The form is assigned to the active user who has the rights to work with this form and a minimum number of forms to be filled in.
  • Clerk. The user who will own the form. The parameter is available if the Clerk auto select parameter is set to None.
  • Clerk Roles. The roles one of which must be assigned to the form owner. By default, the system uses the roles defined for the current process type in RadixWare Explorer.
  • Admin Roles. The roles one of which must be assigned to the form administrator. By default, the system uses the roles defined for the current process type in RadixWare Explorer.
  • Save content. If the flag is set, all actions performed in the particular form will be written to the log.
  • Capture process. If the flag is set, the form owner automatically becomes the process owner.
  • Priority. The form priority. Available values:
    • IDLE
    • VERY_LOW
    • LOW
    • BELOW_NORMAL
    • NORMAL
    • ABOVE_NORMAL
    • HIGH
    • VERY_HIGH
    • CRITICAL
"Additional Properties" Page

The page contains the following elements common for all types of forms:

  • Object class. The class of object being displayed. It depends on the form type:
    • for the editor form, the class of the object being displayed is defined
    • for the selector form, the class of the object being selected is defined
    • for the dialog form, the class of the dialog being displayed is defined
  • Submit variants area. The area is used to define a set of buttons available to complete working with the form. The button is selected from the standard list of buttons (OK, CANCEL, YES, NO, etc.). The buttons behaviour and appearance are defined in the Submit variant dialog box opened by clicking the Dots.jpg button next to the selected button.
"Delays" Page

The page is used to define the delay period affecting the state and behaviour of a form. Specify the periods used when processing the form by setting the following flags:

  • Due. If the flag is set, the form goes to the Due state when the specified period is over. By default, the flag is set and is not editable.
  • Overdue. If the flag is set, the form goes to the Overdue state when the specified period is over. By default, the flag is set.
  • Timeout. If the flag is set, an additional exit from the form is created (Timeout); it is activated when the specified period is over. Thus, it is possible to define the maximum period for the form processing. As a rule, if the exit occurs due to timeout, the Personal Communicator block will be activated, at that the user or administrator will get the notification on the form processing period exceeding. By default, the flag is not set.

Each period can be defined in days, hours, minutes and seconds. The start time of all periods is the time when the form is created.

Dialog Creator Block

This block is used to display the presentation of the editor of the application class inherited from the Radix::Workflow::Dialog class. The application classes are described on a basis of the DialogForm class; these application classes define the user-defined properties, commands and presentations. The block settings can contain the values of the user-defined properties of this class and additional special commands of forms. The block appearance:

Dialog creator appearance.jpg

Editor of Dialog Creator Block

The editor contains the following pages:

"Additional Properties" Page

In addition to the elements common for all types of forms, the page contains the following elements:

  • Object admin presentation. The dialog box presentation that will be displayed to the Workflow administrator.
  • Available presentations area. The list of available presentations of the displayed dialog class editor.

The presentations are listed in descending order of preference (the system selects the first presentation the form owner has the rights to).

"User Properties" Page

The page contains a list of user-defined properties defined in the form class. The list is presented as a table with the following columns:

  • Type. The data type of the user-defined property. The parameter is not editable.
  • Name. The name of the user-defined property. The parameter is not editable.
  • Value. The default value of the user-defined property. To set the value for the user-defined property chosen in the selector, use the Value field in the lower part of the User Properties page.

Editor Form Creator Block

The block settings define the editor presentation to be displayed to the user. The block has several outputs: one output for each command of form sending (OK, Cancel, etc.) and a separate output that receives the control if the form is not filled within the specified time. The block appearance:

Editor form creator appearance.jpg

Editor of Editor Form Creator Block

The editor contains the following pages:

"Additional Properties" Page

In addition to the elements common for all types of forms, the page contains the following elements:

  • Object creation presentation. The dialog box presentation that will be displayed at the form creation.
  • Object admin presentation. The dialog box presentation that will be displayed to the Workflow administrator.
  • Object editing presentations area. The list of available presentations of the displayed dialog class editor.

The presentations are listed in descending order of preference (the system selects the first presentation the form owner has the rights to).

"Restrictions" Page

The page contains a list of actions in the presentation editor available for the current form. The list is presented as a table with the following columns:

  • Name. The action name.
  • Deny. If the flag is set, the action is prohibited in the current form.

A list of actions available for the selector presentation:

  • Create. The facility to create objects from the presentation.
  • Delete. The facility to delete objects using the presentation.
  • Update. The facility to edit the objects using the presentation.
  • Any Command. The use of any context commands published in the presentation.

Selector Form Creator Block

The block settings define the selector presentation to be displayed. Moreover, it is possible to define the additional condition for selecting the records (in SQML). The block has several outputs: one output for the command of form sending (OK, Cancel, etc.) and a separate output that receives the control if the form is not filled within the specified time. The block appearance:

Selector form creator appearance.jpg

Editor of Selector Form Creator Block

The editor contains the following pages:

"Additional Properties" Page

In addition to the elements common for all types of forms, the page contains the following elements:

  • Object presentation. The selector presentation to be displayed in the current form.
  • Condition area. The area is used to write the program code in the JML language; this code defines the condition for displaying the selector objects.
"Restrictions" Page

The page contains a list of actions in the presentation editor available for the current form. The list is presented as a table with the following columns:

  • Name. The action name.
  • Deny. If the flag is set, the action is prohibited in the current form.

A list of actions that are available for the selector presentation:

  • Any Command. The use of any context commands published in the presentation.
  • Create. The facility to create objects from the presentation.
  • Delete. The facility to delete objects using the presentation.
  • Delete All. The facility to delete all objects from the presentation.
  • Editor. The facility to open the editor of the selected object.
  • Insert All Into Tree. The facility to open all presentation objects in the explorer tree.
  • Insert Into Tree. The facility to open the presentation objects in the explorer tree.
  • Copy. The facility to copy the presentation objects.
  • Multiple Copy. The facility to copy several presentation objects simultaneously.
  • Run Editor. The facility to open the editor of the selected object in the modal mode.
  • Update. The facility to edit the objects using the presentation.

Dialog Duplicator Block

The block enables to display a dialog box based on another certain dialog box with the changed properties. In particular, it is possible to redefine the titles, a set of commands to complete working in the form, etc. The block appearance:

Dialog duplicator appearance.jpg

Editor of Dialog Duplicator Block

The editor contains the pages similar to those of the Dialog Creator block editor. The dialog box parameters are inherited from the base dialog box specified in the Source block parameter on the Additional Properties page and can be overridden. The block editor contains one special page: Override Properties. The page contains a list of properties that can be overridden in the current block. If the Overridden flag next to the property is set, the property can be overridden.

Submit Variant Dialog

The dialog is used to set up the behaviour and appearance of the buttons that are used to exit the form.

Submit variant dialog.jpg

The dialog box contains the following parameters:

  • Title. The button title in all languages supported by the layer.
  • Confirmation. If the flag is set, the confirmation will be requested when clicking the button.
  • Select. If the flag is set, the form state and all properties changed when working in the form will be saved when clicking the button.
  • Visibility. This flag indicates whether the button is visible in the form.

Network Port Block

This block implements the network connection. As a result of block execution, a message is sent and the connection is closed or the message is being waited for. The block works only asynchronously, within the Workflow process.

The block has 4 outputs:

  • Timeout. It is activated when the waiting time is exceeded or the strobe is activated.
  • Disconnect. It is activated when the connection is broken by the other side.
  • Recv. It is activated when receiving the message.
  • None. It is activated when there is no message.

If the toSend property of the block has the true value, the block will send the message over a network, otherwise - it will wait for the message to come. To define the structures of incoming and outgoing messages, specify the XML schema in the block.

Personal Communicator Block

This block sends the message to the addressee specified in the address property. The block enables to specify the communication path (Email, SMS, etc.). If the Timeout property is not defined, the block only sends the message to the addressee. In this case, the block has only one output. If the Timeout property is defined, after sending the message, the process goes into a wait state until the response is received, the time is out or the strobe is activated. In this case, the strobe has two outputs:

  • Resp. It is activated when the response is successfully received.
  • Timeout. It is activated when the waiting time is out or if the strobe is activated.

Batch Executor Block

This block executes or undoes the transactions batch. If the batch is being executed or undone, the block waits for the completion. If the batch must be executed, but it is being undone or vice versa, an exception occurs.

The block has the following outputs:

  • Timeout. It is activated if the batch is not processed within the specified time period. The output is displayed if the Timeout block property is set.
  • Cancel. It is activated if the batch processing is interrupted.
  • Finish. It is activated if the batch processing is successfully completed.