ManPageW ReportProcess

From ADempiere ERP Wiki

Jump to: navigation, search

Return to Index

Enjoy it, and help to fill it! But please, always respecting copyright.

Please write your contributions under the Contributions Section



Contents

Window: Report & Process

Description : Maintain Reports & Processes

Help : The Report & Process Window is used to define the parameters and access rules for every Report and Process within the system. This window is for System Admin use only.



Tab: Report & Process

Description : Define Report & Process

Help : The Report and Process Tab defines each report and process run in the system. Please note that the Print Format is only used for Document Print when you want to share a common format defined on System level. For normal reports and formats, you would not define a Print Format here, but modify the generated print format and set it as the default.

Table Name  : AD_Process

Fields

Name Description Help Technical Data
Client Client/Tenant for this installation. A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. AD_Client_ID

NUMBER(10)

TableDir

Organization Organizational entity within client An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. AD_Org_ID

NUMBER(10)

TableDir

Search Key Search key for the record in the format required - must be unique A search key allows you a fast method of finding a particular record.

If you leave the search key empty, the system automatically creates a numeric number. The document sequence used for this fallback number is defined in the "Maintain Sequence" window with the name "DocumentNo_<TableName>", where TableName is the actual name of the table (e.g. C_Order).

Value

NVARCHAR2(40)

String

Name Alphanumeric identifier of the entity The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. Name

NVARCHAR2(60)

String

Description Optional short description of the record A description is limited to 255 characters. Description

NVARCHAR2(255)

String

Comment/Help Comment or Hint The Help field contains a hint, comment or help about the use of this item. Help

NVARCHAR2(2000)

Text

Active The record is active in the system There are two methods of making records 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 reports.

There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries.

IsActive

CHAR(1)

YesNo

Beta Functionality This functionality is considered Beta Beta functionality is not fully tested or completed. IsBetaFunctionality

CHAR(1)

YesNo

Entity Type Dictionary Entity Type; Determines ownership and synchronization The Entity Types "Dictionary", "Adempiere" and "Application" might be automatically synchronized and customizations deleted or overwritten.

For customizations, copy the entity and select "User"!

EntityType

VARCHAR2

Table

Data Access Level Access Level required Indicates the access level required for this record or process. AccessLevel

CHAR(1)

List

Report Indicates a Report record The Report checkbox indicates that this record is a report as opposed to a process IsReport

CHAR(1)

YesNo

Server Process Run this Process on Server only Enabling this flag disables to run the process on the client. This potentially decreases the availability. IsServerProcess

CHAR(1)

YesNo

Classname Java Classname The Classname identifies the Java classname used by this report or process. Classname

NVARCHAR2(60)

String

Procedure Name of the Database Procedure The Procedure indicates the name of the database procedure called by this report or process. ProcedureName

NVARCHAR2(60)

String

Workflow Workflow or combination of tasks The Workflow field identifies a unique Workflow in the system. AD_Workflow_ID

NUMBER(10)

TableDir

Report View View used to generate this report The Report View indicates the view used to generate this report. AD_ReportView_ID

NUMBER(10)

TableDir

Direct print Print without dialog The Direct Print checkbox indicates that this report will print without a print dialog box being displayed. IsDirectPrint

CHAR(1)

YesNo

Print Format Data Print Format The print format determines how data is rendered for print. AD_PrintFormat_ID

NUMBER(10)

TableDir

Show Help ShowHelp

CHAR(1)

List

Statistic Count Internal statistics how often the entity was used For internal use. Statistic_Count

NUMBER(10)

Integer

Statistic Seconds Internal statistics how many seconds a process took For internal use Statistic_Seconds

NUMBER

Integer

Jasper Report JasperReport

NVARCHAR2(255)

Text


Tab: Report Translation

Description :

Help :

Table Name  : AD_Process_Trl

Fields

Name Description Help Technical Data
Client Client/Tenant for this installation. A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. AD_Client_ID

NUMBER(10)

TableDir

Organization Organizational entity within client An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. AD_Org_ID

NUMBER(10)

TableDir

