ERP/2.50/Developers Guide/Database Model/org.openbravo.model.ad.module/AD Module

Contents 1 AD_Module 1.1 Other Info 1.1.1 Check constraints 1.1.2 Indexes 1.1.2.1 Unique 1.2 Columns 1.2.1 Module 1.2.2 Client 1.2.3 Organization 1.2.4 Active 1.2.5 Creation Date 1.2.6 Created By 1.2.7 Updated 1.2.8 Updated By 1.2.9 Name 1.2.10 Version 1.2.11 Description 1.2.12 Help/Comment 1.2.13 URL 1.2.14 Type 1.2.14.1 Callout: SL_ModuleCallout 1.2.14.2 List values: Module type 1.2.15 License text 1.2.16 In Development 1.2.16.1 Callout: SL_ModuleCallout 1.2.17 Default 1.2.17.1 Callout: SL_IsDefault 1.2.18 Sequence Number 1.2.19 Java Package 1.2.20 License Type 1.2.20.1 List values: License Type 1.2.21 Author 1.2.22 Status 1.2.22.1 List values: Module status 1.2.23 Available Update 1.2.24 Translation Required 1.2.25 Module Language 1.2.26 Has chart of accounts 1.2.27 Is translation module 1.2.28 Has reference data 1.2.29 Register Module 1.2.30 Update Information 1.2.31 Update Version 1.2.32 Reference Data Description 1.2.33 Version_Label 1.2.34 VersionID 1.2.35 Commercial 1.2.36 Maturity_Update 1.2.37 Tier 1.2.37.1 List values: CommercialTier 1.2.38 Enabled 1.2.39 Upgrade Available 1.2.40 Apply Configuration Script 1.3 Related tables

AD_Module

Contains the information about the currently installed modules and defines which of them are active for development.

• Name:ADModule
• Classname:Module

This table contains the following columns:

Name	Nullable	Data Type	Description
AD_Module_ID	N	VARCHAR2(32)	Module
AD_Client_ID	N	VARCHAR2(32)	Client for this installation.
AD_Org_ID	N	VARCHAR2(32)	Organizational entity within client
IsActive	N	CHAR(1)	A flag indicating whether this record is available for use or de-activated.
Created	N	DATE	The date that this record is completed.
CreatedBy	N	VARCHAR2(32)	User who created this records
Updated	N	DATE	x not implemented
UpdatedBy	N	VARCHAR2(32)	User who updated this records
Name	N	NVARCHAR2(60)	A non-unique identifier for a record/document often used as a search tool.
Version	N	VARCHAR2(10)	Module version
Description	N	NVARCHAR2(255)	A space to write additional related information.
Help	Y	NVARCHAR2(2000)	A comment that adds additional information to help users work with fields.
URL	Y	VARCHAR2(300)	An address which can be accessed via internet.
Type	N	VARCHAR2(60)	A distinct item characteristic used for processes and sometimes grouped within a category.
License	Y	NVARCHAR2(2000)	Module license text
IsInDevelopment	Y	CHAR(1)	Determines wether the module is currently in development process.
IsDefault	Y	CHAR(1)	A value that is shown whenever a record is created.
Seqno	Y	NUMBER	The order of records in a specified document.
JavaPackage	N	VARCHAR2(255)	Java package for the module
LicenseType	Y	VARCHAR2(60)	Type of license
Author	Y	NVARCHAR2(2000)	Module author/licensor
Status	Y	VARCHAR2(60)	A defined state or position of a payment.
Update_Available	Y	VARCHAR2(10)	New version to update the current module
IsTranslationRequired	Y	CHAR(1)	This module requires of tranlsation
AD_Language	Y	VARCHAR2(6)	Language for the current module
HasChartOfAccounts	N	CHAR(1)	The module contains a chart of accounts
IsTranslationModule	N	CHAR(1)	This is a translation module
HasReferenceData	N	CHAR(1)	The module contains reference data
IsRegistered	Y	CHAR(1)	Indicates whether the module is registered in the Central Repository
UpdateInfo	Y	NVARCHAR2(2000)	Information about the update
Update_Ver_ID	Y	VARCHAR2(32)	Update Version
ReferenceDataInfo	Y	NVARCHAR2(2000)	Description for the reference data contained within the module
Version_Label	Y	VARCHAR2(60)	Human readable version identifer
Version_ID	Y	VARCHAR2(60)	Version identifier
IsCommercial	N	CHAR(1)	Commercial Module
Maturity_Update	Y	VARCHAR2(60)	Minimum Maturity Status of modules for update
Commercial_Tier	Y	VARCHAR2(60)	Tier for commercial modules
Enabled	N	CHAR(1)	Is the module enabled
Upgrade_Available	Y	VARCHAR2(4000)	Upgrade Available
IsConfigScriptApplied	N	CHAR(1)	null

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_TYPE_CHK: TYPE IN ('M', 'P', 'T')

top

Indexes

These are the indexes for this table (for each index there is a list of all the columns included within it):

Unique

• AD_MODULE_JAVAPACKAGE_UN
  • JavaPackage
• AD_MODULE_PK
  • AD_Module_ID

top

