Skip to content

DataSplice Support Website

Sections
Personal tools
You are here: Home » Product Manuals DataSplice 3.0 » DataSplice Administration Client Manual » Settings and Attributes
 

Settings and Attributes

When on the View Configuration screen, selecting Settings and Attributes from the Configuration Section drop-down list displays the following screen:

View Configuration

Basic Options

The Basic Options section allows for general settings to be configured for a particular view, such as the data source to connect to and the permitted operations within the view.

Option Name Option Value
Product Name The name of the licensed product this view is associated with.
View Description Describes the functionality provided by the view.
Query Permission Specifies a condition used to evaluate if the user has permission to query records for this view. This permission is true by default.
Insert Permission Specifies a condition used to evaluate if the user has permission create new records within this view. This permission is false by default.
Update Permission Specifies a condition used to evaluate if the user has permission to modify existing records within this view. This permission is false by default.
Delete Permission Specifies a condition used to evaluate if the user has permission to delete existing records within this view. This permission is false by default.
Connection Profile The name of the database profile to use from the Database Connection Profile section of the ADO.NET data source plug-in configuration.

SQL Statements

The Base SQL Statement section defines the specific information to retrieve and use from the database. The different fields and tables are specified using standard SQL syntax. SQL statements that are proprietary to the database in use are also valid.

Base SQL Statement

After a SQL statement is entered, clicking the Save Changes button Save Changes Button will update the view and rebuild the list of fields displayed in the grid.

In relation to the SQL statements available, there are some important considerations to keep in mind:

  • Certain providers have difficulty with complex query statements involving function calls, sub queries, etc. Often these statements can be compiled as database views which can then be queried simply.
  • Attributes are not processed within the SQL statement.
  • WHERE clauses in the SQL statement should be restricted to join statements and other clauses that should always be evaluated. Queries supplied by the Remote Client will be logically ANDed with this WHERE clause.

Field Name Mapping

After the view has been saved and the field list rebuilt, the list of available fields is displayed. This information shows up in the Field Name Mapping section.

Field Name Mapping

The Database Name and DataSplice Name columns specify the different names used to reference each field. The Database Name is simply extracted from the SQL statement. The DataSplice Name is generally the more important one, as it is the value that will be displayed and used throughout the application.

It is possible to use column aliases in the SQL statement to control the names of the fields, but it is typically clearer and easier to leave the aliases out of the statement and simply modify the DataSplice Name column.

The Override Filter Expression column is an advanced setting that allows the right-hand side of any queries bound to this view to be explicitly provided. This is only needed if the database provider cannot adequately determine the correct expression to use. Current Filter Expression will display the value that is used to generate queries.

Built-in View Attributes

Like the system and user/group attributes, attributes can be set at the view level as well. These are configured in the View Attributes section. Once configured, view attributes can control many aspects of the view behavior. Any number of additional attributes can be defined for this view in the Custom Attributes section.

Note: Keep in mind that attribute settings here will only apply for the selected view.

View Attributes

Explanation of Built-in View Attributes

