Open Source ERP Academy

Updating iDempiere's Help Documentation

The purpose of this page is to guide you though the process of updating iDempiere's help documentation. Please note this is an advanced topic, and you should assign an individual or a team to perform this task. They will have access to options that can harm your iDempiere instance.

Help Options

All of iDempiere's help can be changed. Doing so can greatly aid your users.
  1. The field label itself is the primary way a user knows how to use a field. You can change the field labels.
  2. The field tip-strip (or hover text) is another way a user knows how to use a field. The tip-strip can be much longer than the field label.
  3. The tab's help page - blue question mark on left side of a window's toolbar.

Before you Change

Please be aware that making changes (even to help) makes your instance more custom. Use good judgement when making changes.

Help Change/Configuration Options

There are two ways to change iDempiere's help:
  1. Log in as the System Administrator and change the help for all clients. If you are an iDempiere integrator, you will tend to use this option.
  2. Use your Client's "Window Customization" window. If you are an end-user, you will tend to use this option.

System Administrator Level Help Changes

Note: by making changes using this method, all clients will see your changes. This includes the GardenWorld sample client.
  1. Log in with a user (ex: SuperUser) that has access to the "System Administrator" Role.
  2. Find the window that you want to change in the "Window, Tab and Field" window.
  3. Make changes to the window record as is needed.
  4. Find your desired tab in the "Tab" sub-tab.
  5. Modify the Tab Name, Description, and Comment/Help as you wish.
  6. Find your desired field in the "Field" sub-tab.
  7. Here you have to make a decision. Are you changing this field for just this window, or are you changing the Name, Description, Help/Comment for all instances of this column?
    1. If just changing this instance, make your changes to the field record and un-check the Centrally Maintained field. By un-checking the Centrally Maintained, you are excluding this field from being updated when changes are made at the Element record (described below).
    2. If you wish to make the change for all instances, then zoom to the Column from the Field. Once at the Column, zoom to the System Element. Make your changes as you wish. Please note that all fields that are centrally maintained that use this System Element will be updated upon saving the element.

Client Level Help Changes

Note: by making changes using this method, only your client will see your changes. This will exclude the GardenWorld client if you are making changes in your own custom client.
  1. Log in with your client's admin role.
  2. Open the "Window Customization" window.
  3. Find the window you with to edit. If you cannot find your window, create a new record and choose your window.
  4. Find the tab you wish to edit in the "Tab Customization" sub-tab. If you cannot find your tab, create a new record and choose your tab.
  5. Find the field you wish to edit in the "Field Customization" sub-tab. If you cannot find your field, create a new record and choose your field.
  6. Once you are finished making your changes, either log out and log back in or simply execute the "Cache Reset" process from the main menu.
  7. Open with window you wished to change and confirm the changes exist.

Workflow Diagrams

iDempiere has workflow diagrams to help users visualize and navigate a process and interact with windows. An example of iDempiere workflow for documentation is the "Sales Setup". There is a "Workflow Editor" window where you can modify existing and create new workflows.