iDempiere en - User contributions [en]

Plugin: Asset Maintenance

2026-01-23T23:44:25Z

Red1:

__FORCETOC__

Maintainer: [[User:Red1|Redhuan D.]] Oon, CTFL. (red1org@gmail.com)

Based on: OFB-Consulting, Chile

Sponsor: Zeeshan Hasan (zeeshan@sysnova.com)

Current Version: 2.1.0.3 for iDempiere 13

License: GPLv2

====Source: https://github.com/red1oon/idempiere-asset-maintenance<nowiki/>====
Binary: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/org.asset.maintenance_2.1.0.202601231802.jar org.asset.maintenance_2.X.X.jar] (available in target/ folder)

Garden World: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/SampleData2Pack.zip Sample Data]

Guide: AssetMaintenanceUserGuide.docx (in doc/ folder) IN PROGRESS (come back tomorrow)

===Description===
Asset Maintenance is a lightweight plugin for preventive maintenance of enterprise assets in iDempiere.

===Features:===

====Core Functionality:====
<nowiki>*</nowiki> Meter-based scheduling (kilometers, operating hours, calendar days)

<nowiki>*</nowiki> Calendar-based scheduling with configurable intervals

<nowiki>*</nowiki> Standard Job templates with predefined task sequences

<nowiki>*</nowiki> Maintenance Plans linked to assets with scheduling rules

<nowiki>*</nowiki> Work Order (OT) generation from maintenance plans or requests

<nowiki>*</nowiki> Work Order task tracking with duration and resource allocation

<nowiki>*</nowiki> Asset Meter logging with reading history

<nowiki>*</nowiki> Maintenance Request workflow (Draft → Approved → Work Order)

==== Windows:====
<nowiki>*</nowiki> Meter - Define meter types (Kilometers, Operating Hours, Calendar Days)

<nowiki>*</nowiki> Job Standard - Create reusable job templates with task lists

<nowiki>*</nowiki> Maintenance - Asset maintenance plans with scheduling

<nowiki>*</nowiki> Order/Work Order (OT) - Work order management and execution

<nowiki>*</nowiki> Request - Maintenance request submission and approval

====Reference Lists:====
<nowiki>*</nowiki> Job Standard Type (AA-Asset Adjustment, CM-Corrective, PM-Preventive, PD-Predictive)

<nowiki>*</nowiki> Maintain Area (EL-Electrical, ME-Mechanical, OP-Operational, SF-Safety)

<nowiki>*</nowiki> Document Status for Request (AP-Approved, VO-Voided, WC-Waiting Confirmation)

<nowiki>*</nowiki> Resource Type (BP-Business Partner, BT-B.Partner Type, HH-Human, RR-Resource, TT-Tool/Equipment)

The plugin is server-side only (no Swing client) - simplified as a single OSGi bundle.

---

===Release Notes:===
Version 2.1.0.3 (January 2026) - iDempiere 13

<nowiki>*</nowiki> Tested: Silent pack-in support with proper filename format

<nowiki>*</nowiki> NEW: SQLStatement format for sample data (FK-safe import)

<nowiki>*</nowiki> NEW: GardenWorld sample data with 3 assets, 3 job standards, 3 maintenance plans

<nowiki>*</nowiki> FIX: MP_RefList values aligned with AD_Reference definitions

<nowiki>*</nowiki> FIX: Document Status values (AP/VO/WC) for Request workflow

<nowiki>*</nowiki> FIX: Resource Type values (BP/BT/HH/RR/TT) for work order resources

<nowiki>*</nowiki> FIX: HELP text added at AD_Tab level for all windows

<nowiki>*</nowiki> TOOL: Dict2Pack - silent dictionary export from PostgreSQL

<nowiki>*</nowiki> TOOL: GenericPO2Pack --sql - FK-safe sample data export

====Version 2.0.0 (2024)====
<nowiki>*</nowiki> Initial release for iDempiere 12

<nowiki>*</nowiki> Core maintenance management functionality

<nowiki>*</nowiki> Based on OFB-Consulting Chile original work

====Version 1.x (Legacy) ====
<nowiki>*</nowiki> Original ADempiere/Compiere version by OFB-Consulting

==== Installation:====
1. Deploy JAR to iDempiere plugins folder

- Copy org.asset.maintenance_2.0.0.jar to $IDEMPIERE_HOME/plugins/

2. OSGI Plugins Console - Install and Press Start.

3. Load sample data (as GardenWorld Admin)

- Pack In > data/SampleData2Pack.zip

- Or silent: copy as 202601231700_GardenWorld_SampleData.zip

- Or SQL: psql -d idempiere -f data/GardenWorldSample.sql

4. Sync sequences (System Admin)

- System Admin > Sequence Check (process)

Silent Pack-In Filename Format:

<timestamp>_<AD_Client.Value>_<Description>.zip

Examples:

- 202601231700_SYSTEM_AssetMaintenance.zip (dictionary to System)

- 202601231700_GardenWorld_SampleData.zip (data to GardenWorld)

For comments and questions, use the Discussion page or GitHub Issues.
[[Category:Available_Plugins]]

Plugin: Asset Maintenance

2026-01-23T20:10:28Z

Red1: user tag

__FORCETOC__

==== Maintainer: [[User:Red1|Redhuan D.]] Oon, CTFL. (red1org@gmail.com)====

====Based on: OFB-Consulting, Chile====

====Sponsor: Zeeshan Hasan (zeeshan@sysnova.com)====

====Current Version: 2.1.0.3 for iDempiere 13====

====License: GPLv2====

====Source: https://github.com/red1oon/idempiere-asset-maintenance<nowiki/>====

====Binary: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/org.asset.maintenance_2.1.0.202601231802.jar org.asset.maintenance_2.X.X.jar] (available in target/ folder)====

====Garden World: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/SampleData2Pack.zip Sample Data]====

====Guide: AssetMaintenanceUserGuide.docx (in doc/ folder) IN PROGRESS (come back tomorrow)====

===Description===
Asset Maintenance is a lightweight plugin for preventive maintenance of enterprise assets in iDempiere.

===Features:===

====Core Functionality:====
<nowiki>*</nowiki> Meter-based scheduling (kilometers, operating hours, calendar days)

<nowiki>*</nowiki> Calendar-based scheduling with configurable intervals

<nowiki>*</nowiki> Standard Job templates with predefined task sequences

<nowiki>*</nowiki> Maintenance Plans linked to assets with scheduling rules

<nowiki>*</nowiki> Work Order (OT) generation from maintenance plans or requests

<nowiki>*</nowiki> Work Order task tracking with duration and resource allocation

<nowiki>*</nowiki> Asset Meter logging with reading history

<nowiki>*</nowiki> Maintenance Request workflow (Draft → Approved → Work Order)

==== Windows:====
<nowiki>*</nowiki> Meter - Define meter types (Kilometers, Operating Hours, Calendar Days)

<nowiki>*</nowiki> Job Standard - Create reusable job templates with task lists

<nowiki>*</nowiki> Maintenance - Asset maintenance plans with scheduling

<nowiki>*</nowiki> Order/Work Order (OT) - Work order management and execution

<nowiki>*</nowiki> Request - Maintenance request submission and approval

====Reference Lists:====
<nowiki>*</nowiki> Job Standard Type (AA-Asset Adjustment, CM-Corrective, PM-Preventive, PD-Predictive)

<nowiki>*</nowiki> Maintain Area (EL-Electrical, ME-Mechanical, OP-Operational, SF-Safety)

<nowiki>*</nowiki> Document Status for Request (AP-Approved, VO-Voided, WC-Waiting Confirmation)

<nowiki>*</nowiki> Resource Type (BP-Business Partner, BT-B.Partner Type, HH-Human, RR-Resource, TT-Tool/Equipment)

The plugin is server-side only (no Swing client) - simplified as a single OSGi bundle.

---

===Release Notes:===
Version 2.1.0.3 (January 2026) - iDempiere 13

<nowiki>*</nowiki> Tested: Silent pack-in support with proper filename format

<nowiki>*</nowiki> NEW: SQLStatement format for sample data (FK-safe import)

<nowiki>*</nowiki> NEW: GardenWorld sample data with 3 assets, 3 job standards, 3 maintenance plans

<nowiki>*</nowiki> FIX: MP_RefList values aligned with AD_Reference definitions

<nowiki>*</nowiki> FIX: Document Status values (AP/VO/WC) for Request workflow

<nowiki>*</nowiki> FIX: Resource Type values (BP/BT/HH/RR/TT) for work order resources

<nowiki>*</nowiki> FIX: HELP text added at AD_Tab level for all windows

<nowiki>*</nowiki> TOOL: Dict2Pack - silent dictionary export from PostgreSQL

<nowiki>*</nowiki> TOOL: GenericPO2Pack --sql - FK-safe sample data export

====Version 2.0.0 (2024)====
<nowiki>*</nowiki> Initial release for iDempiere 12

<nowiki>*</nowiki> Core maintenance management functionality

<nowiki>*</nowiki> Based on OFB-Consulting Chile original work

====Version 1.x (Legacy) ====
<nowiki>*</nowiki> Original ADempiere/Compiere version by OFB-Consulting

==== Installation:====
1. Deploy JAR to iDempiere plugins folder

- Copy org.asset.maintenance_2.0.0.jar to $IDEMPIERE_HOME/plugins/

2. OSGI Plugins Console - Install and Press Start.

3. Load sample data (as GardenWorld Admin)

- Pack In > data/SampleData2Pack.zip

- Or silent: copy as 202601231700_GardenWorld_SampleData.zip

- Or SQL: psql -d idempiere -f data/GardenWorldSample.sql

4. Sync sequences (System Admin)

- System Admin > Sequence Check (process)

Silent Pack-In Filename Format:

<timestamp>_<AD_Client.Value>_<Description>.zip

Examples:

- 202601231700_SYSTEM_AssetMaintenance.zip (dictionary to System)

- 202601231700_GardenWorld_SampleData.zip (data to GardenWorld)

For comments and questions, use the Discussion page or GitHub Issues.
[[Category:Available_Plugins]]

User talk:Red1

2026-01-23T20:07:11Z

Red1:

My email is red1org@gmail.com.<br>
I have lost my previous red1.org to squatters during the plandemic, together with its historical forums. But it is archived [https://web.archive.org/web/20200922052554/http://red1.org/adempiere/index.php here] [User:Red1]

Plugin: Asset Maintenance

2026-01-23T19:50:02Z

Red1: /* Maintainer: Red1 (talk) - Redhuan D. Oon red1org@gmail.com */

__FORCETOC__

==== Maintainer: Red1 (talk) - Redhuan D. Oon, CTFL. (red1org@gmail.com)====

====Based on: OFB-Consulting, Chile====

====Sponsor: Zeeshan Hasan (zeeshan@sysnova.com)====

====Current Version: 2.1.0.3 for iDempiere 13====

====License: GPLv2====

====Source: https://github.com/red1oon/idempiere-asset-maintenance<nowiki/>====

====Binary: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/org.asset.maintenance_2.1.0.202601231802.jar org.asset.maintenance_2.X.X.jar] (available in target/ folder)====

====Garden World: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/SampleData2Pack.zip Sample Data]====

====Guide: AssetMaintenanceUserGuide.docx (in doc/ folder) IN PROGRESS (come back tomorrow)====

===Description===
Asset Maintenance is a lightweight plugin for preventive maintenance of enterprise assets in iDempiere.

===Features:===

====Core Functionality:====
<nowiki>*</nowiki> Meter-based scheduling (kilometers, operating hours, calendar days)

<nowiki>*</nowiki> Calendar-based scheduling with configurable intervals

<nowiki>*</nowiki> Standard Job templates with predefined task sequences

<nowiki>*</nowiki> Maintenance Plans linked to assets with scheduling rules

<nowiki>*</nowiki> Work Order (OT) generation from maintenance plans or requests

<nowiki>*</nowiki> Work Order task tracking with duration and resource allocation

<nowiki>*</nowiki> Asset Meter logging with reading history

<nowiki>*</nowiki> Maintenance Request workflow (Draft → Approved → Work Order)

==== Windows:====
<nowiki>*</nowiki> Meter - Define meter types (Kilometers, Operating Hours, Calendar Days)

<nowiki>*</nowiki> Job Standard - Create reusable job templates with task lists

<nowiki>*</nowiki> Maintenance - Asset maintenance plans with scheduling

<nowiki>*</nowiki> Order/Work Order (OT) - Work order management and execution

<nowiki>*</nowiki> Request - Maintenance request submission and approval

====Reference Lists:====
<nowiki>*</nowiki> Job Standard Type (AA-Asset Adjustment, CM-Corrective, PM-Preventive, PD-Predictive)

<nowiki>*</nowiki> Maintain Area (EL-Electrical, ME-Mechanical, OP-Operational, SF-Safety)

<nowiki>*</nowiki> Document Status for Request (AP-Approved, VO-Voided, WC-Waiting Confirmation)

<nowiki>*</nowiki> Resource Type (BP-Business Partner, BT-B.Partner Type, HH-Human, RR-Resource, TT-Tool/Equipment)

The plugin is server-side only (no Swing client) - simplified as a single OSGi bundle.

---

===Release Notes:===
Version 2.1.0.3 (January 2026) - iDempiere 13

<nowiki>*</nowiki> Tested: Silent pack-in support with proper filename format

<nowiki>*</nowiki> NEW: SQLStatement format for sample data (FK-safe import)

<nowiki>*</nowiki> NEW: GardenWorld sample data with 3 assets, 3 job standards, 3 maintenance plans

<nowiki>*</nowiki> FIX: MP_RefList values aligned with AD_Reference definitions

<nowiki>*</nowiki> FIX: Document Status values (AP/VO/WC) for Request workflow

<nowiki>*</nowiki> FIX: Resource Type values (BP/BT/HH/RR/TT) for work order resources

<nowiki>*</nowiki> FIX: HELP text added at AD_Tab level for all windows

<nowiki>*</nowiki> TOOL: Dict2Pack - silent dictionary export from PostgreSQL

<nowiki>*</nowiki> TOOL: GenericPO2Pack --sql - FK-safe sample data export

====Version 2.0.0 (2024)====
<nowiki>*</nowiki> Initial release for iDempiere 12

<nowiki>*</nowiki> Core maintenance management functionality

<nowiki>*</nowiki> Based on OFB-Consulting Chile original work

====Version 1.x (Legacy) ====
<nowiki>*</nowiki> Original ADempiere/Compiere version by OFB-Consulting

==== Installation:====
1. Deploy JAR to iDempiere plugins folder

- Copy org.asset.maintenance_2.0.0.jar to $IDEMPIERE_HOME/plugins/

2. OSGI Plugins Console - Install and Press Start.

3. Load sample data (as GardenWorld Admin)

- Pack In > data/SampleData2Pack.zip

- Or silent: copy as 202601231700_GardenWorld_SampleData.zip

- Or SQL: psql -d idempiere -f data/GardenWorldSample.sql

4. Sync sequences (System Admin)

- System Admin > Sequence Check (process)

Silent Pack-In Filename Format:

<timestamp>_<AD_Client.Value>_<Description>.zip

Examples:

- 202601231700_SYSTEM_AssetMaintenance.zip (dictionary to System)

- 202601231700_GardenWorld_SampleData.zip (data to GardenWorld)

For comments and questions, use the Discussion page or GitHub Issues.
[[Category:Available_Plugins]]

Plugin: Asset Maintenance

2026-01-23T19:47:21Z

Red1: /* Release Notes: */ redundant

__FORCETOC__

==== Maintainer: Red1 (talk) - Redhuan D. Oon red1org@gmail.com ====

==== Based on: OFB-Consulting, Chile ====

==== Sponsor: zeeshan@sysnova.com ====

==== Current Version: 2.1.0.3 for iDempiere 13 ====

==== License: GPLv2 ====

==== Source: https://github.com/red1oon/idempiere-asset-maintenance ====

==== Binary: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/org.asset.maintenance_2.1.0.202601231802.jar org.asset.maintenance_2.X.X.jar] (available in target/ folder) ====

==== Garden World: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/SampleData2Pack.zip Sample Data] ====

==== Guide: AssetMaintenanceUserGuide.docx (in doc/ folder) IN PROGRESS (come back tomorrow) ====

=== Description ===
Asset Maintenance is a lightweight plugin for preventive maintenance of enterprise assets in iDempiere.

=== Features: ===

==== Core Functionality: ====
<nowiki>*</nowiki> Meter-based scheduling (kilometers, operating hours, calendar days)

<nowiki>*</nowiki> Calendar-based scheduling with configurable intervals

<nowiki>*</nowiki> Standard Job templates with predefined task sequences

<nowiki>*</nowiki> Maintenance Plans linked to assets with scheduling rules

<nowiki>*</nowiki> Work Order (OT) generation from maintenance plans or requests

<nowiki>*</nowiki> Work Order task tracking with duration and resource allocation

<nowiki>*</nowiki> Asset Meter logging with reading history

<nowiki>*</nowiki> Maintenance Request workflow (Draft → Approved → Work Order)

==== Windows: ====
<nowiki>*</nowiki> Meter - Define meter types (Kilometers, Operating Hours, Calendar Days)

<nowiki>*</nowiki> Job Standard - Create reusable job templates with task lists

<nowiki>*</nowiki> Maintenance - Asset maintenance plans with scheduling

<nowiki>*</nowiki> Order/Work Order (OT) - Work order management and execution

<nowiki>*</nowiki> Request - Maintenance request submission and approval

==== Reference Lists: ====
<nowiki>*</nowiki> Job Standard Type (AA-Asset Adjustment, CM-Corrective, PM-Preventive, PD-Predictive)

<nowiki>*</nowiki> Maintain Area (EL-Electrical, ME-Mechanical, OP-Operational, SF-Safety)

<nowiki>*</nowiki> Document Status for Request (AP-Approved, VO-Voided, WC-Waiting Confirmation)

<nowiki>*</nowiki> Resource Type (BP-Business Partner, BT-B.Partner Type, HH-Human, RR-Resource, TT-Tool/Equipment)

The plugin is server-side only (no Swing client) - simplified as a single OSGi bundle.

---

=== Release Notes: ===
Version 2.1.0.3 (January 2026) - iDempiere 13

<nowiki>*</nowiki> Tested: Silent pack-in support with proper filename format

<nowiki>*</nowiki> NEW: SQLStatement format for sample data (FK-safe import)

<nowiki>*</nowiki> NEW: GardenWorld sample data with 3 assets, 3 job standards, 3 maintenance plans

<nowiki>*</nowiki> FIX: MP_RefList values aligned with AD_Reference definitions

<nowiki>*</nowiki> FIX: Document Status values (AP/VO/WC) for Request workflow

<nowiki>*</nowiki> FIX: Resource Type values (BP/BT/HH/RR/TT) for work order resources

<nowiki>*</nowiki> FIX: HELP text added at AD_Tab level for all windows

<nowiki>*</nowiki> TOOL: Dict2Pack - silent dictionary export from PostgreSQL

<nowiki>*</nowiki> TOOL: GenericPO2Pack --sql - FK-safe sample data export

==== Version 2.0.0 (2024) ====
<nowiki>*</nowiki> Initial release for iDempiere 12

<nowiki>*</nowiki> Core maintenance management functionality

<nowiki>*</nowiki> Based on OFB-Consulting Chile original work

==== Version 1.x (Legacy) ====
<nowiki>*</nowiki> Original ADempiere/Compiere version by OFB-Consulting

==== Installation: ====
1. Deploy JAR to iDempiere plugins folder

- Copy org.asset.maintenance_2.0.0.jar to $IDEMPIERE_HOME/plugins/

2. OSGI Plugins Console - Install and Press Start.

3. Load sample data (as GardenWorld Admin)

- Pack In > data/SampleData2Pack.zip

- Or silent: copy as 202601231700_GardenWorld_SampleData.zip

- Or SQL: psql -d idempiere -f data/GardenWorldSample.sql

4. Sync sequences (System Admin)

- System Admin > Sequence Check (process)

Silent Pack-In Filename Format:

<timestamp>_<AD_Client.Value>_<Description>.zip

Examples:

- 202601231700_SYSTEM_AssetMaintenance.zip (dictionary to System)

- 202601231700_GardenWorld_SampleData.zip (data to GardenWorld)

For comments and questions, use the Discussion page or GitHub Issues.
[[Category:Available_Plugins]]

Plugin: Asset Maintenance

2026-01-23T19:46:01Z

Red1: readability, accuracy

__FORCETOC__

==== Maintainer: Red1 (talk) - Redhuan D. Oon red1org@gmail.com ====

==== Based on: OFB-Consulting, Chile ====

==== Sponsor: zeeshan@sysnova.com ====

==== Current Version: 2.1.0.3 for iDempiere 13 ====

==== License: GPLv2 ====

==== Source: https://github.com/red1oon/idempiere-asset-maintenance ====

==== Binary: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/org.asset.maintenance_2.1.0.202601231802.jar org.asset.maintenance_2.X.X.jar] (available in target/ folder) ====

==== Garden World: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/SampleData2Pack.zip Sample Data] ====

==== Guide: AssetMaintenanceUserGuide.docx (in doc/ folder) IN PROGRESS (come back tomorrow) ====

=== Description ===
Asset Maintenance is a lightweight plugin for preventive maintenance of enterprise assets in iDempiere.

=== Features: ===

==== Core Functionality: ====
<nowiki>*</nowiki> Meter-based scheduling (kilometers, operating hours, calendar days)

<nowiki>*</nowiki> Calendar-based scheduling with configurable intervals

<nowiki>*</nowiki> Standard Job templates with predefined task sequences

<nowiki>*</nowiki> Maintenance Plans linked to assets with scheduling rules

<nowiki>*</nowiki> Work Order (OT) generation from maintenance plans or requests

<nowiki>*</nowiki> Work Order task tracking with duration and resource allocation

<nowiki>*</nowiki> Asset Meter logging with reading history

<nowiki>*</nowiki> Maintenance Request workflow (Draft → Approved → Work Order)

==== Windows: ====
<nowiki>*</nowiki> Meter - Define meter types (Kilometers, Operating Hours, Calendar Days)

<nowiki>*</nowiki> Job Standard - Create reusable job templates with task lists

<nowiki>*</nowiki> Maintenance - Asset maintenance plans with scheduling

<nowiki>*</nowiki> Order/Work Order (OT) - Work order management and execution

<nowiki>*</nowiki> Request - Maintenance request submission and approval

==== Reference Lists: ====
<nowiki>*</nowiki> Job Standard Type (AA-Asset Adjustment, CM-Corrective, PM-Preventive, PD-Predictive)

<nowiki>*</nowiki> Maintain Area (EL-Electrical, ME-Mechanical, OP-Operational, SF-Safety)

<nowiki>*</nowiki> Document Status for Request (AP-Approved, VO-Voided, WC-Waiting Confirmation)

<nowiki>*</nowiki> Resource Type (BP-Business Partner, BT-B.Partner Type, HH-Human, RR-Resource, TT-Tool/Equipment)

The plugin is server-side only (no Swing client) - simplified as a single OSGi bundle.

---

=== Release Notes: ===
Version 2.1.0.3 (January 2026) - iDempiere 13

<nowiki>*</nowiki> Tested: Silent pack-in support with proper filename format

<nowiki>*</nowiki> NEW: SQLStatement format for sample data (FK-safe import)

<nowiki>*</nowiki> NEW: GardenWorld sample data with 3 assets, 3 job standards, 3 maintenance plans

<nowiki>*</nowiki> FIX: MP_RefList values aligned with AD_Reference definitions

<nowiki>*</nowiki> FIX: Document Status values (AP/VO/WC) for Request workflow

