ERP/3.0/Developers Guide/Database Model/org.openbravo.client.application/OBUIAPP Process
OBUIAPP_Process
- Name:OBUIAPP_Process
- Classname:OBUIAPP_Process
This table contains the following columns:
| Name | Nullable | Data Type | Description
|
| Isactive | No | CHAR (1) | 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 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. |
| Isbackground | No | CHAR (1) | This identifies a background process that will be run without any user interaction and needs to be scheduled properly before it will be run using the "Process Scheduling" window. |
| IsCanAddRecordsToSelector | No | CHAR (1) | By selecting this flag, the process will be available in the 'Defined Selector' window.
This process has to be capable of adding records to a selector. |
| AD_Client_ID | No | VARCHAR (32) | A Client is a company or a legal entity. You cannot share data between Clients. |
| Clientsidevalidation | Yes | VARCHAR (200) | JavaScript function to be executed before invoking the backend Handler.
This function (manually coded), can: - Perform validations on the parameters, being possible to prevent execution in case these validations are not satisfied. - Request for additional info to complete the parameter values. |
| Createdby | No | VARCHAR (32) | The Created By field indicates the user who created this record. |
| Created | No | TIMESTAMP (7) | The Created field indicates the date that this record was created. |
| Accesslevel | No | VARCHAR (60) | Indicates what type of data (in terms of AD_CLIENT and AD_ORG data columns) can be entered or viewed. We can classify data in 4 major categories:
- System (AD_CLIENT_ID=0, AD_ORG_ID=0) - system data (such as metadata for window, tab and field definition) - Organization (AD_CLIENT<>0, AD_ORG_ID<>0) - data particular to an organization (such as sales orders) - Client/Organization (AD_CLIENT<>0, AD_ORG_ID=anything) - data particular to an organization or shared among all organizations within one client - Client (AD_CLIENT<>0, AD_ORG_ID=0) - data that is specific to a client but can be used by all organizations within that client or All (AD_CLIENT=anything, AD_ORG_ID=anything) |
| Description | Yes | VARCHAR (255) | A description is limited to 255 characters. |
| Help | Yes | VARCHAR (2000) | The Help field contains a hint, comment or help about the use of this item. |
| IsMultiRecord | No | CHAR (1) | Multi Record allows to execute the process in multiple records at the same time. When this flag is set, multiple records can be selected in grid mode and the process can be executed in all of them at the same time. |
| Isgridlegacy | No | CHAR (1) | This flags is used to specify if this process should be compatible with the legacy parameter windows.
The legacy parameter windows could only contain one grid, so the _selection and _allRows properties of the grid were directly accessible in the handler from the params object. I.e: JSONArray gridRows = jsonparams.getJSONArray(ApplicationConstants.ALL_ROWS_PARAM); New process definitions should access these value like this: JSONObject myGridItem = jsonparams.getJSONObject("myGridItemName"); JSONArray myGridSelectedRows = myGridItem.getJSONArray("_selection"); The 'Compatibility with Legacy Grids' flag should only be checked if its handler retrieves the grid values in the old way.
|
| Classname | No | VARCHAR (200) | The classname is used when generating a representation of the table in java (the entity or business object). The classname is the simplename of the class (so without the package name). Often the AD_Table.name can be used here. The combination of classname and package needs to be unique. |
| AD_Module_ID | No | VARCHAR (32) | Indicates the module the element forms part of. |
| Name | No | VARCHAR (60) | A more descriptive identifier (that does need to be unique) of a record/document that is used as a default search option along with the search key (that is unique and mostly shorter). It is up to 60 characters in length. |
| ON_Load_Function | Yes | VARCHAR (200) | In this field a javascript function can be defined. This function will be executed when the parameter window is loaded, just after the default values are set. |
| ON_Refresh_Function | Yes | VARCHAR (200) | In this field a javascript function can be defined. This function will be executed when the parameter window refresh action be invoked. For example, if the process has a child-process, once the child-process finishes, it will invoke a refresh of the parent process.
Since each process has its particularities, a custom refresh function should be defined in case the process be susceptible of being refreshed/reloaded. |
| Obuiapp_Process_ID | No | VARCHAR (32) | Process Defintion is a re implementation of Process with 3.0 infrastructure. |
| AD_Org_ID | No | VARCHAR (32) | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. |
| Is_Explicit_Access | No | CHAR (1) | When processes are executed from a button in a window, by default, they inherit permissions granted to the window. So if the window is accessible it can be executed without the need of explicitly granting access for that role to the process.
This behavior can be overwritten by the "Secured Process" preference. Processes with "Requires Explicit Access Permission" flag set to true, do not inherit permissions from the window but they always require the role to be explicitly granted to this process. |
| Value | No | VARCHAR (40) | A search key allows for a fast method of finding a particular record. If you leave the search key empty, the system automatically creates a numeric number originating from a document sequence defined in the "Document Sequence" window. The sequence naming convention follows a rule "DocumentNo_TableName", where TableName is the actual name of the database table (e.g. C_Order).
Usually, company's internal identifiers for various records (products, customers, etc) are stored here. |
| Uipattern | No | VARCHAR (60) | Defines the UI Pattern that the object implements. |
| Updated | No | TIMESTAMP (7) | The Updated field indicates the date that this record was updated. |
| Updatedby | No | VARCHAR (32) | The Updated By field indicates the user who updated this record. |
Columns
Active
- Physical column name: Isactive
- Property Name: active
- Reference: YesNo
- Default value: Y
Background
- Physical column name: Isbackground
- Property Name: background
- Reference: YesNo
- Default value: N
Can Add Records to a Selector
- Physical column name: IsCanAddRecordsToSelector
- Property Name: canAddRecordsToASelector
- Reference: YesNo
- Default value: N
Client
- Physical column name: AD_Client_ID
- Property Name: client
- Reference: TableDir
Foreign key column to AD_Client table, (column: AD_Client_ID)
ClientSideValidation
- Physical column name: Clientsidevalidation
- Property Name: clientSideValidation
- Reference: String
Created By
- Physical column name: Createdby
- Property Name: createdBy
- Reference: Search
Foreign key column to AD_User table, (column: AD_User_ID)
Creation Date
- Physical column name: Created
- Property Name: creationDate
- Reference: DateTime
- Default value: SYSDATE
Data Access Level
- Physical column name: Accesslevel
- Property Name: dataAccessLevel
- Reference: List
List values: AD_Table Access Levels
The allowed values for this list are:
- 1 (Organization)
- 3 (Client/Organization)
- 4 (System only)
- 7 (All)
- 6 (System/Client)
Description
- Physical column name: Description
- Property Name: description
- Reference: String
Help/Comment
- Physical column name: Help
- Property Name: helpComment
- Reference: Text
IsMultiRecord
- Physical column name: IsMultiRecord
- Property Name: isMultiRecord
- Reference: YesNo
- Default value: N
Isgridlegacy
- Physical column name: Isgridlegacy
- Property Name: isgridlegacy
- Reference: YesNo
- Default value: N
Java Class Name
- Physical column name: Classname
- Property Name: javaClassName
- Reference: String
Module
- Physical column name: AD_Module_ID
- Property Name: module
- Reference: TableDir
- Default value: 0
Foreign key column to AD_Module table, (column: AD_Module_ID)
It has a validation "Ad_Module_ID IsInDevelopment", with the following code
IsInDevelopment = 'Y' and type != 'T'
Name
- Physical column name: Name
- Property Name: name
- Reference: String
- This column is part of the table's identifier
ON_Load_Function
- Physical column name: ON_Load_Function
- Property Name: loadFunction
- Reference: String
ON_Refresh_Function
- Physical column name: ON_Refresh_Function
- Property Name: refreshFunction
- Reference: String
Obuiapp_Process_ID
- Physical column name: Obuiapp_Process_ID
- Property Name: id
- Reference: ID
Organization
- Physical column name: AD_Org_ID
- Property Name: organization
- Reference: TableDir
Foreign key column to AD_Org table, (column: AD_Org_ID)
Requires Explicit Access Permission
- Physical column name: Is_Explicit_Access
- Property Name: requiresExplicitAccessPermission
- Reference: YesNo
- Default value: N
Search Key
- Physical column name: Value
- Property Name: searchKey
- Reference: String
UI Pattern
- Physical column name: Uipattern
- Property Name: uIPattern
- Reference: List
- Default value: S
List values: Process Definition UIPattern
The allowed values for this list are:
- M (Manual)
- S (Standard): Not implemented
- OBUIAPP_PickAndExecute (Standard (Parameters defined in Dictionary))
- OBUIAPP_Report (Report (Using JR templates))
Updated
- Physical column name: Updated
- Property Name: updated
- Reference: DateTime
- Default value: SYSDATE
Updated By
- Physical column name: Updatedby
- Property Name: updatedBy
- Reference: Search
Foreign key column to AD_User table, (column: AD_User_ID)
Other Info
Check Constraints
These are the check constraints for this table:
- OBUIAPP_PROC_GRIDLEGACY_CHK: ISGRIDLEGACY IN ('Y', 'N')
- OBUIAPP_PROC_ISACTIVE_CHK: ISACTIVE IN ('Y', 'N')
- OBUIAPP_PROC_ISBACKGROUND_CHK: ISBACKGROUND IN ('Y', 'N')
- OBUIAPP_PROC_ISCANADDR2SEL_CHK: ISCANADDRECORDSTOSELECTOR IN ('Y', 'N')
- OBUIAPP_PROC_MULTI_CHK: ISMULTIRECORD IN ('Y', 'N')
- OBUIAPP_PROCESS_EXPLICITACC_CK: IS_EXPLICIT_ACCESS IN ('Y', 'N')
 | Back to org.openbravo.client.application |