Object Groups

An Object Group displays line items.  A number of Objects (or fields) will form a line within the Object Group.  The user is allowed to add as many lines as needed to the object group.

The line items can be populated from a database, or individual line items can be added as more fields are completed.

The three steps required to use an Object Group are as follows:

  1. The first step in creating and using an Object Group is defining the Object Group. This is performed on Activity Level.
  2. The second step will be to add Objects to the Object Group using the Object Group property on an Object.
  3. The third step is to populate the Object Group with information.

Example: Items on an invoice will be displayed in an Object Group. One line in the Object Group will contain the following Objects – Stock Code, Description, Price, Quantity and Sub Total. There will be one line in the Object Group containing the Header and then the lines will follow.

Properties of an Object Group Explained

Behavior
Allow Adding Is the user allowed to add lines to the Object Group? If this property is set to False, the Add button will be removed from the Object Group in the XMPro Workspace.
Allow Delete Is the user allowed to delete lines from the Object Group?If you set this property to False, the Delete button will be removed from the Object Group in the XMPro Workspace.
Lines To Add Specify how many lines should be added to this Object Group if the user clicks on Add (+).
Visible Should the Object Group be visible?
Content Definition
Dynamic Content Use this property to specify scripts that populate the Object Group dynamically. These are called Object Group scripts.
ID
ID A numerical value which uniquely identifies this Object Group.  This property is automatically assigned, and used internally by XMPro.
Identifier
Description Specify the heading or description for the Object Group in this property.
Name This property specifies the name of the Object Group. The name uniquely identifies the field.  It will be used to call the Object Group when you need it.
Parent This property stores the ID of the activity that this Object Group belongs to.
Performance
Add Lines Script Execution Mode Determines whether the scripts of the entire page (0) or the current group (1) are executed, or no scripts should be executed (2) at all, when adding new lines to this Object Group.
Delete Lines Script Execution Mode Determines whether the scripts of the entire page (0) or the current group (1) are executed, or no scripts should be executed (2) at all, when deleting lines from this Object Group.
Post Back Script Execution Mode Determines whether the scripts of the entire page (0), or the current group (1), or only the current line (2) should be executed when a post back/refresh occurs from a control within this Object Group.

Important points to remember when working with Object Groups are as follows:

  • The first column displayed in the object group is the key.  If the key is empty, the entire line will be discarded by the XMPro Engine.
  • Members of an Object Group may not be a required field.
  • When using Objects, Object Groups don’t have scope in other object groups.
  • If the user clicks on (+) in the top left-hand corner of the object group in the XMPro Workspace, more lines will be added to the Object Group.
  • If the user checks the checkbox to the left of the line item in an Object Group and then clicks on the (-) in the top left-hand corner of the Object Group, the checked line will be deleted.
  • You can prevent a user from adding or deleting line items by setting the Allow Adding and Allow Delete properties to False.  This is helpful when populating an object group from an external source.

Options

The Object Configuration Wizard Options tab shows the specific properties for the control.

