Collapse AllExpand All

11.6.1. Package

Once a Package has been loaded into xTuple ERP, you have the ability to review the Package's contents using the Package screen. You won't be able to edit the Package, because Package details are defined at the Package level. However, being able to view Package details is helpful for general information and debugging purposes. For additional information, please see the CreateUpdaterPackages wiki page.

To view the details of a specific Package, select the VIEW button from the Packages master list. The following screen will appear:

View Package

When viewing a Package, you are presented with the following options:

Name

Displays the name of the Package, as defined in the package.xml file.

Version

Displays the Package version, as defined in the package.xml file.

Description

Displays the Package description, as defined in the package.xml file.

Developer

Displays the name Package developer, as defined in the package.xml file. The name used could be an individual or a company name.

Enabled

Indicates whether the package is enabled or disabled.

Modifications Allowed

Indicates whether users with sufficient privilege are allowed to modify contents of this package. This is used to switch between development mode and production mode of a package. Only database administrators may change this setting.

Notes

Displays any notes related to the Package, as defined in the package.xml file.

To review the contents included in a Package, select the "Contents" tab at the top of the "Package" screen. The following screen will appear:

Package Contents

The contents screen displays a directory listing of all the components contained in the Package. Packages may include any of the following:

  • user interface forms

  • application scripts

  • images

  • report definitions

  • MetaSQL statements

  • tables

  • views

  • stored procedures

  • application privileges

  • custom commands

To review a list of any Packages required to load the Package, select the "Requirements" tab at the top of the screen. The following screen will appear:

Package Requirements

The "Requirements" list displays information on all packages required to load the Package, including Package name, description, and version.

To review a list of any Packages which depend on the Package, select the "Dependencies" tab at the top of the screen. The following screen will appear:

Package Dependencies

The "Dependencies" list displays information on all packages dependent on this package including, package name, description, and version.