Process Process or Report The Process field identifies a unique Process or Report in the system. AD_Process_ID

NUMBER(10)

TableDir

Language Language for this entity The Language identifies the language to use for display and formatting AD_Language

VARCHAR2

Table

Active The record is active in the system There are two methods of making records 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 reports.

There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries.

IsActive

CHAR(1)

YesNo

Translated This column is translated The Translated checkbox indicates if this column is translated. IsTranslated

CHAR(1)

YesNo

Name Alphanumeric identifier of the entity The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. Name

NVARCHAR2(60)

String

Description Optional short description of the record A description is limited to 255 characters. Description

NVARCHAR2(255)

String

Comment/Help Comment or Hint The Help field contains a hint, comment or help about the use of this item. Help

NVARCHAR2(2000)

Text


Tab: Report Access

Description : Report Access

Help : The Report Access Tab determines who can access a report or process

Table Name  : AD_Process_Access

Fields

Name Description Help Technical Data
Client Client/Tenant for this installation. A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. AD_Client_ID

NUMBER(10)

TableDir

Organization Organizational entity within client An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. AD_Org_ID

NUMBER(10)

TableDir

Process Process or Report The Process field identifies a unique Process or Report in the system. AD_Process_ID

NUMBER(10)

TableDir

Role Responsibility Role The Role determines security and access a user who has this Role will have in the System. AD_Role_ID

NUMBER(10)

TableDir

Active The record is active in the system There are two methods of making records 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 reports.

There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries.

IsActive

CHAR(1)

YesNo

Read Write Field is read / write The Read Write indicates that this field may be read and updated. IsReadWrite

CHAR(1)

YesNo


Tab: Parameter

Description : Report Parameter

Help : The Report Parameter Tab defines any parameters required to execute a report or process.

Table Name  : AD_Process_Para

Fields

Name Description Help Technical Data
Client Client/Tenant for this installation. A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. AD_Client_ID

NUMBER(10)

TableDir

Organization Organizational entity within client An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. AD_Org_ID

NUMBER(10)

TableDir

Process Process or Report The Process field identifies a unique Process or Report in the system. AD_Process_ID

NUMBER(10)

TableDir

Name Alphanumeric identifier of the entity The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. Name

NVARCHAR2(60)

String

Description Optional short description of the record A description is limited to 255 characters. Description

NVARCHAR2(255)

String

Comment/Help Comment or Hint The Help field contains a hint, comment or help about the use of this item. Help

NVARCHAR2(2000)

Text

Active The record is active in the system There are two methods of making records 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 reports.

There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries.

IsActive

CHAR(1)

YesNo

Entity Type Dictionary Entity Type; Determines ownership and synchronization The Entity Types "Dictionary", "Adempiere" and "Application" might be automatically synchronized and customizations deleted or overwritten.

For customizations, copy the entity and select "User"!

EntityType

VARCHAR2

Table

Centrally maintained Information maintained in System Element table The Centrally Maintained checkbox indicates if the Name, Description and Help maintained in 'System Element' table or 'Window' table. IsCentrallyMaintained

CHAR(1)

YesNo

Sequence Method of ordering records; lowest number comes first The Sequence indicates the order of records SeqNo

NUMBER(10)

Integer

DB Column Name Name of the column in the database The Column Name indicates the name of a column on a table as defined in the database. ColumnName

VARCHAR2

String

System Element System Element enables the central maintenance of column description and help. The System Element allows for the central maintenance of help, descriptions and terminology for a database column. AD_Element_ID

NUMBER(10)

Search

Reference System Reference and Validation The Reference could be a display type, list or table validation. AD_Reference_ID

NUMBER(10)

Table

Reference Key Required to specify, if data type is Table or List The Reference Value indicates where the reference values are stored. It must be specified if the data type is Table or List. AD_Reference_Value_ID

NUMBER(10)

Table

Value Format Format of the value; Can contain fixed format elements, Variables: "_lLoOaAcCa09" Validation elements:
	(Space) any character

_ Space (fixed character) l any Letter a..Z NO space L any Letter a..Z NO space converted to upper case o any Letter a..Z or space O any Letter a..Z or space converted to upper case a any Letters & Digits NO space A any Letters & Digits NO space converted to upper case c any Letters & Digits or space C any Letters & Digits or space converted to upper case 0 Digits 0..9 NO space 9 Digits 0..9 or space

Example of format "(000)_000-0000"

VFormat

NVARCHAR2(20)

String

Dynamic Validation Dynamic Validation Rule These rules define how an entry is determined to valid. You can use variables for dynamic (context sensitive) validation. AD_Val_Rule_ID

NUMBER(10)

TableDir

Length Length of the column in the database The Length indicates the length of a column as defined in the database. FieldLength

NUMBER(10)

Integer

Mandatory Data entry is required in this column The field must have a value for the record to be saved to the database. IsMandatory

CHAR(1)

YesNo

Range The parameter is a range of values The Range checkbox indicates that this parameter is a range of values. IsRange

CHAR(1)

YesNo

Default Logic Default value hierarchy, separated by ; The defaults are evaluated in the order of definition, the first not null value becomes the default value of the column. The values are separated by comma or semicolon. a) Literals:. 'Text' or 123 b) Variables - in format @Variable@ - Login e.g. #Date, #AD_Org_ID, #AD_Client_ID - Accounting Schema: e.g. $C_AcctSchema_ID, $C_Calendar_ID - Global defaults: e.g. DateFormat - Window values (all Picks, CheckBoxes, RadioButtons, and DateDoc/DateAcct) c) SQL code with the tag: @SQL=SELECT something AS DefaultValue FROM ... The SQL statement can contain variables. There can be no other value other than the SQL statement. The default is only evaluated, if no user preference is defined. Default definitions are ignored for record columns as Key, Parent, Client as well as Buttons. DefaultValue

NVARCHAR2(2000)

String

Default Logic 2 Default value hierarchy, separated by ; The defaults are evaluated in the order of definition, the first not null value becomes the default value of the column. The values are separated by comma or semicolon. a) Literals:. 'Text' or 123 b) Variables - in format @Variable@ - Login e.g. #Date, #AD_Org_ID, #AD_Client_ID - Accounting Schema: e.g. $C_AcctSchema_ID, $C_Calendar_ID - Global defaults: e.g. DateFormat - Window values (all Picks, CheckBoxes, RadioButtons, and DateDoc/DateAcct) c) SQL code with the tag: @SQL=SELECT something AS DefaultValue FROM ... The SQL statement can contain variables. There can be no other value other than the SQL statement. The default is only evaluated, if no user preference is defined. Default definitions are ignored for record columns as Key, Parent, Client as well as Buttons. DefaultValue2

NVARCHAR2(2000)

String

Min. Value Minimum Value for a field The Minimum Value indicates the lowest allowable value for a field. ValueMin

NVARCHAR2(20)

String

Max. Value Maximum Value for a field The Maximum Value indicates the highest allowable value for a field ValueMax

NVARCHAR2(20)

String


Tab: Parameter Translation

Description :

Help :

Table Name  : AD_Process_Para_Trl

Fields

Name Description Help Technical Data
Client Client/Tenant for this installation. A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. AD_Client_ID

NUMBER(10)

TableDir

Organization Organizational entity within client An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. AD_Org_ID

NUMBER(10)

TableDir

Process Parameter AD_Process_Para_ID

NUMBER(10)

TableDir

Language Language for this entity The Language identifies the language to use for display and formatting AD_Language

VARCHAR2

Table

Active The record is active in the system There are two methods of making records 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 reports.

There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries.

IsActive

CHAR(1)

YesNo

Translated This column is translated The Translated checkbox indicates if this column is translated. IsTranslated

CHAR(1)

YesNo

Name Alphanumeric identifier of the entity The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. Name

NVARCHAR2(60)

String

Description Optional short description of the record A description is limited to 255 characters. Description

NVARCHAR2(255)

String

Comment/Help Comment or Hint The Help field contains a hint, comment or help about the use of this item. Help

NVARCHAR2(2000)

Text

Contributions

Personal tools