<nowiki>*</nowiki> FIX: Resource Type values (BP/BT/HH/RR/TT) for work order resources

<nowiki>*</nowiki> FIX: HELP text added at AD_Tab level for all windows

<nowiki>*</nowiki> TOOL: Dict2Pack - silent dictionary export from PostgreSQL

<nowiki>*</nowiki> TOOL: GenericPO2Pack --sql - FK-safe sample data export

==== Version 2.0.0 (2024) ====
<nowiki>*</nowiki> Initial release for iDempiere 12

<nowiki>*</nowiki> Core maintenance management functionality

<nowiki>*</nowiki> Based on OFB-Consulting Chile original work

==== Version 1.x (Legacy) ====
<nowiki>*</nowiki> Original ADempiere/Compiere version by OFB-Consulting

==== Installation: ====
1. Deploy JAR to iDempiere plugins folder

- Copy org.asset.maintenance_2.0.0.jar to $IDEMPIERE_HOME/plugins/

2. OSGI Plugins Console - Install and Press Start.

2.1 Login System : Do Sequence Check and Synch Terminology

3. Load sample data (as GardenWorld Admin)

- Pack In > data/SampleData2Pack.zip

- Or silent: copy as 202601231700_GardenWorld_SampleData.zip

- Or SQL: psql -d idempiere -f data/GardenWorldSample.sql

4. Sync sequences (System Admin)

- System Admin > Sequence Check (process)

Silent Pack-In Filename Format:

<timestamp>_<AD_Client.Value>_<Description>.zip

Examples:

- 202601231700_SYSTEM_AssetMaintenance.zip (dictionary to System)

- 202601231700_GardenWorld_SampleData.zip (data to GardenWorld)

For comments and questions, use the Discussion page or GitHub Issues.
[[Category:Available_Plugins]]

Plugin: Asset Maintenance

2026-01-23T10:27:01Z

Red1: name

__FORCETOC__

Maintainer: Red1 (talk) - Redhuan D. Oon

Based on: OFB-Consulting, Chile

Copyright: red1org@gmail.com

Sponsor: zeeshan@sysnova.com

Current Version: 2.1.0.3 for iDempiere 13

License: GPLv2

Source: https://github.com/red1oon/idempiere-asset-maintenance

Binary: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/org.asset.maintenance_2.1.0.202601231802.jar org.asset.maintenance_2.0.0.jar] (available in target/ folder)

Garden World [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/SampleData2Pack.zip Sample Data]

Guide: AssetMaintenanceUserGuide.docx (in doc/ folder) IN PROGRESS (come back tomorrow)

==== Description ====
Asset Maintenance is a lightweight plugin for preventive maintenance of enterprise assets in iDempiere.

Features:

==== Core Functionality: ====
<nowiki>*</nowiki> Meter-based scheduling (kilometers, operating hours, calendar days)

<nowiki>*</nowiki> Calendar-based scheduling with configurable intervals

<nowiki>*</nowiki> Standard Job templates with predefined task sequences

<nowiki>*</nowiki> Maintenance Plans linked to assets with scheduling rules

<nowiki>*</nowiki> Work Order (OT) generation from maintenance plans or requests

<nowiki>*</nowiki> Work Order task tracking with duration and resource allocation

<nowiki>*</nowiki> Asset Meter logging with reading history

<nowiki>*</nowiki> Maintenance Request workflow (Draft → Approved → Work Order)

==== Windows: ====
<nowiki>*</nowiki> Meter - Define meter types (Kilometers, Operating Hours, Calendar Days)

<nowiki>*</nowiki> Job Standard - Create reusable job templates with task lists

<nowiki>*</nowiki> Maintenance - Asset maintenance plans with scheduling

<nowiki>*</nowiki> Order/Work Order (OT) - Work order management and execution

<nowiki>*</nowiki> Request - Maintenance request submission and approval

==== Reference Lists: ====
<nowiki>*</nowiki> Job Standard Type (AA-Asset Adjustment, CM-Corrective, PM-Preventive, PD-Predictive)

<nowiki>*</nowiki> Maintain Area (EL-Electrical, ME-Mechanical, OP-Operational, SF-Safety)

<nowiki>*</nowiki> Document Status for Request (AP-Approved, VO-Voided, WC-Waiting Confirmation)

<nowiki>*</nowiki> Resource Type (BP-Business Partner, BT-B.Partner Type, HH-Human, RR-Resource, TT-Tool/Equipment)

The plugin is server-side only (no Swing client) - simplified as a single OSGi bundle.

---

==== Release Notes: ====
Version 2.1.0.3 (January 2026) - iDempiere 13

<nowiki>*</nowiki> NEW: Silent pack-in support with proper filename format

<nowiki>*</nowiki> NEW: SQLStatement format for sample data (FK-safe import)

<nowiki>*</nowiki> NEW: GardenWorld sample data with 3 assets, 3 job standards, 3 maintenance plans

<nowiki>*</nowiki> FIX: MP_RefList values aligned with AD_Reference definitions

<nowiki>*</nowiki> FIX: Document Status values (AP/VO/WC) for Request workflow

<nowiki>*</nowiki> FIX: Resource Type values (BP/BT/HH/RR/TT) for work order resources

<nowiki>*</nowiki> FIX: HELP text added at AD_Tab level for all windows

<nowiki>*</nowiki> TOOL: Dict2Pack - silent dictionary export from PostgreSQL

<nowiki>*</nowiki> TOOL: GenericPO2Pack --sql - FK-safe sample data export

==== Version 2.0.0 (2024) ====
<nowiki>*</nowiki> Initial release for iDempiere 12

<nowiki>*</nowiki> Core maintenance management functionality

<nowiki>*</nowiki> Based on OFB-Consulting Chile original work

==== Version 1.x (Legacy) ====
<nowiki>*</nowiki> Original ADempiere/Compiere version by OFB-Consulting

==== Installation: ====
1. Deploy JAR to iDempiere plugins folder

- Copy org.asset.maintenance_2.0.0.jar to $IDEMPIERE_HOME/plugins/

2. OSGI Plugins Console - Install and Press Start.

2.1 Login System : Do Sequence Check and Synch Terminology

3. Load sample data (as GardenWorld Admin)

- Pack In > data/SampleData2Pack.zip

- Or silent: copy as 202601231700_GardenWorld_SampleData.zip

- Or SQL: psql -d idempiere -f data/GardenWorldSample.sql

4. Sync sequences (System Admin)

- System Admin > Sequence Check (process)

Silent Pack-In Filename Format:

<timestamp>_<AD_Client.Value>_<Description>.zip

Examples:

- 202601231700_SYSTEM_AssetMaintenance.zip (dictionary to System)

- 202601231700_GardenWorld_SampleData.zip (data to GardenWorld)

For comments and questions, use the Discussion page or GitHub Issues.
[[Category:Available_Plugins]]

Plugin: Asset Maintenance

2026-01-23T10:26:15Z

Red1: 2.1.0.3

__FORCETOC__

Maintainer: Red1 (talk) - RED1.org

Based on: OFB-Consulting, Chile

Copyright: red1org@gmail.com

Sponsor: zeeshan@sysnova.com

Current Version: 2.1.0.3 for iDempiere 13

License: GPLv2

Source: https://github.com/red1oon/idempiere-asset-maintenance

Binary: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/org.asset.maintenance_2.1.0.202601231802.jar org.asset.maintenance_2.0.0.jar] (available in target/ folder)

Garden World [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/Release2.1.0.3/SampleData2Pack.zip Sample Data]

Guide: AssetMaintenanceUserGuide.docx (in doc/ folder) IN PROGRESS (come back tomorrow)

==== Description ====
Asset Maintenance is a lightweight plugin for preventive maintenance of enterprise assets in iDempiere.

Features:

==== Core Functionality: ====
<nowiki>*</nowiki> Meter-based scheduling (kilometers, operating hours, calendar days)

<nowiki>*</nowiki> Calendar-based scheduling with configurable intervals

<nowiki>*</nowiki> Standard Job templates with predefined task sequences

<nowiki>*</nowiki> Maintenance Plans linked to assets with scheduling rules

<nowiki>*</nowiki> Work Order (OT) generation from maintenance plans or requests

<nowiki>*</nowiki> Work Order task tracking with duration and resource allocation

<nowiki>*</nowiki> Asset Meter logging with reading history

<nowiki>*</nowiki> Maintenance Request workflow (Draft → Approved → Work Order)

==== Windows: ====
<nowiki>*</nowiki> Meter - Define meter types (Kilometers, Operating Hours, Calendar Days)

<nowiki>*</nowiki> Job Standard - Create reusable job templates with task lists

<nowiki>*</nowiki> Maintenance - Asset maintenance plans with scheduling

<nowiki>*</nowiki> Order/Work Order (OT) - Work order management and execution

<nowiki>*</nowiki> Request - Maintenance request submission and approval

==== Reference Lists: ====
<nowiki>*</nowiki> Job Standard Type (AA-Asset Adjustment, CM-Corrective, PM-Preventive, PD-Predictive)

<nowiki>*</nowiki> Maintain Area (EL-Electrical, ME-Mechanical, OP-Operational, SF-Safety)

<nowiki>*</nowiki> Document Status for Request (AP-Approved, VO-Voided, WC-Waiting Confirmation)

<nowiki>*</nowiki> Resource Type (BP-Business Partner, BT-B.Partner Type, HH-Human, RR-Resource, TT-Tool/Equipment)

The plugin is server-side only (no Swing client) - simplified as a single OSGi bundle.

---

==== Release Notes: ====
Version 2.1.0.3 (January 2026) - iDempiere 13

<nowiki>*</nowiki> NEW: Silent pack-in support with proper filename format

<nowiki>*</nowiki> NEW: SQLStatement format for sample data (FK-safe import)

<nowiki>*</nowiki> NEW: GardenWorld sample data with 3 assets, 3 job standards, 3 maintenance plans

<nowiki>*</nowiki> FIX: MP_RefList values aligned with AD_Reference definitions

<nowiki>*</nowiki> FIX: Document Status values (AP/VO/WC) for Request workflow

<nowiki>*</nowiki> FIX: Resource Type values (BP/BT/HH/RR/TT) for work order resources

<nowiki>*</nowiki> FIX: HELP text added at AD_Tab level for all windows

<nowiki>*</nowiki> TOOL: Dict2Pack - silent dictionary export from PostgreSQL

<nowiki>*</nowiki> TOOL: GenericPO2Pack --sql - FK-safe sample data export

==== Version 2.0.0 (2024) ====
<nowiki>*</nowiki> Initial release for iDempiere 12

<nowiki>*</nowiki> Core maintenance management functionality

<nowiki>*</nowiki> Based on OFB-Consulting Chile original work

==== Version 1.x (Legacy) ====
<nowiki>*</nowiki> Original ADempiere/Compiere version by OFB-Consulting

==== Installation: ====
1. Deploy JAR to iDempiere plugins folder

- Copy org.asset.maintenance_2.0.0.jar to $IDEMPIERE_HOME/plugins/

2. OSGI Plugins Console - Install and Press Start.

2.1 Login System : Do Sequence Check and Synch Terminology

3. Load sample data (as GardenWorld Admin)

- Pack In > data/SampleData2Pack.zip

- Or silent: copy as 202601231700_GardenWorld_SampleData.zip

- Or SQL: psql -d idempiere -f data/GardenWorldSample.sql

4. Sync sequences (System Admin)

- System Admin > Sequence Check (process)

Silent Pack-In Filename Format:

<timestamp>_<AD_Client.Value>_<Description>.zip

Examples:

- 202601231700_SYSTEM_AssetMaintenance.zip (dictionary to System)

- 202601231700_GardenWorld_SampleData.zip (data to GardenWorld)

For comments and questions, use the Discussion page or GitHub Issues.
[[Category:Available_Plugins]]

Plugin: Asset Maintenance

2026-01-22T00:07:04Z

Red1: Give links to successful jar release

__FORCETOC__

Maintainer: Red1 (talk) - RED1.org

Based on: OFB-Consulting, Chile

Copyright: red1org@gmail.com

Sponsor: zeeshan@sysnova.com

Current Version: 2.1 for iDempiere 13

License: GPLv2

Source: https://github.com/red1oon/idempiere-asset-maintenance