Alternating Row To enhance readability, you can highlight alternating (odd) grid rows with a different style. To do so, set the property to true.
Customization Window Must this object group display the customization window?
Data Filter Row The Filter Row allows end-users to filter data by entering the text within its cells.
Data Filter Row Menu For total control over the values returned by the filter row, an optional filter row menu displays a list of filter conditions for a given search operation.  Once enabled, you can view this menu and apply one of the nine filter conditions to restrict your search results.
Data Filter Row Mode Which filter mode to use for the Grid (Auto = True, OnClick = False)?
Export to PDF Allow the data to be exported to a PDF file.
Export to XLS Allow the data to be exported to an XLS file.
Export to XLSX Allow the data to be exported to an XLSX file.
Export to RTF Allow the data to be exported to an RTF file.
Export to CSV Allow the data to be exported to a CSV file.
Filter Control The Filter Control allows end-users to build complex filter criteria with an unlimited number of filter conditions and logical operators.
Fixed Groups To help improve readability when data is grouped within the grid, the Grid allows you to anchor a group row to the top edge of its container when scrolling a group’s data rows.
Focused Row The Focused Row feature is disabled by default. To enable it, set the property to true.
Footer Total Summaries are aggregate function values calculated against all rows within the ASPxGridView, and displayed within the Footer.
Grid Lines Horizontal Use this property to specify the grid line style for the Grid.
Grid Lines Vertical Use this property to specify the grid line style for the Grid.
Grid Page Size How many lines to allow before paging.
Grid Paging Page Size Right This property controls where a page size item is displayed: to the left or right of the pager.
Grid Paging Position Bottom This property controls the pager’s position within the grid.
Grid Paging Position Top This property controls the pager’s position within the grid.
Grid Paging Show Disabled Buttons This property controls the visibility of the pager’s buttons that cannot be used at the moment and are temporarily disabled.
Grid Paging Show All Button This property controls whether the All button is displayed for the pager.
Grid Paging Show Numeric Buttons This property controls the visibility of the pager’s numeric buttons that navigate a user to the corresponding pages.
Grid Paging Show Page Size This property controls page size item visibility.
Grid Paging Show Separators This property specifies whether or not page number separators are displayed.
Grid Paging Show Summary This property controls the pager’s summary visibility.
Group Panel End-users can group data by dragging column headers to the group panel.
Group Summary Group Summaries represent the value of an aggregate function calculated across all data rows within a group.
Group Summary Footer Group Footers are an alternative way to display summaries for grouped data. Group Footers contain footer cells that correspond to individual data columns. Footer cells display formatted summary values.
Height Height set before the scrollbars for the grid are visible.  Set to 0 to disable.
Header Filter Invoked by activating the column header’s filter button, end-users can filter the records stored in the underlying dataset by selecting the values displayed within the drop-down.
Header Filter Checklist Mode You can specify the header filter mode for a column using the this property.  Setting to True set the Checklist mode, setting to False sets the List mode.
Right to Left The Grid provides support for right-to-left languages such as Arabic and Hebrew.
Search Panel The Grid allows you to filter data and highlight search results via its integrated Search Panel. To enable the easy-to-use Search Panel, set the property to true.
Search Panel Delay The Delay property to specify the time interval between the time an and user starts typing within the search panel, and filtering is applied.
Search Panel Show Apply Button Specifies whether the Apply button is displayed within the Search Panel.
Search Panel Show Clear Button Specifies whether the Clear button is displayed within the Search Panel.
Scrollbar Horizontal The indicate if the scrollbar is visible within the grid.
Total Summary Must this object group show a total summary when grids are enabled?
Width Width set before the scrollbars for the grid are visible.  Set to 0 to disable.

How to Use

Create an Object Group

Defining the Object Group (in the example below we are going to create an Object Group that will display invoice lines).

  1. Click the Relevant Process.
  2. Click the Relevant Activity (form/screen) that you want to create the Object Group on.
  3. Click the Properties tab.
  4. Click the ellipsis button next to Object Groups as indicated in the previous figure.
  5. Click Add.
  6. Click the New Object Group in the left-hand pane.
  7. Provide the Property values of the Object Group in the right-hand pane as indicated below.
  8. Ensure to follow naming conventions when providing values for the Description and Name properties.
  9. Click OK.

Assign Objects on your Activity (screen/form) to the Object Group

  1. Double-click on your Activity to open it in the work area.
  2. Drag-and-drop the objects of choice (that you want to appear in your List) from your Toolbox to your work area (in order of display preference left to right).
  3. Click on the first object (Invoice Line Description) as indicated in the following figure.

  1. Click the ellipsis button menu next to Object Group on the Properties tab.
  2. Choose the Object Group that you defined in Step 1 of Creating an Object Group.
  3. Click OK.
  4. Do the same for all the other Objects you want to form part of this Object Group. In the example above the yellow highlighted objects.
  5. On the ribbon, click the File tab, click Save or press CTRL+S to save your changes.