Columns

Module

Indicates the module the element forms part of.

• Physical column name: AD_Module_ID
• Property Name: id
• Reference: ID

top

Client

• Physical column name: AD_Client_ID
• Property Name: client
• Reference: TableDir
• Default value: @AD_CLIENT_ID@

Foreign key column to AD_Client table, (column: AD_Client_ID)

Validation Rule AD_Client Security validation: Clients with user access rights. With the following code:

 
AD_Client.AD_Client_ID IN (@#User_Client@)

top

Organization

• Physical column name: AD_Org_ID
• Property Name: organization
• Reference: TableDir
• Default value: @AD_ORG_ID@

Foreign key column to AD_Org table, (column: AD_Org_ID)

Validation Rule AD_Org Security validation: Organizations of the Client with user acces rights. 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'))

top

Active

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.

• Physical column name: IsActive
• Property Name: active
• Reference: YesNo
• Default value: Y

top

Creation Date

The Created field indicates the date that this record was created.

• Physical column name: Created
• Property Name: creationDate
• Reference: DateTime
• Default value: SYSDATE

top

Created By

• Physical column name: CreatedBy
• Property Name: createdBy
• Reference: Search

Foreign key column to AD_User table, (column: AD_User_ID)

top

Updated

The Updated field indicates the date that this record was updated.

• Physical column name: Updated
• Property Name: updated
• Reference: DateTime
• Default value: SYSDATE

top

Updated By

• Physical column name: UpdatedBy
• Property Name: updatedBy
• Reference: Search

Foreign key column to AD_User table, (column: AD_User_ID)

top

Name

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.

• Physical column name: Name
• Property Name: name
• Reference: String
• This column is part of the table's identifier

top

Version

Module version is a 3 integer dot separated number to identify the version. The 2 first ones define the module's major version whereas the last one is the minor version. An example could be 2.50.10440, where 2.50 is the major version and 10440 is the minor one.

• Physical column name: Version
• Property Name: version
• Reference: String
• This column is part of the table's identifier

top

Description

A description is limited to 255 characters.

• Physical column name: Description
• Property Name: description
• Reference: String

top

Help/Comment

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

• Physical column name: Help
• Property Name: helpComment
• Reference: Text

top

URL

The URL defines an online address for this element.

• Physical column name: URL
• Property Name: uRL
• Reference: String

top

Type

The Type indicates the type of validation that will occur. This can be SQL, Java Script or Java Language.

• Physical column name: Type
• Property Name: type
• Reference: List
• Default value: M

Callout: SL_ModuleCallout

This element is linked to a callout.

It is implemented by org.openbravo.erpCommon.ad_callouts.SL_ModuleCallout 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)
• P (Package): Contains a set of modules
• T (Template): Contains a set of modules and a configuration script.

top

License text

Contains the text of the license the module is release with, this information is additional to the license type.

• Physical column name: License
• Property Name: licenseText
• Reference: Text

top

In Development

Determines wether the module is currently in development process. Only the modules that currently are being developed will be exported.

• Physical column name: IsInDevelopment
• Property Name: inDevelopment
• Reference: YesNo
• Default value: N

Callout: SL_ModuleCallout

This element is linked to a callout.

It is implemented by org.openbravo.erpCommon.ad_callouts.SL_ModuleCallout Java class.

top

Default

The Default Checkbox indicates if this record will be used as a default value.

• Physical column name: IsDefault
• Property Name: default
• Reference: YesNo
• Default value: N

Callout: SL_IsDefault

This element is linked to a callout.

It is implemented by org.openbravo.erpCommon.ad_callouts.SL_IsDefault Java class.

top

Sequence Number

The Sequence indicates the order of records

• Physical column name: Seqno
• Property Name: sequenceNumber
• Reference: Integer
• Default value: @SQL=SELECT COALESCE(MAX(SeqNo),0)+10 AS DefaultValue FROM AD_Module WHERE AD_Module_ID=@AD_Module_ID@

top

Java Package

Is the Java package the module will use.

• Physical column name: JavaPackage
• Property Name: javaPackage
• Reference: String

top

License Type

There is a list of possible licenses to select one of them for the current element.

• Physical column name: LicenseType
• Property Name: licenseType
• Reference: List

List values: License Type

The allowed values for this list are:

• Affero (Affero GNU Public License): Affero GNU Public License
• Apache2.0 (Apache License 2.0): Apache License 2.0
• Artistic/GPL (Artistic License/GPL): Artistic License/GPL
• BSD (New BSD License): New BSD License
• CPAL1.0 (Common Public Attribution License 1.0): Common Public Attribution License 1.0
• EPL1.0 (Eclipse Public License 1.0): Eclipse Public License 1.0
• GPL2.0 (GNU General Public License 2.0): GNU General Public License 2.0
• GPL3.0 (GNU General Public License 3.0): GNU General Public License 3.0
• LGPL (GNU Lesser General Public License): GNU Lesser General Public License
• MIT (MIT License): MIT License
• MPL1.1 (Mozilla Public License 1.1): Mozilla Public License 1.1
• OBCL (Openbravo Commercial License): Openbravo Commercial License
• OBPL (Openbravo Public License): Openbravo Public License
• OtherCOM (Other commercial): Other commercial
• OtherOS (Other open source ): Other open source
• PD (Public Domain): Public Domain