The following is a brief explanation of the built-in view attributes. The format used is as follows:

  • User-Friendly Attribute Name as Displayed in the Admin Client (UNDERLYING ATTRIBUTE NAME CALLED BY DATASPLICE) - Textual explanation.

  • Allow Error Postponement (DS_ALLOW_POSTPONE_ERRORS) - When enabled, this attribute allows user errors to be postponed and sent to the DataSplice Server to be resolved at a later time. In this manner, errors can be resolved by the user from within the Remote Client or by an administrator from within the Administration Client.
  • Assume Modifications (DS_ASSUME_MODIFICATIONS) - Determines whether or not the Remote Client application will re-query a record after changes are committed. This may be useful if other non-DataSplice changes may have affected the record, such as database triggers.
  • Auto Commit Changes (DS_AUTO_COMMIT) - When enabled, changes on the Remote Client are immediately submitted to the DataSplice Server when the new or updated record loses focus. Thus, when this attribute is enabled, it is no longer necessary to use the Save Changes button to commit changes on the Remote Client.
  • Auto Postpone Errors (DS_AUTO_POSTPONE_ERRORS) - In conjunction with the Allow Error Postponement attribute, this attribute automatically postpones any errors from the Remote Client when synching up with the DataSplice Server.
  • Auto Reload (DS_AUTO_RELOAD) - When enabled, this attribute causes the view data to be refreshed when a record is saved or a view is navigated to.
  • Cache Timeout (DS_CACHE_TIMEOUT) - The amount of time, in minutes, that the Remote Client will retain query data in a cached state.
  • Date Format (DS_DATE_FORMAT) - This attribute defines how dates are formatted. It uses the same syntax as that in the date formatting section.
  • Decimal Precision (DS_DECIMAL_PRECISION) - This attribute specifies the number of decimal places to be displayed given a floating point number. The attribute is given an integer value. An example of this is for a number 1234.6789 with a decimal precision of 2 would display as 1234.67.
  • Default Filter Action (DS_DEFAULT_FILTER_ACTION) - This attribute specifies the initial behavior to undertake when a user hits the ENTER key when currently selected on a filter. Available options are:
    • Display Filter - Initially prompts the user for necessary criteria in order to perform the desired query.
    • Display Grid - Initially displays a set of data showing multiple records.
    • Display Record - Initially displays a single record at a time.
    • Navigate Up - Moves the user to the parent of the current view.
    • View Selection - Moves the user to the top level view list.
  • Default Grid Action (DS_DEFAULT_GRID_ACTION) - This attribute specifies the initial behavior to undertake when a user hits the ENTER key when currently selected on a grid. Available options are:
    • Display Filter - Initially prompts the user for necessary criteria in order to perform the desired query.
    • Display Grid - Initially displays a set of data showing multiple records.
    • Display Record - Initially displays a single record at a time.
    • Navigate Up - Moves the user to the parent of the current view.
    • View Selection - Moves the user to the top level view list.
  • Default Query (DS_DEFAULT_QUERY) - Specifies the query to execute by default, such as when the view is selected rather than a specific query from the navigation list.
  • Default Record Action (DS_DEFAULT_RECORD_ACTION) - This attribute specifies the initial behavior to undertake when a user hits the Enter key when currently selected in a single record display. Available options are:
    • Display Filter - Initially prompts the user for necessary criteria in order to perform the desired query.
    • Display Grid - Initially displays a set of data showing multiple records.
    • Display Record - Initially displays a single record at a time.
    • Navigate Up - Moves the user to the parent of the current view.
    • View Selection - Moves the user to the top level view list.
  • Hidden View (DS_HIDDEN_VIEW) - Determines if the view is visible or not to the users on the Remote Client.
  • Navigation Checkpoint (DS_NAVIGATION_CHECKPOINT) - Checkbox that determines whether or not the Remote Client remembers the user's place for the particular view. If this is true, it is possible to select Recent Data from the home screen to restore the position at a previous checkpoint.
  • Offline SQL Indexes (DS_OFFLINE_SQL_INDEX) - Allows indexes to be set up on the SQL CE engine when using offline sessions. This is particularly useful if an offline filter search is rather slow. In these circumstances, creating an index results in a quicker retrieval of data. This can be set for a field, such as Field Num, which then indexes that field. The format for multiple indexes looks like FieldOne Asc; FieldTwo Desc. In this manner, multiple fields can be indexed, separated by semicolons. It is also possible to create compound indexes by using a comma rather than a semi-colon. Using the same example, entering FieldOne, FieldTwo creates a single compound index. In general, individual indexes can be used effectively. If a query has a compound sort (involving multiple fields) and large amounts of data, then a compound index (in the same field order, and matching ASC/DESC order for each field) may improve performance further. By default, ascending order is used for indexes. To explicitly specify the order, use either Asc or Desc for ascending or descending, respectively. There are a few additional important indexing considerations:
    • While indexing speeds up searches, it can potentially slow down inserts and updates.
    • A large number of indexes can consume a considerable amount of storage space.
    • If a field name contains part of the reserved word for the order direction, then the order direction must be explicitly defined. For example, if a field is named Work Order Desc (for Work Order Description), it can be successfully indexed by entering Work Order Desc desc.
  • Record Description (DS_RECORD_DESCRIPTION) - The description used to identify records in this view when they show up in the modification list.
  • Use Transactions (DS_USE_TRANSACTIONS) - When true, this causes record commits to be performed in a transaction process.
    Note: Due to the nature of locked records in Maximo, this attribute should not be enabled when connecting to Maximo systems.
  • View Category (DS_VIEW_CATEGORY) - The grouping to associate this view within. For example, in a computerized maintenance management system (CMMS), typical view categories would be Inventory, Work Order, and Equipment.

Custom View Attributes

The Custom Attributes section allows for custom attributes to be defined for this view, in addition to the standard view attributes defined in the previous section.

Contents
 


Last modified 2007-02-01 03:21 PM
 
Powered by Plone

This site conforms to the following standards: