SubWorkWith

WebFormIcon Description

This node contains the definition for a Sub Work With interface associated with a transaction related to the transaction where the pattern is applied.

A sub work with interface allows the end user to view all instances of the related transaction, and to perform actions on them. By default, the standard actions available in this interface are:

  1. To display an instance.
  2. To update an instance.
  3. To delete an instance.
  4. To create a new instance.
  5. To export data for all instances.
  6. To generate a PDF report with data for all instances.

The developer may choose to include more actions.

The grid may be filtered, and ordered, accodring to the specification given by the developer. The grid is a crucial part of this interface's specification. This grid is specified using the Grid Columns, Filters, and Orders nodes.

Runtime appearance

SubWorkWithDefinition SubWorkWithSectionRT
SubWorkWith Definition SubWorkWith Runtime Appearance

Properties

Category Name Value
General Object Name Name that should be assigned to the generated SubWorkWith object. If set to default, the value will be read from K2BEntityServices Settings
Code Identifier for this component. Must be unique inside a Components node.
Related Transaction The transaction that this component refers to.
Title Title for the interface. This value will be shown at the top of the WebForm.
Title Attribute Defines an attribute whose value for the instance being shown will be used as the component's title. When available, this value will replace the text set in the Title property.
Title Expression Expression used to evaluate the component's title in runtime. When available, this value will replace the text set by the Title and Title Attribute properties.
Icon Icon used to identify this component. Not available if this node is a direct child of a 'Tabs' group.
EditMode Edit Mode Determines the edit mode for this interface. The edit mode affects how the end user can insert, edit and delete records, and the navigation after those actions are confirmed. For more information see Edit Mode property.
Layout Layout Object Basic Layout object used to generate the interface, when generating non-Responsive panels.
Two Pane Layout Object

Basic Layout object used to generate the interface, when generating non-Responsive panels.

This property applies only when using TwoPane as the EditMode.

Responsive Layout Object Basic Layout object used to generate the interface, when generating Responsive panels
Two Pane Responsive Layout Object

Basic Layout object used to generate the interface, when generating Responsive panels.

This property applies only when using TwoPane as the EditMode.

Advanced Condition Condition that determines if the component is visible or not.
Check Condition In For Each Determines if the condition will be evaluated inside a For Each command. If the condition references attributes, this property must be set to True.
Grid Automatic Refresh Determines if the Automatic Refresh property will be active for the generated WebPanel.
Use Default Dataselector If Available Determines if the DataSelector specified (if any) in K2BToolsPatterns General Settings should be used in this WebPanel.
Table Element Collapsible Determines if the component will be collapsible in runtime.
Start Collapsed Determines if the component will be collapsed by default in runtime.
Component Position Position of this component relative to the previous component.

Child nodes

FixedDataIcon FixedData ActionIcon Modes (WorkWith) VariablesIcon Variables (Node)
ArgumentsIcon Parameters ArgumentIcon Rules (Node) EventsIcon Events and Subroutines
WebFormIcon FormSection ColumnsIcon Grid Columns FiltersIcon Filters
OrdersIcon Orders ActionsIcon Actions (Patterns) DataSelectorIcon DataSelector (node)

Note

By default the subworkwith node does not contian a parameters node. This means that the parm rule of the subworkwith will be generated with the primary key of the K2BEntityServices main transaction.

If the relationship between the main transaction and subworkwith is using subtypes a parameters/parameter node will be needed so the generated parm rule of the subworkwith containing the subtype instead of the super type.

When there is no parameters node or there is a parameter node containing an attribute (example: <att>) the parm rule will be generated defining a variable based on this attribute (parm(In:&<att>) and a condition (<att> = &<att>) will be generated. There are scenarios in which developers needs this condition to be avoided. In order to instruct K2BTools not to generate the condition, instead of defining the parameter node with an attribute the developer must define it with a variable (adding an & before the attribute name).