Properties

Properties are components of a Record Type, each defining a different data element of that Record Type.

The Column Property Editor

  • Title: This field names the property, and will be displayed as the column title in a Grid View.
  • Hint: When hovering over the name of the Property, this will be the message that appears to give the user more information on what the Property is for.
  • Data Type: Defines what type of data will be retained by the property. This is the core of what makes DataVoke so powerful, because here the framework can be configured to retain, manage, and use several kinds of data. The available options are as follows:
    • AttachmentAny file of any format may be attached.NOTE:Attachments should be limited to maximum size of 50 MB. Attachments with a size beyond 50 MB could potentially cause DataVoke to react erratically--either with "network connectivity" errors within DataVoke.
    • BooleanCreates a check-box that can be Checked, Unchecked, or Neutral (shown with a horizontal line through the box). Neutral is the default state.
    • DateTimeThe date is entered by choosing from a pop-up calendar. These DateTime values will always use the local client's time zone to display the local time(based off of the UTC offset). Below is an example of the functionality of this type:
      • Client A in EST saves the current date and time as a DateTime value of 8/6/2013 14:35:12 (a UTC offset of -5).
      • The value is saved in the framework (and internally in memory) as UTC date/time value 8/6/2013 19:35:12.
      • When Client B in PST views that DateTime value, it is displayed using the PST time zone with a value of 8/6/2013 11:35:12 (with a UTC offset of -8).
    • Static DateTimeSimilar to DateTime in format, except that these values will ONLY display the local time at which they were saved. In other words, the date and time that is shown will always be the same, no matter what time zone the user is in. What follows is an example showing the functionality of this type:
      • Client A in EST saves the current date and time as a StaticDateTime value of 8/6/2013 14:35:12 (a UTC offset of -5).
      • The value is saved in the framework (and internally in memory) as UTC date/time value 8/6/2013 19:35:12.
      • When Client B in PST views the StaticDateTime value, it is displayed as 8/6/2013 14:35:12 (using the UTC offset of -5 saved with the record from EST).
    • DecimalA numerical value in decimal form. There is no provision to specify the number of decimal places to be used.
    • IntegerAn integer value.
    • TextSimple plain text entry.  Text properties can also be Spell checked by enabling the "Check Spelling" option.
    • List:  Allows the property to store a list of values.  The values are added and managed on the Drop-down tab of the property.    
  • Do Not Save: If checked, the specified property will never be saved to the framework.
  • Check Spelling: If checked, a text property field will use the browser's dictionary to spell check the contents of  the text grid or form field.  This feature is only available for Text Properties.
  • Generated By Server: This feature is only available in DataTime type properties and will upon save will generate the data and time stamp directly from the server.
  • Display FormatThis is equivalent to forcing the displayed value to follow a certain format when displayed in the grid. The formatting options available for this setting can be seen via the field's drop-down menu. Note that the available options vary depending on the selected type of the property. Here are some examples that reflect some of the available options:
    • {0:C}; Displays a number in the form of Currency. 5 yields "$5.00".
    • {0:dd-MMM-yyyy}; Displays the date in the form "25-Oct-2013".
    • {0:dd-MMM-yyyy, hh:mm}; Displays date/time group as "25-Oct-2013, 12:38".
    • For more detailed information, the following article provides many examples:  Display Format
  • Formula: It allows the property to be automatically calculated based on a function or any other property in that record type. Click Expression Editor Icon to launch the Expression Editor, which allows the user to choose operators and fields as opposed to requiring manual entries. Formulas should be built one piece at a time and tested for errors after each piece until the entire formula is completed.
  • On Create Only:  If checked, the formula specified for the Formula setting will run only once, when the record is created.

Details

  • Always Required for Record Save:  If checked, the property becomes a mandatory field to be filled out when creating a new record of the type to which the property belongs. This field will be required regardless of which view is being used to create the record. It should be noted that fields can be required on a view-specific basis as well.
  • Ignore Record Status:  Some statuses are configured to automatically apply that status to an entire record, as opposed to an individual property. If such a status is applied to a record containing an "Ignore Record Status" property, then that property will retain its own status regardless of the status of the record it is contained in.
  • Name:  This is the official title of the property stored internally in the DataVoke Framework.
  • UID:  This is a read only globally unique ID used internally by the DataVoke Framework
  • ID: This is a read only numeric identifier of the property.
  • Note:  Enter a detailed description of the property's meaning and/or intent.
  • Record Type:  This block is for information only and cannot be modified from the tuner. It displays the record type to which the property being tuned belongs.  Use the Edit button to access the Edit Record Type screen

