niota

fascinating. logical.

User Tools

Site Tools


niota-docs:niota_grid_config_catalog

This is an old revision of the document!


configure table or view to be managed

Any table or view that should be managed by niota must be configured as a so called catalog object. Every catalog object has a unique ID by which this object is referenced later on. See below how to create a catalog object.

navigate to the menu item

  • add/edit a record → enter valid values for fields listed below

catalog object




Catalog ID

Unique ID for this catalog object. The catalog object ID for customer objects must be positive integer numbers. Negative integer numbers are reserved for system catalog object.

DB connection

Database connection where object is stored. Via this connection access to the database object is established.

Catalogobject

Physical name of the object on its original source database.

Description Catalogobject

Short description of the object.

Date of activation

Date when object is logically activated in niota. Activation date is optional and not parsed or used anywhere.

Object Category

Optional custom defined category to group catalog object by your needs. On grid edit page catalog object can be filtered by object category by default.

Filename formatter

Name of a formatter file without file extions. The formatter file is used to execute format option. The formatter file must be on the server in a subfolder which name matches the name of the database connection for this catalogobject.

Owner

ID of an user account who is the data owner of this catalog object. There are some APIs which return this data owner so it can be used in own scripts.

Deputy Group

ID of an usergroup which is the deputy group for data ownership. There are some APIs which return this deputy group so it can be used in own scripts.

suppress upload log

protected - Checkbox to switch off logging for this object in case table is populated via Excel(R) upload

Custom Flag 01 to Custom Flag 10

Checkboxes for custom use only.


instance of an object

An instance is a default or a configured representation of a catalogobject. By default for every catalog object the *default instance is created. You must not delete the *default instance of an catalogobject. If you want to have different represenations of a single physical object (table of or view) you can create different instances of this object with totally different settings.




Instance

Logical name for this instance. Do not use * anywhere in the name of your instance. * is a reserved character for system instances.

Description Instance

Description of instance to be used within niota.

Columnlist

List of columns in SQL notation in case not all columns should be selected or in case additional function on columns should be applied. When Join is used the columns must be qualified. See system defaults file for qualifier options.

The use Columnlist checkbox must be on to activate this option.

Read-only-list (deprecated)

Join

Optional (left outer) join condition to another table or view you want to join with the main table. The joined table must be qualified by schema name. When join is used, the columns in columnlist must be qualified as well if column names are ambigeous.

The use Join checkbox must be on to activate this option.

Filter

Filtering condition in SQL where - notation without WHERE keyword. The use Filter checkbox must be on to activate this option.

Group by

Group by clause in SQL notation without GROUP BY keyword. Group by needs aggregation functions in the column list.

The use Group by checkbox must be on to activate this option.

Order by

Order by clause in SQL notation without ORDER BY keyword. See system defaults file for default order by options.

Union

Union clause in SQL notation without “'UNION'' keyword. Tables in the union clause must be fully qualified as the connection settings are not applied to the union - string.

use Columnlist/Read-only list/Join/Filter/Group by/Order by/Union

Checkboxes to toggle usage of related SQL strings.

niota-docs/niota_grid_config_catalog.1641388493.txt.gz · Last modified: 2025/07/17 14:11 (external edit)