apache/ofbiz-plugins/create-component

Skill: create-component

Goal

Create a new, isolated OFBiz component with the correct directory structure and configuration.

Triggers

ALWAYS read this skill when:

• Creating a new plugin or component.
• Isolating a large feature set into a separate module.
• Understanding plugin discovery vs. manual registration.

Use when

• Starting a brand new feature (e.g., my-custom-module).
• Developing an integration that should not impact core components.

Procedure

1. Gradle Command:

• Run ./gradlew createPlugin -PpluginId=my-plugin-name.
• Optional flags: -PwebappName=my-app, -PbasePermission=MY_PERM.

1. Base Structure:

• Ensure the following folders are present: src, webapp, entitydef, servicedef, data, widget.

1. Initial Configuration:

• Update ofbiz-component.xml with proper titles and descriptions.
• Add basic security permissions in data/[Component]SecurityData.xml.

1. Registration (Automatic):

• OFBiz automatically discovers any directory in plugins/ that contains an ofbiz-component.xml file.
• NO command like ./gradlew loadAll is required for registration.
• OFBiz must be restarted (or a container reload triggered) to detect new components.

Post-Scaffold Customization

1. Directory Structure: Verify the existence of entitydef/, servicedef/, data/, and webapp/.
2. Component XML: Update ofbiz-component.xml with actual resource locations.
3. Web Application: If your component has a UI, ensure the <webapp> entry has a unique mount-point.
4. Permissions: Define base permissions in data/MyComponentSecurityData.xml.

Guardrails

• Naming: Use lowercase, kebab-case (e.g., order-management).
• Location: All custom components MUST reside in the plugins/ directory.
• Discovery: Plugins in plugins/ are auto-discovered. Do not try to manually register them in framework load files.
• Independence: Ensure the new component doesn't break existing ones.
• Best Practice: Immediately create a dedicated SecurityData.xml to avoid permission conflicts.
• Cleanliness: Delete unused scaffolded files (e.g., placeholder entities) after creation.

Examples

Example: Creating a new inventory plugin

./gradlew createPlugin -PpluginId=inventory-custom -PwebappName=inventoryApp
./gradlew loadAll

Then, verify the folder plugins/inventory-custom exists.