Catalog Resource Properties

Specify the aggregation function of the aggregation object.

Data type: String

By default, the property is "false". In this case, when a column's mapping name contains the "tablename_" prefix which however is not automatically generated but user customized and you add a view element based on the column, Server still removes the prefix from the display name of the view element.

Data type: Boolean

Specify the description of the object.

Data type: String

Specify the display name of the object.

Data type: String

Specify whether you can filter on the object.

Data type: Boolean

Data type: String

When this property is "false", Report Engine queries data on demand at runtime. When several business view elements are based on the same columns, they reuse the columns.

This property also affects the following:

• When it is "true", the List<ColumnInfo> parameter in the implementation class of the QueryOptimizer interface includes all columns in the business view; otherwise, it only includes columns that the report or dashboard uses.
• When it is "true", Server displays all the parameters that the business view applies in the UI for specifying the parameter values at runtime; otherwise, it only displays the parameters the data objects in the report or dashboard reference.

Data type: Boolean

Data type: String

• Unqualified Name
  Select to include neither catalog nor schema in data manipulation. If you add a table or view from a different schema, you can create queries on it and use the queries to build reports, but when you run the reports, the table or view applies the default schema and you get an error that the table or view does not exist.

  Example: SELECT t.c FROM t

• 2-Part Names
  Select to use schema in data manipulation. If you want to use tables and views from more than one schema, you must use 2 part or 3 part names.

  Example: SELECT schema.t.c FROM schema.t

• 3-Part Names
  Select to use both catalog and schema in data manipulation.

  Example: SELECT catalog.schema.t.c from catalog.schema.t

This is very useful when you want to build reports that get data from more than one catalog and/or schema. If you only use one unqualified name, the SQL statement that Server generates does not contain the catalog and schema name, and therefore Server may not be able to find the table or view in the default schema and/or catalog.

Data type: Enumeration

• Default (JDBC)
  
  Select to get the extra name characters from JDBC.
• User Defined
  
  Select to modify the quote character according to the database system.
  • Extra Characters
    
    Specify the extra characters for identifier names.
  • Quote Character
    Specify the quote character.

Data type: Enumeration

• Tables
  Select to apply the modified qualifier to all tables in the connection.
• Views
  Select to apply the modified qualifier to all views in the connection.
• Imported SQLs
  Select to apply the modified qualifier to all imported SQLs in the connection.
• Stored Procedures
  Select to apply the modified qualifier to all stored procedures in the connection.

Different database systems use different Date and Time formats for Date and Time values. You can specify the format here, so that when Server sends the SQL statement with Date or Time parameters, they can be correctly translated into the format of your database system. For example, in an Oracle database, the default Date format is "dd-MMM-yy"; while in a MySQL database system, it is "yyyy-MM-dd". Thus, you need to modify the Date format for the connection accordingly, so that the Server generated SQL statements can function correctly with the database.

The Date and Time formats Report supports follows that of Java. For more information, refer to the java.text package DateFormat interface in the Java API Specification.

Data type: String

Data type: String

Data type: String

• Default
  
  Select to apply the default setting of the database, which can be "Read & Write" or "Read Only".
• Read Only
  
  Select to allow users to access the database in read-only mode. This allows the driver to optimize performance for reporting which does not need to write to the database.
• Read & Write
  Select to allow users to access the database in read-write mode. This opens the database with updates enabled which requires more processing to ensure concurrency control.

Data type: Enumeration

• Default
  Select to apply the setting from the database.
• None
  Select to not use transactions in the connection.
• Read Uncommitted
  Select to allow dirty reads, non-repeatable reads, and phantom reads to occur in the connection. This mode can speed up the transaction of the connection.

  If you select this mode, transactions are not isolated from each other. If the database supports other transaction isolation levels, it ignores whatever mechanism it uses to implement those levels, so that they do not adversely affect other transactions. Transactions running at the Read Uncommitted level are usually read-only.

  When you set the Read Only option and select the Transaction Isolation option of "Read Uncommitted", it provides faster access to the data. However, if a database transaction is rolled back, the read retrieves an invalid row and results in an inaccurate report.

• Read Committed
  Select to prevent dirty reads, and allow non-repeatable reads and phantom reads to occur in the connection.

  If you select this mode, when one transaction is reading, updating, or deleting a row, other transactions cannot update or delete it until this transaction has been committed or rolled back.

• Repeatable Read
  Select to prevent dirty reads and non-repeatable reads, and allow phantom reads to occur in the connection.

  If you select this mode, when one transaction is updating, deleting several rows, or inserting new rows into them, other transactions cannot also update or delete these rows, until this transaction has been committed or rolled back.

