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

Contents 1 AD_Module_Install 1.1 Other Info 1.1.1 Check constraints 1.1.2 Indexes 1.1.2.1 Unique 1.2 Columns 1.2.1 AD_Module_Install_ID 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 Module 1.2.10 Name 1.2.11 Version 1.2.12 Description 1.2.13 Help/Comment 1.2.14 URL 1.2.15 Type 1.2.16 License text 1.2.17 In Development 1.2.18 Default 1.2.19 Sequence Number 1.2.20 Java Package 1.2.21 License Type 1.2.22 Author 1.2.23 Status 1.2.24 Available Update 1.2.25 Translation Required 1.2.26 Language 1.2.27 Has chart of accounts 1.2.28 Is translation module 1.2.29 Has reference data 1.2.30 Register Module 1.2.31 Update Information 1.2.32 Update Version 1.2.33 Reference Data Description 1.2.34 Version Label 1.2.35 Version ID 1.2.36 IsCommercial 1.2.37 Tier 1.2.37.1 List values: CommercialTier 1.2.38 Enabled 1.2.39 Apply Configuration Script

AD_Module_Install

This temporary table is used in the installation and update process for modules. It stores the information for the upcoming module.

• Name:ADModuleInstall
• Classname:ModuleInstall

This table contains the following columns:

Name	Nullable	Data Type	Description
AD_Module_Install_ID	N	VARCHAR2(32)	Temporary table used when installing/updating modules
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
AD_Module_ID	N	VARCHAR2(32)	Module
Name	N	NVARCHAR2(60)	A non-unique identifier for a record/document often used as a search tool.
Version	N	VARCHAR2(10)	Version of the table definition
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)	A method of communication being used.
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
Commercial_Tier	Y	VARCHAR2(60)	Tier for commercial modules
Enabled	N	CHAR(1)	Is the module enabled
Isconfigscriptapplied	N	CHAR(1)	null

Other Info

Check constraints

These are the check constraints for this table:

• AD_MODULE_INSTALL_ISDEFAUL_CHK: (ISDEFAULT = 'N') OR ((ISDEFAULT = 'Y') AND (ISINDEVELOPMENT = 'Y'))
• AD_MODULE_INS_APPLYCFG_CHK: ISCONFIGSCRIPTAPPLIED IN ('Y', 'N')
• AD_MODULE_INS_ISACTIVE_CHK: ISACTIVE IN ('Y', 'N')
• AD_MODULE_INS_ISREGISTERED_CHK: ISREGISTERED IN ('Y', 'N')
• AD_MODULE_INS_TYPE_CHK: TYPE IN ('M', 'P', 'T')
• AD_MOD_INS_INDEVELOPMENT_CHK: ISINDEVELOPMENT IN ('Y', 'N')
• AD_MOD_INS_ISTRANSLATEABLE_CHK: ISTRANSLATIONREQUIRED IN ('Y', 'N')

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_INSTALL_PK
  • AD_Module_Install_ID

top

Columns

AD_Module_Install_ID

This temporary table is used in the installation and update process for modules. It stores the information for the upcoming module.

• Physical column name: AD_Module_Install_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

Module

Indicates the module the element forms part of.

• Physical column name: AD_Module_ID
• Property Name: module
• Reference: String

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

The Version indicates the version of this table definition.

• 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: String
• Default value: M

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

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

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_INSTALL WHERE xxParentColumn=@xxParentColumn@

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: String

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: String
• Default value: I

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

Language

The Language identifies the language to use for display

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

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: YesNo
• 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

Version ID

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

IsCommercial

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: isCommercial
• Reference: YesNo
• Default value: N

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

Apply Configuration Script

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

top