Conditional Statues

Status Expressions can be compared to conditional formatting in a spreadsheet, except that a status is more powerful than just affecting the appearance of a given cell. Multiple Status Expressions can be applied to any property. Status Expressions are applied in sequence, so for expressions that are not mutually exclusive, order does matter. The arrows on the right side of this section can be used to rearrange the expressions in the list.

To add a Conditional Status click on the Plus sign.  

Each Status Expression consists of two parts: the Status and the Expression.

Status:

When a new row is created by clicking the plus("+ ") Icon, clicking the “Set Status To” dialog will bring up a list of all available statuses. Simply select the desired status from the list. A few points to consider when making this selection:

  • Remember that a status can affect not only the appearance, but also the ability to change data contained in the property or record to which it is applied.
  • A Record Status will apply to the entire record, but only if applied to the Record Code property. A Record Status applied to a normal property will apply only to that property.
  • A Status Expression using a Record Status applied to the Record Code property will supersede the Status Expression of a normal property, unless that normal property is set to ignore the record status(i.e.,the Ignore Record Status setting for the property is enabled).

Refer to the Status Editor section of this documentation for more information on statuses.

Expression:

The Expression is what establishes the conditions under which the status is applied. To enter or change the Expression, click the Expression Editor icon to the right of the "If Expr = True” dialog, and the Expression Editor will appear. A few items to note:

  • The Expression Editor is identical to the Formula Builder.
  • The Expression that is built must return a boolean "True" or "False". If "True", the status will be applied.
  • If at some later point in time the Expression ceases to be "True", the status will NOT be removed. If this is desired, a separate Status Expression must be generated with the original Status and an opposite Expression.

Aggregation

Aggregation is useful for when a user wants to analyze large numbers of linked records. They require some work to set up effectively, but can become extraordinarily useful. Suppose for example that a user has a record type for discrepancies, which contains a linked property that links them to a given piece of equipment. It could be useful to know, while looking at the list of equipment, how many discrepancies are tagged to each. This may be accomplished with an Aggregate Property. To edit a property to be an Aggregate Property, all three Aggregate Property Settings fields (Source View, Aggregate, and Of Property) must be used appropriately, AND the Of Property itself must also be properly configured.  Before going into the Aggregate Property settings, there needs to be a brief discussion in regards to preliminarily setting up an Aggregate Property.

The first step in setting up any Aggregate Property is actually to set up a new view. This new view which will contain the Aggregate Property--is typically dedicated to completing the aggregation and not actually displayed in practice. This new view MUST be a Sub-Grid that is listening to the Source View that is specified (which is explained below). With this information in mind, the user can now address the Aggregate Property settings as they are editing an Aggregation Property in the new view.

  • Source View: As mentioned above, this is the view that the "new view" is listening to. It is from this view that the analysis is made.
  • Aggregate: These are the aggregate calculations that are available: Count, Average, Sum, Min, and Max.

Since a mathematical calculation is being performed, the specified type for the Aggregation Property must be numerical in nature; either Integer or Decimal.

For Average and Sum calculations, the Of Property(see below) must also be numerical in nature.

  • Only those records that would be visible in the Source View are used in the aggregate calculation.
  • Any filters that are tuned into the Source View will be applied.

Of Property:  This is the selected property from the Source View that the aggregate calculation will be performed on.

  • The list of available Aggregation Properties always begins with the term Records at the top, and then proceeds to list all properties visible in the Source View.
  • Remember that the properties visible in a view are NOT always the same as the properties of its primary record type. If the property that is needed is not listed, the user should try editing the Source View to include it.
  • When the aggregate calculation is applied, only those properties with values listed will be included. A blank cell will be omitted from the calculation.

Where Used

The grid displays results of all references to this property throughout the framework.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.