Object Group Content Definition

Object Groups can be populated with information from another system(s) or from a previous step in the process (form/screen). We recommend that you use the XMPro Integration Wizard for information retrieved from another system or from a database in XMPro OR the Object Fast Field Wizard if the information comes from a previous process step or screen.

Use values from the previous process step (scanned invoice) to populate the Object Group.
Refer to How to Use the XMPro Integration Wizard to learn how to populate an Object Group with information from a database or file.

  1. Click on the relevant Activity in your work area.
  2. Click the Properties tab.
  3. Click the Object Groups Property ellipsis button button. The Maintain Object Groups window will open.
  4. Click your Object Group configured in Step 1 of Creating an Object Group.
  5. Click on the Managed Object Group under Content Definition as indicated below. The Object Field Fast Field window will open.

  1. Click the Previous Activity radio button as indicated below.
  2. Click on the From Activity drop-down.
  3. Click on the relevant Previous Activity.
  4. Click on the From Object Group drop-down.
  5. Click on the relevant Object Group. The Objects will be displayed in the left-hand pane.
  6. Drag-and-drop each object in the left-hand pane to the corresponding Object in the right-hand pane as indicated below.

  1. Click on Save.
  2. Click CTRL+ S to save the Activity. The Object Group will be populated with information from the previous step during run-time.

Calculate Values in an Object Group

  1. Click on the relevant Process Group.
  2. Click on the relevant Process.
  3. Double-click on the relevant Activity.
  4. Click the Object that will contain the “calculated value” (Assuming that you have completed Step 1 and Step 2 of Creating an Object Group). In the previous figure, we are going to calculate “Total” (IA2070Total). The Total will be Unit * Qty.
  5. Click the ellipsis button button next to Managed Object under Content Definition. The Script Editor will open.
  6. Add the following to the OnLoad and/or OnRefresh sections: fcLabel = aObjects(“IA2050Qty”) * aObjects(“IA2060Unit”)
  7. Click Save.
  8. Close the Scripting window.
  9. Click CTRL+ S to save the Activity.

Calculate Values outside an Object Group using Values in the Object Group

Add all the IA2090Inclusive line values (in the Object Group) and display the total in the IA20150TotalCost Object (outside of the Object Group) as follows.

  1. Click on the relevant Process Group.
  2. Click on the relevant Process.
  3. Double-click on the relevant Activity.
  4. Click on the IA20150TotalCost object in your work area.
  5. Click on the ellipsis button button next to Managed Object under Content Definition in your Toolbox. The Script Editor window will open as indicated in the following figure.

  1. Provide the code as indicated for the OnLoad and OnRefresh functions.
  2. Click CTRL+ S to save the Activity. You will be returned to the work area.

Populate Object Groups from Object Groups used in a previous step in your process

  1. Click on the relevant Activity.
  2. Click on the Properties Tab.
  3. Click on Object Group Collection ellipsis button button. The Maintain Object Groups window will open.
  4. Click on the Object Group that you want to populate with information.
  5. Click on Managed Object Group (under Content Definition). The Object Field Fast Field window will open.
  6. Click on the Previous Activity (Retrieve Data From) radio button if not selected.
  7. Provide the detail as required for From Activity, From Object Group.
  8. Provide the mapping detail.
  9. Click on Save.
  10. Click OK.
  11. Click CTRL+ S to save the Activity.

Delete an Object Group

  1. Click on the relevant process in the Server Explorer window.
  2. Click on the Activity containing the Object Group.
  3. Click on the Properties Tab.
  4. Click on the ellipsis button button next to Object Groups in the Properties window. The Maintain Object Groups window will open.
  5. Click on the Object Group you would like to remove.
  6. Click on the Remove button.
  7. Click OK.
  8. Click CTRL+ S to save the Activity.

 

This is the legacy version of the XMPro Documentation site. For the latest XMPro documentation, please visit documentation.xmpro.com

X