Binary: [https://github.com/red1oon/idempiere-asset-maintenance/releases/download/OSGIPlugin/org.asset.maintenance_13.0.0.202601220757.jar org.asset.maintenance_2.0.0.jar] (available in target/ folder)

Guide: AssetMaintenanceUserGuide.docx (in doc/ folder) IN PROGRESS (come back tomorrow)

(THIS PAGE IS UNDER CONSTRUCTION)

=== <big>Description</big> ===
Asset Maintenance is a lightweight plugin for preventive maintenance of enterprise assets in iDempiere.

=== <big>Features:</big> ===
<nowiki>*</nowiki> Meter-based scheduling (kilometers, operating hours, etc.)

<nowiki>*</nowiki> Calendar-based scheduling (days, weeks, months)

<nowiki>*</nowiki> Standard Job templates with predefined tasks

<nowiki>*</nowiki> Maintenance forecasting for upcoming maintenance

<nowiki>*</nowiki> Work Order generation and tracking

<nowiki>*</nowiki> Asset Meter logging

The plugin is server-side only (no Swing client) - simplified as a single OSGi bundle.

=== <big>Installation:</big> ===
1. Deploy JAR to iDempiere plugins folder

2. Run 2Pack import from META-INF/2Pack.zip

3. Load sample data in GardenWorld Admin / Pack In (data/SampleGardenWorld.zip)

For comments and questions, use the Discussion page.
[[Category:Available_Plugins]]

Plugin: Asset Maintenance

2026-01-21T23:23:42Z

Red1: Upgraded Release notes

__FORCETOC__

Maintainer: Red1 (talk) - RED1.org

Based on: OFB-Consulting, Chile

Copyright: red1org@gmail.com

Sponsor: zeeshan@sysnova.com

Current Version: 2.1 for iDempiere 13

License: GPLv2

Source: <nowiki>https://github.com/red1oon/idempiere-asset-maintenance</nowiki>

Binary: org.asset.maintenance_2.0.0.jar (available in target/ folder)

Guide: AssetMaintenanceUserGuide.docx (in doc/ folder) IN PROGRESS (come back tomorrow)

(THIS PAGE IS UNDER CONSTRUCTION)

=== <big>Description</big> ===
Asset Maintenance is a lightweight plugin for preventive maintenance of enterprise assets in iDempiere.

=== <big>Features:</big> ===
<nowiki>*</nowiki> Meter-based scheduling (kilometers, operating hours, etc.)

<nowiki>*</nowiki> Calendar-based scheduling (days, weeks, months)

<nowiki>*</nowiki> Standard Job templates with predefined tasks

<nowiki>*</nowiki> Maintenance forecasting for upcoming maintenance

<nowiki>*</nowiki> Work Order generation and tracking

<nowiki>*</nowiki> Asset Meter logging

The plugin is server-side only (no Swing client) - simplified as a single OSGi bundle.

=== <big>Installation:</big> ===
1. Deploy JAR to iDempiere plugins folder

2. Run 2Pack import from META-INF/2Pack.zip

3. Load sample data in GardenWorld Admin / Pack In (data/SampleGardenWorld.zip)

For comments and questions, use the Discussion page.
[[Category:Available_Plugins]]

User:Red1

2026-01-21T23:13:04Z

Red1: updated reference

*Main user page: http://wiki.idempiere.org/wiki/User:Red1
*My present works are in https://github.com/red1oon/
*Email: red1org@gmail.com (If you do not hear from me, i am most likely not impressed enough just yet.)

=I have a dream=
*That all code will be free and all wealth is shared more equitably.
*That all miserable people who claimed their kids do not have enough to eat stop complaining and start contributing. Then their kids will not be so fat and the world is a better place.
*That human beings remain decent and not cheat when using open source by hiding their improvements from others to help them improve it.
*That more of you implementers out there engage the top contributors professionally instead of hiring your own coders which will leave you to die. Don't take my word for it. It happened to most of you i met all over the world.
*By contributing then you become like us, a branded name, where more inquiries will gravitate towards you instead of others. The more honest you are, the more it attracts high value projects. Even when you die (everyone dies) your karma will get you a better life.
*Case in point - http://red1.org/BlackPaper.pdf

=Steal From Me=
*Yes, you heard me right. I encourage you to fork and copy all my work to displace the other bloated giants been used. In the interim term, the trickle effect is tremendous and guess who stands out most?
*If you do credit me back, i just have to thank you. If you don't i will still thank you (anonymously).
*Anyway i have enough credit in my http://red1.org/guestbook/ since a decade ago now frozen due to spam.
*You can get my stuff at the Files Download section of my SourceForge.net account: http://sf.net/projects/red1/files/

=Talk To Me=
*If you find any shit in my work then post in the forum for me to fix it.
*If you find any shit with any other's work, then write to me to expose their evil.
*If you wish to engage me for a project together with the local them there, i give priority to the following countries at this moment (I change the list once it is out of my bucket list):
**North Korea
**Iran
**Iceland
**Mongolia
**Tibet
**Antartica
*I usually will work with the local FOSS spirited person there. If none exists, i usually take on an apprentice and soon s/he is the one. This is not poetry. This is my history.

=Some Good Stuff=
*This list may change depending on what i analyse to be really interesting stuff for any project member to delve in too. Of course, tell me what you think or knock me on the head.
*[[PO_Wrapper]] is the E=mc2 of the code.
*[[Plugin:_Purchasing_Forecast]] is one example of perfect 100% separation of plugin from core.

=Help Me!=
*Yes, I need your help too. For one if you help me translate some of my PDFs into your own language and publish it or I publish it for you. Like this amigo here: http://sourceforge.net/projects/red1/files/Espanol/
*You can also submit subtitles to my Youtube movies: http://www.youtube.com/user/redhuanoon/videos
*If you have an interesting large ERP challenge that can contribute to the project then call me.

=My votes=
*Can you all please do us a favour and vote for as many plugins that you find useful. That is the least you can do to show your moral support. Do check them out here http://wiki.idempiere.org/en/Category:Available_Plugins. Thanks!
<w4grb_ratinglist uservotes user="Red1" items="5"/>
*

IDempiere workshop 2019

2019-11-20T01:38:44Z

Red1: mostly capitalizations

The workshop at the 2019 conference started without a fixed agenda. This page is used for a transcript of what we did there.

= JIRA tickets =

You can find all JIRA tickets we created or touched here:

[https://idempiere.atlassian.net/issues/?jql=labels%20%3D%20%22ChateauChapeau2019%22 JIRA label ChateauChapeau2019]

= Suggested topics =

Some participants proposing what items we can discuss.

* Workflows (Frank)

* DMS Solution by Deepak

* Norbert is interested in REST
** (Sergey, Norbert, Deepak, Carlos)
** -> responsive UI, integration with other frameworks
** authentication
** Client side development
** Heng Sin implementation of REST

* Client Side Callouts
* User Experience (zk)
** Accessibility
* How to display kiosk screens/data visualisation (Anton)
* Ask for input callouts
* Multi selection fields
* Process callouts
* Styles on info window
* Editable info window
* Combobox auto-filter
* Alternatives for zk

* Modularization - decoupling (Carlos)
** Distros
** identify functionalities that are core vs plugin
* Plugin Marketplace (Thomas)
** Best practices
** Validation - certification

* How to collect business features (Norbert)
** CMS
** costing recalculation

* Documentation
** Who is doing what

* DB Transaction management - for long trx (Chuck)
* Distribution (Chuck)
** Shipment vs Move+Shipment
** Stock monitor
** move confirmation
* Charges and Products (Chuck)
** Charge on requisition
** Using product as charge
* product dependency on price list (Chuck)
* machine learning (Chuck)
* Selective data Replication (Chuck)
* User export of data in large quantities
* Oracle to postgres migration

* Asset - core has some fundamental things wrong (Anton)
** Dependency between asset and product
** Asset maintenance
** Asset must be an dimension on fact_acct
** Fixed assets vs asset management
** Asset Tracking (Deepak)
* More free configurable dimensions in fact_acct (Anton)
* BP Accounting
** Customer vs vendor accounting
* Currency rate by document or transaction
* Open item management at fact_acct (Anton)

* BI
-> Primefaces app for BI

* Tab context (Anton)
* Tab ID and SubTab ID in context
* "Go to line" in detail tabs
* Foreign context
* Multi-Row Process button (that is already done, but quite new)
** Pagination problem
* User Preference to see inactive records
** Other user preferences
* Open window with a predefined search
* Share saved searches - share tab customization... other user preferences
** Saved search accessible from toolbar button
** Relative search
** Multiple tab customization - accessible from toolbar button, shareable
* User preference formulas (Murilo)

* Bulk changes

* JSON and JSON-Blobl field type (Norbert)
** Nosql

* Oracle vs PostgreSQL - trend of postgres only features (CHuck)

* Form development - best practices (Chuck)

* Development environment management (Murilo)
** projects, developers, tools (sonar), plugins

* Simple production (Anton implemented this and has some improvements)

* Aggregated fact_acct ??

* Average costing

= First day =

== Oracle to Postgres migration (and other database migration issues) ==

Carlos used this tool for a long time http://www.adempiere.com/Migration/DDLUtils and it worked very well. For very big databases it does not work. It seems to load everything into memory. He then tried [http://ora2pg.darold.net/start.html Ora2Pg] but there seems to be no documentation about using this with iDempiere.

Also an interesting tool to copy databases is:

* https://wiki.idempiere.org/en/NF6.2_Copy_Client

You can use this tool to read from Oracle and write to PostgreSQL.

This process help to migrate tenants. It does not copy system data. That means you have to be prepared before and have 2packs for system customizations.

If you use that process everything is validated well even if you copy only parts of the database. It can preserve IDs or create new ones. Look at the wikipage and the screenshots there to get an overview.

https://wiki.idempiere.org/en/NF6.2_Migrate_ID can help if you get problems with IDs that are already in the database.

Both processes do not (yet) work with multiple selection fields.

== Oracle vs PostgreSQL ==

Carlos would always choose Postgres for new installations. Sometimes user companies want Oracle for several reasons - mostly historical reasons.

Chuck asked if we like to change that the internal sql language of iDempiere is Oracle. Carlos does not like to change that. Oracle is still an important market.

Carlos said that PostgreSQL has become very effients in optimizing complicated queries. He advises to use the analyze command before these kind of queries.

== PostgreSQL optimization ==

Chuck suggested [http://pgbadger.darold.net/ pgbadger] to analyze database queries. It analyses the logs of postgresql and gives hints about wrong or slow or a lot used queries. Norbert uses it and has good experiences using it.

Norbert uses https://explain.depesz.com/ to better understand the "explain analyse" command of postgresql. We had a look at this page and it does a nice job and it has also good documentation about how optimizing postgresql works.

== PostgreSQL Replication ==

iDempiere has some functions about Replication:

* https://wiki.idempiere.org/en/Manual#Replication_Data

Chuck also told us that you can use "foreign data wrappers" (fdw) of PostgreSQL to connect databases. You can use a VPN to connect far away databases and e.g. create a materialized view from an foreign table and so you have an effient way to work with the foreign data and extract records that you need.

== Virtual UI columns (Murilo) ==

Murilo showed the new functionality of virtual ui columns.

Thomas advised to add the possiblility of "virtual search columns" to have virtual columns to search with an sql formula. Perhaps we can even use that for reports. Carlos liked the idea.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4087 IDEMPIERE-4087]

== Ask for Input improvements (Murilo) ==

Murilo showed us how to use the Input windows. We have improved functionality of https://wiki.idempiere.org/en/NF2.1_Ask_Input_Within_Process

In [https://idempiere.atlassian.net/browse/IDEMPIERE-3969 IDEMPIERE-3969] you can find that. Murilo did some example Process and Callout code for that and showed us.

== Special Forms (Murilo) ==

Murilo talked about "special forms" that are included in the core. The special form can use user selected data (choosen from an infowindow) to do something useful.

We talked about how to make the creation of forms more easy. It was thought to do a form modelled in the application dictionary but that is not really possible. A besser solution is to create ready made components that we can use in our java code to fasten the creation of forms.

Carlos had the idea to create a form definition in the application dictionary that consists of ad_field entries. That makes the fields configurable. He does not likes to use ad_tab for that because it needs to create ad_table and ad_column for every form. But it even may be possible to create a view for every form. Then we got the idea to use the InfoWindow structure for that. It gives us a directory of fields connected to system elements.

It is worthful to avoid forms because they are special work. And even if we think about using another ui library than zk in the future then the forms will be a huge lot of work to reimplement one by one.

A lot of form tasks may also be solved in an InfoWindow.

The goal should be to have a more generic way to create forms using a common standard way by using common components.

=== Embedded snippets ===

Norbert said we can improve the rest interface and create the form in javascript on the client. But that is a very different approach. It may be we talk more about that when we discuss the rest interface. Carlos summarized this as: "Allowing non-zk forms by using rest access." Norbert said "Embedded Snipped".

=== Client side callouts ===

Deepak talked about the possibility that Java code can inject JavaScript code into the ui elements to create client side callouts. It may be interesting to use that in very special circumstances.
The idea is: Having Java Script callouts in the dictionary that can be attached to fields on browser side.

== Multi selection field ==

Murilo showed us a good extension that they use about multi selection fields. But after seeing the new functionality in core that Heng Sin did he likes that more. We had a deeper look at it. You can create fields with "multi selection table" and "multi selection search".

That field allows us to use multiple records in search parameters.

== Community communication / messenger ==

We asked ourselves how we can improve the communication of the community. We asked if IRC is still the best tool for a fast communication. One other way can be to use a Telegram group. Norbert likes slack but we are not sure if it is free. One advantage to e.g. Telegram is that it supports threads. Diego proposed [https://gitter.im/ gitter] ([https://en.wikipedia.org/wiki/Gitter Gitter at Wikipedia]). It is similar than slack.

Hideaki sometimes does an summarize of jira tickets and wiki changes. Carlos likes the idea but someone has to dG that manually or moderated.

We also think about guidelines to create jira tickets to not create too much noise at jira.

== multiple choice representation in database ==

Deepak suggested to use the array data type and not comma separated string values for the multiple choice fields. He suspects that this can give us referential integrity. Paul says that it does not. We should review that.

== Guidelines ==

Thomas wants to have guidelines e.g. for plugins. That allows to know about and judge guidelines. It will also improve documentation.

[[Plugin Guidelines]]

= Second day =

== Product dependency on price list ==

We want no dependency on pricelists. (Chuck) We can have a flag at the product to make a pricelist that have prices mandatory or not. Norbert proposed his own solution where in the document type there is a flag to make the product price mandatory. Thomas said that he uses a plugin for conditions & calculations that creates prices without using a price list. This plugin should not be broken when we change things.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4086 IDEMPIERE-4086 product dependency on price list]

== More free configurable dimensions in fact_acct ==

Anton asked for that. There are reasons to have dimensions for warehouse, charge, asset, locator

(Chuck opened a ticket before about this) TODO: add chucks ticket

Carlos thinks that it can be worth to add more columns as User1 and User2. Two of them might be not enough.

== Currency rate by document or transaction ==

There is a patch from Trek Global that uses a spot currency rate type (e.g. "manual") that allows to enter a currency rate for every single document.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4083 IDEMPIERE-4083]

== User preferences to see inactive records (and even more) ==

Thomas and Nicolas proposed to have it possible to not show inactive records in the search. There are different ways to do that.

* We can do a default search value.
* Another way is to create a special SQL where filter in the tab definition.
* As Carlos mentioned the SQL filter can use environment variables. That allows to use user preferences to switch this kind of filter on and off (because they also are in the environment).

Thomas liked also to have preferences to switch fields on or off or make it read-only or so. As the user preferences are in the environment you are able to configure different levels of information or read/write using a system preference.

Carlos advised us to revisit the proposal from Nicolas to see if we can include a useful way in the search window to implement that. [https://idempiere.atlassian.net/browse/IDEMPIERE-733 IDEMPIERE-733 Show only active records by default when opening a window]

Thomas did a proof of concept of a solution to this problem and it worked well. He used user preferences in a WHERE CLAUSE of a tab. He dosumented it in IDEMPIERE-733. We can think about adding that to the standard configuration in core.

== Open window with a predefined search ==

Chuck advised to be able to save searches and use them in the toolbar buttons.

Thomas said that we want to share searches to all users or to a specific role. Chuck said we can have a default search (perhaps configured in system) for a window (up to now it is configured by table).

An additional idea: We want to have relative formulas in the searches (to do things like "last month").

Instead (or additional to) the virtual search columns we can have sql code in a relative formula. For that we can use a flag for superuser to use sql in the search definition. Then the field "validation code" can contain "@SQL=".

Norbert proposed that already in the last workshop and Diego added tickets at this time:

* [https://idempiere.atlassian.net/browse/IDEMPIERE-2837 IDEMPIERE-2837 use in a better way saved searches]
* [https://idempiere.atlassian.net/browse/IDEMPIERE-2836 IDEMPIERE-2836 sql searches for advanced users]
* [https://idempiere.atlassian.net/browse/IDEMPIERE-2835 IDEMPIERE-2835 Allow relative searchs]

Someone should review these tickets and optionally open new tickets or add description based on what we spoke about today.

== Dynamic validation in search ==

Paul complained that opening a search window with dynamic validation fields that can be very slow because all the validations load when the search opens.

Murilo said that this is nearly solved but some small issues still pending.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-3981 IDEMPIERE-3981]

== Search in the toolbar ==

We like to have preconfigured searches in the toolbar. We can add these as a submenu to the search button or as a combobox. The combobox also shows the actual search's name in the ui. (Norbert showed us his implementation)

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4085 IDEMPIERE-4085]

== Improve Toolbar ==

Norbert showed us his toolbar. It looked good. He has icons and text buttons and you have only some buttons shown at the left and a "more" drop down menu at the very right.

The audience agreed that Norberts toolbar is nice and we should open a ticket to add his changes.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4084 IDEMPIERE-4084]

== Transportation management system ==

Norbert showed an example of his transportation management.

They use shipping region tabl and a shipping slot.

Evan and Ben also use a sophisticated transportation management in their "big dog erp". Thomas also has an implementation of that.

We liked to talk about that later in a smaller circle of an "[[Transportation Management System]] workgroup".

== Workflows ==

Frank was interested in subworkflows. They are not implemented yet in iDempiere. We talked about several features of workflows.

We have no real workflows in iDempiere. There are just basic capabilities beyond the simple document workflow.

== REST ==

Sergey showed us what state the REST implementations have. There is an implementation from Heng Sin and one from Sergey.

Heng Sin created authentication services, services to get window definitions and data object of PO objects. His code is very generic.

It seems that you can replace the ui using that. Heng Sin is not here to explain. Carlos noted that it will not call callouts or have dynamic validation. It may also be the plan to configure a tab and fields for special needs (for a client side application) in the application dictionary and use it here in a generic way. This will not be a real window but a definition of the interface of fields to exchange with a client application that may add its own logic.

Carlos advised to have a look at http://odata.org

Someone said that we can use the JSON parser code to also include document data into pdfs (for example use this German standard https://www.ferd-net.de/zugferd/definition/was-ist-zugferd.html).

Norbert and Paul talked about [https://graphql.org GraphQL]. That can be a more modern alternative to using REST.

== Replication from Norbert ==

Norbert has an system to replicate data between iDempiere systems. You define your own Export formats, then configure one of very different export processors (export to another database but also to other things like a file or an nosql store). He uses that also to replicate to mobile clients and the like. He uses different configurable replication strategies for different use cases. For example replicating only several tables. In his usecase he uses ActiveMQ and sends JSON objects for the exchange of replicated data.

== share tab customizations ==

A superuser should be able to create a tab layout, give it a name and make it as a system or client standard or share it with a role or another user.

If a user copies it he creates an own copy and does not change the global customization.

''(not Chuck)'' Thomas had the idea to add an customization to the export window. That allows to export e.g. csv files with different columns.

We like to have several different grid customizations. Norbert says there is a ticket Hiep is working at. [https://idempiere.atlassian.net/browse/IDEMPIERE-2708 IDEMPIERE-2708]

Carlos wants to add a tab customization field to the user search query table. That allows to open a specific customization if the user uses a specific search. Thomas idea is to add an ordering for that. We can save it in the customization record.

Chuck advised that he likes to have a way to see if something is customized or not.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4088 IDEMPIERE-4088 share tab customizations]

=== Bug in csv export ===

No - Chuck did not say that, it was Thomas idea. ;-) But Chuck said that virtual columns do not work in csv files.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4089 IDEMPIERE-4089]

== Simple Production ==

* Document type (Deepak has already code for that)
* Manufacturing setup (Anton)
* Adaxa improvements
* Multi-BOM (TrekGlobal, Chuck suggested a hack using views replacing M_ProductBOM)
* Negative BOM Line quantity (verify)
* WIP - financial and inventory move
* reservations when preparing production documents
* Production (single) vs Production (multi) - worth to consider enabling it back?

Chuck has experience with using http://frepple.com as a production planning system. One of his friends integrated this into iDempiere.

== Processes working on multiple records ==

Now we have the possibility to check several records (using the checkmark at the very left of the grid view). Deepak did it. This is discussed and documented here: https://groups.google.com/forum/#!topic/idempiere/YDnr8nCFGyA

This functionality suffers of pagination. It can work only on what is shown on the current page (maximum of 25 records).

* [https://idempiere.atlassian.net/browse/IDEMPIERE-3998 IDEMPIERE-3998 Execute Toolbar Process on Multiple Records]

Thomas likes to have something that work on all records in the search query.

Thomas had the idea the create a kind of automatically loop that calls a process for every single record. That allows to use all older processes for that. But Carlos said that can cause problems because then it is not checked if the button is available or not (or even not visible) - that may be dependent on fields of the record.

== bulk changes ==

Carlos thought about bulk changes. That is to have a button that shows all fields that can be changed in all shown records. There will be big issues because we do not know if everything can be changed or will be shown. After thinking about it it seems not a good idea.

The original proposal was about deleting or completing things. That can better be done with a simple process or with the csv importer.

== Aggregating accounting in fact_acct ==

Norbert proposed to have a more similar accounting. For example if we complete an invoice with several product lines we get several lines in the accounting. He likes to have only one line for all products to make it simpler for him. Especially to make the tables smaller.

Carlos shows us a link to an quite old explanation from Jörg Janke about this: https://www.compieresource.com/2007/08/financial-data-warehouse.html

What Norbert proposed is doable, not easy, and not recommended

== Assets ==

Anton has some issues with Assets. He says that you first have to create a product. Then you do a vendor invoice to buy the thing and the you can create an asset record.

Chuck explains that an asset can be created in two ways: From an product (if you buy it) or from an project (that you create yourself). The process to create it from an project does not work very well.

Some issues we found:
* Dependency between asset and product
* Asset maintenance
* Asset must be dimension in fact_acct
* Fixed assets vs asset management
* Creating an asset group is not pre-filling default accounts
* Chuck suggests to "pluginize" it -> knowledge group - > Anton, Chuck, Deepak, Steven/Paul
* Improvement in core to support better Assets -> Product as a Charge that posts in material receipt and not just in Invoice (Chuck to collect and document this here: [https://idempiere.atlassian.net/browse/IDEMPIERE-4092 IDEMPIERE-4092]

There are problems if you mix the concepts of "fixed assets" and "maintenance assets". Both use the same tables but they are very different.

Chuck already talked to Steven about the charge product he suggests and tries to figure out how to improve it.

== Combobox auto filter ==

There is a new field reference type to create a combobox with an auto filter facility. You use a "table direct" and you set the "Autocomplete" flag. This is done in [https://idempiere.atlassian.net/browse/IDEMPIERE-3851 IDEMPIERE-3851 Filtering list box (AP2-671 TrekGlobal)].

Thomas has problems using it because it is not very performant with big data sets.

Norbert uses https://fusejs.io to do that on client side.

Carlos had a look into our source code. It seems that it does not use the database for every keystroke but it sorts data on the server and has to resend it to the client. Something in this process is too slow.

Strategies to solve it:

* make it configurable when it searches 'ab%' vs. '%abc%'
* wait e.g. half a second before you run the query
* run the query not in the foreground but in a background thread
* see if we can cache data in the client and process it there

* we added [https://idempiere.atlassian.net/browse/IDEMPIERE-4093 IDEMPIERE-4093]

= third day =

== DB Transaction management - for long trx ==

Chuck asked how to do that. These kind of processes happen when a new user fills tables when he starts working with iDempiere but there are also users that need to import long data day by day.

Carlos says there is an hardcoded limit to have no SQL transaction longer than 2 hours.

=== Improved process transaction management ===

Chucks question was if it is possible for an process source code to get the transaction handle of this transaction, commit it and create a new transaction.

Diego led us to Event Handlers for PRE_PROCESS & POSTPROCESS. You can find them in IEventTopics.java. They are done with [https://idempiere.atlassian.net/browse/IDEMPIERE-3924 IDEMPIERE-3924 Implement EventHandler for pre/after/post processes] The OSGi Interface IEventManager can be used.

That can be used to extend the timeout of Trx, or to implement the postgresql no-logging.

Some of that are connected to ticket [https://idempiere.atlassian.net/browse/IDEMPIERE-3969 IDEMPIERE-3969]

=== Call csv import in smaller parts ===

Thomas did a bash script that split a very long CSV file into parts calling a web-service to import every part in a single transaction.

=== CSV import button vs. CSV process button ===

CSV Import Button is slow. (That is the button that is in every window). It uses the UI thread. So it blocks the UI. It emulates to use the actual shown user interface.

The CSV process button (that has to be configured for specific tasks) uses an dedicated process and emulates just a smaller kind of a window (it also uses callouts). It runs much more performant.

=== Dedicated server for background processes ===

Norberts idea is that it should be possible in an environment with multiple application servers to send a background process to a configurable dedicated service server.

An advanced idea is to make it possible to send a job to an external system working e.g. with [https://aws.amazon.com/de/lambda/ AWS lambda].

We talked about improving the discovery strategy (schedulers). How to implement server groups and how to find out which servers are working or when to even start new server instances. For example EC2-tags, server variables, server name, etc.

[https://idempiere.atlassian.net/browse/IDEMPIERE-4090 IDEMPIERE-4090 start background processes on a dedicated service server]

== TMS Transportation Management System ==

A meeting will be coordinated in future. [[Transportation Management System]]

== User Experience ==

We talked about:
* a staging/experimental/prototype server
** Hiep already has an experimental server from an experimental branch. It helped to do complicated topics that needed several functions and ticketsan

Norbert showed us a list of User Eperience changes he likes to have. We started a discussion about how to work on these items perhaps with a working group or so.

ONe idea was to open a kind of special branch for new user experience functionalities and use jenkins to automatically create a test server for that. A test server might be very helpful especially for User Experience issues because people that are interested in that are not developers and may like to see and use the new things.

== Attract developers and implementors ==

We talked about doing more trainings. That is what Diego proposed in the conference. We do not all like the idea to have a certificate for that.

Carlos had the thought that teachers are a good point to see new students and see their abilities. In our community Chuck is the one to see new worthful developers. We may improve things to attract these.

There can be different views of the project and its parts. At the end we have the same thougts be we need to find a better way to view the structure of the project (and also on code) that is not centric to one center (or even one center).

== User Experience Focus Group ==

We like to build a user experience user group.

== Other user Experience topics ==

* Guidelines about window layouts
* Multi-Dashboard - the layout of home windows is outdated

== Accesibility ==

Alain expresses the importance of accessibility for people with disabilities in the UI, in countries such as France there are laws of ´inclusive-society´, therefore the software being used in companies need to be compliant with these laws easing the user experience for people with visual disabilities for example.

The focus of this work can also include mobile and high resolution displays.

== Alternatives for zk ==

* Evolving REST could lead to a client-side client
* Evolving REST is strategic

== Distribution / shipment process ==

Chuck expained that the workflow of shipment is quite simple. And he thinks to change or extend the way it works for complex cases. He want some intermediate place for inventory entries to go. Carlso says that is part of warehouse management but it does not work well in core.

* shipment vs move + shipment
* stock monitor
* move confirmation

It was talked about a way to move items from a warehouse locator (that keeps big palettes) to a picking locator (that keeps single opened packages) to a packing locator (where items are prepared for shipping). Only the packing locator can be shipped. We thought how items can be moved from one locator to the other. That can be done based on replenishment or orders or we even have to create a custom version of them.

Chuck advised that it should be possible to change the generate shipments process to work with different locators. Some things have to be done with replenishment.

* it must be a replenishment algorithm that takes into acount the date needed
* To support complex cases we need an allocation inventory document and a storage allocated view/table

== DMS ==

Deepak explained how he implemented his DMS system.

We were interested how he implemented the storage provider. He still did not implement an CMIS interface.

If you like to access the files as a filesystem you can use the filesystem storage provider and access it as a direct filesystem.

== How to display kiosk screens ==

* REST will make it easy to implement outside applications to do that

Thomas likes to have a way to use one single http call to
* login as a dedicated user
* opening a dedicated window
* in a borderless view
* that refreshes after a set timeout
* it can even be good to open more than one window and let the view cycle through them

* ZK_SESSION_TIMEOUT_IN_SECONDS has to work not globally but on a single user (kiosk user without timeout)
* we can use dashboards to collect data in one window
** Norbert explained that dashboard layout may be improved
* integration with external kiosk tools - via sending HTML or screenshots periodically
* /kiosk like idempiereMonitor -> dedicated to show the required info
* could use the cookie information to login -> problem - how to relogin in a server crash
* Carlso says there is an extension to refresh chrome every minute. As that creates a session every x minutes we should better have autorefresh windows

What already works:
* if you close the borders (left, right and at the top) for a single user, this is persisted
* you can automatic open a window when you login using menu favourites (you set a sequence there)
* one can refresh a chrome tab in some ways

What does not work
* automatic passwordless login
** Deepak already uses authentication login in web services
** using cookies does not work on a server crash
* no menu for the kiosk user
* automatic refresh e.g. for normal data windows, reports, etc.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4094 IDEMPIERE-4094 kiosk mode screens]

== Column reference type for json/jsonb ==

Norbert thinks about adding JSON and/or JSONB field types. He says that allows to work as in a nosql database. There is a datatype for JSON objects in PostgreSQL.

Carlos proposed to change ASI to a JSON field.

We could maybe link JSON fields to attribute definiton.

== Machine learning ==

Chuck talked about machine learning.

== Open item management on fact_acct ==

Anton has problems to bring the balance of accounting together with the balancing of open items and reconcile everything. Especially using different currencys.

== Customer and vendor accounting ==

There was a question from the audience how the difference in accounting for customers and vendors work.

There are accounting tabs for both of them in the business partner window. The preset for these can be set in the business partner group - that is copied when you create a new business partner. There is a button in the group to copy a changed group setting to all business partners that belong to this group.

== Charge on requisition ==

Deepak has done that and will open this code soon.

== Documentation - who is doing what ==

* Chuck advice: much of the documentation is in the code
* Manual from compiere is not available any more in the internet
* we have ADempiere books
* There is a compiere book
* There is documentation from Red1
* We have our wiki
* There is a book from Michael McKay at http://adempiere.gitbook.io
* Jan Thielemann did a lot of documentations in the wiki and in a video
An example for a implementor specific documentation using docbook is (in portuguese language):
* http://docs.devcoffee.com.br

Chuck showed us what his Open Source ERP Academy offers and gave us an overview.

We talked about that someone wants to write a book. See e.g. http://erp-fundamentals.chuckboecking.com/basics/ that Chuck did using markdown and [https://gohugo.io hugo].

Chuck likes to write the book. It will be open and on his website but it should also be able to be printed. Everyone will be free to translate it to other languages.

== Foreign context ==

* Document
* Think how to standardize - take into account backward compatibility.

== Tab context for processes ==

Anton opened this topic. When a process is launched by a button it can not access the state of the ui. To e.g. work on a range of all records in a window we need to know what is the actual window where the process has called from. It would help to include a tab identification (context variable id?) in the context.

The bug that Anton had should be solved now and it is possible to get the context of the right tab.

Chuck did a nice documentation about that and sent it to Carlos by mail. Someone has to copy that to our wiki. Please. ;-)

IDempiere workshop 2019

2019-11-20T01:12:46Z

Red1: /* multiple choice represantation in database */

The workshop at the 2019 conference started without a fixed agenda. This page is used for a transcript of what we did there.

= JIRA tickets =

You can find all JIRA tickets we created or touched here:

[https://idempiere.atlassian.net/issues/?jql=labels%20%3D%20%22ChateauChapeau2019%22 JIRA label ChateauChapeau2019]

= suggestions for topics =

Some people question for things that we can discuss.

* Workflows (Frank)

* DMS Solution by Deepak

* Norbert is interested in REST
** (Sergey, Norbert, Deepak, Carlos)
** -> responsive UI, integration with other frameworks
** authentication
** Client side development
** Heng Sin implementation of REST

* Client side callouts
* User Experience (zk)
** Accessibility
* How to display kiosk screens/data visualisation (Anton)
* Ask for input callouts
* Multi selection fields
* Process callouts
* Styles on info window
* Editable info window
* Combobox auto-filter
* Alternatives for zk

* Modularization - decoupling (Carlos)
** Distros
** identify functionalities that are core vs plugin
* Plugin Marketplace (Thomas)
** Best practices
** Validation - certification

* How to collect business features (Norbert)
** CMS
** costing recalculation

* Documentation
** who is doing what

* DB Transaction management - for long trx (Chuck)
* Distribution (Chuck)
** Shipment vs Move+Shipment
** Stock monitor
** move confirmation
* Charges and Products (Chuck)
** Charge on requisition
** Using product as charge
* product dependency on price list (Chuck)
* machine learning (Chuck)
* Selective data Replication (Chuck)
* User export of data in large quantities
* Oracle to postgres migration

* Asset - core has some fundamental things wrong (Anton)
** Dependency between asset and product
** asset maintenance
** asset must be an dimension on fact_acct
** fixed assets vs asset management
** Asset Tracking (Deepak)
* more free configurable dimensions in fact_acct (Anton)
* BP Accounting
** customer vs vendor accounting
* currency rate by document or transaction
* open item management at fact_acct (Anton)

* BI
-> primefaces app for BI

* Tab context (Anton)
* Tab ID and SubTab ID in context
* "go to line" in detail tabs
* foreign context
* Multi-Row Process button (that is already done, but quite new)
** pagination problem
* User Preference to see inactive records
** other user preferences
* Open window with a predefined search
* share saved searches - share tab customization... other user preferences
** saved search accessible from toolbar button
** relative search
** multiple tab customization - accessible from toolbar button, shareable
* User preference formulas (Murilo)

* Bulk changes

* JSON and JSON-Blobl field type (Norbert)
** nosql

* Oracle vs PostgreSQL - trend of postgres only features (CHuck)

* Form development - best practices (Chuck)

* Development environment management (Murilo)
** projects, developers, tools (sonar), plugins

* Simple production (Anton implemented this and has some improvements)

* Aggregated fact_acct ??

* Average costing

= first day =

== oracle to postgres migration (and other database migration issues) ==

Carlos used this tool for a long time http://www.adempiere.com/Migration/DDLUtils and it worked very well. For very big databases it does not work. It seems to load everything into memory. He then tried [http://ora2pg.darold.net/start.html Ora2Pg] but there seems to be no documentation about using this with iDempiere.

Also an interesting tool to copy databases is:

* https://wiki.idempiere.org/en/NF6.2_Copy_Client

You can use this tool to read from Oracle and write to PostgreSQL.

This process help to migrate tenants. It does not copy system data. That means you have to be prepared before and have 2packs for system customizations.

If you use that process everything is validated well even if you copy only parts of the database. It can preserve IDs or create new ones. Look at the wikipage and the screenshots there to get an overview.

https://wiki.idempiere.org/en/NF6.2_Migrate_ID can help if you get problems with IDs that are already in the database.

Both processes do not (yet) work with multiple selection fields.

== Oracle vs PostgreSQL ==

Carlos would always choose Postgres for new installations. Sometimes user companies want Oracle for several reasons - mostly historical reasons.

Chuck asked if we like to change that the internal sql language of iDempiere is Oracle. Carlos does not like to change that. Oracle is still an important market.

Carlos says that PostgreSQL has become very effients in optimizing complicated queries. He advises to use the analyze command before these kind of queries.

== PostgreSQL optimization ==

Chuck advises [http://pgbadger.darold.net/ pgbadger] to analyze database queries. It analyses the logs of postgresql and gives hints about wrong or slow or a lot used queries. Norbert uses it and has good experiences using it.

Norbert uses https://explain.depesz.com/ to better understand the "explain analyse" command of postgresql. We had a look at this page and it does a nice job and it has also good documentation about how optimizing postgresql works.

== PostgreSQL Replication ==

iDempiere has some functions about Replication:

* https://wiki.idempiere.org/en/Manual#Replication_Data

Chuck also told us that you can use "foreign data wrappers" (fdw) of PostgreSQL to connect databases. You can use a VPN to connect far away databases and e.g. create a materialized view from an foreign table and so you have an effient way to work with the foreign data and extract records that you need.

== Virtual UI columns (Murilo) ==

Murilo showed the new functionality of virtual ui columns.

Thomas advised to add the possiblility of "virtual search columns" to have virtual columns to search with an sql formula. Perhaps we can even use that for reports. Carlos liked the idea.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4087 IDEMPIERE-4087]

== Ask for Input improvements (Murilo) ==

Murilo showed us how to use the Input windows. We have improved functionality of https://wiki.idempiere.org/en/NF2.1_Ask_Input_Within_Process

In [https://idempiere.atlassian.net/browse/IDEMPIERE-3969 IDEMPIERE-3969] you can find that. Murilo did some example Process and Callout code for that and showed us.

== Special Forms (Murilo) ==

Murilo talked about "special forms" that are included in the core. The special form can use user selected data (choosen from an infowindow) to do something useful.

We talked about how to make the creation of forms more easy. It was thought to do a form modelled in the application dictionary but that is not really possible. A besser solution is to create ready made components that we can use in our java code to fasten the creation of forms.

Carlos had the idea to create a form definition in the application dictionary that consists of ad_field entries. That makes the fields configurable. He does not likes to use ad_tab for that because it needs to create ad_table and ad_column for every form. But it even may be possible to create a view for every form. Then we got the idea to use the InfoWindow structure for that. It gives us a directory of fields connected to system elements.

It is worthful to avoid forms because they are special work. And even if we think about using another ui library than zk in the future then the forms will be a huge lot of work to reimplement one by one.

A lot of form tasks may also be solved in an infowindow.

The goal should be to have a more generic way to create forms using a common standard way by using common components.

=== embedded snippets ===

Norbert said we can improve the rest interface and create the form in javascript on the client. But that is a very different approach. It may be we talk more about that when we discuss the rest interface. Carlos summarized this as: "Allowing non-zk forms by using rest access." Norbert said "Embedded Snipped".

=== client side callouts ===

Deepak talked about the possibility that Java code can inject JavaScript code into the ui elements to create client side callouts. It may be interesting to use that in very special circumstances.
The idea is: Having Java Script callouts in the dictionary that can be attached to fields on browser side.

== Multi selection field ==

Murilo showed us a good extension that they use about multi selection fields. But after seeing the new functionality in core that Heng Sin did he likes that more. We had a deeper look at it. You can create fields with "multi selection table" and "multi selection search".

That field allows us to use multiple records in search parameters.

== community communication / messenger ==

We asked ourselves how we can improve the communication of the community. We asked if IRC is still the best tool for a fast communication. One other way can be to use a Telegram group. Norbert likes slack but we are not sure if it is free. One advantage to e.g. Telegram is that it supports threads. Diego proposed [https://gitter.im/ gitter] ([https://en.wikipedia.org/wiki/Gitter Gitter at Wikipedia]). It is similar than slack.

Hideaki sometimes does an summarize of jira tickets and wiki changes. Carlos likes the idea but someone has to do that manually or moderated.

We also think about guidelines to create jira tickets to not create too much noise at jira.

== multiple choice representation in database ==

Deepak suggested to use the array data type and not comma separated string values for the multiple choice fields. He suspects that this can give us referential integrity. Paul says that it does not. We should review that.

== guidelines ==

Thomas wants to have guidelines e.g. for plugins. That allows to know about and judge guidelines. It will also improve documentation.

[[Plugin Guidelines]]

= second day =

== product dependency on price list ==

We want no dependency on pricelists. (Chuck) We can have a flag at the product to make a pricelist that have prices mandatory or not. Norbert proposed his own solution where in the document type there is a flag to make the product price mandatory. Thomas said that he uses a plugin for conditions & calculations that creates prices without using a price list. This plugin should not be broken when we change things.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4086 IDEMPIERE-4086 product dependency on price list]

== more free configurable dimensions in fact_acct ==

Anton asked for that. There are reasons to have dimensions for warehouse, charge, asset, locator

(Chuck opened a ticket before about this) TODO: add chucks ticket

Carlos thinks that it can be worth to add more columns as User1 and User2. Two of them might be not enough.

== currency rate by document or transaction ==

There is a patch from Trek Global that uses a spot currency rate type (e.g. "manual") that allows to enter a currency rate for every single document.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4083 IDEMPIERE-4083]

== user preferences to see inactive records (and even more) ==

Thomas and Nicolas proposed to have it possible to not show inactive records in the search. There are different ways to do that.

* We can do a default search value.
* Another way is to create a special SQL where filter in the tab definition.
* As Carlos mentioned the SQL filter can use environment variables. That allows to use user preferences to switch this kind of filter on and off (because they also are in the environment).

Thomas liked also to have preferences to switch fields on or off or make it read-only or so. As the user preferences are in the environment you are able to configure different levels of information or read/write using a system preference.

Carlos advised us to revisit the proposal from Nicolas to see if we can include a useful way in the search window to implement that. [https://idempiere.atlassian.net/browse/IDEMPIERE-733 IDEMPIERE-733 Show only active records by default when opening a window]

Thomas did a proof of concept of a solution to this problem and it worked well. He used user preferences in a WHERE CLAUSE of a tab. He dosumented it in IDEMPIERE-733. We can think about adding that to the standard configuration in core.

== Open window with a predefined search ==

Chuck advised to be able to save searches and use them in the toolbar buttons.

Thomas said that we want to share searches to all users or to a specific role. Chuck said we can have a default search (perhaps configured in system) for a window (up to now it is configured by table).

An additional idea: We want to have relative formulas in the searches (to do things like "last month").

Instead (or additional to) the virtual search columns we can have sql code in a relative formula. For that we can use a flag for superuser to use sql in the search definition. Then the field "validation code" can contain "@SQL=".

Norbert proposed that already in the last workshop and Diego added tickets at this time:

* [https://idempiere.atlassian.net/browse/IDEMPIERE-2837 IDEMPIERE-2837 use in a better way saved searches]
* [https://idempiere.atlassian.net/browse/IDEMPIERE-2836 IDEMPIERE-2836 sql searches for advanced users]
* [https://idempiere.atlassian.net/browse/IDEMPIERE-2835 IDEMPIERE-2835 Allow relative searchs]

Someone should review these tickets and optionally open new tickets or add description based on what we spoke about today.

== dynamic validation in search ==

Paul complained that opening a search window with dynamic vaildation fields that can be very slow because all the validations load when the search opens.

Murilo said that this is nearly solved but some small issues have to be solved.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-3981 IDEMPIERE-3981]

== search in the toolbar ==

We like to have preconfigured searches in the toolbar. We can add these as a submenu to the search button or as a combobox. The combobox also shows the actual search's name in the ui. (Norbert showed us his implementation)

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4085 IDEMPIERE-4085]

== improve toolbar ==

Norbert showed us his toolbar. It looked good. He has icons and text buttons and you have only some buttons shown at the left and a "more" drop down menu at the very right.

The audience agreed that Norberts toolbar is nice and we should open a ticket to add his changes.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4084 IDEMPIERE-4084]

== transportation management system ==

Norbert showed an example of its transportation management.

They use shipping region tabel and a shipping slot.

Evan and Ben also use a sophisticated transportation management in their "big dog erp". Thomas also has an implementation of that.

We liked to talk about that later in a smaller circle of an "[[Transportation Management System]] workgroup".

== workflows ==

Frank was interested in subworkflows. They are not implemented yet in iDempiere. We talked about several features of workflows.

We have no real workflows in iDempiere. There are just basic capabilities beyond the simple document workflow.

== REST ==

Sergey showed us what state the REST implementations have. There is an implementation from Heng Sin and one from Sergey.

Heng Sin created authentification services, services to get window definitions and data object of PO objects. His code is very generic.

It seems that you can replace the ui using that. HEng Sin is not here to explain. Carlos noted that it will not call callouts or have dynamic validation. It may also be the plan to configure a tab and fields for special needs (for a client side application) in the application dictionary and use it here in a generic way. This will not be a real window but a definition of the interface of fields to exchange with a client application that may add its own logic.

Carlos advised to have a look at http://odata.org

Someone said that we can use the JSON parser code to also include document data into pdfs (for example use this german standard https://www.ferd-net.de/zugferd/definition/was-ist-zugferd.html).

Norbert and Paul talked about [https://graphql.org GraphQL]. That can be a more modern alternative to using REST.

== Replication from Norbert ==

Norbert has an system to replicate data between iDempiere systems. You define your own Export formats, then configure one of very different export processors (export to another database but also to other things like a file or an nosql store). He uses that also to replicate to mobile clients and the like. He uses different configurable replication strategies for different use cases. For example replicating only several tables. In his usecase he uses ActiveMQ and sends JSON objects for the exchange of replicated data.

== share tab customizations ==

A superuser should be able to create a tab layout, give it a name and make it as a system or client standard or share it with a role or another user.

If a user copies it he creates an own copy and does not change the global customization.

''(not Chuck)'' Thomas had the idea to add an customization to the export window. That allows to export e.g. csv files with different columns.

We like to have several different grid customizations. Norbert says there is a ticket Hiep is working at. [https://idempiere.atlassian.net/browse/IDEMPIERE-2708 IDEMPIERE-2708]

Carlos wants to add a tab customization field to the user search query table. That allows to open a specific customization if the user ues a specific search. Thomas idea is to add an ordering for that. We can save it in the customization record.

Chuck advised that he likes to have a way to see if something is customized or not.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4088 IDEMPIERE-4088 share tab customizations]

=== bug in csv export ===

No - Chuck did not say that, it was Thomas idea. ;-) But Chuck said that virtual columns do not work in csv files.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4089 IDEMPIERE-4089]

== simple production ==

* Document type (Deepak has already code for that)
* Manufacturing setup (Anton)
* Adaxa improvements
* Multi-BOM (TrekGlobal, Chuck suggested a hack using views replacing M_ProductBOM)
* Negative BOM Line quantity (verify)
* WIP - financial and inventory move
* reservations when preparing production documents
* Production (single) vs Production (multi) - worth to consider enabling it back?

Chuck has experience with using http://frepple.com as a production planning system. One of his friends integrated this into iDempiere.

== processes working on multiple records ==

Now we have the possibility to check several records (using the checkmark at the very left of the grid view). Deepak did it. This is discussed and documented here: https://groups.google.com/forum/#!topic/idempiere/YDnr8nCFGyA

This functionality suffers of pagination. It can work only on what is shown on the current page (maximum of 25 records).

* [https://idempiere.atlassian.net/browse/IDEMPIERE-3998 IDEMPIERE-3998 Execute Toolbar Process on Multiple Records]

Thomas likes to have something that work on all records in the search query.

Thomas had the idea the create a kind of automatically loop that calls a process for every single record. That allows to use all older processes for that. But Carlos said that can cause problems because then it is not checked if the button is available or not (or even not visible) - that may be dependent on fields of the record.

== bulk changes ==

Carlos thought about bulk changes. That is to have a button that shows all fields that can be changed in all shown records. There will be big issues because we do not know if everything can be changed or will be shown. After thinking about it it seems not a good idea.

The original proposal was about deleting or completing things. That can better be done with a simple process or with the csv importer.

== aggregating accounting in fact_acct ==

Norbert proposed to have a more similar accounting. For example if we complete an invoice with several product lines we get several lines in the accounting. He likes to have only one line for all products to make it simpler for him. Especially to make the tables smaller.

Carlos shows us a link to an quite old explanation from Jörg Janke about this: https://www.compieresource.com/2007/08/financial-data-warehouse.html

What Norbert proposed is doable, not easy, and not recommended

== Assets ==

Anton has some issues with Assets. He says that you first have to create a product. Then you do a vendor invoice to buy the thing and the you can create an asset record.

Chuck explains that an asset can be created in two ways: From an product (if you buy it) or from an project (that you create yourself). The process to create it from an project does not work very well.

Some issues we found:
* dependency between asset and product
* asset maintenance
* asset must be dimension in fact_acct
* fixed assets vs asset management
* creating an asset group is not pre-filling default accounts
* Chuck suggests to "pluginize" it -> knowledge group - > Anton, Chuck, Deepak, Steven/Paul
* Improvement in core to support better Assets -> Product as a Charge that posts in material receipt and not just in Invoice (Chuck to collect and document this here: [https://idempiere.atlassian.net/browse/IDEMPIERE-4092 IDEMPIERE-4092]

There are problems if you mix the concepts of "fixed assets" and "maintenance assets". Both use the same tables but they are very different.

Chuck already talked to Steven about the charge product he suggests and tries to figure out how to improve it.

== combobox auto filter ==

There is a new field reference type to create a combobox with an auto filter facility. You use a "table direct" and you set the "Autocomplete" flag. This is done in [https://idempiere.atlassian.net/browse/IDEMPIERE-3851 IDEMPIERE-3851 Filtering list box (AP2-671 TrekGlobal)].

Thomas has problems using it because it is not very performant with big data sets.

Norbert uses https://fusejs.io to do that on client side.

Carlos had a look into our source code. It seems that it does not use the database for every keystroke but it sorts data on the server and has to resend it to the client. Something in this process is too slow.

Strategies to solve it:

* make it configurable when it searches 'ab%' vs. '%abc%'
* wait e.g. half a second before you run the query
* run the query not in the foreground but in a background thread
* see if we can cache data in the client and process it there

* we added [https://idempiere.atlassian.net/browse/IDEMPIERE-4093 IDEMPIERE-4093]

= third day =

== DB Transaction management - for long trx ==

Chuck asked how to do that. These kind of processes happen when a new user fills tables when he starts working with iDempiere but there are also users that need to import long data day by day.

Carlos says there is an hardcoded limit to have no SQL transaction longer than 2 hours.

=== improved process transaction management ===

Chucks question was if it is possible for an process source code to get the transaction handle of this transaction, commit it and create a new transaction.

Diego leaded us to Event Handlers for PRE_PROCESS & POSTPROCESS. You can find them in IEventTopics.java. They are done with [https://idempiere.atlassian.net/browse/IDEMPIERE-3924 IDEMPIERE-3924 Implement EventHandler for pre/after/post processes] The OSGi Interface IEventManager can be used.

That can be used to extend the timeout of trx, or to implement the postgresql no-logging.

Some of that can be connected with the ticket [https://idempiere.atlassian.net/browse/IDEMPIERE-3969 IDEMPIERE-3969]

=== call csv import in smaller parts ===

Thomas did a bash script that splitted a very long csv file into parts and called a webservice to import every part in a single transaction.

=== CSV import button vs. CSV process button ===

CSV Import Button is slow. (That is the button that is in every window). It uses the UI thread. So it blocks the UI. It emulates to use the actual shown user interface.

The CSV process button (that has to be configured for specific tasks) uses an dedicated process and emulates just a smaller kind of a window (it also uses callouts). It runs much more performant.

=== dedicated server for background processes ===

Norberts idea is that it should be possible in an environment with multiple application servers to send a background process to a configurable dedicated service server.

An advanced idea is to make it possible to send a job to an external system working e.g. with [https://aws.amazon.com/de/lambda/ AWS lambda].

We talked about improving the discovery strategy (schedulers). How to implement server groups and how to find out which servers are working or when to even start new server instances. For example EC2-tags, server variables, server name, etc.

[https://idempiere.atlassian.net/browse/IDEMPIERE-4090 IDEMPIERE-4090 start background processes on a dedicated service server]

== TMS Transportation Management System ==

A meeting will be coordinated in future. [[Transportation Management System]]

== User Experience ==

We talked about:
* a staging/experimental/prototype server
** Hiep already has an experimental server from an experimental branch. It helped to do complicated topics that needed several functions and ticketsan

Norbert showed us a list of User Eperience changes he likes to have. We started a discussion about how to work on these items perhaps with a working group or so.

ONe idea was to open a kind of special branch for new user experience functionalities and use jenkins to automatically create a test server for that. A test server might be very helpful especially for User Experience issues because people that are interested in that are not developers and may like to see and use the new things.

== attract developers and implementors ==

We talked about doing more trainings. That is what Diego proposed in the conference. We do not all like the idea to have a certificate for that.

Carlos had the thought that teachers are a good point to see new students and see their abilities. In our community Chuck is the one to see new worthful developers. We may improve things to attract these.

There can be different views of the project and its parts. At the end we have the same thougts be we need to find a better way to view the structure of the project (and also on code) that is not centric to one center (or even one center).

== User Experience Focus Group ==

We like to build a user experience user group.

== other user Experience topics ==

* Guidelines about window layouts
* Multi-Dashboard - the layout of home windows is outdated

== Accesibility ==

Alain expresses the importance of accesibility for people with disabilities in the UI, in countries such as France there are laws of ´inclusive-society´, therefore the software being used in companies need to be compliant with these laws easing the user experience for people with visual disabilities for example.

The focus of this work can also include mobile and high resolution displays.

== Alternatives for zk ==

* Evolving REST could lead to a client-side client
* Evolving REST is strategic

== distribution / shipment process ==

Chuck expained that the workflow of shipment is quite simple. And he thinks to change or extend the way it works for complex cases. He want some intermediate place for inventory entries to go. Carlso says that is part of warehouse management but it does not work well in core.

* shipment vs move + shipment
* stock monitor
* move confirmation

It was talked about a way to move items from a warehouse locator (that keeps big palettes) to a picking locator (that keeps single opened packages) to a packing locator (where items are prepared for shipping). Only the packing locator can be shipped. We thought how items can be moved from one locator to the other. That can be done based on replenishment or orders or we even have to create a custom version of them.

Chuck advised that it should be possible to change the generate shipments process to work with different locators. Some things have to be done with replenishment.

* it must be a replenishment algorithm that takes into acount the date needed
* To support complex cases we need an allocation inventory document and a storage allocated view/table

== DMS ==

Deepak explained how he implemented his DMS system.

We were interested how he implemented the storage provider. He still did not implement an CMIS interface.

If you like to access the files as a filesystem you can use the filesystem storage provider and access it as a direct filesystem.

== how to display kiosk screens ==

* REST will make it easy to implement outside applications to do that

Thomas likes to have a way to use one single http call to
* login as a dedicated user
* opening a dedicated window
* in a borderless view
* that refreshes after a set timeout
* it can even be good to open more than one window and let the view cycle through them

* ZK_SESSION_TIMEOUT_IN_SECONDS has to work not globally but on a single user (kiosk user without timeout)
* we can use dashboards to collect data in one window
** Norbert explained that dashboard layout may be improved
* integration with external kiosk tools - via sending HTML or screenshots periodically
* /kiosk like idempiereMonitor -> dedicated to show the required info
* could use the cookie information to login -> problem - how to relogin in a server crash
* Carlso says there is an extension to refresh chrome every minute. As that creates a session every x minutes we should better have autorefresh windows

What already works:
* if you close the borders (left, right and at the top) for a single user, this is persisted
* you can automatic open a window when you login using menu favourites (you set a sequence there)
* one can refresh a chrome tab in some ways

what does not work
* automatic passwordless login
** Deepak already uses authentication login in web services
** using cookies does not work on a server crash
* no menu for the kiosk user
* automatic refresh e.g. for normal data windows, reports, etc.

* [https://idempiere.atlassian.net/browse/IDEMPIERE-4094 IDEMPIERE-4094 kiosk mode screens]

== column reference type for json/jsonb ==

Norbert thinks about adding JSON and/or JSONB field types. He says that allows to work as in a nosql database. There is a datatype for JSON objects in PostgreSQL.

Carlos proposed to change ASI to a JSON field.

We could maybe link JSON fields to attribute definiton.

== machine learning ==

Chuck talked about machine learning.

== open item management on fact_acct ==

Anton has problems to bring the balance of accounting together with the balancing of open items and reconcile everything. Especially using different currencys.

== customer and vendor accounting ==

There was a question from the audience how the difference in accounting for customers and vendors work.

There are accounting tabs for both of them in the business partner window. The preset for these can be set in the business partner group - that is copied when you create a new business partner. There is a button in the group to copy a changed group setting to all business partners that belong to this group.

== charge on requisition ==

Deepak has done that and will open this code soon.

== Documentation - who is doing what ==

* Chuck advice: much of the documentation is in the code
* manual from compiere is not available any more in the internet
* we have ADempiere books
* there is a compiere book
* There is documentation from Redhun
* we have our wiki
* there is a book from Michael McKay at http://adempiere.gitbook.io
* Jan Thielemann did a lot of documentations in the wiki and in a video
An example for a implementor specific documentation using docbook is (in portuguese language):
* http://docs.devcoffee.com.br

Chuck showed us what his Open Source ERP Academy offers and gave us an overview.

We talked about that someone wants to write a book. See e.g. http://erp-fundamentals.chuckboecking.com/basics/ that Chuck did using markdown and [https://gohugo.io hugo].

Chuck likes to write the book. It will be open and on his website but it should also be able to be printed. Everyone will be free to translate it to other languages.

== foreign context ==

* Document
* think how to standardize - take into account backward compability

== tab context for processes ==

Anton openened this topic. When a process is launched by a button it can not access the state of the ui. To e.g. work on a range of all records in a window we need to know what is the actual window where the process has called from. It would help to include a tab identification (context variable id?) in the context.

The bug that Anton had should be solved now and it is possible to get the context of the right tab.

Chuck did a nice documentation about that and sent it to Carlos by mail. Someone has to copy that to our wiki. Please. ;-)

NF1.0 PasswordRules

2019-06-12T10:26:41Z

Red1: /* Feature: Password Rules */

= '''Feature:''' Password Rules =

'''Goal:''' Security

'''Sponsor:''' [[Sponsor:Trek_Global|Trek Global]]

'''External Credits:''' Supported on [http://code.google.com/p/vt-middleware/wiki/vtpassword vt-password] and [http://code.google.com/p/vt-middleware/wiki/vtdictionary vt-dictionary] libraries by [http://www.middleware.vt.edu Middleware Services] at [http://www.vt.edu/ Virginia Tech].

'''Description:'''

* Implementors can define now system wide password policies using the window ''Password Rule'', in this window you can configure:
** Lengths: maximum and/or minimum
** Number of Characters Required per type: Alphabetical, Digit, Uppercase, Lowercase, Non-Alphanumeric
** Length of sequences to Forbid per type: Alphabetical, Numerical, QWERTY (keyboard), Repeated characters
** Disallow using username within the password
** Disallow whitespaces within the password
** Check password against a text configurable dictionary, in this case you can also configure if the match will be checked backwards also and the minimum word length to check

* On ''Client'' just for System Client window you can configure the specific password policies that you want to apply to each client

[[Image:NF001_SEC_PasswordRules.png]]

'''Technical Info:''' [http://idempiere.atlassian.net/browse/IDEMPIERE-221 IDEMPIERE-221]

[[en:NF1.0_PasswordRules]]
[[de:NF1.0 Passwort Regeln]]
[[fr:NF1.0_Règles_du_mot_de_passe]]

[[Category:New Features|S]]
[[Category:New Features v1.0|S]]
[[Category:New Features Security]]
[[Category:Security Features]]
[[Category:User Manual]]
[[Category:Security]]
[[Category:Role]]
[[Category:User]]

Info Window Print

2019-03-12T05:34:00Z

Red1: /* install */

__FORCETOC__

* '''Maintainer:''' [[User:Hieplq|Hieplq]] ([[User talk:Hieplq|talk]])
* '''Main Copyright:''' Hieplq.
* '''Lesser Copyright:''' Hieplq
* '''Current Version:''' 1.0
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''sponsor:''' Thailand project
* '''Source:''' [https://bitbucket.org/idplugin/th.motive.idempiere.info.print th.motive.idempiere.info.print]

== Description ==
This wiki will guide you how to activate and use Print button plugin for Info-Window. [https://bitbucket.org/idplugin/th.motive.idempiere.info.print th.motive.idempiere.info.print]

== install ==
* Apply patch at [https://idempiere.atlassian.net/browse/IDEMPIERE-3784 IDEMPIERE-3784]
**This patch provides ability to turn on or off display icon of Print button
**This patch handles the click-event when button is used

*Install plugin at [https://bitbucket.org/idplugin/th.motive.idempiere.info.print th.motive.idempiere.info.print]
*This plugin utilizes services approach. So it is a lazy plugin. As it contains a 2pack you will need to start it manually the first time.

== setup (use system role) ==
* Create a report/process
[[File:Report.process.invoice.info.print.png|300px|frame|center]]

This report use a jasper to print, this jasper will receive parameter name INFO_SELECTED_KEYS, value is a collection contain all key of selected record
on main query you can use bellow code to query "WHERE $X{IN, inv.c_invoice_ID, INFO_SELECTED_KEYS}"
this step can be done by packin file [https://bitbucket.org/idplugin/th.motive.idempiere.info.print/src/default/META-INF/demoInvoceInfoProcess.zip demoInvoceInfoProcess.zip]

* Set report for info window
open info window and navigate to record "Invoice Info"
set value of new field "Process" = "Info Barcode Print"

== Use (gardenword use) ==
default idempiere open info window from View on single selection mode, you can choose other way to open on multi selection mode, for me i change code to test

* go to class DefaultInfoFactory

change InfoPanel info = create(-1, tableName, keyColumn, null, false, null, AD_InfoWindow_ID, false);
to InfoPanel info = create(-1, tableName, keyColumn, null, true, null, AD_InfoWindow_ID, false);

* open invoice info
now print button come up
do query and choose some record
click print button
jasper report is called and show you result on other tab

Info Window Print

2019-03-12T05:21:13Z

Red1: /* Description */

__FORCETOC__

* '''Maintainer:''' [[User:Hieplq|Hieplq]] ([[User talk:Hieplq|talk]])
* '''Main Copyright:''' Hieplq.
* '''Lesser Copyright:''' Hieplq
* '''Current Version:''' 1.0
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''sponsor:''' Thailand project
* '''Source:''' [https://bitbucket.org/idplugin/th.motive.idempiere.info.print th.motive.idempiere.info.print]

== Description ==
This wiki will guide you how to activate and use Print button plugin for Info-Window. [https://bitbucket.org/idplugin/th.motive.idempiere.info.print th.motive.idempiere.info.print]

== install ==
* Apply patch at [https://idempiere.atlassian.net/browse/IDEMPIERE-3784 IDEMPIERE-3784]
this patch provide ability to add plugin control status (display/invisible) of print button

this patch also provide ability to add plugin to handle event click this button

* install plugin at [https://bitbucket.org/idplugin/th.motive.idempiere.info.print th.motive.idempiere.info.print]
'''this plugin contain service to manage print button. So it's lazy plugin. but it contain 2pack so need to start it manual first time.'''

== setup (use system role) ==
* Create a report/process
[[File:Report.process.invoice.info.print.png|300px|frame|center]]

This report use a jasper to print, this jasper will receive parameter name INFO_SELECTED_KEYS, value is a collection contain all key of selected record
on main query you can use bellow code to query "WHERE $X{IN, inv.c_invoice_ID, INFO_SELECTED_KEYS}"
this step can be done by packin file [https://bitbucket.org/idplugin/th.motive.idempiere.info.print/src/default/META-INF/demoInvoceInfoProcess.zip demoInvoceInfoProcess.zip]

* Set report for info window
open info window and navigate to record "Invoice Info"
set value of new field "Process" = "Info Barcode Print"

== Use (gardenword use) ==
default idempiere open info window from View on single selection mode, you can choose other way to open on multi selection mode, for me i change code to test

* go to class DefaultInfoFactory

change InfoPanel info = create(-1, tableName, keyColumn, null, false, null, AD_InfoWindow_ID, false);
to InfoPanel info = create(-1, tableName, keyColumn, null, true, null, AD_InfoWindow_ID, false);

* open invoice info
now print button come up
do query and choose some record
click print button
jasper report is called and show you result on other tab

Building iDempiere by tycho

2018-11-16T03:31:42Z

Red1: /* Reference */

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools" and "Maven Tycho Utilities"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click '''Open Catalog'''
# On Find field, enter '''Tycho'''
# Select '''Tycho Configurator''', click '''Finish''' to install it
# Restart Eclipse and use the same dialog to install '''m2e connector for maven-dependency-plugin'''

Note: Use Help > About Eclipse IDE > Installation Details > Installed Software to find out the list of m2e Connector and Tycho plugins that you have installed.

== Steps to build and setup development environment ==
# Materialize and build (this step is needed for both headless build and setup of Eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to a folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and execute command "mvn verify" (in case you focus to setup eclipse, don't want to build product, use "mvn validate")
##* Downloads all libraries on Bundle-ClassPath
##* Build all projects and output binary to [idempiere-home]/org.idempiere.p2/target/products
# Setup Eclipse Workspace
## Import Projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose File/Import
### At Import dialog, choose Maven/Existing Maven Projects
### Click Next button and Browse to [idempiere-home]
### Select all projects, click Finish to complete the import
### All projects are loaded to workspace
## Set Target Platform
### From Eclipse Menu, choose File/Import
### At Import dialog, choose General/Existing Projects into Workspace
### Click Next button and Browse to [idempiere-home]/org.idempiere.p2.targetplatform. Click Finish to complete the import
### Open the org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target file. This is the default target platform definition with remote url
### At Target Editor, click the "Set as Active Target Platform" link
### Wait for Eclipse to download bundles onto target platform. Click the "Reload Target Platform" link if some download fail
## Say good bye to Buckminster

[[User:Hengsin|Hengsin]] ([[User talk:Hengsin|talk]]) 05:54, 20 October 2018 (UTC), org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is slow and error prone for me. I'm not sure that's the intended alternative but idempiere/org.idempiere.p2/target/repository works fine for me as Target Platform (add new empty target platform and add the idempiere/org.idempiere.p2/target/repository folder/directory to it) and without all the hassle with org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target

== Config For Jenkins ==
# Setup Maven for Jenkins
# Create a Maven Project
# In "Source Code Management" Section
#* Repository URL=ssh://hg@bitbucket.org/idempiere/idempiere-experimental (or the url of your target repository)
#* Revision=experimental (or the revision of your target repository)
# On build step, setup with value:
#* Root POM=pom.xml
#* Goals and options=verify

== How to set an OSGi Plugin as a Maven Project ==
# Create a normal plugin/feature project on eclipse
# Right click on project and choose "''Configure/Convert to Maven Project"''
# At dialog, value of "Package" type field depends on type of plug-in
#* Eclipse feature => "eclipse-feature"
#* Eclipse plugin/fragment => "eclipse-plugin"
# After eclipse has converted project, there will be a pom.xml inside project space, please adjust value as below:
#* Add parent section
<pre>
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</pre>
# Open MANIFEST.MF and continue checking..
#* At Runtime tab, section classpath has item "." if not, you should create one
# In build.properties
#* Adjust Output to "/target/classes"
#* In case your project has source, make sure it is stated: "source.. = src/"
# Reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* Core project

== Build Extra Plugin ==

=== Build by Run Script from local ===
# Build idempiere core so we have a p2 repository that contains idempiere core plus dependency at idempiere/org.idempiere.p2/target/repository
# Host this repository with a web server. If you don't have one, you can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin] to host it
# Create a maven tycho target plugin point to the p2 repository server setup at step 2
# Build extra plugin by using target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by Run Jenkins Job ===
Because you have to check out from multi repository, I prefer to use jenkins pipeline

Besides, normal pipeline plugin, you have to install "Pipeline Maven Integration Plugin"

For newbie to jenkins pipeline, I suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Steps to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, for access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# Successful build will copy artifact to /var/www/html/idempiere-core/latest
# This is pipeline for build idempiere-core
<pre>
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</pre>
# Setup other jenkins job to build extra plugin
# This's pipeline script
<pre>
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</pre>
note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository to feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) that build with command "mvn verify -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* parent pom with common configuration, for other bundle to inherit from this pom
* profiles
** Set properties for build condition, currently use to setup online and offline repository
* repositories
** Setup list of repository to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define OSGi bundles feed from maven repositories

== Known Issue ==
# Before the completion of step 2.2 (Set Target Platform), you should turn off "Project/Build Automatically". Before the setting of Active Target Platform, build will be slow and full with errors.
# Sometimes due to condition in Sourceforge, the setting of Active Target Platform ends with errors, hindering a complete clean build. Take a look bellow for tips:
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configure tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html More API to configure tycho plugin]

[http://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[http://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[http://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[http://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guide about tycho setup] (Must read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

==See Also==
[[Update_JDK]]

IDempiere light

2018-06-30T01:42:59Z

Red1:

In the [[IDempiere_Workshop_2014]] we talked about some possibilities to restrict iDempiere. There are different usecases we want to cover:

* Creating a demo with a small functional overview to not confuse new users
* fast creation of a new client with some standard functionalities
* dividing the functional areas of iDempiere into modules that can be activated during an installation

There was a discussion on irc if we begin by creating a "Tiny iDempiere" to get a system with a minimal functionality or by first defining functional areas and think how we define modules. We agreed that we have to begin somewhere and want to do it iterative.

== technical base ==

We discussed in the workshop about using ASP and/or Master Roles (using Window Customizations) for that as the technical base. This discussion did not lead to a final decision for one or the other way. Some differences are:

* Roles allow always to open a role to use the full functionality (or use the admin role to access everything). That can be a blessing or a curse...
* ASP may be a better way if we want to switch off an functionality totally (like manufacturing in a trading company).
* ASP allows to define "modules" and "levels". At the end you can give access to some of them, but only client based.

It seems that both things deal with the same issues and need a similar functional grouping. ASP is good on a low layer to let a user have

== what is missing? ==

Some things seem to be missing in the code:

JIRA tickets that are connected to this project can be found [[https://idempiere.atlassian.net/issues/?jql=labels%20%3D%20iDempiereLight with this JIRA search term]].

=== check if one of my roles allows something ===

At some points we want to limit access with a formula e.g. with a display logic like "#AD_Role = 1000001". I see two problems with this approach:
* The ID of the role can change if we load the "System Master Roles" with 2pack.
* We will create a hierarchical system of master roles. The display logic in our package will likely depend on a master role not on the given user's role

We need a way to ask "Do I have the rights of role 'blabla'". Two ideas to do that:
* create an SQL query for that that works recursive through all my roles
* allow a (master) role to set an special context variable. (This is a bit similar like the aktivation of accounting dimensions works.) A EventValidator at Login time could do that.

=== change where clause depending on role ===

It should be possible that we want some roles see only some of the records in a table. I would like to override the WHERE-clause of a table in the Windows Customizations.

While talking to a customer about "deleting things" in the database I wonder if it would be possible to create a user role that does not see any deactivated records and an admin role to see all records.

Any other ideas?!

=== deal with "crossing" of roles (dimensions of roles) ===

Lets say we have a module for a base and one for manufacturing. Now I want to use accounting. The accounting module is a third one. It opens the accounting functions of the base module. Now the question: what about the accounting of manufacturing?!? Is it a fourth module? Is it activated automatically?

And what if we want to add reporting? Do we need "base reporting", "accountant reporting", "manufacturing reporting" and "manufacturing accounting reporting"?

One of the most important crossing dimensions is "administration". MAny modules will have functions that we want to use regularly and some windows that are only needed to configure them.

wdyt?

=== Document Type Access ===

The configuration of the allowed actions for a document type can be much work. Because document types belong to the client it may be a problem to do that in System. Any ideas?

=== take back rights ===

What if a user says he wants the "accounting reports" but does not need one or two of them? Is it possible to take back a right only for one user? Or can one role take back the right that another role gives?

= Modules =

This list is only a first proposal and should work as a seed for further thinkings.

* Base
: Is there a base without an ERP? What if someone wants to use iDempiere to maintain his stamps collection in some self-created tables? Is this an abstract idea to help us finding the "inner core"?
* Base ERP User
: This allows to work with the smallest thinkable system. I see a small one-man company that wants to sell some services to some businesspartners. Accounting is not done in-house. Products can be sold but there is no inventory, warehouse, etc.
: Is it part of this base to deal with incoming invoices? Or is this another module "Purchase"?
: Is there a subrole for "Sales" too?
* Base ERP Admin
: Configuration of some minor used things like groups, categories, etc.
: Setup of things that have to be set up only once like bank account, etc.
* User Admin
: A role that is needed to deal with users, roles and security
* Open Items
* Accounting
* Inventory

=See Also=
*[http://red1.org/adempiere/viewtopic.php?f=45&t=1849 Simple Menu Tree Manager] by [[User:Red1|Red1]] ([[User talk:Red1|talk]])

[[Category: Development]]
[[Category: Community]]
[[Category: Meetings|4]]
[[Category: Meetings 2014]]

Plugin: Australian ABA Export

2018-05-25T18:53:11Z

Red1: typo

* '''Creator/Maintainter:''' [[User:PhilB|Phil Barnett]] ([[User talk:PhilB|talk]])
* '''Current Version:''' 1.0.1
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [https://bitbucket.org/fullnoize/bmidempiere BitBucket repository]
* '''Plugin:''' [https://bitbucket.org/fullnoize/bmidempiere/downloads/au.blindmot.abapaymentexport_1.0.1.201805212305.jar]

__FORCETOC__

== Description ==

__FORCETOC__

Many Australian banks use the '.ABA' file format for importing payment files, an ancient, fixed width flat file format that really should have been replaced by an XML equivalent at least a decade ago. See http://ddkonline.blogspot.com.au/2009/01/aba-bank-payment-file-format-australian.html for more info. This plugin makes use of the PaymentExport interface to allow multiple payments to be prepared in the Payment Selection Window. Then an .aba file can be created from the 'Payment Export' window, allowing multiple payments to made using the one file.

== Configuration ==

After installing the plugin:
*Go to the Business Partner window of the Business Partners you would like to pay and click on the Bank Account tab. Create a new record and add the details of the Australian bank account you'd like to pay.
*Go to the Bank / Cash window and ensure that a record exists for the Australian bank account you will be using to pay your business partners from.
*In the Payment Export Class field of the Bank / Cash window enter 'au.blindmot.ABAPaymentExport.ABAPaymentExporter'.
*In the 'Bank Account Document' tab, ensure there's an appropriate Bank Account document associated with this bank account.

== Making payments ==
*To start using the plugin, first create a Payment Selection record, ensuring that bank account records exist for both the source bank account and for the business partners being paid.
*Click the 'Prepare payment' button.
*Got to the 'Open Items' menu and select 'Payment Print / Export'.
*Search and select the record you just created in the 'Payment Selection' field.
*Ensure that the 'Payment Rule' drop down contains a valid payment rule.
*The export button in the bottom left of the window should be active. Click it to start the export.
*Once you've saved the file, close the 'Record saved' dialogue, then in the next dialogue where you're asked "Is the payment print correct ? If answered yes, then it will create and complete payments." click the OK button. Idempiere will then process the payments, allocating a payment and marking the invoices you're paying as 'Paid'.
<gallery>
File:BP_bank2018-05-21 22-13-25.png|BP bank record
File:Client bank2018-05-21 22-21-26.png|thumb|Australian BP bank details
File:Payment selection2018-05-21 22-30-27.png|Payment Selection window
File:Payment export window2018-05-21 22-31-43.png|thumb|Payment export window.
File:File exported 2018-05-21 22-31-58.png|File has been exported and saved.
</gallery>

= Improvements in recent versions =

For Version 1.0.1:
* More descriptive empty BP bank account error message.

== Feedback ==

Please rate this plugin:

{{#w4grb_rate:Plugin:_Australian ABA Export}}

<w4grb_ratinglist pagevotes idpage="Plugin:_Australian ABA Export" items="30" notitle/>

If you want to provide additional comments, please use the [[Talk:Plugin:_Australian ABA Export|Discussion page]].

[[Category:Available_Plugins]]

Building iDempiere by tycho

2018-03-23T14:10:01Z

Red1: /* How to set an OSGi Plugin as a Maven Project */

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and execute command "mvn verify"
##* It downloads all libraries on Bundle-ClassPath
##* Compiles all projects
##* Package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup Eclipse
## Import projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose File/Import
### From dialog, choose Maven/Exist maven project
### Next dialog, browse to [idempiere-home]
### Select all projects and finish dialog
### All projects are loaded to workspace
## Activate a target file
### From Eclipse Menu, choose File/Import
### From dialog, choose "Existing projects into workspace"
### Choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### Open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### From Target Editor, click to "Set as active target platform"
### Wait for Eclipse to download bundles onto target platform
## Now your environment is similar to previous Buckminster's.

== Config For Jenkins ==
# Setup Maven for Jenkins
# Create a Maven Project
# In "Source Code Management" Section
#* Repository URL=ssh://hg@bitbucket.org/idempiere/idempiere-experimental (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# On build step, setup with value:
#* Root POM=pom.xml
#* Goals and options=verify

== How to set an OSGi Plugin as a Maven Project ==
# Create a normal plugin/feature project on eclipse
# Right click to project and choose "''Configure/Convert to Maven Project"''
# In dialog, field "Package" type value depends on type of plug-in
#* Eclipse feature => "Eclipse-feature"
#* Eclipse plugin/fragment => "Eclipse-plugin"
# After eclipse has converted project, there will be a pom.xml inside project space, please adjust value as below:
#* Add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# Open MANIFEST.MF and continue checking..
#* At Runtime tab, section classpath has item "." if not, you should create one
# In build.properties
#* Adjust Output to "/target/classes"
#* In case your project has source, make sure it is stated: "source.. = src/"
# Reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* Core project

== Build Extra Plugin ==

=== Build by Run Script from local ===
# Build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# Host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# Create a maven tycho target plugin point to server setup at step 2
# Build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by Run Jenkins Job ===
Because you have to check out from multi repository, I prefer to use jenkins pipeline

Besides, normal pipeline plugin, you have to install "Pipeline Maven Integration Plugin"

For newbie to jenkins pipeline, I suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Steps to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, for access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# Successful build will copy artifact to /var/www/html/idempiere-core/latest
# This is pipeline for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Known Issue ==
# Before step 2.2.1 "On eclipse menu choose file/import", uncheck "project/automatically", because that time the Target Platform is still inactive, so build becomes slow and cannot complete.
# Sometimes due to condition in Sourceforge, the active Target Platform ends with errors, hindering a complete clean build. Take a look bellow for tips:
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configure tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html More API to configure tycho plugin]

[http://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[http://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[http://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[http://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guide about tycho setup] (Must read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T14:09:01Z

Red1: /* Config For Jenkins */

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and execute command "mvn verify"
##* It downloads all libraries on Bundle-ClassPath
##* Compiles all projects
##* Package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup Eclipse
## Import projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose File/Import
### From dialog, choose Maven/Exist maven project
### Next dialog, browse to [idempiere-home]
### Select all projects and finish dialog
### All projects are loaded to workspace
## Activate a target file
### From Eclipse Menu, choose File/Import
### From dialog, choose "Existing projects into workspace"
### Choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### Open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### From Target Editor, click to "Set as active target platform"
### Wait for Eclipse to download bundles onto target platform
## Now your environment is similar to previous Buckminster's.

== Config For Jenkins ==
# Setup Maven for Jenkins
# Create a Maven Project
# In "Source Code Management" Section
#* Repository URL=ssh://hg@bitbucket.org/idempiere/idempiere-experimental (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# On build step, setup with value:
#* Root POM=pom.xml
#* Goals and options=verify

== How to set an OSGi Plugin as a Maven Project ==
# Create a normal plugin/feature project on eclipse
# Right click to project and choose "''Configure/Convert to Maven Project"''
# In dialog, field "Package" type value depends on type of plug-in
#* Eclipse feature => "Eclipse-feature"
#* Eclipse plugin/fragment => "Eclipse-plugin"
# After eclipse has converted project, there will be a pom.xml inside project space, please adjust value as below:
#* Add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# Open MANIFEST.MF and continue checking..
#* At Runtime tab, section classpath has item "." if not, you should create one
# on build.properties
#* Adjust Output to "/target/classes"
#* In case your project has source, make sure it is stated: "source.. = src/"
# Reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* Core project

== Build Extra Plugin ==

=== Build by Run Script from local ===
# Build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# Host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# Create a maven tycho target plugin point to server setup at step 2
# Build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by Run Jenkins Job ===
Because you have to check out from multi repository, I prefer to use jenkins pipeline

Besides, normal pipeline plugin, you have to install "Pipeline Maven Integration Plugin"

For newbie to jenkins pipeline, I suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Steps to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, for access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# Successful build will copy artifact to /var/www/html/idempiere-core/latest
# This is pipeline for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Known Issue ==
# Before step 2.2.1 "On eclipse menu choose file/import", uncheck "project/automatically", because that time the Target Platform is still inactive, so build becomes slow and cannot complete.
# Sometimes due to condition in Sourceforge, the active Target Platform ends with errors, hindering a complete clean build. Take a look bellow for tips:
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configure tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html More API to configure tycho plugin]

[http://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[http://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[http://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[http://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guide about tycho setup] (Must read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T08:43:16Z

Red1: continue english edits

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and execute command "mvn verify"
##* It downloads all libraries on Bundle-ClassPath
##* Compiles all projects
##* Package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup Eclipse
## Import projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose File/Import
### From dialog, choose Maven/Exist maven project
### Next dialog, browse to [idempiere-home]
### Select all projects and finish dialog
### All projects are loaded to workspace
## Activate a target file
### From Eclipse Menu, choose File/Import
### From dialog, choose "Existing projects into workspace"
### Choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### Open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### From Target Editor, click to "Set as active target platform"
### Wait for Eclipse to download bundles onto target platform
## Now your environment is similar to previous Buckminster's.

== Config For Jenkins ==
# Setup Maven for Jenkins
# Create a Maven Project
# In "Source Code Management" Section
#* Repository URL=[[ssh://hg@bitbucket.org/idempiere/idempiere-experimental]] (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# On build step, setup with value:
#* Root POM=pom.xml
#* Goals and options=verify

== How to set an OSGi Plugin as a Maven Project ==
# Create a normal plugin/feature project on eclipse
# Right click to project and choose "''Configure/Convert to Maven Project"''
# In dialog, field "Package" type value depends on type of plug-in
#* Eclipse feature => "Eclipse-feature"
#* Eclipse plugin/fragment => "Eclipse-plugin"
# After eclipse has converted project, there will be a pom.xml inside project space, please adjust value as below:
#* Add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# Open MANIFEST.MF and continue checking..
#* At Runtime tab, section classpath has item "." if not, you should create one
# on build.properties
#* Adjust Output to "/target/classes"
#* In case your project has source, make sure it is stated: "source.. = src/"
# Reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* Core project

== Build Extra Plugin ==

=== Build by Run Script from local ===
# Build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# Host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# Create a maven tycho target plugin point to server setup at step 2
# Build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by Run Jenkins Job ===
Because you have to check out from multi repository, I prefer to use jenkins pipeline

Besides, normal pipeline plugin, you have to install "Pipeline Maven Integration Plugin"

For newbie to jenkins pipeline, I suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Steps to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, for access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# Successful build will copy artifact to /var/www/html/idempiere-core/latest
# This is pipeline for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Known Issue ==
# Before step 2.2.1 "On eclipse menu choose file/import", uncheck "project/automatically", because that time the Target Platform is still inactive, so build becomes slow and cannot complete.
# Sometimes due to condition in Sourceforge, the active Target Platform ends with errors, hindering a complete clean build. Take a look bellow for tips:
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configure tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html More API to configure tycho plugin]

[http://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[http://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[http://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[http://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guide about tycho setup] (Must read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T08:39:22Z

Red1: continue english edits

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and execute command "mvn verify"
##* It downloads all libraries on Bundle-ClassPath
##* Compiles all projects
##* Package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup Eclipse
## Import projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose File/Import
### From dialog, choose Maven/Exist maven project
### Next dialog, browse to [idempiere-home]
### Select all projects and finish dialog
### All projects are loaded to workspace
## Activate a target file
### From Eclipse Menu, choose File/Import
### From dialog, choose "Existing projects into workspace"
### Choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### Open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### From Target Editor, click to "Set as active target platform"
### Wait for Eclipse to download bundles onto target platform
## Now your environment is similar to previous Buckminster's.

== Config For Jenkins ==
# Setup Maven for Jenkins
# Create a Maven Project
# In "Source Code Management" Section
#* Repository URL=[[ssh://hg@bitbucket.org/idempiere/idempiere-experimental]] (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# On build step, setup with value:
#* Root POM=pom.xml
#* Goals and options=verify

== How to set an OSGi Plugin as a Maven Project ==
# Create a normal plugin/feature project on eclipse
# Right click to project and choose "''Configure/Convert to Maven Project"''
# In dialog, field "Package" type value depends on type of plug-in
#* Eclipse feature => "Eclipse-feature"
#* Eclipse plugin/fragment => "Eclipse-plugin"
# After eclipse has converted project, there will be a pom.xml inside project space, please adjust value as below:
#* Add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# Open MANIFEST.MF and continue checking..
#* At Runtime tab, section classpath has item "." if not, you should create one
# on build.properties
#* Adjust Output to "/target/classes"
#* In case your project has source, make sure it is stated: "source.. = src/"
# Reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* Core project

== Build Extra Plugin ==

=== Build by Run Script from local ===
# Build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# Host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# Create a maven tycho target plugin point to server setup at step 2
# Build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by Run Jenkins Job ===
Because you have to check out from multi repository, I prefer to use jenkins pipeline

Besides, normal pipeline plugin, you have to install "Pipeline Maven Integration Plugin"

For newbie to jenkins pipeline, I suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Steps to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, for access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# Successful build will copy artifact to /var/www/html/idempiere-core/latest
# This is pipeline for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Known issue ==
# Before step 2.2.1 "On eclipse menu choose file/import" uncheck "project/automatically", because that time the target platform is still inactive, so build became slow and can't complete.
# Sometimes due to sourceforge, active target platform done with errors, so can't complete build complete. Follow bellow:
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configure tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html More API to configure tycho plugin]

[http://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[http://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[http://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[http://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guide about tycho setup] (Must read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T08:17:48Z

Red1: continue english edits

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and execute command "mvn verify"
##* It downloads all libraries on Bundle-ClassPath
##* Compiles all projects
##* Package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup Eclipse
## Import projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose File/Import
### From dialog, choose Maven/Exist maven project
### Next dialog, browse to [idempiere-home]
### Select all projects and finish dialog
### All projects are loaded to workspace
## Activate a target file
### From Eclipse Menu, choose File/Import
### From dialog, choose "Existing projects into workspace"
### Choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### Open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### From Target Editor, click to "Set as active target platform"
### Wait for Eclipse to download bundles onto target platform
## Now your environment is similar to previous Buckminster's.

== Config For Jenkins ==
# Setup Maven for Jenkins
# Create a Maven Project
# In "Source Code Management" Section
#* Repository URL=[[ssh://hg@bitbucket.org/idempiere/idempiere-experimental]] (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# On build step, setup with value:
#* Root POM=pom.xml
#* Goals and options=verify

== How to set an OSGi Plugin as a Maven Project ==
# Create a normal plugin/feature project on eclipse
# Right click to project and choose "''Configure/Convert to Maven Project"''
# In dialog, field "Package" type value depends on type of plug-in
#* Eclipse feature => "Eclipse-feature"
#* Eclipse plugin/fragment => "Eclipse-plugin"
# After eclipse has converted project, there will be a pom.xml inside project space, please adjust value as below:
#* Add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# Open MANIFEST.MF and continue checking..
#* At Runtime tab, section classpath has item "." if not, you should create one
# on build.properties
#* Adjust Output to "/target/classes"
#* In case your project has source, make sure it is stated: "source.. = src/"
# Reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* Core project

== Build extra plugin ==

=== Build by run script from local ===
# build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# create a maven tycho target plugin point to server setup at step 2
# build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by run jenkins job ===
because you have to check out from multi repository, i prefer to use jenkins pipeline

beside normal pipeline plugin you have to install "Pipeline Maven Integration Plugin"

for newbie to jenkins pipeline, i suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Step to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, so access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# when success build copy artifact to /var/www/html/idempiere-core/latest
# this is pipe line for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Known issue ==
# Before step 2.2.1 "On eclipse menu choose file/import" uncheck "project/automatically", because that time the target platform is still inactive, so build became slow and can't complete.
# Sometimes due to sourceforge, active target platform done with errors, so can't complete build complete. Follow bellow:
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configure tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html More API to configure tycho plugin]

[http://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[http://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[http://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[http://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guide about tycho setup] (Must read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T08:11:20Z

Red1: continue english edits

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and execute command "mvn verify"
##* It downloads all libraries on Bundle-ClassPath
##* Compiles all projects
##* Package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup Eclipse
## Import projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose File/Import
### From dialog, choose Maven/Exist maven project
### Next dialog, browse to [idempiere-home]
### Select all projects and finish dialog
### All projects are loaded to workspace
## Activate a target file
### From Eclipse Menu, choose File/Import
### From dialog, choose "Existing projects into workspace"
### Choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### Open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### From Target Editor, click to "Set as active target platform"
### Wait for Eclipse to download bundles onto target platform
## Now your environment is similar to previous Buckminster's.

== Config For Jenkins ==
# Setup Maven for Jenkins
# Create a Maven Project
# In "Source Code Management" Section
#* Repository URL=[[ssh://hg@bitbucket.org/idempiere/idempiere-experimental]] (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# On build step, setup with value:
#* Root POM=pom.xml
#* Goals and options=verify

== Make a Osgi plugin become maven project ==
# create a normal plugin/feature project on eclipse
# right click to project and choose "''Configure/Convert to Maven Project"''
# on dialog, field "Package" type value depend on type of plug-in
#* eclipse feature => "eclipse-feature"
#* eclipse plugin/fragment => "eclipse-plugin"
# after eclipse do convert project. it add a pom.xml to project, i advice you adjust below value
#* add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# open MANIFEST.MF and make sure below thing
#* on runtime tab, section classpath have item "." if don't have one, you should create new one
# on build.properties
#* adjust output to "/target/classes"
#* in case your project have source, make sure it list on "source.. = src/"
# reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* core project

== Build extra plugin ==

=== Build by run script from local ===
# build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# create a maven tycho target plugin point to server setup at step 2
# build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by run jenkins job ===
because you have to check out from multi repository, i prefer to use jenkins pipeline

beside normal pipeline plugin you have to install "Pipeline Maven Integration Plugin"

for newbie to jenkins pipeline, i suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Step to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, so access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# when success build copy artifact to /var/www/html/idempiere-core/latest
# this is pipe line for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Known issue ==
# Before step 2.2.1 "On eclipse menu choose file/import" uncheck "project/automatically", because that time the target platform is still inactive, so build became slow and can't complete.
# Sometimes due to sourceforge, active target platform done with errors, so can't complete build complete. Follow bellow:
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configure tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html More API to configure tycho plugin]

[http://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[http://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[http://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[http://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guide about tycho setup] (Must read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T08:10:04Z

Red1: continue english edits

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and execute command "mvn verify"
##* It downloads all libraries on Bundle-ClassPath
##* Compiles all projects
##* Package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup Eclipse
## Import projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose File/Import
### From dialog, choose Maven/Exist maven project
### Next dialog, browse to [idempiere-home]
### Select all projects and finish dialog
### All projects are loaded to workspace
## Activate a target file
### From Eclipse Menu, choose File/Import
### From dialog, choose "Existing projects into workspace"
### Choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### Open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### From Target Editor, click to "Set as active target platform"
### Wait for Eclipse to download bundles onto target platform
## Now your environment is similar to previous Buckminster's.

== Config a jenkins ==
# setup maven for jenkins
# create a maven project
# on "Source Code Management" section
#* Repository URL=[[ssh://hg@bitbucket.org/idempiere/idempiere-experimental]] (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# on build step, setup below value
#* Root POM=pom.xml
#* Goals and options=verify

== Make a Osgi plugin become maven project ==
# create a normal plugin/feature project on eclipse
# right click to project and choose "''Configure/Convert to Maven Project"''
# on dialog, field "Package" type value depend on type of plug-in
#* eclipse feature => "eclipse-feature"
#* eclipse plugin/fragment => "eclipse-plugin"
# after eclipse do convert project. it add a pom.xml to project, i advice you adjust below value
#* add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# open MANIFEST.MF and make sure below thing
#* on runtime tab, section classpath have item "." if don't have one, you should create new one
# on build.properties
#* adjust output to "/target/classes"
#* in case your project have source, make sure it list on "source.. = src/"
# reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* core project

== Build extra plugin ==

=== Build by run script from local ===
# build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# create a maven tycho target plugin point to server setup at step 2
# build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by run jenkins job ===
because you have to check out from multi repository, i prefer to use jenkins pipeline

beside normal pipeline plugin you have to install "Pipeline Maven Integration Plugin"

for newbie to jenkins pipeline, i suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Step to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, so access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# when success build copy artifact to /var/www/html/idempiere-core/latest
# this is pipe line for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Known issue ==
# Before step 2.2.1 "On eclipse menu choose file/import" uncheck "project/automatically", because that time the target platform is still inactive, so build became slow and can't complete.
# Sometimes due to sourceforge, active target platform done with errors, so can't complete build complete. Follow bellow:
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configure tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html More API to configure tycho plugin]

[http://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[http://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[http://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[http://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guide about tycho setup] (Must read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T06:17:59Z

Red1: continue english edits

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and fire command "mvn verify"
##* It downloads all library on Bundle-ClassPath
##* Compiles all project
##* Package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup eclipse
## Import projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose file/import
### From dialog, choose Maven/Exist maven project
### Next dialog, browse to [idempiere-home]
### Select all projects and finish dialog
### All projects are loaded to workspace
## Activate a target file
### From Eclipse Menu, choose File/Import
### From Dialog, choose "Existing projects into workspace"
### Choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### Open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### From Target Editor, click to "Set as active target platform"
### Wait for Eclipse to download bundles onto target platform
## Now your environment is similar to Buckminster's.

== Config a jenkins ==
# setup maven for jenkins
# create a maven project
# on "Source Code Management" section
#* Repository URL=[[ssh://hg@bitbucket.org/idempiere/idempiere-experimental]] (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# on build step, setup below value
#* Root POM=pom.xml
#* Goals and options=verify

== Make a Osgi plugin become maven project ==
# create a normal plugin/feature project on eclipse
# right click to project and choose "''Configure/Convert to Maven Project"''
# on dialog, field "Package" type value depend on type of plug-in
#* eclipse feature => "eclipse-feature"
#* eclipse plugin/fragment => "eclipse-plugin"
# after eclipse do convert project. it add a pom.xml to project, i advice you adjust below value
#* add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# open MANIFEST.MF and make sure below thing
#* on runtime tab, section classpath have item "." if don't have one, you should create new one
# on build.properties
#* adjust output to "/target/classes"
#* in case your project have source, make sure it list on "source.. = src/"
# reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* core project

== Build extra plugin ==

=== Build by run script from local ===
# build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# create a maven tycho target plugin point to server setup at step 2
# build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by run jenkins job ===
because you have to check out from multi repository, i prefer to use jenkins pipeline

beside normal pipeline plugin you have to install "Pipeline Maven Integration Plugin"

for newbie to jenkins pipeline, i suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Step to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, so access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# when success build copy artifact to /var/www/html/idempiere-core/latest
# this is pipe line for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Known issue ==
# Before step 2.2.1 "On eclipse menu choose file/import" uncheck "project/automatically", because that time the target platform is still inactive, so build became slow and can't complete.
# Sometimes due to sourceforge, active target platform done with errors, so can't complete build complete. Follow bellow:
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configure tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html More API to configure tycho plugin]

[http://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[http://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[http://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[http://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guide about tycho setup] (Must read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T06:07:01Z

Red1: continue english edits

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and fire command "mvn verify"
##* It downloads all library on Bundle-ClassPath
##* Compiles all project
##* Package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup eclipse
## Import projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose file/import
### From dialog, choose Maven/Exist maven project
### Next dialog, browse to [idempiere-home]
### Select all projects and finish dialog
### All projects are loaded to workspace
## Activate a target file
### From Eclipse Menu, choose File/Import
### From Dialog, choose "Existing projects into workspace"
### Choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### Open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### From Target Editor, click to "Set as active target platform"
### Wait for Eclipse to download bundles onto target platform
## Now your environment is similar to Buckminster's.

== Config a jenkins ==
# setup maven for jenkins
# create a maven project
# on "Source Code Management" section
#* Repository URL=[[ssh://hg@bitbucket.org/idempiere/idempiere-experimental]] (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# on build step, setup below value
#* Root POM=pom.xml
#* Goals and options=verify

== Make a Osgi plugin become maven project ==
# create a normal plugin/feature project on eclipse
# right click to project and choose "''Configure/Convert to Maven Project"''
# on dialog, field "Package" type value depend on type of plug-in
#* eclipse feature => "eclipse-feature"
#* eclipse plugin/fragment => "eclipse-plugin"
# after eclipse do convert project. it add a pom.xml to project, i advice you adjust below value
#* add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# open MANIFEST.MF and make sure below thing
#* on runtime tab, section classpath have item "." if don't have one, you should create new one
# on build.properties
#* adjust output to "/target/classes"
#* in case your project have source, make sure it list on "source.. = src/"
# reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* core project

== Build extra plugin ==

=== Build by run script from local ===
# build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# create a maven tycho target plugin point to server setup at step 2
# build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by run jenkins job ===
because you have to check out from multi repository, i prefer to use jenkins pipeline

beside normal pipeline plugin you have to install "Pipeline Maven Integration Plugin"

for newbie to jenkins pipeline, i suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Step to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, so access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# when success build copy artifact to /var/www/html/idempiere-core/latest
# this is pipe line for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Known issue ==
# Before step 2.2.1 "On eclipse menu choose file/import" uncheck "project/automatically", because that time the target platform is still inactive, so build became slow and can't complete.
# Sometimes due to sourceforge, active target platform done with errors, so can't complete build complete. Follow bellow:
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configuration tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html API to configuration extra tycho plugin]

[https://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[https://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[https://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[https://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guild about tycho setup] (Have to read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T06:04:51Z

Red1: continue english edits

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## Clone source from [http://bitbucket.org/idempiere/idempiere bitbucket.org] to folder [idempiere-home]
## Open terminal, cd to [idempiere-home] and fire command "mvn verify"
##* It downloads all library on Bundle-ClassPath
##* Compiles all project
##* Package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup eclipse
## Import projects
### Open Eclipse with Workspace at [idempiere-home]
### From Eclipse Menu, choose file/import
### From dialog, choose Maven/Exist maven project
### Next dialog, browse to [idempiere-home]
### Select all projects and finish dialog
### All projects are loaded to workspace
## Activate a target file
### From Eclipse Menu, choose File/Import
### From Dialog, choose "Existing projects into workspace"
### Choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### Open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### From Target Editor, click to "Set as active target platform"
### Wait for Eclipse to download bundles onto target platform
## Now your environment is similar to Buckminster's.

== Config a jenkins ==
# setup maven for jenkins
# create a maven project
# on "Source Code Management" section
#* Repository URL=[[ssh://hg@bitbucket.org/idempiere/idempiere-experimental]] (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# on build step, setup below value
#* Root POM=pom.xml
#* Goals and options=verify

== Make a Osgi plugin become maven project ==
# create a normal plugin/feature project on eclipse
# right click to project and choose "''Configure/Convert to Maven Project"''
# on dialog, field "Package" type value depend on type of plug-in
#* eclipse feature => "eclipse-feature"
#* eclipse plugin/fragment => "eclipse-plugin"
# after eclipse do convert project. it add a pom.xml to project, i advice you adjust below value
#* add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# open MANIFEST.MF and make sure below thing
#* on runtime tab, section classpath have item "." if don't have one, you should create new one
# on build.properties
#* adjust output to "/target/classes"
#* in case your project have source, make sure it list on "source.. = src/"
# reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* core project

== Build extra plugin ==

=== Build by run script from local ===
# build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# create a maven tycho target plugin point to server setup at step 2
# build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by run jenkins job ===
because you have to check out from multi repository, i prefer to use jenkins pipeline

beside normal pipeline plugin you have to install "Pipeline Maven Integration Plugin"

for newbie to jenkins pipeline, i suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Step to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, so access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# when success build copy artifact to /var/www/html/idempiere-core/latest
# this is pipe line for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Know issue ==
# before step 2.2.1 "on eclipse menu choose file/import" un-tick "project/automatically", because that time not yet active target platform, so build make slow and can't complete.
# some time by sourceforge, active target platform done with error, so can't build complete. check like bellow
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configuration tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html API to configuration extra tycho plugin]

[https://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[https://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[https://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[https://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guild about tycho setup] (Have to read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T06:00:44Z

Red1: continuing english edits

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
# Buckminster is no longer maintained
# Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## clone source from [[Bitbucket.org/idempiere/idempiere|bitbucket.org]] to folder [idempiere-home]
## open terminal, cd to [idempiere-home] and fire command "mvn verify"
##* it download all library on Bundle-ClassPath
##* compiler all project
##* package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup eclipse
## Import projects
### open eclipse with workspace at [idempiere-home]
### on eclipse menu choose file/import
### on dialog choose Maven/Exist maven project
### next dialog browse to [idempiere-home]
### select all project and finish dialog
### all project is loaded to workspace
## Active a target file
### on eclipse menu choose file/import
### on dialog choose "existing projects into workspace"
### choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### on target editor click to "Set as active target platform"
### waiting eclipse download bundles to target platform
## now you have environment same buckminster age

== Config a jenkins ==
# setup maven for jenkins
# create a maven project
# on "Source Code Management" section
#* Repository URL=[[ssh://hg@bitbucket.org/idempiere/idempiere-experimental]] (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# on build step, setup below value
#* Root POM=pom.xml
#* Goals and options=verify

== Make a Osgi plugin become maven project ==
# create a normal plugin/feature project on eclipse
# right click to project and choose "''Configure/Convert to Maven Project"''
# on dialog, field "Package" type value depend on type of plug-in
#* eclipse feature => "eclipse-feature"
#* eclipse plugin/fragment => "eclipse-plugin"
# after eclipse do convert project. it add a pom.xml to project, i advice you adjust below value
#* add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# open MANIFEST.MF and make sure below thing
#* on runtime tab, section classpath have item "." if don't have one, you should create new one
# on build.properties
#* adjust output to "/target/classes"
#* in case your project have source, make sure it list on "source.. = src/"
# reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* core project

== Build extra plugin ==

=== Build by run script from local ===
# build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# create a maven tycho target plugin point to server setup at step 2
# build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by run jenkins job ===
because you have to check out from multi repository, i prefer to use jenkins pipeline

beside normal pipeline plugin you have to install "Pipeline Maven Integration Plugin"

for newbie to jenkins pipeline, i suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Step to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, so access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# when success build copy artifact to /var/www/html/idempiere-core/latest
# this is pipe line for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Know issue ==
# before step 2.2.1 "on eclipse menu choose file/import" un-tick "project/automatically", because that time not yet active target platform, so build make slow and can't complete.
# some time by sourceforge, active target platform done with error, so can't build complete. check like bellow
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configuration tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html API to configuration extra tycho plugin]

[https://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[https://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[https://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[https://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guild about tycho setup] (Have to read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Building iDempiere by tycho

2018-03-23T06:00:02Z

Red1: editing english

== Why move to [http://www.eclipse.org/tycho/ Maven Tycho]? ==
1. Buckminster is no longer maintained
2. Maven has huge following

More discussion at [http://idempiere.atlassian.net/browse/IDEMPIERE-3531 IDEMPIERE-3531] and [http://groups.google.com/forum/#!msg/idempiere/yBU69qw8ZDk/_ZVjwF7vBAAJ group]

== Prepare Eclipse to handle Tycho Project ==
=== Install Tycho Support ===
# Go to Eclipse Marketplace
# Search for Tycho
# Choose to install "Tycho Build Tools", "maven tycho utility"
=== Install m2e Connector ===
# Go to Window/Preferences
# Menu Maven/Discovery
# Click to open Catalog
# On find field type "Tycho"
# Choose tycho configurator and install it
# Do same for "m2e connector for the maven dependency plugin"

== Step to build and setup development environment ==
# Materialize and build (this step use for headless build also use for setup development for eclipse)
## clone source from [[Bitbucket.org/idempiere/idempiere|bitbucket.org]] to folder [idempiere-home]
## open terminal, cd to [idempiere-home] and fire command "mvn verify"
##* it download all library on Bundle-ClassPath
##* compiler all project
##* package a binary at [idempiere-home]/org.idempiere.p2/target/products
# Setup eclipse
## Import projects
### open eclipse with workspace at [idempiere-home]
### on eclipse menu choose file/import
### on dialog choose Maven/Exist maven project
### next dialog browse to [idempiere-home]
### select all project and finish dialog
### all project is loaded to workspace
## Active a target file
### on eclipse menu choose file/import
### on dialog choose "existing projects into workspace"
### choose [idempiere-home]/org.idempiere.p2.targetplatform and click finish
### open a target file org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target is default with remote url
### on target editor click to "Set as active target platform"
### waiting eclipse download bundles to target platform
## now you have environment same buckminster age

== Config a jenkins ==
# setup maven for jenkins
# create a maven project
# on "Source Code Management" section
#* Repository URL=[[ssh://hg@bitbucket.org/idempiere/idempiere-experimental]] (up to your actual repository)
#* Revision=experimental (up to your actual repository)
# on build step, setup below value
#* Root POM=pom.xml
#* Goals and options=verify

== Make a Osgi plugin become maven project ==
# create a normal plugin/feature project on eclipse
# right click to project and choose "''Configure/Convert to Maven Project"''
# on dialog, field "Package" type value depend on type of plug-in
#* eclipse feature => "eclipse-feature"
#* eclipse plugin/fragment => "eclipse-plugin"
# after eclipse do convert project. it add a pom.xml to project, i advice you adjust below value
#* add parent section
#** <syntaxhighlight lang="xml">
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>5.1.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
</syntaxhighlight>
# open MANIFEST.MF and make sure below thing
#* on runtime tab, section classpath have item "." if don't have one, you should create new one
# on build.properties
#* adjust output to "/target/classes"
#* in case your project have source, make sure it list on "source.. = src/"
# reference:
#* http://codeandme.blogspot.co.at/2012/12/tycho-build-1-building-plug-ins.html
#* core project

== Build extra plugin ==

=== Build by run script from local ===
# build idempiere core so we have a p2 repository contain all idempiere core also dependency at idempiere/org.idempiere.p2/target/repository
# host this repository to a web server. can use [https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html#jetty-start-goal jetty-maven-plugin]
# create a maven tycho target plugin point to server setup at step 2
# build extra plugin by use target at step 3
Full example and step by step guideline [https://bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle/overview here]

=== Build by run jenkins job ===
because you have to check out from multi repository, i prefer to use jenkins pipeline

beside normal pipeline plugin you have to install "Pipeline Maven Integration Plugin"

for newbie to jenkins pipeline, i suggest to use this tool to generate script http://[jenkins_server]/job/[job_name]/pipeline-syntax/
[[File:Pipeline syntax.png|none|thumb]]

==== Step to build ====
# Setup a web server (like apache httpd at port 80 on same server jenkin, so access by localhost), assume document dir at /var/www/html
# Setup a jenkins job to build idempiere core.
# when success build copy artifact to /var/www/html/idempiere-core/latest
# this is pipe line for build idempiere-core<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh "cd ${WORKSPACE}/idempiere && mvn verify"
}

sh '''p2OutputDir="${WORKSPACE}/idempiere/org.idempiere.p2/target/repository"
webDir="/var/www/html/repository/idempiere-hsv-core/latest"
mkdir -p ${webDir}
cp -r ${p2OutputDir}/* ${webDir}'''
}
stage('Results') {

}
}
</syntaxhighlight>
# Setup other jenkins job to build extra plugin
# This's pipeline script<syntaxhighlight lang="groovy">
node {
def mvnHome
stage('Preparation') { // for display purposes
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/idempiere', subdir: 'idempiere'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/idplugin/idempiere.maven.tycho.build.extra.bundle', subdir: 'idempiere.maven.tycho.build.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/project.extra.bundle', subdir: 'project.extra.bundle'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', revision: 'hsv', source: 'ssh://hg@bitbucket.org/hasuvimex/org.idempiere.customize-feature', subdir: 'project.extra.bundle/org.idempiere.customize-feature'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.idempiere.base', subdir: 'project.extra.bundle/th.motive.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasper.report.font', subdir: 'project.extra.bundle/th.motive.jasper.report.font'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.utility', subdir: 'project.extra.bundle/th.motive.utility'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.editor.currencyrate', subdir: 'project.extra.bundle/vn.hsv.editor.currencyRate'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.base', subdir: 'project.extra.bundle/vn.hsv.idempiere.base'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.idempiere.override', subdir: 'project.extra.bundle/vn.hsv.idempiere.override'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/hasuvimex/vn.hsv.jasperreport.install', subdir: 'project.extra.bundle/vn.hsv.jasperreport.install'])
checkout([$class: 'MercurialSCM', clean: true, credentialsId: 'mainSshKey', source: 'ssh://hg@bitbucket.org/idplugin/th.motive.jasperreport.configuration', subdir: 'project.extra.bundle/th.motive.jasperreport.configuration'])

}
stage('Build') {

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''
${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/update.version.sh "/var/www/html/repository/idempiere-hsv-core/latest/plugins" "org.adempiere.base_*.jar"
'''
}

sh '''newP2Url="http://localhost/repository/idempiere-hsv-core/latest"
oldP2Url=http://localhost:8080/idempiere-core
sed -ri "s|${oldP2Url}|${newP2Url}|g" ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle/org.idempiere.p2.build.extra.bundle.targetplatform/org.idempiere.p2.build.extra.bundle.targetplatform.target'''

withMaven(jdk: 'openjdk', maven: 'build-in maven', publisherStrategy: 'EXPLICIT') {
sh '''cd ${WORKSPACE}/idempiere.maven.tycho.build.extra.bundle && mvn verify -Didempiere.target="org.idempiere.p2.build.extra.bundle.targetplatform"'''
}
}
stage('Results') {

}
}
</syntaxhighlight>note: you still have to checkout idempire on this job, because some plugin refer to parent pom on idempiere

== Common command ==
* mvn verify -P online
** build idempiere with online profile (will use remote repository for feed all dependency bundle)

== Summary about tycho use on idempiere (for full [http://www.eclipse.org/tycho/sitedocs/index.html reference tycho API]) ==

=== [idempiere-root]/pom.xml ===
setup list of module (bundle) will build with command "mvn -P online"

=== [idempiere-root]/org.idempiere.parent/pom.xml ===
* is parent pom with almost configuration, other bundle will inheritance from this pom
* profiles
** Set properties for build condition, current use to setup online and offline repository
* repositories
** Setup list of repository use to resolve dependency
** with P2 repository use "<layout>p2</layout>"
* dependencies
** define Osgi bundle feed from maven repositorys

== Know issue ==
# before step 2.2.1 "on eclipse menu choose file/import" un-tick "project/automatically", because that time not yet active target platform, so build make slow and can't complete.
# some time by sourceforge, active target platform done with error, so can't build complete. check like bellow
[[File:TargetIssue.png|none|thumb]]

== Reference ==
[http://www.eclipse.org/tycho/sitedocs/index.html API to configuration tycho]

[http://www.eclipse.org/tycho/sitedocs-extras/index.html API to configuration extra tycho plugin]

[https://hudson.eclipse.org/tycho/job/tycho-sitedocs/ws/target/staging/tycho-release/tycho-versions-plugin/update-eclipse-metadata-mojo.html Sync bundle version on manifest with version on pom.xml]

[https://wiki.eclipse.org/Tycho/Packaging_Types Tycho package type]

[https://github.com/FTSRG/cheat-sheets/wiki/Maven-and-Eclipse A good summary]

[https://stackoverflow.com/questions/11373009/should-i-use-pom-first-or-manifest-first-when-developing-osgi-application-with-m Idempiere maven tycho is MANIFEST-First]

[http://codeandme.blogspot.co.at/p/tycho-articles.html A complete guild about tycho setup] (Have to read)

[http://www.lorenzobettini.it/2015/03/build-your-own-custom-eclipse/ Explain about root-ui for feature]

Note Update To 5.1

2017-12-18T02:36:56Z

Red1: English

== Note about update from experiment branch ==
* update jetty to latest
* update Equinox to latest (neon 3)
* update zk to 8.0.2.2
* update jasper report to 6.3.1 and use osgi library
* [https://idempiere.atlassian.net/browse/IDEMPIERE-3353 IDEMPIERE-3353]
* remove some warning
* org.idempiere.customize-feature become option
* [https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/idempiere/fe_Sm3cXTpQ/d2K0QmdfAgAJ Atmosphere]

== How to update launch after change plugin list [https://idempiere.atlassian.net/browse/IDEMPIERE-3353 IDEMPIERE-3353] ==
=== Why have to change ===
Normal idempiere use eclipse debug configuration to manage list of active plug-ins at development phase

On debug configuration you can use features or plugin mode to define collection active plug-ins

[[File:DebugConfigurationSelectMode.png|300px|thumb|center|DebugConfigurationSelectMode]]

Advanced of plugin mode selection is you can quick select/un-select particular plugin for test your configuration

Idempiere use server.product to manage to manage list plug-ins at product phase. it use feature mode define collection of active plugin

Feature mode help us clear group relate plugin together.

Normal we don't get any issue with this configuration.

But when you get update, special update equinox framework or jetty.

It get a set of new plugins and hard to figure out plugin to update debug configuration.

It's also hard working when you maintain a customize launching, because you have a group of customize plugin.

Eclipse maintain launching on text file and list of active plugin on a line. order of plugin is messy hard to keep track with mercurial.

Is not easy for you to sync your customize launching file with new file of idempiere

=== New process to update launching file ===
==== Change set of active plug-ins ====
1. add/remove plug-ins from it's feature

2. open server.product tab overview, click to "launch an eclipse application" or "launch an eclipse application on debug mode"
[[File:SyncLaunching.png|300px|thumb|center|SyncLaunching]]

3. dialog display to you can choose a launching for sync
[[File:ChooseLaunching.png|300px|thumb|center|ChooseLaunching]]

4. now your launching of eclipse is synchronized with your product. if it run well mean your binary also run same.

5. from now you can run your application like before (from debug/run gear) util you change profile
[[File:LaunchFromGear.png|300px|thumb|center]]

==== Change parameter ====
1. parameter also sync from product to debug configuration, so keep change from product and use "launch an eclipse application" to sync
[[File:SyncParameter.png|300px|thumb|center|SyncParameter]]

== Note ==
=== Post materialize ===
Do a restart after materialize, by limit of neon, it just recognize feature after you restart.

=== [[Add_customize_plugin_to_package_with_core|org.idempiere.customize-feature become option]] ===
1. org.idempiere.customize-feature is empty feature, purpose to add customize plugin

so i setup it become option, and delete it from core, materialize and create product still work well.

2. Now how to add customize plugin?

you have to create org.idempiere.customize-feature by yourself when you use it. if you don't have customize plugin, just ignore it.

you can add this feature to idempiere source and make a commit, but i recommend place it separate from core.

when you separate it from core, you can let idempiere auto materialize by add entry to org.adempiere.sdk-feature/materialize.properties

example

<code>
extend.bundle.folder.1=[relative path from idempiere-experimental/org.adempiere.sdk-feature to folder contain org.idempiere.customize-feature]
</code>

3. by improve of [https://idempiere.atlassian.net/browse/IDEMPIERE-3353 IDEMPIERE-3353] when you add/remove plugin on org.idempiere.customize-feature (or any feature), it auto reflex after you sync launch

=== Found two entries for component ===
1. Overview
Jenkin build 1st is successfully, but when build at 2nd it get error "has no action, group, or local artifact named bundle.jar"

{| class="wikitable mw-collapsible mw-collapsed"
! CSpec org.apache.httpcomponents.httpclient.source:osgi.bundle$4.3.6.v201511171540 has no action, group, or local artifact named bundle.jar
|-
|
org.eclipse.buckminster.core.cspec.model.MissingAttributeException: CSpec org.apache.httpcomponents.httpclient.source:osgi.bundle$4.3.6.v201511171540 has no action, group, or local artifact named bundle.jar
at org.eclipse.buckminster.core.cspec.model.CSpec.getRequiredAttribute(CSpec.java:653)
at org.eclipse.buckminster.core.cspec.model.CSpec.getReferencedAttribute(CSpec.java:624)
at org.eclipse.buckminster.core.cspec.model.Prerequisite.getReferencedAttribute(Prerequisite.java:146)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:327)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:329)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:329)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:329)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:329)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:329)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:329)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:329)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:329)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:329)
at org.eclipse.buckminster.core.internal.actor.PerformManager.addAttributeChildren(PerformManager.java:329)
at org.eclipse.buckminster.core.internal.actor.PerformManager.getOrderedActionList(PerformManager.java:414)
at org.eclipse.buckminster.core.internal.actor.PerformManager.internalPerform(PerformManager.java:435)
at org.eclipse.buckminster.core.internal.actor.PerformManager.perform(PerformManager.java:293)
at org.eclipse.buckminster.core.internal.actor.PerformManager.perform(PerformManager.java:305)
at org.eclipse.buckminster.core.commands.Perform.internalRun(Perform.java:108)
at org.eclipse.buckminster.core.commands.WorkspaceCommand.run(WorkspaceCommand.java:86)
at org.eclipse.buckminster.cmdline.AbstractCommand.basicRun(AbstractCommand.java:200)
at org.eclipse.buckminster.cmdline.Headless.run(Headless.java:343)
at org.eclipse.buckminster.cmdline.Headless.run(Headless.java:284)
at org.eclipse.buckminster.cmdline.Headless.start(Headless.java:358)
at org.eclipse.equinox.internal.app.EclipseAppHandle.run(EclipseAppHandle.java:196)
at org.eclipse.core.runtime.internal.adaptor.EclipseAppLauncher.runApplication(EclipseAppLauncher.java:134)
at org.eclipse.core.runtime.internal.adaptor.EclipseAppLauncher.start(EclipseAppLauncher.java:104)
at org.eclipse.core.runtime.adaptor.EclipseStarter.run(EclipseStarter.java:382)
at org.eclipse.core.runtime.adaptor.EclipseStarter.run(EclipseStarter.java:236)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:498)
at org.eclipse.equinox.launcher.Main.invokeFramework(Main.java:648)
at org.eclipse.equinox.launcher.Main.basicRun(Main.java:603)
at org.eclipse.equinox.launcher.Main.run(Main.java:1465)
at org.eclipse.equinox.launcher.Main.main(Main.java:1438)
CSpec org.apache.httpcomponents.httpclient.source:osgi.bundle$4.3.6.v201511171540 has no action, group, or local artifact named bundle.jar
|}

2. Reason (Just guess)
orbit repository have 2 version of org.apache.httpcomponents.httpclient

1st do materialize, buckminster get correct verison org.apache.httpcomponents.httpclient and org.apache.httpcomponents.httpclient.source at version 4.3.6

2nd do materialize at without clear old one (like on jenkin) it will get new one version of source at 4.5.2

i guest issue by wrong process resolve dependency on org.idempiere.eclipse.platform-feature
after 1st materialize, cspec of org.idempiere.eclipse.platform-feature have dependency to org.apache.httpcomponents.httpclient.source and it will get newest version.

* don't know why it don't happen to org.apache.httpcomponents.httpclient bundle just happen source bundle
* org.apache.commons.codec.source have same condition, it get two source version, but don't effect to create product process.
I guest reason because org.idempiere.eclipse.platform-feature have customize step on org.adempiere.server-feature/buckminster.cspex

{| class="wikitable mw-collapsible mw-collapsed"
! customize step on org.adempiere.server-feature/buckminster.cspex
|-
|
<alterGroups>
<public name="bundle.jars">
<attribute name="bundle.jars" component="org.idempiere.eclipse.platform"/>
<attribute name="bundle.jars" component="org.idempiere.fitnesse.fixture"/>
<attribute name="bundle.jars" component="org.idempiere.fitnesse.server"/>
<attribute name="bundle.jars" component="org.idempiere.fitnesse"/>
<attribute name="bundle.jars" component="org.idempiere.fitrecorder"/>
<attribute name="bundle.jars" component="org.idempiere.ui.zk.selenium"/>
</public>
<public name="feature.references">
<attribute name="feature.jars" component="org.idempiere.eclipse.platform"/>
<attribute name="feature.jars" component="org.idempiere.fitnesse"/>
</public>
</alterGroups>
|}

=== Break materialize process by repository host at sourceforge ===
I get success at local but try fail after a lot of try with Jenkin (i guess it host at Germany)

I guest when i upload repository to sourceforge, it will upload to Asian server, and replicate to other zone.

When i run jenkin, it isn't finish at to replicate to Euro zone, so Jenkin get fail

When i change url to http://jaist.dl.sourceforge.net/project/idempiere/binary.file it always get success.

So in case you can't materialize with error relate sourceforge get a try by do bellow step

[idempiere]/org.adempiere.sdk-feature/materialize.properties
change local.repository.root=http://downloads.sourceforge.net/project/idempiere/binary.file
to local.repository.root=http://jaist.dl.sourceforge.net/project/idempiere/binary.file

=== You also can offline sourceforge by below command ====
# offline file from sourceforge
rsync -avrPq hiepgau,idempiere@frs.sourceforge.net:/home/frs/project/idempiere/binary.file /path/to/offline/folder

# open file
[idempiere-root]/org.adempiere.sdk-feature/materialize.properties

# modify
local.repository.root=http://downloads.sourceforge.net/project/idempiere/binary.file
by
local.repository.root=file:///path/to/offline/folder

(*) change hiepgau by your account

offline all document here: http://wiki.idempiere.org/en/Offline_all_material_of_idempiere

=== Atmosphere -jetty ===
[https://idempiere.atlassian.net/browse/IDEMPIERE-3369 atmosphere websocket jetty conflict]

=== Separate zk configuration of development and runtime ===
https://bitbucket.org/idempiere/idempiere/commits/bdfb673f22d3c580e8ac8c5bb4837eefc8de3c5f

== Update environment development ==
when you update to 5.1 (or any release) you have to do the following 4 steps:

# delete folders ".metadata, targetPlatform, RemoteSystemsTempFiles, jettyhome"
# delete all jar file on [idempiere-home] and sub folder
# open eclipse and run materialize again
# run script update your db http://wiki.idempiere.org/en/Importing_DB_Seed_Manually#Applying_additional_migration_scripts

if i correct some jar file still on bitbucket, not yet take out. please check by hg.

if you see hg show any jar file is remove, just revert for that files

for 5.1 make sure you use eclipse oxygen

[[Category:HowTo-Technical]]

Plugin: WMS

2017-12-06T02:35:20Z

Red1:

* '''Maintainer:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''Copyright:''' red1, SYSNOVA
* '''Current Version:''' 1.0 BETA
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Guide:''' [http://sourceforge.net/projects/red1/files/Warehousing/WMSGuide.pdf/download Download PDF]
*'''Download Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ Click on org.red1.wms.jar]
*'''SourceCode:''' [http://bitbucket.org/red1/org.red1.wms BitBucket/red1/wms]
*'''Ninja Excel:''' [http://sourceforge.net/projects/red1/files/Warehousing/WMS_Excel.xlsx/download Data Model].

__FORCETOC__

== Description ==
*This is a fresh rewritten WMS (Warehouse Management System) version based on ideas from SAP's HandlingUnit and EmptyStorage together with expert domain advice from consultants and users.
*It is useful on its own or in conjunction with other plugins described in the forum below.
*Please follow the forum used in developing this at http://red1.org/adempiere/viewtopic.php?f=45&t=1839

== Feedback ==

If you want to provide additional comments, please use the [[Talk:Plugin:_WMS|Discussion page]].

[[Category:Available_Plugins]]

Plugin: WMS

2017-10-01T11:06:27Z

Red1: /* Description */

* '''Maintainer:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''Copyright:''' red1, SYSNOVA
* '''Current Version:''' 1.0 BETA
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Guide:''' [http://sourceforge.net/projects/red1/files/Warehousing/WMSGuide.pdf/download Download PDF]
*'''Download Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ Click on org.red1.wms.jar]
*'''SourceCode:''' [http://bitbucket.org/red1/org.red1.wms BitBucket/red1/wms]

__FORCETOC__

== Description ==
*This is a fresh rewritten WMS (Warehouse Management System) version based on ideas from SAP's HandlingUnit and EmptyStorage together with expert domain advice from consultants and users.
*It is useful on its own or in conjunction with other plugins described in the forum below.
*Please follow the forum used in developing this at http://red1.org/adempiere/viewtopic.php?f=45&t=1839

== Feedback ==

If you want to provide additional comments, please use the [[Talk:Plugin:_WMS|Discussion page]].

[[Category:Available_Plugins]]

Plugin: WMS

2017-10-01T11:04:30Z

Red1:

* '''Maintainer:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''Copyright:''' red1, SYSNOVA
* '''Current Version:''' 1.0 BETA
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Guide:''' [http://sourceforge.net/projects/red1/files/Warehousing/WMSGuide.pdf/download Download PDF]
*'''Download Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ Click on org.red1.wms.jar]
*'''SourceCode:''' [http://bitbucket.org/red1/org.red1.wms BitBucket/red1/wms]

__FORCETOC__

== Description ==
*This is a fresh rewritten WMS version based on ideas from SAP's HandlingUnit and EmptyStorage together with expert domain advice from consultants and users.
*Please follow the forum used in developing this at http://red1.org/adempiere/viewtopic.php?f=45&t=1839

== Feedback ==

If you want to provide additional comments, please use the [[Talk:Plugin:_WMS|Discussion page]].

[[Category:Available_Plugins]]

Plugin: WMS

2017-10-01T11:02:25Z

Red1: Created page with "* '''Maintainer:''' Red1 (talk) - [http://red1.org RED1.org] * '''Copyright:''' red1, SYSNOVA * '''Current Version:''' 1.0 BETA * '''License:..."

* '''Maintainer:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''Copyright:''' red1, SYSNOVA
* '''Current Version:''' 1.0 BETA
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Guide:''' [http://sourceforge.net/projects/red1/files/Warehousing/WMSGuide.pdf/download Download PDF]
*'''Download Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ org.red1.wms..]
*'''SourceCode:''' [http://bitbucket.org/red1/org.red1.wms BitBucket/red1/wms]

__FORCETOC__

== Description ==
*This is a fresh rewritten WMS version based on ideas from SAP's HandlingUnit and EmptyStorage together with expert domain advice from consultants and users.
*Please follow the forum used in developing this at http://red1.org/adempiere/viewtopic.php?f=45&t=1839

== Feedback ==

If you want to provide additional comments, please use the [[Talk:Plugin:_WMS|Discussion page]].

[[Category:Available_Plugins]]

Plugin: Vaadin Mobile

2017-09-07T03:29:05Z

Red1:

*'''Maintainer:''' [[User:Diego.ruiz|Diego Ruiz - Bx Service GmbH]]
*'''Status:''' Beta
*'''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2]
*'''Sources:''' [https://bitbucket.org/druiz/vaadinmobile]
*'''Jenkins files:''' [http://ci.idempiere.org/job/vaadinmobile/]

== Description ==
*This plugin is based on [http://wiki.idempiere.org/en/Plugin:_ADAXA_Mobile the iuiMobile client] and ZK client
*It eases the use of iDempiere in mobile devices ('''It is specially designed for phones''')

The plugin is based on both iuiMobile and ZK, it was intended to take the simplicity of iui but with the proper context and model management of ZK.

== Feedback ==

Please rate this plugin:

{{#w4grb_rate:Plugin:_Vaadin_Mobile}}

<w4grb_ratinglist pagevotes idpage="Plugin:_Vaadin_Mobile" items="30" notitle/>

If you want to provide additional comments, please use the [[Talk:Plugin:_Vaadin_Mobile|Discussion page]]

== Configuration ==
No configuration required - just install and use navigating to /m in your server

== Changing the Theme ==
The UI is designed with css, so the theme can be fully changed and customized.

To change the theme, add a folder with the name of your theme and your own css and scss files under the folder VAADIN/themes and set the SysConfig VAADIN_THEME with your theme name.

'''''Vaadin needs to compile the theme before using it, this can be done with the vaadin plugin in eclipse or via console with the following command: java -cp '$VAADIN_REPOSITORY/com.trekglobal.vaadinmobile/WEB-INF/lib/*' com.vaadin.sass.SassCompiler styles.scss styles.css'''''

== How to Install ==
=== From command line ===
update-prd.sh http://ci.idempiere.org/job/vaadinmobile/ws/buckminster.output/com.trekglobal.vaadin.update_1.0.0-eclipse.feature/site.p2/ com.trekglobal.vaadinmobile
=== From apache felix ===
Download the jar file with name
<code>com.trekglobal.vaadinmobile_4.1.0.v[timestamp].jar</code>
from this link:
http://ci.idempiere.org/job/vaadinmobile/ws/buckminster.output/com.trekglobal.vaadin.update_1.0.0-eclipse.feature/site.p2/plugins/
and install using the felix console as usual - recommended start level 6

= Known Issues =
== Limitations ==
The following features are not yet supported by vaadin client:
*Reports (Only pdf supported, in development)
*Forms (Out of scope)
*Workflows (Need review on which are worthy to implement)
*Account fields (Not supported, in development)
*PAttribute (Not supported, in development)
*Tablet UI (Need review on if this is worthy to implement)
*When a window has too many records it takes long to open the window, a way to avoid this behaviour and control the initial number of rows being displayed will be developed

== Different behaviour ==
The following features behave different than ZK
*Info windows are displayed with the identifiers columns and the records can be look only using those fields as filter
*Different field types are currently being displayed as Text fields:
**ID
**Binary
**Row ID
**Color
**Image (In development - will be supported)
**FilePath
**URL
**Printer Name
*Search and Locator field type are currently being displayed as combo boxes, this will be changed in future version
*No buttons are displayed in the single record view, all are presented in the process menu of each window (In development - will be supported)

[[Category:Available_Plugins]]

Plugin: BackOrder Management

2017-09-02T13:45:19Z

Red1:

[[File:BackOrderInitiate.png|450px|right]]
* '''Creator:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''Sponsor:''' SYSNOVA (as bonus feature of WMS).
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [http://bitbucket.org/red1/org.backorder.management BitBucket repository]
* '''Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ org.backorder.management]
* '''Forum:''' [http://red1.org/adempiere/viewtopic.php?f=45&t=1844#p8925 red1.org]
[[File:BackOrderReadiness.png|600px|right]]
__FORCETOC__
==Features==
*Knows which BackOrder is ready to Ship by looking at the 'Ready' flag.
*Knows which supply or production to chase by looking at the 'Insufficient' flag.
*Knows where the stock are located across different warehouses.
*Knows what other BackOrders are pending.
*Generate Sales Order much faster without touching core but modify cockpit plugin.
*Further processes can be added to this cockpit source using Ninja plugin.

== Motivation ==
*Management Inventory Constraints often result in back-orders that need follow up.
*Plugin gives full 360 degree visibility to commitment and inventory readiness prioritizing lines to ship.
==Usage==
*Go to Main Menu, BackOrder Management window for easy definition of Sales Order details and Generate Sales Order
*Completed but undelivered Sales Orders can be viewed in BackOrder AvailableToShip Info-Window
*Refresh to get up-to-date status
**'Ready' flag will recalculate based on available stock to fulfil order lines from the top.
**Reset LineNo back at BackOrder line tab to get sorted for priority shipment
*Generate (WMS) Shipment (pending) -- use normal iDempiere.

==Coupling With WMS==
*This is a standalone plugin not needing the WMS plugin which it was originally created for.
*When WMS plugin is installed, its WMS Picking function will turn on.

== Feedback ==
If you want to provide additional comments, please use the [[Talk:Plugin:_BackOrder_Management|Discussion page]].

[[Category:Available_Plugins]]

Plugin: BackOrder Management

2017-09-02T11:58:49Z

Red1: /* Coupling With WMS */

[[File:BackOrderInitiate.png|450px|right]]
* '''Creator:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''SPONSOR:''' SYSNOVA (as bonus feature of WMS).
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [http://bitbucket.org/red1/org.backorder.management BitBucket repository]
* '''Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ org.backorder.management]
* '''Forum:''' [http://red1.org/adempiere/viewtopic.php?f=45&t=1844#p8925 red1.org]
[[File:BackOrderReadiness.png|600px|right]]
__FORCETOC__
==Features==
*Knows which BackOrder is ready to Ship by looking at the 'Ready' flag.
*Knows which supply or production to chase by looking at the 'Insufficient' flag.
*Knows where the stock are located across different warehouses.
*Knows what other BackOrders are pending.
*Generate Sales Order much faster without touching core but modify cockpit plugin.
*Further processes can be added to this cockpit source using Ninja plugin.

== Motivation ==
*Management Inventory constraint results in back orders that needs follow up
*Plugin gives full 360 degree visibility as to its status and readiness of back order lines to ship
==Usage==
*Go to Main Menu, BackOrder Management window for easy definition of Sales Order details and Generate Sales Order
*Completed but undelivered Sales Orders can be viewed in BackOrder AvailableToShip Info-Window
*Refresh to get up-to-date status
**'Ready' flag will recalculate based on available stock to fulfil order lines from the top.
**Reset LineNo back at BackOrder line tab to get sorted for priority shipment
*Generate (WMS) Shipment (pending) -- use normal iDempiere.

==Coupling With WMS==
*This is a standalone plugin not needing the WMS plugin which it was originally created for.
*When WMS plugin is installed, its WMS Picking function will turn on.

== Feedback ==
If you want to provide additional comments, please use the [[Talk:Plugin:_BackOrder_Management|Discussion page]].

[[Category:Available_Plugins]]

Plugin: BackOrder Management

2017-09-02T11:57:51Z

Red1: /* Usage */

[[File:BackOrderInitiate.png|450px|right]]
* '''Creator:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''SPONSOR:''' SYSNOVA (as bonus feature of WMS).
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [http://bitbucket.org/red1/org.backorder.management BitBucket repository]
* '''Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ org.backorder.management]
* '''Forum:''' [http://red1.org/adempiere/viewtopic.php?f=45&t=1844#p8925 red1.org]
[[File:BackOrderReadiness.png|600px|right]]
__FORCETOC__
==Features==
*Knows which BackOrder is ready to Ship by looking at the 'Ready' flag.
*Knows which supply or production to chase by looking at the 'Insufficient' flag.
*Knows where the stock are located across different warehouses.
*Knows what other BackOrders are pending.
*Generate Sales Order much faster without touching core but modify cockpit plugin.
*Further processes can be added to this cockpit source using Ninja plugin.

== Motivation ==
*Management Inventory constraint results in back orders that needs follow up
*Plugin gives full 360 degree visibility as to its status and readiness of back order lines to ship
==Usage==
*Go to Main Menu, BackOrder Management window for easy definition of Sales Order details and Generate Sales Order
*Completed but undelivered Sales Orders can be viewed in BackOrder AvailableToShip Info-Window
*Refresh to get up-to-date status
**'Ready' flag will recalculate based on available stock to fulfil order lines from the top.
**Reset LineNo back at BackOrder line tab to get sorted for priority shipment
*Generate (WMS) Shipment (pending) -- use normal iDempiere.

==Coupling With WMS==
*This is a standalone plugin not needing the WMS plugin which it was originally created for.
*When WMS plugin is available, its WMS Picking function will turn on (pending version 2.0)

== Feedback ==
If you want to provide additional comments, please use the [[Talk:Plugin:_BackOrder_Management|Discussion page]].

[[Category:Available_Plugins]]

Plugin: BackOrder Management

2017-09-02T11:53:53Z

Red1: /* Feedback */

[[File:BackOrderInitiate.png|450px|right]]
* '''Creator:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''SPONSOR:''' SYSNOVA (as bonus feature of WMS).
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [http://bitbucket.org/red1/org.backorder.management BitBucket repository]
* '''Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ org.backorder.management]
* '''Forum:''' [http://red1.org/adempiere/viewtopic.php?f=45&t=1844#p8925 red1.org]
[[File:BackOrderReadiness.png|600px|right]]
__FORCETOC__
==Features==
*Knows which BackOrder is ready to Ship by looking at the 'Ready' flag.
*Knows which supply or production to chase by looking at the 'Insufficient' flag.
*Knows where the stock are located across different warehouses.
*Knows what other BackOrders are pending.
*Generate Sales Order much faster without touching core but modify cockpit plugin.
*Further processes can be added to this cockpit source using Ninja plugin.

== Motivation ==
*Management Inventory constraint results in back orders that needs follow up
*Plugin gives full 360 degree visibility as to its status and readiness of back order lines to ship
==Usage==
*Go to Main Menu, BackOrder Management window for easy definition of Sales Order details and Generate Sales Order
*Completed Sales Orders can be viewed in BackOrder AvailableToShip Info-Window
*Refresh to get up-to-date status
**'Ready' flag will recalculate based on available stock to fulfil order lines from the top.
**Reset LineNo back at BackOrder line tab to get sorted for priority shipment
*Generate (WMS) Shipment (pending) -- use normal iDempiere.

==Coupling With WMS==
*This is a standalone plugin not needing the WMS plugin which it was originally created for.
*When WMS plugin is available, its WMS Picking function will turn on (pending version 2.0)

== Feedback ==
If you want to provide additional comments, please use the [[Talk:Plugin:_BackOrder_Management|Discussion page]].

[[Category:Available_Plugins]]

Plugin: BackOrder Management

2017-09-02T11:29:04Z

Red1: /* Features */

[[File:BackOrderInitiate.png|450px|right]]
* '''Creator:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''SPONSOR:''' SYSNOVA (as bonus feature of WMS).
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [http://bitbucket.org/red1/org.backorder.management BitBucket repository]
* '''Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ org.backorder.management]
* '''Forum:''' [http://red1.org/adempiere/viewtopic.php?f=45&t=1844#p8925 red1.org]
[[File:BackOrderReadiness.png|600px|right]]
__FORCETOC__
==Features==
*Knows which BackOrder is ready to Ship by looking at the 'Ready' flag.
*Knows which supply or production to chase by looking at the 'Insufficient' flag.
*Knows where the stock are located across different warehouses.
*Knows what other BackOrders are pending.
*Generate Sales Order much faster without touching core but modify cockpit plugin.
*Further processes can be added to this cockpit source using Ninja plugin.

== Motivation ==
*Management Inventory constraint results in back orders that needs follow up
*Plugin gives full 360 degree visibility as to its status and readiness of back order lines to ship
==Usage==
*Go to Main Menu, BackOrder Management window for easy definition of Sales Order details and Generate Sales Order
*Completed Sales Orders can be viewed in BackOrder AvailableToShip Info-Window
*Refresh to get up-to-date status
**'Ready' flag will recalculate based on available stock to fulfil order lines from the top.
**Reset LineNo back at BackOrder line tab to get sorted for priority shipment
*Generate (WMS) Shipment (pending) -- use normal iDempiere.

==Coupling With WMS==
*This is a standalone plugin not needing the WMS plugin which it was originally created for.
*When WMS plugin is available, its WMS Picking function will turn on (pending version 2.0)

== Feedback ==

Please rate this plugin:

{{#w4grb_rate:Plugin:_BackOrder_Management}}

<w4grb_ratinglist pagevotes idpage="Plugin:_BackOrder_Management"/>

If you want to provide additional comments, please use the [[Talk:Plugin:_BackOrder_Management|Discussion page]].

Plugin: BackOrder Management

2017-09-02T11:27:13Z

Red1: /* Features */

[[File:BackOrderInitiate.png|450px|right]]
* '''Creator:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''SPONSOR:''' SYSNOVA (as bonus feature of WMS).
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [http://bitbucket.org/red1/org.backorder.management BitBucket repository]
* '''Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ org.backorder.management]
* '''Forum:''' [http://red1.org/adempiere/viewtopic.php?f=45&t=1844#p8925 red1.org]
[[File:BackOrderReadiness.png|600px|right]]
__FORCETOC__
==Features==
*Knows which BackOrder is ready to Ship by looking at the 'Ready' flag.
*Knows which supply or production to chase by looking at the 'Insufficient' flag.
*Knows where the stock are located across different warehouses.
*Generate Sales Order much faster without touching core but modify cockpit plugin.

== Motivation ==
*Management Inventory constraint results in back orders that needs follow up
*Plugin gives full 360 degree visibility as to its status and readiness of back order lines to ship
==Usage==
*Go to Main Menu, BackOrder Management window for easy definition of Sales Order details and Generate Sales Order
*Completed Sales Orders can be viewed in BackOrder AvailableToShip Info-Window
*Refresh to get up-to-date status
**'Ready' flag will recalculate based on available stock to fulfil order lines from the top.
**Reset LineNo back at BackOrder line tab to get sorted for priority shipment
*Generate (WMS) Shipment (pending) -- use normal iDempiere.

==Coupling With WMS==
*This is a standalone plugin not needing the WMS plugin which it was originally created for.
*When WMS plugin is available, its WMS Picking function will turn on (pending version 2.0)

== Feedback ==

Please rate this plugin:

{{#w4grb_rate:Plugin:_BackOrder_Management}}

<w4grb_ratinglist pagevotes idpage="Plugin:_BackOrder_Management"/>

If you want to provide additional comments, please use the [[Talk:Plugin:_BackOrder_Management|Discussion page]].

Plugin: BackOrder Management

2017-09-02T11:25:36Z

Red1:

[[File:BackOrderInitiate.png|450px|right]]
* '''Creator:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''SPONSOR:''' SYSNOVA (as bonus feature of WMS).
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [http://bitbucket.org/red1/org.backorder.management BitBucket repository]
* '''Plugin:''' [http://sourceforge.net/projects/red1/files/Warehousing/ org.backorder.management]
* '''Forum:''' [http://red1.org/adempiere/viewtopic.php?f=45&t=1844#p8925 red1.org]
[[File:BackOrderReadiness.png|600px|right]]
__FORCETOC__
==Features==
*Know which Back Order is ready to Ship by looking at the 'Ready' flag.
*Know which supply or production to chase by looking at the 'Insufficient' flag.
*Generate Sales Order much faster without touching core but modify cockpit plugin.
== Motivation ==
*Management Inventory constraint results in back orders that needs follow up
*Plugin gives full 360 degree visibility as to its status and readiness of back order lines to ship
==Usage==
*Go to Main Menu, BackOrder Management window for easy definition of Sales Order details and Generate Sales Order
*Completed Sales Orders can be viewed in BackOrder AvailableToShip Info-Window
*Refresh to get up-to-date status
**'Ready' flag will recalculate based on available stock to fulfil order lines from the top.
**Reset LineNo back at BackOrder line tab to get sorted for priority shipment
*Generate (WMS) Shipment (pending) -- use normal iDempiere.

==Coupling With WMS==
*This is a standalone plugin not needing the WMS plugin which it was originally created for.
*When WMS plugin is available, its WMS Picking function will turn on (pending version 2.0)

== Feedback ==

Please rate this plugin:

{{#w4grb_rate:Plugin:_BackOrder_Management}}

<w4grb_ratinglist pagevotes idpage="Plugin:_BackOrder_Management"/>

If you want to provide additional comments, please use the [[Talk:Plugin:_BackOrder_Management|Discussion page]].

Plugin: BackOrder Management

2017-09-02T11:24:01Z

Red1:

[[File:BackOrderInitiate.png|450px|right]]
* '''Creator:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''SPONSOR:''' SYSNOVA (as bonus feature of WMS).
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [http://bitbucket.org/red1/org.backorder.management BitBucket repository]
* '''Plugin:''' [http://sourceforge.net/projects/red1/files/Business/ org.backorder.management]
* '''Forum:''' [http://red1.org/adempiere/viewtopic.php?f=45&t=1844#p8925 red1.org]
[[File:BackOrderReadiness.png|600px|right]]
__FORCETOC__
==Features==
*Know which Back Order is ready to Ship by looking at the 'Ready' flag.
*Know which supply or production to chase by looking at the 'Insufficient' flag.
*Generate Sales Order much faster without touching core but modify cockpit plugin.
== Motivation ==
*Management Inventory constraint results in back orders that needs follow up
*Plugin gives full 360 degree visibility as to its status and readiness of back order lines to ship
==Usage==
*Go to Main Menu, BackOrder Management window for easy definition of Sales Order details and Generate Sales Order
*Completed Sales Orders can be viewed in BackOrder AvailableToShip Info-Window
*Refresh to get up-to-date status
**'Ready' flag will recalculate based on available stock to fulfil order lines from the top.
**Reset LineNo back at BackOrder line tab to get sorted for priority shipment
*Generate (WMS) Shipment (pending) -- use normal iDempiere.

==Coupling With WMS==
*This is a standalone plugin not needing the WMS plugin which it was originally created for.
*When WMS plugin is available, its WMS Picking function will turn on (pending version 2.0)

== Feedback ==

Please rate this plugin:

{{#w4grb_rate:Plugin:_BackOrder_Management}}

<w4grb_ratinglist pagevotes idpage="Plugin:_BackOrder_Management"/>

If you want to provide additional comments, please use the [[Talk:Plugin:_BackOrder_Management|Discussion page]].

Plugin: BackOrder Management

2017-09-02T11:21:57Z

Red1: /* Couopling With WMS */

[[File:BackOrderInitiate.png|500px|right]]
* '''Creator:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''SPONSOR:''' SYSNOVA
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [http://bitbucket.org/red1/org.backorder.management BitBucket repository]
* '''Plugin:''' [http://sourceforge.net/projects/red1/files/Business/ org.backorder.management]
* '''Forum:''' [http://red1.org/adempiere/viewtopic.php?f=45&t=1814 red1.org]
* '''Document:''' [http://sourceforge.net/projects/red1/files/LiberoManufacturing/BOMDrop.pdf/download Download PDF]
[[File:BackOrderReadiness.png|600px|right]]
__FORCETOC__
==Features==
*Know which Back Order is ready to Ship by looking at the 'Ready' flag.
*Know which supply or production to chase by looking at the 'Insufficient' flag.
*Generate Sales Order much faster without touching core but modify cockpit plugin.
== Motivation ==
*Management Inventory constraint results in back orders that needs follow up
*Plugin gives full 360 degree visibility as to its status and readiness of back order lines to ship
==Usage==
*Go to Main Menu, BackOrder Management window for easy definition of Sales Order details and Generate Sales Order
*Completed Sales Orders can be viewed in BackOrder AvailableToShip Info-Window
*Refresh to get up-to-date status
**'Ready' flag will recalculate based on available stock to fulfil order lines from the top.
**Reset LineNo back at BackOrder line tab to get sorted for priority shipment
*Generate (WMS) Shipment (pending) -- use normal iDempiere.

==Coupling With WMS==
*This is a standalone plugin not needing the WMS plugin which it was originally created for.
*When WMS plugin is available, its WMS Picking function will turn on (pending version 2.0)

== Feedback ==

Please rate this plugin:

{{#w4grb_rate:Plugin:_BackOrder_Management}}

<w4grb_ratinglist pagevotes idpage="Plugin:_BackOrder_Management"/>

If you want to provide additional comments, please use the [[Talk:Plugin:_BackOrder_Management|Discussion page]].

Plugin: BackOrder Management

2017-09-02T11:20:30Z

Red1: Created page with "right * '''Creator:''' Red1 (talk) - [http://red1.org RED1.org] * '''SPONSOR:''' SYSNOVA * '''License:'''..."

[[File:BackOrderInitiate.png|500px|right]]
* '''Creator:''' [[User:Red1|Red1]] ([[User talk:Red1|talk]]) - [http://red1.org RED1.org]
* '''SPONSOR:''' SYSNOVA
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2] - Free as in Freedom not Free Lunch
* '''Source:''' [http://bitbucket.org/red1/org.backorder.management BitBucket repository]
* '''Plugin:''' [http://sourceforge.net/projects/red1/files/Business/ org.backorder.management]
* '''Forum:''' [http://red1.org/adempiere/viewtopic.php?f=45&t=1814 red1.org]
* '''Document:''' [http://sourceforge.net/projects/red1/files/LiberoManufacturing/BOMDrop.pdf/download Download PDF]
[[File:BackOrderReadiness.png|600px|right]]
__FORCETOC__
==Features==
*Know which Back Order is ready to Ship by looking at the 'Ready' flag.
*Know which supply or production to chase by looking at the 'Insufficient' flag.
*Generate Sales Order much faster without touching core but modify cockpit plugin.
== Motivation ==
*Management Inventory constraint results in back orders that needs follow up
*Plugin gives full 360 degree visibility as to its status and readiness of back order lines to ship
==Usage==
*Go to Main Menu, BackOrder Management window for easy definition of Sales Order details and Generate Sales Order
*Completed Sales Orders can be viewed in BackOrder AvailableToShip Info-Window
*Refresh to get up-to-date status
**'Ready' flag will recalculate based on available stock to fulfil order lines from the top.
**Reset LineNo back at BackOrder line tab to get sorted for priority shipment
*Generate (WMS) Shipment (pending) -- use normal iDempiere.

==Couopling With WMS==
*This is a standalone plugin not needing the WMS plugin which it was originally created for.
*When WMS plugin is available, its WMS Picking function will turn on.

== Feedback ==

Please rate this plugin:

{{#w4grb_rate:Plugin:_BackOrder_Management}}

<w4grb_ratinglist pagevotes idpage="Plugin:_BackOrder_Management"/>

If you want to provide additional comments, please use the [[Talk:Plugin:_BackOrder_Management|Discussion page]].

File:BackOrderReadiness.png

2017-09-02T11:13:31Z

Red1:

File:BackOrderInitiate.png

2017-09-02T11:05:57Z

Red1:

NF2.1 InfoWindow Improvements

2017-05-12T11:29:28Z

Red1:

= '''Feature:''' InfoWindow Improvements =
'''Goal:''' Usability
To make user more comfortable with info window

'''Description:'''
'''''1. Add button reset to all infoWindow'''''
When clicked, it resets all criteria field to initial value.
* Where field has default value, it resets to default value
* Where field has a preference value it resets to preference value
* Where value of field init to a value (as "Price List Version" in produce info) it reset to this value.
* Others reset to a blank value

[[File:Infowindow_reset.png|550px]]

'''''2. Add ability define "Default Logic" value for criteria field'''''

same default logic field at standard window

[[File:Infowindow_defaultValue.png|550px]]

'''''3. Add is mandatory to criteria field'''''

*Improvement as submitted at [http://idempiere.atlassian.net/browse/IDEMPIERE-1970 IDEMPIERE-1970].
**Info-Window data not only comes from a Table, it can also come from a View.

*Improvement as submitted at [http://idempiere.atlassian.net/browse/IDEMPIERE-1334 IDEMPIERE-1334].
**You can define a process run for group record, other process run for other group record.
**So, you have to set the mandatory parameter.
**You also can define display logic for process button by value input at criteria field.
**According to the filter at the group, only the suitable process button is displayed

[[File:Infowindow_displayLogicProcess.png|550px]]

'''Technical Info:''' [http://idempiere.atlassian.net/browse/IDEMPIERE-1378 IDEMPIERE-1378], [http://idempiere.atlassian.net/browse/IDEMPIERE-1792 IDEMPIERE-1792], [http://idempiere.atlassian.net/browse/IDEMPIERE-1972 IDEMPIERE-1972], [http://idempiere.atlassian.net/browse/IDEMPIERE-1973 IDEMPIERE-1973]

[[Category:New Features|U]]
[[Category:New Features v2.1|U]]
[[Category:New Features User Experience (Usability)]]