Changing the Database
Read this page before you write code if your core contribution adds or changes Application Dictionary records (tables, columns, windows, messages and so on) or the database schema. It explains how to get official IDs from the central ID server and how iDempiere records your changes as migration scripts for your pull request.
Plug-in changes do not need official IDs. Ship them with 2Pack or with migration scripts in the plug-in instead.
TL;DR
- Ask for a user name and password for the central ID server in the forum or on Mattermost.
- Set the
DICTIONARY_ID_*keys in the System Configurator. See Configure the ID server. - Log in as System Administrator. In Preference, turn on Dictionary Maintenance and Log Migration Scripts, and enter a Migration Script Comment with the ticket number. Turn both options on again after every login, because they are not saved.
- Create or change the dictionary records. New records get IDs below 1,000,000 from the central ID server.
- Review the generated migration script, remove failed or unrelated statements, and commit it with your code.
Pages in this section
- Request centralized IDs: get official IDs from the central ID server, check the setup, look up and reserve IDs.
- Generating Migration Scripts: record your dictionary changes as SQL scripts and review them.
- Run a project ID server: share IDs across a plug-in team with separate development databases.