Edit Grid

 You can customize the display and behavior of your FAB data grid through Edit Grid.

More Information:


Edit a new or existing data grid

The following steps illustrate how to edit a new or existing data grid.

Steps

1. Expand the Grid Configuration pane if not already expanded.

2. Expand the FAB Application Data Grids Tree node if it isn't already expanded by clicking on the arrow.

3. Right click a data grid in the list.

4. Select the Edit Grid Configuration menu.  The Edit grid window will appear.  Use the sections and steps below to configure the data grid.

Grid General Configuration (General Tab)

Use the general configuration tab to setup basic grid properties.

PropertyDescriptionRequired?
Grid TitleEnter a unique title for the grid.  This title will be displayed to users.true
Grid CategoryThe grid can be placed in one of three sections in an applicaiton tab. Select the category that beat applies to the data grid's contents and use.  The options are Data Entry, Assumptions, and Report.  The assumptions section appearls at the top of the tab, data entry in the middle, and reports on the bottom.true
TM1 Cube NameThis is the name of the cube that contains the data and cube view for this data grid.  The cube must exist on the TM1 server.true
TM1 Cube ViewThis is the name of the TM1 or Enterprise Services cube view used as the data grid data srouce.  This view must be deinfed in TM1 or in Enterprise Services.true
Total DimensionThis is the name of the dimension used for the total feature of report data grids.  The total feature allows a gorup of records to be totalled for this dimension (for example: cd_Account). The feature displays the total row with a yellow highlight and can be toggled on an off using the data grid button bar.  This property is used in conjunction with the Total Member below to display sub totals in report grids, for example: Total salary for all accounts for an employee for a fiscal year. false
Total MemberThe member in the Total Dimension (above) that identifies the total row in the data set.  For example: All Accounts. false

Grid Columns Configuration (Columns Tab)

ColumnDescriptionRequired?
Display NameEnter a unique title for the data column.  This will be displayed in the column header of the data grid for this column.true
TM1 Dimension NameThe dimension or measure name in the TM1 cube view used to populate this column.  Read Only.  This is populated automatically and can only be changed in the cube view.true
Full Column NameThis is the true dimension or measure name in the TM1 cube view.  Read Only.  This is populated automatically and can only be changed in the underlying cube view.true
Column Data TypeThe suggested column data type used to display data in the column to end users.  Choices are string , Number, or DateTime.  Number fields automatically enforce number only entry in the column, DataTime only allows valid date values and includes a pop up calendar for editing.  If a format is set in the underlying dimension for a member, it will override this suggested setting.true
Column FormatSpecify a format for a number or DateTime field.false
Column AlignAlignment of the data in the column, choices are Right, Left, and Center. false
Column EditorColumns are edited by end users using either a plain text box, auto complete combo box / list of choices , or a combo box list of choices.  For both the auto complete and the combo box a user must choose from the choices in the list.  If you choose either an autocomplete or a combo box you must specify its data source for the list of choices using the Pick List Dimension property and the Pick List Dimension Attribute property.true
TM1 Dimension AliasEnter the TM1 dimension alias to be displayed for each element in this column.  Example:  To display the Name - Num attribute in the column for the cd_Employee dimension set this property to: Name - Num.  The dimension alias must exist in the dimension. If you don't specify an alias, the elements will be displayed using their names.  By default, this alias is also used for a pick list.false
Use TM1 PickList?Set this property to true (click it) if you want to use a TM1 defined pick list as a data list source for your auto complete or combo box editor specified above.  To use a TM1 pick list, the Pick List Dimension must be set to the dimension that has the data that you want to appear in the list. false
Pick List Dimension

This property is used to set the dimension name used as a data source for your pick list for a autocomplete or combo box editor.  This property doesn't apply to TextBox or DataTime columns.   If you want to use a TM1 picklist, you can do this by specifying the dimension name in this property and setting the Use TM1 PickList? column to true.  A TM1 pick list is defined in a dimension (see the TM1 developers guid for specifics).  You can define them either as a static list (for a limted number of values) or as a subset. 

Configuring a static pick list in TM1:

1. In TM1 architect, find the dimension (usually a measure dimension prefixed with cdm) that contain the measure you would like a pick list for.

2. Right click the dimension and choose Edit Element Attributes.

3. Find the PickList column.  If it isn't there create it by selecting Edit -> Add New Attribute from the attribute windows menu.  Name the new attribute PickList as save it.

4.  Find the measure you want to make a list for in the element list in the attributes window.

5. Type in the pick list definition.  A pick list beging with the word static and the list options are seperated with the : character, for example, a list of appointment codes: static:R1:C:R2:R3

6. Exit the attribute editor.

Subset based pick Lists aren't supported at this time.

 
Pick List Dimension Attribute

 If you have set the Pick List Dimension property above, you can set this property to a valid attribute in the Pick List Dimension.  This attribute will be used to select a subset of the dimension members in combination with the Pick List Dimension Attribute Value below.

 
Pick List Dimension Attribute Value

 Set this property to a valid value for the Pick List Dimension Attribute property above.  This is used to filter the list of elements returned from the Pick List Dimension.  For example: you want to filter the cd_Account dimension elements to return a pick list of just eh active accounts.  To do this set Pick List Dimension Attribute to "cd_Account".  Set this property (Pick List Dimenstion Attribute Value) to "Active".

 
Pick List Dimension Attribute To Display

 If you are filterting your Pick List Dimension by attribute using the Pick List Dimension Attribute and Value properties above, you can choose to display another attribute in your pick list for each dimension element.  Specify the name of the attribute to display.  It must be a valid attribute in the Pick List Dimension.

 
Pick List Dimension Attribute 1

 An optional attribute to be returned with the Pick List Dimension data. It must be a valid attribute in the Pick List Dimension.

 
Pick List Dimension Attribute 2

 An optional attribute to be returned with the Pick List Dimension data.  It must be a valid attribute in the Pick List Dimension.

 
Pick List Dimension Attrbute 3

 An optional attribute to be returned with the Pick List Dimension data.  Ite must be a valid attribute in the Pick List Dimension.

 
Aggregate Function

 Set this to Total to create an automatic total of the values in the column.  The total will appear at the bottom of the data grid.

 
Visible

Set to True to show the column in the grid, False to hide it.

 
ReadOnly

 Set to True to set the column to read only, end users will not be able to edit the values in this column.

 
ReadOnlyColumnName

 Set this to the Tm1Dimension Name property of the column that would make this column appear as read only.  This feature allows you to set this column as read only if the value of another column is set to the ReadOnlyColumnValue below.

 
ReadOnlyColumnValue

 Set this to the value of the ReadOnlyColumnName that will cause this column to appear as read only.

 
RelatedColumnName

 Set this to the TM1Dimension Name property of the column that is related to this column.  If this is set, the RelatedAttributeName should also be set (below).  We both the RelatedColumnName and RelatedAttributeName are set, the value of this column will be set to the RelatedColumnName's RelatedAttributeName's value.  An example would be to set a salary object code column to the Salary object code attribute's value of a cd_Position element.

 
RelatedAttributeName

 Set this to either Attribute1, Attribute2, or Attribute3 that you would like to use in conjunction with the RelatedColumnName property above (see description above).  Theses attributes are set above in the Pick List Dimension Attribute 1 - 3 properities above.

 
DefaultValue

 The defalt value for this column.

 
Width

 The default column width for this column.