top

Author

The author of the module is the person or company that created and maintains the module.

• Physical column name: Author
• Property Name: author
• Reference: Text

top

Status

Current status of a debt/payment.

• Physical column name: Status
• Property Name: status
• Reference: List
• Default value: A

List values: Module status

The allowed values for this list are:

• A (Applied)
• I (Installed)
• P (Pending): Module data has been updated in database but it has not been applied yet.
• U (Uninstalled): Uninstalled module, rebuild context to remove it

top

Available Update

Indicates whether and which new version is available to update a module

• Physical column name: Update_Available
• Property Name: availableUpdate
• Reference: String

top

Translation Required

The current module contains user interface elements that can be translated to different languages.

• Physical column name: IsTranslationRequired
• Property Name: translationRequired
• Reference: YesNo
• Default value: N

top

Module Language

This language defines the language used as base for the user interface elements in the module.

• 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_ID)

Reference Table AD_Language

top

Has chart of accounts

The module contains a chart of accounts

• Physical column name: HasChartOfAccounts
• Property Name: hasChartOfAccounts
• Reference: YesNo
• Default value: N

top

Is translation module

This module is a translation module

• Physical column name: IsTranslationModule
• Property Name: isTranslationModule
• Reference: YesNo
• Default value: N

top

Has reference data

The module contains reference data

• Physical column name: HasReferenceData
• Property Name: hasReferenceData
• Reference: YesNo
• Default value: N

top

Register Module

Indicates whether the module is registered in the Central Repository and in case it is not, it allows to register it.

• Physical column name: IsRegistered
• Property Name: registerModule
• Reference: Button
• Default value: N

top

Update Information

Information about the update, this information should include what is new for the new version.

• Physical column name: UpdateInfo
• Property Name: updateInformation
• Reference: Text

top

Update Version

Identifier for the Update Version

• Physical column name: Update_Ver_ID
• Property Name: updateVersion
• Reference: String

top

Reference Data Description

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.

• Physical column name: ReferenceDataInfo
• Property Name: referenceDataDescription
• Reference: Text

top

Version_Label

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...

• Physical column name: Version_Label
• Property Name: versionLabel
• Reference: String

top

VersionID

It is an identifier for the version. In core module this is automatically calculated when it is build in a mercurial working copy, being in this case the last changeset in the working copy.

• Physical column name: Version_ID
• Property Name: versionID
• Reference: String

top

Commercial

Commercial modules are only available to Professional and Basic 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.

• Physical column name: IsCommercial
• Property Name: commercial
• Reference: YesNo
• Default value: N

top

Maturity_Update

Defines the minimum accepted maturity status of modules when they are scanned for update.

• Physical column name: Maturity_Update
• Property Name: maturityUpdate
• Reference: String

top

Tier

Commercial modules are defined in different tiers:
1st Tier: The module can be installed in Professional and Basic Edition instances once it has been purchased.
2nd Tier: The module can be installed in Professional Edition instances once it has been purchased.

• Physical column name: Commercial_Tier
• Property Name: tier
• Reference: List

List values: CommercialTier

The allowed values for this list are:

• 1 (Tier 1 Commercial Module): Tier 1 Commercial Modules can be installed in all Proffesioanl Edition instances that have bought it.
• 2 (Tier 2 Commercial Module): Tier 2 Commercial Modules can be installed in Standard Professioanl Edition Instances that have bought it.

top

Enabled

When a module is not enabled, their artifacts (windows, tabs, forms, reports and processes) will not be accessible.

• Physical column name: Enabled
• Property Name: enabled
• Reference: YesNo
• Default value: Y

top

Upgrade Available

Version of the available upgrade for this module.

• Physical column name: Upgrade_Available
• Property Name: upgradeAvailable
• Reference: String

top

Apply Configuration Script

• Physical column name: IsConfigScriptApplied
• Property Name: applyConfigurationScript
• Reference: YesNo
• Default value: Y

top

Related tables

Tables that link this table:

• ADAuxiliaryInput.Module
• ADCallout.Module
• ADClientModule.Module
• ADColumn.Module
• ADEPProcedures.Module
• ADElement.Module
• ADExtensionPoints.Module
• ADField.Module
• ADFieldGroup.Module
• ADForm.Module
• ADList.Module
• ADMenu.Module
• ADMessage.Module
• ADModelImplementation.Module
• ADOrgModule.Module
• ADPreference.Module
• ADProcess.Module
• ADPropertyConfiguration.Module
• ADReference.Module
• ADTab.Module
• ADTextInterface.Module
• ADValidation.Module
• ADWindow.Module
• ADWorkflow.Module
• DataPackage.Module
• DataSet.Module
• DataSetColumn.Module
• DataSetTable.Module
• ModuleDBPrefix.Module
• ModuleDependency.Dependent Module
• ModuleDependency.Module
• ModuleTrl.Module
• NamingException.Module
• OrganizationModuleV.Module
• ReferenceDataStore.Module

top