ERP/3.0/Developers Guide/Database Model/org.openbravo.model.ad.module/AD Module
This article is protected against manual editing because it is automatically generated from Openbravo meta-data. Learn more about writing and translating such documents.
AD_Module
- Name:AD_Module
- Classname:ADModule
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. |
| IsConfigScriptApplied | No | CHAR (1) | This check affects to Template modules. When it is active, the template they contain is applied to the instance when the application is built.
Note that this information is kept only in the instance but not it is not exported to the module. |
| Author | Yes | NVARCHAR (2000) | The author of the module is the person or company that created and maintains the module. |
| Update_Available | Yes | VARCHAR (10) | Indicates whether and which new version is available to update a module |
| AD_Client_ID | No | VARCHAR (32) | A Client is a company or a legal entity. You cannot share data between Clients. |
| IsCommercial | No | CHAR (1) | Commercial modules are only available to Professional and Enterprise Edition instances whereas non commercial ones can be downloaded and installed in Community Edition Instances.
Commercial modules can have a fee to be payed before they can be installed. |
| 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. |
| IsDefault | Yes | CHAR (1) | The Default Checkbox indicates if this record will be used as a default value. |
| Description | No | NVARCHAR (255) | A description is limited to 255 characters. |
| Enabled | No | CHAR (1) | When a module is not enabled, their artifacts (windows, tabs, forms, reports and processes) will not be accessible. |
| Istrialallowed | Yes | CHAR (1) | |
| HasChartOfAccounts | No | CHAR (1) | The module contains a chart of accounts |
| HasReferenceData | No | CHAR (1) | The module contains reference data |
| Help | Yes | NVARCHAR (2000) | The Help field contains a hint, comment or help about the use of this item. |
| IsInDevelopment | Yes | CHAR (1) | Determines wether the module is currently in development process. Only the modules that currently are being developed will be exported. |
| IsTranslationModule | No | CHAR (1) | This module is a translation module |
| JavaPackage | No | VARCHAR (255) | The Java Package is a unique identifier of your module and has to match the Java package naming rules as described in the Java Naming Conventions (names and package names). Be careful when setting this value as you are not allowed to change it once your module is registered in the central repository. If your module includes Java files they have to be packaged within your module's Java package or in its sub-packages. |
| AD_Language | Yes | VARCHAR (6) | The Language identifies the language to use for display |
| LicenseType | Yes | VARCHAR (60) | There is a list of possible licenses to select one of them for the current element. |
| License | Yes | NVARCHAR (2000) | Contains the text of the license the module is release with, this information is additional to the license type. |
| Maturity_Update | Yes | VARCHAR (60) | Defines the minimum accepted maturity status of modules when they are scanned for update. |
| AD_Module_ID | No | VARCHAR (32) | Indicates the module the element forms part of. |
| Name | No | NVARCHAR (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. |
| 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. |
| ReferenceDataInfo | Yes | NVARCHAR (2000) | Description for the reference data contained within the module. When a module contains reference data this field maintains a description of this data and its purpose. |
| IsRegistered | Yes | CHAR (1) | Indicates whether the module is registered in the Central Repository and in case it is not, it allows to register it. |
| Seqno | Yes | DECIMAL | The Sequence indicates the order of records |
| Status | Yes | VARCHAR (60) | Current status of a debt/payment. |
| IsTranslationRequired | No | CHAR (1) | The current module contains user interface elements that can be translated to different languages. |
| Type | No | VARCHAR (60) | The Type indicates the type of validation that will occur. This can be SQL, Java Script or Java Language. |
| URL | Yes | VARCHAR (300) | The URL defines an online address for this element. |
| UpdateInfo | Yes | NVARCHAR (2000) | Information about the update, this information should include what is new for the new version. |
| Update_Ver_ID | Yes | VARCHAR (32) | Identifier for the Update Version |
| 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. |
| Upgrade_Available | Yes | VARCHAR (4000) | Version of the available upgrade for this module. |
| Version | No | VARCHAR (10) | The Version indicates the version of this table definition. |
| Version_Label | Yes | VARCHAR (60) | It is a human understandable identifier for the version, it will be used with version number. Value examples this field can take are: MP1, dev, alpha... |
Columns
Active
- Physical column name: IsActive
- Property Name: active
- Reference: YesNo
- Default value: Y
Apply Configuration Script
- Physical column name: IsConfigScriptApplied
- Property Name: applyConfigurationScript
- Reference: YesNo
- Default value: Y
Author
- Physical column name: Author
- Property Name: author
- Reference: Text
Available Update
- Physical column name: Update_Available
- Property Name: availableUpdate
- Reference: String
Client
- Physical column name: AD_Client_ID
- Property Name: client
- Reference: TableDir
Foreign key column to AD_Client table, (column: AD_Client_ID)
It has a validation "AD_Client Security validation", with the following code
AD_Client.AD_Client_ID in (@#User_Client@)
Commercial
- Physical column name: IsCommercial
- Property Name: commercial
- Reference: YesNo
- Default value: N
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
Default
- Physical column name: IsDefault
- Property Name: default
- Reference: YesNo
- Default value: N
Callout: SL_IsDefault
This column has a callout associated.
It is implemented by [1] Java Class.
Description
- Physical column name: Description
- Property Name: description
- Reference: String
Enabled
- Physical column name: Enabled
- Property Name: enabled
- Reference: YesNo
- Default value: Y
Free for Trial
- Physical column name: Istrialallowed
- Property Name: freeForTrial
- Reference: YesNo
- Default value: N
Has chart of accounts
- Physical column name: HasChartOfAccounts
- Property Name: hasChartOfAccounts
- Reference: YesNo
- Default value: N
Has reference data
- Physical column name: HasReferenceData
- Property Name: hasReferenceData
- Reference: YesNo
- Default value: N
Help/Comment
- Physical column name: Help
- Property Name: helpComment
- Reference: Text
In Development
- Physical column name: IsInDevelopment
- Property Name: inDevelopment
- Reference: YesNo
- Default value: N
Callout: SL_ModuleCallout
This column has a callout associated.
It is implemented by [2] Java Class.
Is translation module
- Physical column name: IsTranslationModule
- Property Name: isTranslationModule
- Reference: YesNo
- Default value: N
Java Package
- Physical column name: JavaPackage
- Property Name: javaPackage
- Reference: String
Callout: Java package checker
This column has a callout associated. verifies if the java package is valid It is implemented by [3] Java Class.
Language
- Physical column name: AD_Language
- Property Name: language
- Reference: Table
- This column is part of the table's identifier
Foreign key column to AD_Language table, (column: AD_Language)
License Type
- Physical column name: LicenseType
- Property Name: licenseType
- Reference: List
List values: License Type
The allowed values for this list are:
- Apache2.0 (Apache License 2.0): Apache License 2.0
- OBCL (Openbravo Commercial License): Openbravo Commercial License
- LGPL (GNU Lesser General Public License): GNU Lesser General Public License
- MIT (MIT License): MIT License
- OtherCOM (Other commercial): Other commercial
- GPL2.0 (GNU General Public License 2.0): GNU General Public License 2.0
- BSD (New BSD License): New BSD License
- GPL3.0 (GNU General Public License 3.0): GNU General Public License 3.0
- EPL1.0 (Eclipse Public License 1.0): Eclipse Public License 1.0
- CPAL1.0 (Common Public Attribution License 1.0): Common Public Attribution License 1.0
- Affero (Affero GNU Public License): Affero GNU Public License
- Artistic/GPL (Artistic License/GPL): Artistic License/GPL
- MPL1.1 (Mozilla Public License 1.1): Mozilla Public License 1.1
- OtherOS (Other open source ): Other open source
- OBPL (Openbravo Public License): Openbravo Public License
- PD (Public Domain): Public Domain
License text
- Physical column name: License
- Property Name: licenseText
- Reference: Text
Maturity_Update
- Physical column name: Maturity_Update
- Property Name: maturityUpdate
- Reference: String
Module
- Physical column name: AD_Module_ID
- Property Name: id
- Reference: ID
Name
- Physical column name: Name
- Property Name: name
- Reference: String
- This column is part of the table's identifier
Organization
- Physical column name: AD_Org_ID
- Property Name: organization
- Reference: TableDir
Foreign key column to AD_Org table, (column: AD_Org_ID)
It has a validation "AD_Org Security validation", with the following code
(@AD_Client_ID@='0' AND AD_Org.AD_Org_ID='0') OR (@AD_Client_ID@!='0' AND ((AD_Org.AD_Client_ID IN (@#User_Client@) AND AD_Org.AD_Org_ID IN (@#User_Org@)) OR AD_Org.AD_Org_ID='0' AND AD_Org.IsSummary='N'))
Reference Data Description
- Physical column name: ReferenceDataInfo
- Property Name: referenceDataDescription
- Reference: Text
Register Module
- Physical column name: IsRegistered
- Property Name: registerModule
- Reference: Button
- Default value: N
Sequence Number
- Physical column name: Seqno
- Property Name: sequenceNumber
- Reference: Integer
Status
- Physical column name: Status
- Property Name: status
- Reference: List
- Default value: A
List values: Module status
The allowed values for this list are:
- P (Pending): Module data has been updated in database but it has not been applied yet.
- I (Installed)
- A (Applied)
- U (Uninstalled): Uninstalled module, rebuild context to remove it
Translation Required
- Physical column name: IsTranslationRequired
- Property Name: translationRequired
- Reference: YesNo
- Default value: N
Type
- Physical column name: Type
- Property Name: type
- Reference: List
- Default value: M
Callout: SL_ModuleCallout
This column has a callout associated.
It is implemented by [4] Java Class.
List values: Module type
The allowed values for this list are:
- M (Module): Module type: it contains the module itself (data and resources)
- T (Template): Contains a set of modules and a configuration script.
- P (Package): Contains a set of modules
URL
- Physical column name: URL
- Property Name: uRL
- Reference: String
Update Information
- Physical column name: UpdateInfo
- Property Name: updateInformation
- Reference: Text
Update Version
- Physical column name: Update_Ver_ID
- Property Name: updateVersion
- Reference: String
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)
Upgrade Available
- Physical column name: Upgrade_Available
- Property Name: upgradeAvailable
- Reference: String
Version
- Physical column name: Version
- Property Name: version
- Reference: String
- This column is part of the table's identifier
Version_Label
- Physical column name: Version_Label
- Property Name: versionLabel
- Reference: String
Other Info
Check Constraints
These are the check constraints for this table:
- AD_MODULE_APPLYCFG_CHK: ISCONFIGSCRIPTAPPLIED IN ('Y', 'N')
- AD_MODULE_INDEVELOPMENT_CHK: ISINDEVELOPMENT IN ('Y', 'N')
- AD_MODULE_ISACTIVE_CHK: ISACTIVE IN ('Y', 'N')
- AD_MODULE_ISCOMMERCIAL_CHCK: ISCOMMERCIAL IN ('Y', 'N')
- AD_MODULE_ISDEFAULT_CHK: ISDEFAULT = 'N' OR ISDEFAULT = 'Y' AND ISINDEVELOPMENT = 'Y'
- AD_MODULE_ISREGISTERED_CHK: ISREGISTERED IN ('Y', 'N')
- AD_MODULE_ISTRANSLATEABLE_CHK: ISTRANSLATIONREQUIRED IN ('Y', 'N')
- AD_MODULE_ISTRIALALLOWED: ISTRIALALLOWED IN ('Y', 'N')
- AD_MODULE_TYPE_CHK: TYPE IN ('M', 'P', 'T')
 | Back to org.openbravo.model.ad.module |