ERP 2.50:User Manual/Application Dictionary
| Languages: |
Contents |
Module
Use the Module window to create and register a new extension module. A module is a content container that allows you to group all artifacts that make up your extension, including Application Dictionary meta data, data model elements, software resources and reference data.
By defining your extensions as modules, you will then be able to extract them, package them and reuse them in different environments.
All extensions and configurations of an Openbravo ERP instance should be defined in the context of a module.
Openbravo ERP supports three types of extension modules:
- Modules: the basic content container, which defines additional functionality. A module can add artifacts to an Openbravo ERP installation but cannot modify artifacts that are owned by other modules. This constraints allows to simplify dependency management. You can define and install as many modules as you wish in your system.
- Packs: a grouping of modules. You can define and install as many packs as you wish in your system.
- Template: a module with a specific type of artifact, called configuration script that allows you to modify attributes of artifact owned by other modules. You can use an industry template to package and redistribute a specific system configuration. In a system, there can only be one industry template defined.
Please notice that system configurations for a particular instance must be defined in the context of an industry template.
Fields
| Client | In the case of modules, the client is always System | |
| Organization | In the case of modules, the organization is always the super-organization, * | |
| Active: | There are two methods of making modules unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reporting. There are two reasons for de-activating and not deleting records:
(1) The system requires the record for auditing purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are existing invoices for it. By de-activating the Business Partner you prevent it from being used in future transactions.|| | |
| Name | The name of the module. It is up to 60 characters in length. | |
| Version | Modules must have a version, which is then used for dependency tracking. Version numbers must follow the pattern XXX.YYY.ZZZ, where XXX, YYY and ZZZ are integers. For example a valid version number is 1.0.4. The last digit group, ZZZ, is ignored for dependency purposes. For example, if you have module A at version 1.0.0 that depends on module B at version 1.1.0, the publication of version 1.1.1 of B will not break the dependency while version 1.2.0 of B will not be compatible with version 1.0.0 of A. | |
| Java Package | The name of the Java package, using Java naming standards. This package will contain all the Java artifacts included in the module. | |
| Type | Specify whether the module is a module, a pack or a template | |
| In Development | Select the checkbox if the module is currently in development. Artifacts of a module that is not in development cannot be modified. Conversely, only modules in development can be extracted and packaged. | |
| Default | Select the checkbox to make this module the default. | |
| Description | A brief description of the module | |
| Help | Type a more extensive description of the module, explaining its functionality. | |
| Translation required | Select the checkbox if the module contains user interface elements that need translating into other languages. | |
| Is Translation Module | Select the checkbox if the module is a translation module that contains the language translation of another module. | |
| Module Language | For modules requiring translations, select the base language of the module. | |
| Has Reference Data | Select the checkbox if the module includes reference data. When installing a module with reference data, the reference data is first applied at system level but it can then be applied in the context of a specific client or organization.
| |
| Has Chart of Accounts | Select the checkbox if the module includes a chart of accounts | |
| License Type | Select a license type for the module from the list, for example the Openbravo Public License. | |
| License Text | Type or paste the license text for the chosen license | |
| Author | Type the name of the module´s author or authors | |
| URL | If required, type a URL for example to a web page giving more information about the module. | |
| Status | Displays the current installation status of the module. | |
| Update information | Use this field to provide a change history for each version. | |
| Register Module | Use this button to register the module in the Openbravo Central Repository. Registration ensure the validity and uniqueness of the package name, Java package and database prefix, guaranteeing that different developers do not produce conflicting modules. If you plan to share your module across instances, it is essential that you register your module.|| |
Include
If your module is a pack and includes other modules, use this tab to specify the details here.
Fields
| Client | The client is always System | |
| Organization | The organization is always the super-organization, * | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Module | This field displays the name of the current parent module | |
| Included Module | Select the module to be included | |
| First version | Specifies the version of the module to be included |
Dependency
If the module depends on another module, use this tab to specify the details.
Fields
| Client | The client is always System | |
| Organization | The organization is always the super-organization, * | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Module | Displays the current module | |
| Dependent Module | Select the module upon which the current module is dependent. | |
| First version | Specify the first version of the module upon which the current module is dependent. | |
| Last version | Specify the last version of the module upon which the current module is dependent. |
Translation
To provide a translation of the Module information type or paste the translated version here.
Fields
| Client | The client is always System | |
| Organization | The organization is always the super-organization, * | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Language | Type the language | |
| Description | Type or paste a brief description of the module | |
| Help / Comment | Type or paste a translation of the help text. | |
| License Text | Type or paste a translation of the license text for the chosen license | |
| Update information | If the module is an update, type or paste a translation of the update information. | |
| Reference Data Description | If the module includes refrence data type or paste a translation of the reference data description. |
Data Package
The Data Package is a grouping mechanism for tables within a module. Openbravo has a Java business object for each table. The Java package of the Java business object is defined in the Data Package. For example: a module for a CRM package with the name: org.crm has packages: - org.crm.order - org.crm.customer
The corresponding tables have then the following setting: - Customer, in the org.crm.customer package, resulting in the java class: org.crm.customer.Customer - SalesOrder, in the org.crm.order package, resulting in the java class: org.crm.order.SalesOrder
Fields
| Client | The client is always System | |
| Organization | The organization is always the super-organization, * | |
| Name | Type the name of the data package | |
| Description | Type a brief description of the data package | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Java Package | Type the name of the Java package, using Java naming standards, for example org.crm |
DB Prefix
Database prefixes are short (7 characters) identifiers for objects in database. The purpose of database prefixes is to avoid name collision among database objects (tables, views, PL/SQL functions, etc.) delivered by different modules. You must define at least one DB Prefix if you module includes database objects. Fields
| Client | The client is always System | |
| Organization | The organization is always the super-organization, * | |
| Name | Type the name of DBPrefix |
Tables and Columns
Edit tables and columns so that Openbravo can access the database, as well as control the role access.
Keep in Mind:
- Openbravo stores information in an external database, however the database is managed within the system. The management is done using tables and columns, each with corresponding attributes, keys, and other identification information.
- In order to access a table from a selected window it is essential to activate the table beforehand.
- Before creating tables and columns in the application, create them in the database.
Column
Define columns within a table that Openbravo can access in the database.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Application Element: | An element that consolidates help, descriptions and terms for a database column and allows for a central maintenance. | |
| Callout: | A series of actions that occur when data is modified. | |
| Callout: | A series of actions that occur when data is modified. | |
| Client: | Client for this installation. | |
| Column: | A link to the database column of the table. | |
| DB Column Name: | The name of a column within the database. | |
| Default Value: | The first non-null value in a set of values. It is used as a default value for a field when creating a record. | |
| Description: | A space to write additional related information. | |
| Development Status: | Development Status | |
| Display Encription: | An indication noting if the input box of a field will present full text or just asterisks. | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| Identifier: | This column is part of the record identifier | |
| Is desencryptable: | Is desencryptable | |
| Is secondary key: | Is secondary key | |
| Is session attribute: | Is session attribute | |
| Key column: | This column is the key in this table | |
| Length: | An indication of the column length as defined in the database. | |
| Mandatory: | An indication noting that completing in a field is required to proceed. | |
| Max. Value: | The highest possible value an item can have. | |
| Min. Value: | The lowest possible value an object can take. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Parent link column: | This column is a link to the parent table (e.g. header from lines) - incl. Association key columns | |
| Process: | A series of actions carried out in sequential order. | |
| Read Only Logic: | Logic to determine if field is read only (applies only when field is read-write) | |
| Reference: | The data type of this field. | |
| Reference Search Key: | The exact reference specification for a list or a table. | |
| Selection Column: | Is this column used for finding rows in windows | |
| Sequence: | The order of records in a specified document. | |
| Synchronize Column: | Change database table definition from application dictionary | |
| Table: | A dictionary table used for this tab that points to the database table. | |
| Translation: | An indication that an item is translated. | |
| Updatable: | An indication that an item can be updated by the user. | |
| Validation: | A validation rule that defines how an entry is determined to be valid or invalid. | |
| Value Format: | Value Format | |
| Version: | Version of the table definition |
Role Access
Edit role access to a particular table. Active
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Exclude: | A selection permitting or denying a role access to specified data. | |
| Organization: | Organizational entity within client | |
| Read Only: | An object which may only be viewed, not edited. | |
| Role: | The profile of security for the user defining what windows and tabs they can see. | |
| Table: | A dictionary table used for this tab that points to the database table. |
Table
Define tables that Openbravo can access in the database.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Create Columns from DB: | Create Dictionary Columns of Table not existing as a Column but in the Database | |
| Data Access Level: | A privilege required to make adjustments to an object. | |
| DB Table Name: | Name of the table in the database | |
| Description: | A space to write additional related information. | |
| Development Status: | Development Status | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| High Volume: | Use Search instead of Pick list | |
| Is default account: | Is default account | |
| Maintain Change Log: | Maintain a log of changes | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| PO Window: | Purchase Order Window | |
| Records deleteable: | Indicates if records can be deleted from the database | |
| Replication Type: | A distinct replication characteristic used for processes and sometimes grouped within a category. | |
| Security enabled: | If security is enabled, user access to data can be restricted via Roles | |
| Seq. of Introduced Tables: | The order of introduced tables. | |
| SQL_Record_Identifier: | SQL_Record_Identifier | |
| Table: | A dictionary table used for this tab that points to the database table. | |
| Validation: | A validation rule that defines how an entry is determined to be valid or invalid. | |
| View: | This is a view | |
| Window: | A work area which can be used to create, view, edit, and process a record. |
Windows, Tabs, and Fields
Create and edit windows, tabs, and fields according to your business preferences.
What is a Window?
Windows are screens used by the application to manage data. On these screens it is possible to insert, update or delete data. A window is composed of one or many tabs.
What is a Tab?
Tabs organize data in Openbravo hierarchically in a window. A tab is composed of one or many fields. In a window, tabs can be independent or subordinated to other tabs.
What is a Field?
Fields can be a registry, or space used for a particular data category. A field is one or more related characters treated as a unit constituting part of a record. Fields are where items such as names, dates, etc. are inserted.
Access
Edit role access to a window.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Editable Field: | An indication that this field may be viewed. | |
| Organization: | Organizational entity within client | |
| Role: | The profile of security for the user defining what windows and tabs they can see. | |
| Window: | A work area which can be used to create, view, edit, and process a record. |
Field
Define fields within a tab.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Central Maintenance: | A flag indicating that this label is managed in a central repository. | |
| Client: | Client for this installation. | |
| Column: | A link to the database column of the table. | |
| Description: | A space to write additional related information. | |
| Display Encription: | An indication noting if the input box of a field will present full text or just asterisks. | |
| Display Length: | The number of characters that made be added to a specified field. | |
| Display Logic: | A specification of statements which, when evaluated as false, are required to hide the field. | |
| Displayed: | Determines, if this field is displayed | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Field: | Any element which can be viewed, edited, or added to a window. | |
| Field Category: | A classification of similar fields. | |
| Field Only: | Label is not displayed | |
| Heading only: | Field without Column - Only label is displayed | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Read Only: | An object which may only be viewed, not edited. | |
| Record Sort No.: | A means of sorting and ordering records in a window. | |
| Same Line: | An indication that this field will be displayed on the same line as the previous one. | |
| Sequence: | The order of records in a specified document. | |
| Show in relation: | Show in relation | |
| Tab: | An indication that a tab is displayed within a window. | |
| Is First Focused Field: | An indication that if the field is the default focused field when the window loads. |
Tab
Define tabs within a window.
Fields:
| Accounting Tab: | This tab contain accounting information | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Column: | A link to the database column of the table. | |
| Confirmation Message: | A warning or information displayed when saving the record. | |
| Copy Tab Fields: | Copy Fields from other Tab | |
| Create Fields: | Create Field from Table, which do not exist in the Tab yet | |
| Description: | A space to write additional related information. | |
| Edit reference: | The form referenced in the edition command | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Filter clause: | Filter clause | |
| Has Tree: | Window has Tree Graph | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| Image: | A visual picture used to describe an item. | |
| Included Column: | Column determining if a Table Column is included in Ordering | |
| Included Tab: | Included Tab in this Tab (Master Dateail) | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Order Column: | Column determining the order | |
| Order Tab: | The Tab determines the Order | |
| Organization: | Organizational entity within client | |
| Process: | A series of actions carried out in sequential order. | |
| Read Only: | An object which may only be viewed, not edited. | |
| Sequence: | The order of records in a specified document. | |
| Single Row Layout: | Default for toggle between Single- and Multi-Row (Grid) Layout | |
| SQL Order by Clause: | A specification of the SQL ORDER BY clause used for a displayed default sort of records. | |
| SQL Where Clause: | A specification of the SQL WHERE clause used for permanently filtering displayed data. | |
| Tab: | An indication that a tab is displayed within a window. | |
| Tab Level: | Hierarchical Tab Level (0 = top) | |
| Table: | A dictionary table used for this tab that points to the database table. | |
| TranslationTab: | This tab contains translation information | |
| Window: | A work area which can be used to create, view, edit, and process a record. |
Tab Class
View the Java class that implements the tab.
Fields:
| Action: | A drop down list box indicating the next step to take. | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Callout: | A series of actions that occur when data is modified. | |
| Client: | Client for this installation. | |
| Default: | A value that is shown whenever a record is created. | |
| Java Class Name: | Java Classname | |
| Model Object: | An identification of an object in the dictionary. | |
| Organization: | Organizational entity within client | |
| OS Task: | The name of an operating task. | |
| Process: | A series of actions carried out in sequential order. | |
| Reference: | The data type of this field. | |
| Special Form: | The name of the form being edited. | |
| Tab: | An indication that a tab is displayed within a window. | |
| Workbench: | Collection of windows, reports | |
| Workflow: | A set of procedures used to show the path to complete a specified task. |
Tab Mapping
View the Java class mapping that enables it to be accessible through a browser..
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Default: | A value that is shown whenever a record is created. | |
| Mapping Name: | A direction or guide used to call this object through a browser. | |
| Model Object: | An identification of an object in the dictionary. | |
| Organization: | Organizational entity within client |
Window
Define automatically generated windows of the application.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Color: | Color for backgrounds or indicators | |
| Copy Window Tabs: | Copy all Tabs and Fields from other Window | |
| Default: | A value that is shown whenever a record is created. | |
| Description: | A space to write additional related information. | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| Image: | A visual picture used to describe an item. | |
| Name: | Alphanumeric identifier of the entity | |
| Organization: | Organizational entity within client | |
| Sales Transaction: | An indication that a transfer of goods and money between business partners is occurring. | |
| Window: | A work area which can be used to create, view, edit, and process a record. | |
| Window Type: | Type or classification of a Window |
Reference
Edit standard data types such as strings, integers, lists as well as custom data types.
What is a Reference?
References define data types. This is for the purpose of inputs, processing, outputs, or storage by the application regarding fields and their parameters. In the configuration of a column, it specifies the data type that it contains. Reference examples include the following: string, date, integer, list, and search.
List Reference
Define the list elements for a list validation type.
What is the List Reference?
Defines the possible values for a list type reference. This type of reference is used only when there is a unique set of possibilities that are not significantly different from one another. A good example of such a list are days of the week. This list can only be modified by the System Administrator.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Description: | A space to write additional related information. | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Reference: | The data type of this field. | |
| Reference List: | Reference List based on Table | |
| Search Key: | A fast method for finding a particular record. | |
| Valid from Date: | A parameter stating the starting time of a specified request. | |
| Valid until Date: | A parameter stating the ending time of a specified request. |
Reference
Define basic reference name, description and type.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Description: | A space to write additional related information. | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Reference: | The data type of this field. | |
| Validation type: | Different method of validating data | |
| Value Format: | Value Format |
Selector Class
Define the Java classes that implement the selector reference.
Fields:
| Action: | A drop down list box indicating the next step to take. | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Callout: | A series of actions that occur when data is modified. | |
| Client: | Client for this installation. | |
| Default: | A value that is shown whenever a record is created. | |
| Java Class Name: | Java Classname | |
| Model Object: | An identification of an object in the dictionary. | |
| Organization: | Organizational entity within client | |
| OS Task: | The name of an operating task. | |
| Process: | A series of actions carried out in sequential order. | |
| Reference: | The data type of this field. | |
| Special Form: | The name of the form being edited. | |
| Tab: | An indication that a tab is displayed within a window. | |
| Workbench: | Collection of windows, reports | |
| Workflow: | A set of procedures used to show the path to complete a specified task. |
Selector Mapping
Add mappings used to call the selector reference through a browser.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Default: | A value that is shown whenever a record is created. | |
| Mapping Name: | A direction or guide used to call this object through a browser. | |
| Model Object: | An identification of an object in the dictionary. | |
| Organization: | Organizational entity within client |
Selector Reference
Define the selector reference with corresponding table and column.
What is a Selector Reference?
In some cases the user can use a pop-up window to fill in a selected field. The pop-up facilitates the selection from the list with a possibility of using different filters. These fields are created with the search type reference.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Column: | A link to the database column of the table. | |
| Organization: | Organizational entity within client | |
| Reference: | The data type of this field. | |
| Search: | ||
| Table: | A dictionary table used for this tab that points to the database table. | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Column Type: | ||
| DB Column Name: | The name of a column within the database. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Search: | ||
| Suffix: | One or many characters which are added at the end of a statement or number. |
Table Reference
Define the table reference.
What is the Table Reference?
Allows the user to choose a table and a column that are related to the table type reference. This reference is used when a selected column does not meet the rule "table name"+_ID. In this case the TableDir reference cannot be used and it is essential to create a table type reference indicating the Table and Column that the user wants to make a reference to. For example, the user can find the M_LocatorTo_ID column in the M_MovementLine table. To be TableDir it is M_Locator_ID with a table type reference Locator.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Display column: | Column that will display | |
| Display Value: | Displays Value column with the Display column | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Key column: | Unique identifier of a record | |
| Organization: | Organizational entity within client | |
| Reference: | The data type of this field. | |
| SQL Order by Clause: | A specification of the SQL ORDER BY clause used for a displayed default sort of records. | |
| SQL Where Clause: | A specification of the SQL WHERE clause used for permanently filtering displayed data. | |
| Table: | A dictionary table used for this tab that points to the database table. |
Report and Process
Define and edit reports and processes (database or Java).
Parameter
Define parameters for a process.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Application Element: | An element that consolidates help, descriptions and terms for a database column and allows for a central maintenance. | |
| Central Maintenance: | A flag indicating that this label is managed in a central repository. | |
| Client: | Client for this installation. | |
| DB Column Name: | The name of a column within the database. | |
| Default Logic 2: | Default value hierarchy, separated by ; | |
| Default Value: | The first non-null value in a set of values. It is used as a default value for a field when creating a record. | |
| Description: | A space to write additional related information. | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| Length: | An indication of the column length as defined in the database. | |
| Mandatory: | An indication noting that completing in a field is required to proceed. | |
| Max. Value: | The highest possible value an item can have. | |
| Min. Value: | The lowest possible value an object can take. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Process: | A series of actions carried out in sequential order. | |
| Process Parameter: | Process Parameter | |
| Range: | The parameter is a range of values | |
| Reference: | The data type of this field. | |
| Reference Search Key: | The exact reference specification for a list or a table. | |
| Sequence: | The order of records in a specified document. | |
| Validation: | A validation rule that defines how an entry is determined to be valid or invalid. | |
| Value Format: | Value Format |
Process Class
Define the Java classes for the process that implement it.
Fields:
| Action: | A drop down list box indicating the next step to take. | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Callout: | A series of actions that occur when data is modified. | |
| Client: | Client for this installation. | |
| Default: | A value that is shown whenever a record is created. | |
| Java Class Name: | Java Classname | |
| Model Object: | An identification of an object in the dictionary. | |
| Organization: | Organizational entity within client | |
| OS Task: | The name of an operating task. | |
| Process: | A series of actions carried out in sequential order. | |
| Reference: | The data type of this field. | |
| Special Form: | The name of the form being edited. | |
| Tab: | An indication that a tab is displayed within a window. | |
| Workbench: | Collection of windows, reports | |
| Workflow: | A set of procedures used to show the path to complete a specified task. |
Process Mapping
Create mappings for a process used to call the it through a browser.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Default: | A value that is shown whenever a record is created. | |
| Mapping Name: | A direction or guide used to call this object through a browser. | |
| Model Object: | An identification of an object in the dictionary. | |
| Organization: | Organizational entity within client |
Report & Process
Define and edit reports and database or Java processes.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Data Access Level: | A privilege required to make adjustments to an object. | |
| Description: | A space to write additional related information. | |
| Direct print: | Print without dialog | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| Is background: | Is background process | |
| Is Jasper Report: | ||
| Java Class Name: | Java Classname | |
| JR Template name: | ||
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Print Format: | The structure in which a document will be printed. | |
| Procedure: | Name of the Database Procedure | |
| Process: | A series of actions carried out in sequential order. | |
| Report: | An indication whether something is a document, or a report which summarizes information. | |
| Report View: | View used to generate this report | |
| Search Key: | A fast method for finding a particular record. | |
| Statistic Count: | Internal statistics how often the entity was used | |
| Statistic Seconds: | Internal statistics how many seconds a process took | |
| User can start process: | Determines a process can be initiated by the user |
Role Access
Edit role access to a particular report or process.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Editable Field: | An indication that this field may be viewed. | |
| Organization: | Organizational entity within client | |
| Process: | A series of actions carried out in sequential order. | |
| Role: | The profile of security for the user defining what windows and tabs they can see. |
Form
Create and edit forms (manual windows) to be used in the application.
What is a Form?
A manually generated window where data is introduced, modified, or deleted. Unlike standard windows, forms permit more complex data entry and allow the user to input data to be used in more than one location.
Form
Define forms (manual windows) of the application.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Data Access Level: | A privilege required to make adjustments to an object. | |
| Description: | A space to write additional related information. | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| Java Class Name: | Java Classname | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Special Form: | The name of the form being edited. |
Form Class
Define the Java classes that implement the form.
Fields:
| Action: | A drop down list box indicating the next step to take. | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Callout: | A series of actions that occur when data is modified. | |
| Client: | Client for this installation. | |
| Default: | A value that is shown whenever a record is created. | |
| Java Class Name: | Java Classname | |
| Model Object: | An identification of an object in the dictionary. | |
| Organization: | Organizational entity within client | |
| OS Task: | The name of an operating task. | |
| Process: | A series of actions carried out in sequential order. | |
| Reference: | The data type of this field. | |
| Special Form: | The name of the form being edited. | |
| Tab: | An indication that a tab is displayed within a window. | |
| Workbench: | Collection of windows, reports | |
| Workflow: | A set of procedures used to show the path to complete a specified task. |
Form Mapping
Add mappings used to call the form through a browser.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| AD_Model_Object_Mapping_ID: | ||
| Client: | Client for this installation. | |
| Default: | A value that is shown whenever a record is created. | |
| Mapping Name: | A direction or guide used to call this object through a browser. | |
| Model Object: | An identification of an object in the dictionary. | |
| Organization: | Organizational entity within client |
Rule Access
Edit role access to a particular form.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Editable Field: | An indication that this field may be viewed. | |
| Organization: | Organizational entity within client | |
| Role: | The profile of security for the user defining what windows and tabs they can see. | |
| Special Form: | The name of the form being edited. |
Message
Create and edit application initiated information and error messages.
Message
Define application initiated information and error messages.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Hint: | A help or advice provided regarding the application initiated message. | |
| Message: | The name of the application initiated message. | |
| Message Text: | The text/content of the spplication initiated message. | |
| Message Type: | Type of message (Informational, Menu or Error) | |
| Organization: | Organizational entity within client | |
| Search Key: | A fast method for finding a particular record. |
Text Interfaces
Edit translations of forms and reports.
Text Interface
Edit labels of forms and reports.
What is the Text Interface?
Text interfaces determine what content language/information the user sees in each window, tab, and field.
Keep in mind:
In this window, the user configures the translation of manual windows and generated documents. They can indicate a text to be translated and the folder where it is located. If the folder's name is empty the translation is applied to all files where the selected text appears and to the files that do not have any specific translation.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Filename: | ||
| Interface Text: | Text interfaces Identifier | |
| Organization: | Organizational entity within client | |
| Text: | A place to add observations related to a specified check point. |
Synchronize Terminology
Edit fields, columns, parameters etc., by synchronizing them with the data contained in the associated application element.
Setup
Element
Edit the central repository of application elements to update field name descriptions and help/comments.
Element
Create and edit application elements and their texts.
Keep in Mind:
- All columns with the same database name have by default, centralized help, description and terminology. For example, the name error has the abstract name of ad_error_id. Thus, if a company wants to change the element from error to mistakes, this is completed and managed here in one step.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Application Element: | An element that consolidates help, descriptions and terms for a database column and allows for a central maintenance. | |
| Client: | Client for this installation. | |
| DB Column Name: | The name of a column within the database. | |
| Description: | A space to write additional related information. | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Print Name on Purchase Order: | A option to print the name given in the purchase order document. | |
| Print Text: | The displayed text of an element. | |
| Purchase Order Description: | A space to write additional related information for a purchase order. | |
| Purchase Order Help: | A comment that adds additional information to help users work with fields within a purchase order. | |
| Purchase Order Name: | A identifier for a document which can be used as a search tool for a purchase order. |
Used in Columns
View tables and columns that a particular application element applies to.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Application Element: | An element that consolidates help, descriptions and terms for a database column and allows for a central maintenance. | |
| Callout: | A series of actions that occur when data is modified. | |
| Client: | Client for this installation. | |
| Column: | A link to the database column of the table. | |
| DB Column Name: | The name of a column within the database. | |
| Default Value: | The first non-null value in a set of values. It is used as a default value for a field when creating a record. | |
| Description: | A space to write additional related information. | |
| Display Encription: | An indication noting if the input box of a field will present full text or just asterisks. | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Help/Comment: | A comment that adds additional information to help users work with fields. | |
| Identifier: | This column is part of the record identifier | |
| Key column: | This column is the key in this table | |
| Length: | An indication of the column length as defined in the database. | |
| Mandatory: | An indication noting that completing in a field is required to proceed. | |
| Max. Value: | The highest possible value an item can have. | |
| Min. Value: | The lowest possible value an object can take. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Parent link column: | This column is a link to the parent table (e.g. header from lines) - incl. Association key columns | |
| Process: | A series of actions carried out in sequential order. | |
| Read Only Logic: | Logic to determine if field is read only (applies only when field is read-write) | |
| Reference: | The data type of this field. | |
| Reference Search Key: | The exact reference specification for a list or a table. | |
| Selection Column: | Is this column used for finding rows in windows | |
| Sequence: | The order of records in a specified document. | |
| Synchronize Column: | Change database table definition from application dictionary | |
| Table: | A dictionary table used for this tab that points to the database table. | |
| Translation: | An indication that an item is translated. | |
| Updatable: | An indication that an item can be updated by the user. | |
| Validation: | A validation rule that defines how an entry is determined to be valid or invalid. | |
| Value Format: | Value Format | |
| Version: | Version of the table definition |
Field Category
Edit the subsections of fields within of tabs.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Field Category: | A classification of similar fields. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client |
Auxiliary Input
Define new inputs for tabs in order to change their behaviour.
Keep in Mind:
- This is an supplementary field associated to a tab. It allows the user access to data not defined in the tab and to data that does not have session variable. They are used in an analogous form to tab fields.For example, selecting a form of payment can require that all payments be made in cash. Although other options exist, the user is forced to follow the rule.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Tab: | An indication that a tab is displayed within a window. | |
| Validation Code: | The code that will be executed to determine the setup procedure. |
Callout
Define callouts of the application, their classes, and their mapping plan.
What is a Callout?
A callout (sometimes known as a trigger) is an automatic action that occurs when a user makes changes to a given window. An example of a callout is adding or subtracting visible fields, or filling up an order based on information inputted into the system. The user can activate all previously developed issues that are being used in the application.
Callout
Define and edit callouts of the application.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Callout: | A series of actions that occur when data is modified. | |
| Client: | Client for this installation. | |
| Description: | A space to write additional related information. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client |
Callout Class
Define Java classes that implement the callout.
Fields:
| Action: | A drop down list box indicating the next step to take. | |
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Callout: | A series of actions that occur when data is modified. | |
| Client: | Client for this installation. | |
| Default: | A value that is shown whenever a record is created. | |
| Java Class Name: | Java Classname | |
| Model Object: | An identification of an object in the dictionary. | |
| Organization: | Organizational entity within client | |
| OS Task: | The name of an operating task. | |
| Process: | A series of actions carried out in sequential order. | |
| Reference: | The data type of this field. | |
| Special Form: | The name of the form being edited. | |
| Tab: | An indication that a tab is displayed within a window. | |
| Workbench: | Collection of windows, reports | |
| Workflow: | A set of procedures used to show the path to complete a specified task. |
Callout Mapping
Introduce mappings used to call the callout through a browser.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Default: | A value that is shown whenever a record is created. | |
| Mapping Name: | A direction or guide used to call this object through a browser. | |
| Model Object: | An identification of an object in the dictionary. | |
| Organization: | Organizational entity within client |
Validation Setup
Create and edit the validation setup to be used for columns of tables.
Validation
Edit the validation setup used for columns of tables.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| Client: | Client for this installation. | |
| Description: | A space to write additional related information. | |
| Entity Type: | Dictionary Entity Type; Determines ownership and synchronization | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Type: | A distinct item characteristic used for processes and sometimes grouped within a category. | |
| Validation: | A validation rule that defines how an entry is determined to be valid or invalid. | |
| Validation Code: | The code that will be executed to determine the setup procedure. |
Month
Define month names and the part of the year they belong to.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| AD_Month_ID: | A month of the year | |
| Client: | Client for this installation. | |
| Name: | A identifier for a document which can be used as a search tool. | |
| Organization: | Organizational entity within client | |
| Quarter: | Quarter of the year | |
| Search Key: | A fast method for finding a particular record. |
Dimension
Define parameters to be used in making reports.
Fields:
| Active: | A flag indicating whether this record is available for use or de-activated. | |
| AD_Dimension_ID: | Dimension ID | |
| Client: | Client for this installation. | |
| DB Column Name: | The name of a column within the database. | |
| DB Table Name: | Name of the table in the database | |
| Description: | A space to write additional related information. | |
| Join Group 1: | ||
| Join Group 2: | ||
| Line No: | Unique line for this document | |
| Organization: | Organizational entity within client | |
| Process: | A series of actions carried out in sequential order. |