Appboard/old/data collections: Difference between revisions

imported>Cmace
(created to remove appboard_builder)
 
imported>Jason.nicholls
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Data Collections}}
[[Category:AppBoard old]]
[[Image:HeaderFlow03.png]]
[[Image:HeaderFlow03.png]]


Line 8: Line 10:


== Reviewing Data Collections ==
== Reviewing Data Collections ==
Use these instructions to view a list of all Data Collections that are available in the system:
Use these instructions to view a list of all Data Collections that are available in the system:


# Click "Data Collections" link in the left side tool pallette.  
# Click "Data Collections" in the left side tool pallette.  
# Data Collections are listed in a data grid in the first page.
# Data Collections are listed in a data grid in the first page.
# To preview the data in the Data Collection you can hit the preview button on the same line.
# To preview the data in a Data Collection, click the blue preview button in the rightmost column.


== Filtering Data Collections ==
For general information about the various options for filtering Data Collections in AppBoard, see [[appboard/old/filtering_data_collections|Filtering Data Collections]].




== Adding a Data Collection ==
== Adding a Data Collection ==
Use these instructions to create a new Data Collection:
Use these instructions to create a new Data Collection:


# Click "Data Collections" link in the left side tool palette.
# Click '''Data Collections''' link in the left side tool palette.
# Click "Add" button at the bottom of the page.
# Click '''Add''' button at the bottom of the page to launch the '''Data Collections Wizard'''.
# Enter a unique name for the new Data Collection.
# On the '''Configure''' panel, enter the following:
# Select the Data Source from the drop down list.
#* '''Data Collection Name''' - Provide a unique name for the Data Collection.
# Choose the Polling Interval value, these are in seconds.
#* '''Data Source''' - Select the Data Source that will be used for the Data Collection.
# Add any optional Context Data Class
#* '''Options''' - Check one or more of the following options:
# Add any optional Filter Rules. See [[Filtering_Collections_in_AppBoard| Filtering a Data Collection]].
#*# '''Filter''' - Provides an interface for adding server-side filters to the Data Collection (See [[appboard/old/server_side_filter|Server-Side Filters]] and [[appboard/old/compare_static_value_filter|Simple Property Comparison]] for more information).
# Click the "Next" button.
#*# '''Server Side Sort''' - Allows you to specify the default sort order in which the Data Collection is displayed using these options:
# Add any Client Side Filter Rules as needed.
#*#* '''Server Side Sort''' - Select the field from the Data Source by which the Data Collection will be sorted.
#*#* '''Order''' (the box to the right) - Select either '''Ascending''' or '''Descending'''.
#*# '''Limit Row Count''' - Allows you to limit the number of rows returned by the server for this Data Collection, using the '''Server Side Row Limit''' box.
#*# '''[[appboard/old/caching_and_polling|Polling]]''' - Provides the option of setting a Polling Interval.  This is the number of seconds to wait before the client will fetch the latest data from the server cache.  For example, if this is set to 30, every 30 seconds AppBoard will refresh the Data Collection to have the latest data from the server.  The minimum polling interval value is 5 seconds and the maximum value is 3600 seconds (one hour).  '''Note:''' To maximize performance, Data Collections are only polled when one or more of the Widgets that uses that Data Collection is in the foreground display.
#* Click the '''Next''' button.
# On the '''Client Side Filter''' panel, add one or more '''Client Side Filter Rules''' as needed (See [[appboard/old/client_side_filter|Client-Side Filters]] for more information).
# Click "Finish" to create the Data Collection.
# Click "Finish" to create the Data Collection.
{|border="1" cellpadding="5"
!Name
!Description
|-
|''Data Collection Name''
|Your unique name that you give to the Data Collection.
|-
|''Data Source''
|The Data Source being used in this Data Collection
|-
|''Polling Interval''
|
|-
|''Context Data Class''
|
|}
===Server Side Filter===
If you want to add a Server Side Filter, in the "Configure" screen of the "Data Collections Wizard," click "Add Rule" under the "Server Side Filter" field. You are given three options: Data Collection Context Comparison, Server Widget Interaction Comparison, and Simple Property Comparison.  Here are some guidelines for each of the choices.
'''''Data Collection Context Comparison'''''
{|border="1" cellpadding="10"
!Field
!Description
|-
|''Target Data Collection''
|The Data Collection you are applying the filter to.
|-
|''Property''
|This is the property name to perform the comparison against.
|-
|''Operator''
|This is the operation part of the expression, IE. Equal to(=), Not equal to(!=), Contains, etc.
|-
|''Local Property''
|This is the property name of this widget that will be evaluated against the property of the other widget.
|-
|}
'''''Server Widget Interaction Comparison'''''
{|border="1" cellpadding="10"
!Field
!Description
|-
|''Event''
|The event that will cause the filter rule to be active.
|-
|''Widget''
|The widget whose property will be compared against.
|-
|''Property''
|This is the property name to perform the comparison against.
|-
|''Operator''
|This is the operation part of the expression, IE. Equal to(=), Not equal to(!=), Contains, etc.
|-
|''Local Property''
|This is the property name of this widget that will be evaluated against the property of the other widget.
|}
'''''Simple Property Comparison'''''
{|border="1" cellpadding="10"
!Field
!Description
|-
|''Property''
|This is the property name to perform the comparison against.
|-
|''Operator''
|This is the operation part of the expression, IE. Equal to(=), Not equal to(!=), Contains, etc.
|-
|''Value''
|This is the static value that the property will be evaluated against.
|}
===Client Side Filter===
If you wish to add a Client Side Filter to your Data Collection, click the "Add Rule" button in the "Client Side Filter" screen of the "Data Collections Wizard."  From there, you will be given three choices: [[Regular Expression Filter|Match Regular Expression]], [[Compare Static Value Filter|Simple Property Comparison]], [[Widget Interaction Filter|Widget Interaction Comparison]].