• Serializable
  Select to prevent dirty reads, non-repeatable reads, and phantom reads in the connection.

  If you select this mode, when one transaction is updating, deleting several rows, or inserting new rows into them, other transactions cannot update, delete these rows, or insert any new rows into these rows, until this transaction has been committed or rolled back.

Data type: Enumeration

• Tables
  Select to apply the specified schema to all tables in the connection.
• Views
  Select to apply the specified schema to all views in the connection.
• Stored Procedures
  Select to apply the specified schema to all stored procedures in the connection.

Specify the description of the connection.

Data type: String

Data type: String

Data type: Boolean

• Select to push down the group level summary computations to the database if it can perform the computations; otherwise, Report Engine do the computations itself.
• Clear to have Report Engine perform the group level summary computations itself.

Data type: Boolean

For Hive connections, this property can only be "true".

• SQL92
  Select to use the SQL92 standard.
• +
  Select to use Oracle's "+=+" standard.

Data type: Enumeration

SQL of Explicit Join notation: select … from A inner join B on (A.c1 = B.c2)

SQL of Implicit Join notation: select … from A,B where A.c1 = B.c2

Data type: Boolean

For Hive connections, this property can only be "true".

Once you specify the property, the Server administrators are not able to create or schedule report data cache and in-memory cubes, and Report Engine can no longer push down group level summary computations for the catalog containing the connection.

Data type: String

When you use parameters to build queries, there may be special characters in the parameter values like a back slash (\), and you would like Server to interpret them literally, rather than as a special character. In this case, you can replace the special characters with another string according to your database, for example, for an MySQL database, use "\\" to represent "\".

Specify the characters that you want to replace in parameter values when Server passes the parameter values to queries.

Data type: String

• ISO 8601 format
  Select to parse the Date/Time data using ISO 8601 format.
• JDBC timestamp escape format
  Select to parse the Date/Time data using the JDBC Timestamp format.

Data type: String

Data type: String

Data type: Boolean

Data type: String

Data type: Integer

Specify the description of the object.

Data type: String

Data type: String

Specify the display width of the object, which takes effect when you insert the object into reports. Type a numeric value to change the width. If you do not set the display width, Server applies a default width to it automatically.

Data type: Float

After you set the Display Width property of an object and use the object while creating a data component with wizard, Server may adjust its width according to the paper size.

Data type: Boolean

When writing the value of a formula or string that references an encrypted parameter to log, Report Engine may not encrypt the parameter value.

Data type: Boolean

When this property is "true", users should obtain parameter values only from API and there is no parameter dialog box available in any Designer or Server UI for inputting values. Users need to provide values of the parameter by API such as URLs, coding, and sessions; otherwise, Report Engine applies the default value of the parameter.

When this property is "false", the parameter values can be obtained from both GUI and API.

When a member of a cascading parameter group can get values from API only, it means that all the higher-level members shall get values from API only. This also applies to parameters on which other parameters depend. When several parameters share values in JDashboard, if any of them can get values from API only, they will share the values from API.

Data type: Boolean

When you bind a parameter with a column, you can specify to hide the parameter if only a single value is returned to it at runtime. Report Engine then applies the returned single value as the default value of the parameter. This can be very useful for security. For example, you can use a parameter bound with a DBField such as UserID and if there is one to one mapping of UserID to the Server users, then a query for a parameter such as Select UserID FROM Employees WHERE UserID = @username would just return a single value and thus you can use it as a filter for any other queries you create.

Data type: Boolean

Data type: String

Once you edit the SQL statement, the later changes to the Bind Column and Display Column properties cannot take effect unless you remove the SQL lines or bind column to the parameter all over again using dialog box.

Data type: String

Data type: String

Data type: String

Data type: String

Data type: String

Data type: Integer

To help users avoid typing a value out of range, you can add the value range to the end of the prompt text, for example, "Type a customer ID (1~100):"; to help users avoid typing a value in a wrong pattern, you can add the value pattern to the end of the prompt text, for example, "Type an order date (MMM-dd-yy):".

If you bind a parameter with a column, you can specify a RLS policy defined on the bound column to the parameter, then at runtime, the specified security identifier only sees the records it is allowed to view in the parameter value drop-down list. See Applying RLS to a Parameter in the Report Designer Guide for an example.

Data type: String