== Editing a Data Collection ==
== Editing a Data Collection ==
Use these instructions to modify an existing Data Collection:
Use these instructions to modify an existing Data Collection:


# Click "Data Collections" link in the left side tool palette.
# Click '''Data Collections''' in the left side tool palette.
# Select the Data Collection from the data grid.
# Select the Data Collection from the data grid.
# Click "Edit" to view the selected Data Collection.
# Click '''Edit''' at the bottom to enter the '''Data Collections Wizard''' for that Data Collection.
# Make any modifications to the Data Collection.
# Make any necessary modifications to options in the '''Configure''' section.
# Click "Finish" to save the changes to the Data Collection.
# Click '''Next'''
# Make any necessary modifications to the '''Client Side Filter''' section.
# Click '''Finish''' to save the changes to the Data Collection.




== Removing a Data Collection ==
== Removing a Data Collection ==
Use these instructions to remove an existing Data Collection:
Use these instructions to remove an existing Data Collection:


# Click "Data Collections" link in the left side tool palette.
# Click '''Data Collections''' in the left side tool palette.
# Click on the Data Collection you would like to delete.
# Click on the Data Collection you would like to delete.
# Click the "Delete" button at the bottom of the page.  
# Click the '''Delete''' button at the bottom of the page.  
# Click "Yes" to confirm the removal of the Data Collection or<br />click "No" if you do not wish to remove the Data Collection.
# Click '''Yes''' to confirm the removal of the Data Collection.

Latest revision as of 17:34, 17 July 2014

HeaderFlow03.png

Data Collections are sets of tabular data that are maintained in memory by AppBoard. The contents of the Data Collections can be manipulated through filtering, grouping, sorting and pivoting features available in the Data Collections Wizard. Associations can also be established between collections to support the visualization of multiple data sets.



Reviewing Data Collections

Use these instructions to view a list of all Data Collections that are available in the system:

  1. Click "Data Collections" in the left side tool pallette.
  2. Data Collections are listed in a data grid in the first page.
  3. To preview the data in a Data Collection, click the blue preview button in the rightmost column.


Filtering Data Collections

For general information about the various options for filtering Data Collections in AppBoard, see Filtering Data Collections.


Adding a Data Collection

Use these instructions to create a new Data Collection:

  1. Click Data Collections link in the left side tool palette.
  2. Click Add button at the bottom of the page to launch the Data Collections Wizard.
  3. On the Configure panel, enter the following:
    • Data Collection Name - Provide a unique name for the Data Collection.
    • Data Source - Select the Data Source that will be used for the Data Collection.
    • Options - Check one or more of the following options:
      1. Filter - Provides an interface for adding server-side filters to the Data Collection (See Server-Side Filters and Simple Property Comparison for more information).
      2. Server Side Sort - Allows you to specify the default sort order in which the Data Collection is displayed using these options:
        • Server Side Sort - Select the field from the Data Source by which the Data Collection will be sorted.
        • Order (the box to the right) - Select either Ascending or Descending.
      3. Limit Row Count - Allows you to limit the number of rows returned by the server for this Data Collection, using the Server Side Row Limit box.
      4. Polling - Provides the option of setting a Polling Interval. This is the number of seconds to wait before the client will fetch the latest data from the server cache. For example, if this is set to 30, every 30 seconds AppBoard will refresh the Data Collection to have the latest data from the server. The minimum polling interval value is 5 seconds and the maximum value is 3600 seconds (one hour). Note: To maximize performance, Data Collections are only polled when one or more of the Widgets that uses that Data Collection is in the foreground display.
    • Click the Next button.
  4. On the Client Side Filter panel, add one or more Client Side Filter Rules as needed (See Client-Side Filters for more information).
  5. Click "Finish" to create the Data Collection.

Editing a Data Collection

Use these instructions to modify an existing Data Collection:

  1. Click Data Collections in the left side tool palette.
  2. Select the Data Collection from the data grid.
  3. Click Edit at the bottom to enter the Data Collections Wizard for that Data Collection.
  4. Make any necessary modifications to options in the Configure section.
  5. Click Next
  6. Make any necessary modifications to the Client Side Filter section.
  7. Click Finish to save the changes to the Data Collection.


Removing a Data Collection

Use these instructions to remove an existing Data Collection:

  1. Click Data Collections in the left side tool palette.
  2. Click on the Data Collection you would like to delete.
  3. Click the Delete button at the bottom of the page.
  4. Click Yes to confirm the removal of the Data Collection.
Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Appboard/old/data_collections&oldid=1189"