A required parameter must be fulfilled, meaning, users must supply a value to the parameter before they can run the report. If you clear the option, the parameter is an optional parameter. The value of an optional parameter can be blank, which means users can either type a value, or leave it as it is. In the dialog box for specifying the parameter values, Report marks the prompt text of a required parameter with the "*" symbol.

Data type: Boolean

If a parameter is optional and you do not expect it to take effect in the report, when specifying the parameter value, you should clear the content in the value text box. Any value left in the text box functions in the report.

Data type: String

Data type: Boolean

Data type: Boolean

Data type: Boolean

For certain types of parameters, the value format Report provides may not satisfy your requirement. In this case, you can define your own preferred format. Once you define the value format, any value supplied to the parameter should be in accordance with this format; otherwise, there is an error message.

Data type: String

Data type: String

Data type: Boolean

Data type: String

Data type: Boolean

Data type: Integer

Data type: Integer

Data type: String

Data type: String

Data type: String

• true
  Select to push down the group level summary computations to the database if it can perform the computations; otherwise, Report Engine do the computations itself.
• false
  Select to have Report Engine perform the group level summary computations itself.

Data type: Enumeration

Data type: String

Server does not provide this property when the object is in a MongoDB/JSON/Elasticsearch connection.

• default
  Select to apply the setting from the database.
• read & write
  Select to allow users to access the database in read-write mode.
  
• read only
  Select to allow users to access the database in read-only mode. This option can speed up the transaction of the catalog.

Data type: Enumeration

Data type: String

Data type: Boolean

• default
  Select to apply the setting from the database.
• none
  Select to not use transactions for the object.
• read uncommitted
  Select to allow dirty reads, non-repeatable reads, and phantom reads to occur for the object. This mode can speed up the transaction of the catalog.
• read committed
  Select to prevent dirty reads, and allow non-repeatable reads and phantom reads to occur for the object.
• repeatable read
  Select to prevent dirty reads and non-repeatable reads, and allow phantom reads to occur for the object.
• serializable
  Select to prevent dirty reads, non-repeatable reads, and phantom reads for object.

Data type: Enumeration

If you select this option, when the query uses a parameter and the parameter value is null at runtime, Server removes this condition from the query's or business view's criterion.

If a query applies a String-typed parameter and users leave the value of the parameter blank at runtime:

• If you select "Ignore Predicate If Parameter Value Is Null" for the query, Server regards the value of the parameter as "NULL" and does not display the predicate in the WHERE clause.
• If you do not select "Ignore Predicate If Parameter Value Is Null" for the query, Server treats the value of the parameter as an empty string (¡®¡¯).

Specify whether the column is an array type.

Data type: Boolean

Data type: Integer

Data type: String

Specify whether to control the SQL type of the formulas and summaries which reference the column if the column is of the BigDecimal type.

• true
  
  Select to apply the BigDecimal type to the formulas and summaries and set their SQL Type to 3.
• false
  
  Select to apply the normal data type to the formulas and summaries.

Data type: Boolean

Specify the description of the object.

Data type: String

Specify the display width of the object, which takes effect when you insert the object into reports. Type a numeric value to change the width. If you do not set the display width, Server applies a default width to it automatically.

Data type: Float

After you set the Display Width property of an object and use the object while creating a data component with wizard, Server may adjust its width according to the paper size.

Data type: String

Data type: Integer

Specify the mapped name of the object in the catalog.

Data type: String

Specify the nullability for the values of the object.

• true
  
  Select to indicate the object supports null values.
• false
  
  Select to indicate the values of the object cannot be null.
• unknown
  
  Select to indicate whether the values of the object can be null or not is unknown.

Data type: Enumeration

Data type: Integer

Specify the precision for the values of the object. The default precision comes from data source metadata and defines the object's largest number of digits. The larger the precision is, the more memory it might take; however, the more accurate values you can get.

Data type: Integer

Specify the number of digits to the right of the decimal point for the values of the object.

Data type: Integer

Data type: String

Data type: String

Specify the description of the object.

Data type: String

When the table is in a JSON/Elasticsearch connection, this property shows the element path from the root element to current element, and is read only.

Data type: String

Data type: String

Server does not provide this property when the table is in a JSON/Elasticsearch connection.

Specify the mapped name of the object in the catalog.

Data type: String

Data type: String

Server does not provide this property when the table is in a MongoDB/JSON/Elasticsearch connection.

Data type: String

Server does not provide this property when the table is in a MongoDB/JSON/Elasticsearch connection.

Data type: String

Server does not provide this property when the table is in a MongoDB/JSON/Elasticsearch connection.