Development Flow Configuration & Deployment HOTWAX MEDIA, INC. Apache Ofbiz Framework Quick Reference Book

Apache OFBiz Framework Quick Reference Book brought to you by: Revision 1.6.3 - ofbiz.apache.org HOTWAX MEDIA, INC. SVN rev 514251 www.hotwaxmedia.com

Development Flow Conﬁguration & Deployment Start Data Layer General Conﬁguration

Entity Group Entity Deﬁnition JNDI Servers Cache Properties entitygroup*.xml entitymodel.xml jndiservers.xml cache.properties

URL Properties Debug Properties Entity ECA url.properties debug.properties eecas*.xml

Security Logic Layer security.properties security.xml

Service Service Deﬁnition Implementation services*.xml *Services.xml, Containers & Components *Services.java, etc.

Component Load component-load.xml Containers Service ECA Service Group *containers.xml secas*.xml groups*.xml Component ofbiz-component.xml User Interface Layer

Request & View Entity & Service Config Screen Widget Definitions *Screens.xml (web only) controller.xml Entity Config entityengine.xml Service Config serviceengine.xml BeanShell Form Widget *.bsh *Forms.xml Entity Field Type fieldtype*.xml Menu Widget *Menus.xml

FreeMarker Tree Widget *.ftl *Trees.xml

This diagram represents the recommend process for development. See the last page for a diagram that shows how the artifacts refer to each other.

Copyright © 2004-2007 HOTWAX MEDIA, INC. Main Diagram page 1 page 2 Entity Definition, Group, ECA Copyright © 2004-2007 HOTWAX MEDIA, INC. Entity Definition Entity ECA Entity Group [Root Element] [Root Element] [Root Element] [0..1] <entity-group/> [0..*] <eca/> [1..*] <description/> [0..1] </entitygroup> </entity-eca> <copyright/> [0..1] <entity-group group="string [r]" <eca entity="string [r]" <author/> [0..1] entity="string [r]"/> operation="(create|store|remove|find| <version/> [0..1] create-store|create-remove| store- Start Choice [0..*] remove|create-store-remove|any) [r]" <entity/> [1] Entity Definition: View Entities event="(validate|run|return|cache- <view-entity/> [1] check|cache-put|cache-clear) [r]" End Choice [Part of Entity Definition] run-on-error="(true|false) [o]"> </entitymodel> <view-entity entity-name="string [r]" Start Choice [0..*] <title>string package-name="string [r]" [1] string dependent-on="string [o]" [1] string default-resource-name="str[o]" End Choice string never-cache="(true|false) [o]" [1..*] string auto-clear-cache="(true|false)[o]" title="s[o]" copyright="s[o]" operator="(less|greater|less-equals| Entity Definition: Entities [0..1] greater-equals|equals|not-equals|is- [1..*] empty|is-not-empty|contains) [r]" [Part of Entity Definition] [0..*] [0..*] value="string [o]" [0..*] [0..*] type="(PlainString|String|BigDecimal| table-name="string [o]" Double|Float|Long|Integer|Date|Time| package-name="string [r]" format="string [o]"/> dependent-on="string [o]" [0..1] operator="(less|greater|less-equals| no-auto-stamp="(true|false) [o]" contains) [r]" auto-clear-cache="(true|false)[o]" [0..1] to-field-name="string [o]" title="s[o]" copyright="s[o]" [0..*] type="(PlainString|String|BigDecimal| author="s[o]" version="s[o]"> Double|Float|Long|Integer|Date|Time| [0..1] Timestamp|Boolean|Object) [o]" [1..*] [0..*] [0..*] [0..*] name="str [r]" field="str [o]" col-alias="string [o]" mode="(sync|async) [r]" prim-key="string [o]" result-to-value="(true|false) [o]" group-by="(true|false) [o]"> persist="(true|false) [o]" [0..1] [0..*] [0..1] run-as-user="string [0..1:system]" [0..1] value-attr="string [o]"/> rel-entity-name="string [r]" Start Choice [0..*] Entity Group type="(one|many|one-nofk) [r]" [1] fk-name="string [o]"> [1] [based on product/entitydef/entitygroup.xml] [0..1] [1..*] End Choice xsi:noNamesp...="...dtds/entitygroup.xsd"> rel-field-name="string [o]"/> unique="(true|false) [o]"> count-distinct|upper|lower) [o]" [0..1] field="string [r]"/> entity="SomeDataWarehouseEntity" /> [1..*] rel-entity-alias="string [r]" rel-optional="(true|false) [o]"> [0..1] [0..*] [1..*] Entity ECA [0..*] [0..*] [from product/entitydef/eecas.xml] mode="sync" value-attr="productInstance"/> operation="create-store" event="return"> mode="sync"/> operation="create-store-remove" event="return"> service="updateInventoryItemFromDetail" mode="sync"/> Copyright © 2004-2007 HOTWAX MEDIA, INC. Service Definition, Group, ECA page 3

Service Deﬁnition Service Group [from ofbiz/applications/product/servicedef/services.xml] [Root Element] [1..*] xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/services.xsd"> Product Component Services OFBiz 1.0 send-mode="(none|all|first-available| random|round-robin) [o]"> [1..*] mode="(sync|async) [o]" preserve="(optional|preserve) [o]"/> Service Group xsi:noNam...="...dtds/service-group.xsd"> mode="sync" result-to-context="true"/> page 4 simple-methods 1 of 4 Copyright © 2004-2007 HOTWAX MEDIA, INC.

simple-method: General Operations simple-method: Call Operations simple-method [Root Element] [Part of simple-method] [Part of simple-method] [1..*] method-name="string [r]" short-description="string [r]" login-required="(true|false) [o]" use-transaction="(true|false) [o]" default-error-code="str [0..1:error]" [Used when method default-success-code="[0..1:success]" called as a Control Servlet Event] parameter-map-name="[0..1:parameter]" event-request-object-name="string [0..1:request]" event-response-object-name="string [0..1:response]" simple-method: Entity Operations event-response-code-name="string [0..1:_response_code_]" [Part of simple-method] event-error-message-name="string [Used when method [0..1:_error_message_]" called as an OFBiz Service] event-event-message-name="string [0..1:_event_message_]" service-response-message-name="string [0..1:responseMessage]" service-error-message-name="string [0..1:errorMessage]" See Shared service-error-message-list- See Shared name="string [0..1:errorMessageList]" See Shared service-error-message-map- name="string [0..1:errorMessageMap]" See Shared service-success-message-name="string See Shared [0..1:successMessage]" service-success-message-list- simple-method: Control Operations name="str [0..1:successMessageList]" locale-name="string [0..1:locale]" [Part of simple-method] delegator-name="str [0..1:delegator]" security-name="str [0..1:security]" dispatcher-name="s [0..1:dispatcher]" user-login-name="s [0..1:userLogin]"> Start Group: AllOperations [0..*] Start Choice [1] [1] [1] [1] [1] [1] [1] [1] [1] [1] [1] [1] [1] [1] End Choice simple-method example End Group: AllOperations [Example CrUD methods from framework/example/script/org/ofbiz/example/ExampleServices.xml] type="string [o]"/> ... property="str [o]"/> property="str [o]"/> property="str [o]"/> property="str [o]"/> property="str [o]"/> ... property="str [o]"/> property="str [o]"/> property="str [r]"/> ... Copyright © 2004-2007 HOTWAX MEDIA, INC. simple-methods 2 of 4 page 5

simple-method: If Operations 1 of 2 simple-method: If Operations 2 of 2 simple-method: Control Operations

[Part of simple-method] [Part of simple-method] [Part of simple-method] map-name="s[o]" field-name="s[r]" entry-name="string [r]" method="string [r]" list-name="string [r]"> class="s [0..1:org.ofbiz.base.util.UtilValidate]"> Group: AllOperations [0..*] [1] [1] Group: AllOperations [0..*] [0..*] [0..1] [0..1] key-name="string [r]" [1] class="string [r]"> Group: AllOperations [0..*] [1] Group: AllOperations [0..*] End Choice [0..1] count="str [r]" field="str [r]"> value="string [r]" format="string [o]" error-code="string [0..1:error]" [1] [1] operator="(less|greater|less-equals| error-list-name="s[0..1:error_list]"> greater-equals|equals|not-equals| [0..1] contains) [r]" [0..1] Group: AllOperations [0..*] type="(PlainString|String|BigDecimal| [0..1] Double|Float|Long|Integer|Date|Time| [0..1] Timestamp|Boolean|Object) [o]"> Start Group: IfConditions [1..*] Group: AllOperations [0..*] [0..1] error-list-name="s[0..1:error_list]"> [1] Start Choice [1] [1] [1] End Choice map-name="s[o]" field-name="s[r]" [1] End Group: IfConditions to-map-name="string [o]" End Choice to-field-name="string [o]" format="string [o]" greater-equals|equals|not-equals| contains) [r]" Group: IfConditions [1..*] type="(PlainString|String|BigDecimal| If & Service Example Double|Float|Long|Integer|Date|Time| Timestamp|Boolean|Object) [o]"> [from applications/product/script/org/ofbiz/ Group: IfConditions [1] Start Group: AllOperations [0..*] shipment/shipment/ShipmentServices.xml] [0..1] title="string [o]" error-list-name="s[0..1:error_list]"> map-name="s[o]" field-name="s[r]" Group: IfConditions [1..*] expr="string [r]"> Group: AllOperations [0..*] [0..1] "parameters.estimatedShipDate"/> permission="string [r]" map-name="s[o]" field-name="s[r]"> operator="not-equals" to-field- name="lkdUpVal.estimatedShipDate"/> [0..1] Group: AllOperations [0..*] [0..*] [0..1] Start Choice [1] [1] [1] map-name="s[o]" field-name="s[r]"> map-name="parameters"/> End Choice Group: AllOperations [0..*] [0..1] name="parameters.originFacilityId" operator="not-equals" to-field- name="lkdUpVal.originFacilityId"/> party-id-env-name="string [o]"/> permission="string [r]" action="string [o]"> action="string [o]"/> Group: AllOperations [0..*] [0..1] value-name="estShipWe" auto-field-map="false"> map-name="string [o]" env-name="lkdUpVal.estimatedShipWorkEffId"/> Start Choice [0..1] [1] [1] from-field= End Choice "parameters.estimatedShipDate"/> Control Snippets Example service-name="updateWorkEffort" to-map-name="estShipWeUpdMap"/> service-name="updateWorkEffort" in-map-name="estShipWeUpdMap"/> page 6 simple-methods 3 of 4 Copyright © 2004-2007 HOTWAX MEDIA, INC.

simple-method: General Operations simple-method: Call Operations simple-method: Call Service Ops

[Part of simple-method] [Part of simple-method] [Part of simple-method] default-value="string [o]" out-map-name="string [r]" service-name="string [r]" Double|Float|Long|Integer|Date|Time| [0..1] in-map-name="string [o]" Timestamp|Boolean|Object) [o]" include-user-login="(true | false) set-if-null="(true|false) [o]" set-if-empty="(true|false) [o]"/> resource="string [o]" service-name="string [r]" map-name="s[o]" field-name="s[r]" xml-resource="string [o]" include-user-login="(true|false) [o]" break-on-error="(true|false) [o]" list-name="string [r]" obj-field-name="string [r]" success-code="string [0..1:success]"> [0..1] map-name="string [r]" method-name="string [r]" [0..1] to-map-name="string [o]"/> ret-field-name="string [o]" [0..1] [0..1] map-name="s[o]" field-name="s[r]" Start Choice [0..*] [0..1] string="string [r]" [1] [1] [0..1] arg-list-name="string [o]" End Choice [0..1] prefix="string [o]" Start Choice [0..*] suffix="string [o]"/> [1] [1] string="str [r]" list-name="str [r]" method-name="string [r]" [1] arg-list-name="string [o]" ret-field-name="string [o]" [1] message-field-name="string [o]"/> ret-map-name="string [o]"> [1] [1] [1] format="string [o]" End Choice numeric-padding="string [o]"/> class-name="string [r]" field-name="str [o]"/> request-name="str [o]"/> list-name="string [r]"/> Start Choice [0..*] [1] [1] session-name="str [o]"/> End Choice service-result-name="string [o]"/>

[Part of simple-method] message="string [o]"> [1] [1] request-name="string [o]"/> map-name="s[o]" field-name="s[r]" session-name="string [o]"/> env-name="string [r]"/> default="string [o]" or in RPN: "a=+(b,/(*(+(c,x,2),-d),e))" --> resource="s[r]" property="s[r]" map-name="s[o]" field-name="s[r]" EventOperations default="string [o]" request-name="string [r]" no-locale="(true | false) [o]" list-name="string [o]"/> arg-list-name="string [o]"/> value-name="string [r]"/> default="string [o]" field-name="d"/> map-name="s[o]" field-name="s[r]" | Integer | BigDecimal) [o]" resource="str [r]" property="str [r]" decimal-format="string [o]"> default="string [o]" Start Choice [0..*] field-name="string [r]" [1] [1] session-name="string [o]"/> End Choice map-name="s[o]" field-name="s[r]" multiply|divide|negative) [r]" map-name="s[o]" field-name="s[r]"> Start Choice [0..*] [1] [1] End Choice Copyright © 2004-2007 HOTWAX MEDIA, INC. simple-methods 4 of 4 page 7

simple-method: Entity Find Ops simple-method: Entity Misc Ops Simple Map Processor [Part of simple-method] [Part of simple-method] [Root Element] [1..*] EntityFindOperations EntityMiscOperations entity-name="string [o]" sequence-name="string [r]" name="string [r]"> delegator-name="string [o]"/> [0..*] [0..*] entity-name="string [r]" seq-field-name="string [r]" map-name="string [r]" numeric-padding="string [0..1:5]" order-by-list-name="string [o]" increment-by="string [0..1:1]"/> Start Choice [0..*] delegator-name="string [o]" [1] [1] use-cache="(true | false) [o]" location="string [r]" [1] use-iterator="(true | false) [o]" delegator-name="string [o]" End Choice list-name="string [r]"/> timeout="integer [0..1:-1]" entity-name="string [r]" mode="(assert | load) [o]"/> count-name="string [r]"> began-transaction-name="string string Start Choice [1] [0..1:beganTransaction]"/> [1] [1] began-transaction-name="string [1] End Choice [0..1:beganTransaction]"/> [1] [1] [0..1] [1] [1] EntityTxOperations [1] [1] order-by-list-name="string [r]"/> EntityFindOperations Start Choice [1] list-name="[r]" to-list-name="[o]" simple-method: Entity Change Ops [1] [1] map-name="string [o]"/> End Choice EntityFindOperations greater-equals|equals|not-equals| thru-field-name="str [0..1:thruDate]" value-name="string [r]" type="(PlainString|String|BigDecimal| new-value-name="string [r]"/> Double|Float|Long|Integer|Date|Time| Entity Misc Operations Example value-name="string [r]" Start Choice [1] do-cache-clear="(true|false)[o]"/> [1] [1] entity-name="ShipmentItem"/> do-cache-clear="(true|false)[o]"/> field="str [r]" format="str [o]" value-name="string [r]" operator="(less|greater|less-equals| value-name="newEntity"/> greater-equals|equals|not-equals| do-cache-clear="(true|false)[o]"/> Double|Float|Long|Integer|Date|Time| seq-field-name="shipmentItemSeqId"/> value-name="string [r]" [1] [1] field-name="newEntity.shipmentItemSeqId" do-cache-clear="(true|false)[o]"/> result-name="shipmentItemSeqId"/> End Choice entity-name="string [r]" do-cache-clear="(true|false)[o]"/> [1] [1] End Choice EntityValueOperations env-name="newEntity.shipmentId"/> map-name="string [o]"/> Start Choice [1] [1] [1] field-name="newEntity.shipmentId"/> EntityValueOperations/> End Choice value-name="string [r]" set-if-null="(true | false) [o]"/> set-if-null="(true | false) [o]"/> replace="(true | false) [o]" do-cache-clear="(true|false)[o]"/> Start Choice [1] [1] [1] list-name="string [r]" End Choice do-cache-clear="(true|false)[o]"/> page 8 Request & View Deﬁnition Copyright © 2004-2007 HOTWAX MEDIA, INC. Request & View Request & View Example

[Root Element] [from ofbiz/applications/product/webapp/catalog/WEB-INF/controller.xml] [0..1] [0..1] xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/site-conf.xsd"> [1] Catalog Module Site Configuration File The Open For Business Project (c) 2001-2004 [1..*] /error/error.jsp [0..1] [0..1] [0..1] [1..*] [1..*] string string string type="(view | request) [o]" class="string [r]"/> [0..*] [0..*] [0..*] Verify a user is logged in. [0..*] edit="(true | false) [o]"> [0..1] [0..1] [0..1] [1..*] auth="(true|false) [o]" direct-request="(true|false) [o]" external-view="(true|false) [o]"/> path="str[o]" invoke="str[o]"/> type="(none | view | request | request-redirect | url) [r]" value="string [o]"/> page="s[o]" type="s[0..1:default]" info="str[o]" encoding="str[o]" content-type="string [o]"> [0..1] Copyright © 2004-2007 HOTWAX MEDIA, INC. Screen Widget page 9

Screen Widget Screen Widget: Visual Widgets Screen Widget: Include Widgets

[Root Element] [Part of Screen Widget] [Part of Screen Widget] [1..*] id="str [o]" style="str [o]"> name="string [r]" [0..*] location="string [o]"> name="string [r]"> [1..*]

[1] src="string [o]" id="str [o]" name="string [o]"> height="str [o]" border="s [o]" [0..*] See Shared [0..1] url-mode="(ofbiz|content|raw)[o]"/> See Shared [0..1] [1] text="string [o]" id="str [o]" AllWidgets [0..1] style="string [o]"/> name="string [r]"/>

text="string [o]" id="str [o]" name="string [r]" [0..*] style="str [o]" target="s [o]" location="string [r]" name="str [o]" prefix="str [o]" share-scope="(true | false) [o]"/> target-window="string [o]" [0..*] url-mode="(intra-app | inter-app | name="string [r]" content | plain) [o]" location="string [r]"/> full-path="(true | false) [o]" secure="(true | false) [o]" name="string [r]" encode="(true | false) [o]"> location="string [o]" [0..1] share-scope="(true | false) [o]"/>

content-id="string [r]" location="string [r]" edit-request="string [o]" share-scope="(true | false) [o]"/> edit-container-style="string [0..1:editWrapper]" entry-name="string [r]" xml-escape="(true | false) [o]"/> list-name="string [r]"

content-id="s [r]" map-key="s [r]" view-size="string [o]" edit-request="string [o]" paginate-target="string [o]" edit-container-style="string paginate="(true | false) [o]"> [0..1:editWrapper]"

[0..*] xml-escape="(true | false) [o]"/>

Screen Widget: Platform Speciﬁc Screen Widget Example

[Part of Screen Widget] [from ofbiz/applications/product/widget/catalog/ProductScreens.xml] [0..1]

[0..1] End Choice

[0..*]

location="string [r]"/>

location="string [r]"> ${uiLabelMap.${labelTitleProperty}} ${product.internalName} [${productId}]

[1..*]

text="[${uiLabelMap.ProductProductPage}]" style="buttontext"/> [0..*]

${uiLabelMap.ProductCatalogViewPermissionError}

...

[Root Element] [from ofbiz/applications/product/webapp/catalog/product/ProductForms.xml]

[1..*] xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/widget-form.xsd"> upload) [r]" target="string [o]" target-window="string [o]" target-type="(intra-app | inter-app | content | plain) [o]" title="string [o]" tooltip="string [o]" list-name="string [o]" list-entry-name="string [o]" default-map-name="string [o]" default-entity-name="str [o]" default-service-name="str [o]" default-title-area-style="str [o]" default-widget-area-style="str[o]" default-title-style="str [o]" default-widget-style="str [o]" default-tooltip-style="str[o]" default-required-field-style="string [o]" form-title-area-style="str [o]" form-widget-area-style="str [o]" paginate="(true|false) [o]" paginate-target-anchor="str [o]" paginate-size-field="str [o]"

paginate-next-label="str [o]" paginate-previous-style="str [o]"

item-index-separator="str [0..1:_o_]" extends="string [o]" separate-columns="(true|false) [o]" row-count="string [o]" use-row-submit="(true|false) [o]" skip-start="(true|false) [o]" hide-header="(true|false) [o]" header-row-style="string [o]" default-table-style="string [o]"> See Shared [0..1] widget-style="standardSubmit">

[0..*]

[0..*] [0..*] description="[${uiLabelMap.CommonDelete}]" also-hidden="false"/> [0..1]

target="string [o]"/>

[0..*]

Form Widget: Fields Form Widget: Field Types 2 of 2 Form Widget: Field Sub-elements [Part of Form Widget] [Part of Form Widget] [Part of Form Widget] allow-empty="(true|false) [o]" name="string [r]" current="(first-in-list|selected) operator="(less|greater|less-equals | [o]" greater-equals|equals|not-equals|in| no-current-selected-key="s[o]" between|like) [o]" current-description="str [o]"> ignore-if-null="(true|false) [o]" Start Choice [0..*] ignore-if-empty="(true|false) [o]" [1] env-name="string [o]" [1] value="string [o]"/> description="string [r]" size="posInteger [0..1:25]" filter-by-date="(true|false|by-name) maxlength="posInteger [o]" [o]"> default-value="string [o]"> [0..*] [0..1] [0..*] <hidden value="string [o]"/> <entity-order-by <text-find/> <hyperlink used in AllFields field-name="string [r]"/> </AllFields> also-hidden="(true | false) [o]" <list-options <field target-type="(intra-app | inter-app | list-name="string [r]" name="string [r]" content | plain) [o]" list-entry-name="string [o]" map-name="string [o]" target="string [r]" key-name="string [r]" entity-name="string [o]" description="string [o]" description="string [o]"/> field-name="string [o]" target-window="string [o]"/> <option service-name="string [o]" <ignored used in AllFields/> key="string [r]" attribute-name="string [o]" <image used in AllFields description="string [o]"/> entry-name="string [o]" border="nonNegInteger [0..1:0]" <sub-hyperlink parameter-name="string [o]" width="positiveInteger [o]" use-when="string [o]" title="string [o]" height="positiveInteger [o]" link-style="string [o]" header-link="string [o]" value="string [o]" target-type="(intra-app | inter-app | header-link-style="string [o]" default-value="string [o]"> content | plain) [o]" tooltip="string [o]" <sub-hyperlink/> [0..1] target="string [r]" title-area-style="string [o]" </image> description="string [o]" widget-area-style="string [o]" <lookup used in AllFields target-window="string [o]"/> title-style="string [o]" target-form-name="string [r]" widget-style="string [o]" size="posInteger [0..1:25]" tooltip-style="string [o]" maxlength="posInteger [o]" position="posInteger [0..1:1]" default-value="string [o]"> red-when="(never | before-now | <sub-hyperlink/> [0..1] after-now | by-name) [o]" </lookup> use-when="string [o]" <password used in AllFields event="string [o]" size="posInteger [0..1:25]" action="string [o]" maxlength="posInteger [o]" id-name="string [o]" default-value="string [o]"> separate-column="(true|false) [o]" <sub-hyperlink/> [0..1] required-field="(true|false) [o]" </password> required-field-style="string [o]" <radio used in AllFields <AllFields/> [0..1] no-current-selected-key="[o]"> </field> Start Choice [0..*] <entity-options/> [1] <list-options/> [1] <option/> [1] Form Widget: Field Types 1 of 2 End Choice [Part of Form Widget] </radio> <check used in AllFields/> <range-find used in AllFields <date-find used in AllFields size="positiveInteger [0..1:25]" type="(timestamp|date|time) [o]" maxlength="positiveInteger [o]" default-value="string [o]"/> default-value="string [o]"> <date-time used in AllFields <sub-hyperlink/> [0..1] type="(timestamp|date|time) [o]" </range-find> default-value="string [o]"/> <reset used in AllFields/> <display used in AllFields <submit used in AllFields also-hidden="(true|false) [o]" button-type="(button | text-link | description="string [o]" image) [o]" type="(text|currency) [o]" image-location="string [o]"/> currency="string [o]"/> <text used in AllFields <display-entity used in AllFields size="posInteger [0..1:25]" entity-name="string [r]" maxlength="posInteger [o]" key-field-name="string [o]" default-value="string [o]"> description="str[0..1:${description}]" <sub-hyperlink/> [0..1] also-hidden="(true|false) [o]" </text> cache="(true|false) [o]"> <textarea used in AllFields <sub-hyperlink/> [0..1] cols="positiveInteger [0..1:60]" </display-entity> rows="positiveInteger [0..1:3]" default-value="string [o]"/> <text-find used in AllFields size="posInteger [0..1:25]" maxlength="posInteger [o]" default-value="string [o]"> <sub-hyperlink/> [0..1] </text-find> page 12 Menu & Tree Widgets Copyright © 2004-2007 HOTWAX MEDIA, INC.</p><p>Menu Widget Tree Widget Tree Widget: Node</p><p><menus> [Root Element] <trees> [Root Element] <node name="string [r]" <menu/> [1..*] <tree/> [1..*] wrap-style="string [o]" </menus> </trees> render-style="(simple | follow-trail <menu <tree name="string [r]" | show-peers | expand-collapse)[o]" name="string [r]" root-node-name="string [r]" entry-name="string [o]" type="(simple | cascade) [o]" default-render-style="(simple | entity-name="string [o]" title="string [o]" follow-trail | show-peers | expand- join-field-name="string [o]"> tooltip="string [o]" collapse) [o]" <condition/> See Shared [0..1] default-entity-name="string [o]" default-wrap-style="string [o]" Start Choice [0..1] default-title-style="string expand-collapse-request="str [o]" <entity-one/> See Shared [1] [0..1:tabButton]" trail-name="string [o]" <service/> See Shared [1] default-widget-style="string [o]" open-depth="string [0..1:0]" End Choice default-tooltip-style="string [o]" post-trail-open-depth="str [0..1:0]" Start Choice [0..1] default-selected-style="str force-child-check="(true|false)[o]" <include-screen/> [1] [0..1:tabButtonSelected]" entity-name="string [o]"> <label/> [1] orientation="(vertical | horizontal) <node/> [1..*] <link/> See Shared [1] [o]" </tree> End Choice extends="string [o]" <include-screen name="string [r]" <sub-node/> [0..*] extends-resource="string [o]" location="string [r]" </node> default-menu-item-name="str [o]" share-scope="(true | false) [o]"/> <sub-node node-name="string [r]"> default-associated-content-id="string <label text="string [o]" Start Choice [1] [o]" id="str [o]" style="str [o]"/> <entity-and/> See Shared [1] default-hide-if-selected="(true | <entity-condition/> See Shared [1] false) [o]" <service/> See Shared [1] menu-width="string [o]" End Choice default-cell-width="string [o]" <out-field-map/> [0..*] default-disabled-title-style="string </sub-node> [o]" selected-menuitem-context-field- Menu Widget Example name="string [0..1:currentMenuItemName]" menu-container-style="string [from ofbiz/applications/content/webapp/content/content/ContentMenus.xml] [0..1:tabContainer]"> <menus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" default-align="(right | left) [o]" xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/widget-menu.xsd"> fill-style="string [o]" <menu name="content" type="simple" title="" default-title-style="tabButton" default-permission-operation="string default-widget-style="tabButton" default-tooltip-style="tabletext" [o]" default-selected-style="tabButtonSelected" default-menu-item-name="content" default-permission-entity- orientation="horizontal" menu-width="100%" default-permission-operation="HAS_AUTHOR_ROLE|CONTENT_ADMIN" action="string [o]" default-permission-entity-action="_ADMIN" <actions/> See Shared [0..1] default-associated-content-id="${userLogin.userLoginId}" <menu-item/> [0..*] selected-menuitem-context-field-name="currentMenuItemName"> </menu> <menu-item name="FindContent" title="Find"> <menu-item <link target="FindContent"/> name="str [r]" title="str [o]" </menu-item> tooltip="string [o]" <menu-item name="EditContent" title="Content"> <condition><not><if-empty field-name="contentId"/></not></condition> title-style="string [o]" <link target="EditContent?contentId=${contentId}"/> widget-style="string [o]" </menu-item> align-style="string [o]" <menu-item name="AddContent" title="Content"> tooltip-style="string [o]" <condition><if-empty field-name="contentId"/></condition> selected-style="string [o]" <link target="AddContent"/> position="string [0..1:1]" </menu-item> associated-content-id="string [o]" <menu-item name="contentassoc" title="Association"> <condition disabled-style="buttontextdisabled"> hide-if-selected="string [o]" <not><if-empty field-name="contentId"/></not> cell-width="string [o]" </condition> disable-if-empty="string [o]" <link target="EditContentAssoc?contentId=${contentId}"/> disabled-title-style="string [o]" </menu-item> target-window="string [o]" </menu> sub-menu="string [o]"> </menus> default-align="(right | left) [o]" <condition/> See Shared [0..1] <actions/> See Shared [0..1] Tree Widget Example <link/> See Shared [0..1] <menu-item/> [0..*] [from ofbiz/applications/accounting/widget/AccountingTrees.xml] </menu-item> <trees xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/widget-tree.xsd"> <condition [Exception from Shared] <tree name="GlAccountTree" entity-name="GlAccount" root-node-name="node-root" pass-style="string [o]" render-style="expand-collapse" default-wrap-style="accountItem"> disabled-style="string [o]"> <node name="node-root"> <AllConditionals/> [1] <sub-node node-name="node-body"> </condition> <entity-and entity-name="GlAccount"> <AllActions> [Exception from Shared] <field-map field-name="parentGlAccountId" env-name="NA"/> <property-map/> </entity-and> </sub-node> <property-to-field/> </node> <script/> <node name="node-body" wrap-style="treewrapper"> <set/> <link style="treeitem" </AllActions> target="GlAccountNavigate?glAccountId=${glAccountId}&trail=${currentNodeTrailPiped}" text="${glAccountId} ${accountName} ${postedBalance}"/> <sub-node node-name="node-body"> <entity-and entity-name="GlAccount"> <field-map field-name="parentGlAccountId" env-name="glAccountId"/> </entity-and> </sub-node> </node> </tree> </trees> Copyright © 2004-2007 HOTWAX MEDIA, INC. Shared Elements page 13 Conditions Actions - General Actions - Entity</p><p><AllConditionals> <AllActions> <entity-and used in AllActions <and/> <xor/> <or/> <not/> <get-related-one/> entity-name="string [r]" <if-has-permission/> <get-related/> use-cache="(true | false) [o]" <if-entity-permission/> <property-map/> filter-by-date="(true|false|by-name) <if-validate-method/> <property-to-field/> [o]" <if-compare/> <if-compare-field/> <script/> result-set-type="(forward|scroll) <if-regexp/> <if-empty/> <service/> [o]" </AllConditionals> <set/> list-name="string [r]"> <condition> <entity-and/> <field-map/> [1..*] <AllConditionals/> [1] <entity-condition/> <select-field/>[0..*]<order-by/>[0..*] </condition> <entity-one/> Start Choice [0..1] <and used in AllConditionals> </AllActions> <limit-range/> [1] <limit-view/> [1] <AllConditionals/> [1..*] <actions> <use-iterator/> [1] </and> <AllActions/> [0..*] End Choice <xor used in AllConditionals> </actions> </entity-and> <AllConditionals/> [1..*] <get-related-one used in AllActions <entity-condition used in AllActions </xor> value-name="string [r]" entity-name="string [r]" <or used in AllConditionals> relation-name="string [r]" use-cache="(true | false) [o]" <AllConditionals/> [1..*] use-cache="(true | false) [o]" filter-by-date="(true|false|by-name) </or> to-value-name="string [r]"/> [o]" <not used in AllConditionals> <get-related used in AllActions distinct="(true|false) [o]" <AllConditionals/> [1] value-name="string [r]" delegator-name="string [o]" </not> relation-name="string [r]" result-set-type="(forward|scroll) <if-has-permission in AllConditionals map-name="string [o]" [o]" permission="string [r]" order-by-list-name="string [o]" list-name="string [r]"> action="string [o]"/> use-cache="(true | false) [o]" Start Choice [0..1] <if-entity-permission AllConditionals list-name="string [r]"/> <condition-expr/> [1] entity-name="string [r]" <property-map used in AllActions <condition-list/> [1] entity-id="string [r]" resource="string [r]" <condition-object/> [1] target-operation="string [r]"/> map-name="string [r]" End Choice <if-validate-method in AllConditionals global="(true | false) [o]"/> <having-condition-list/> [0..1] field-name="string [r]" <property-to-field used in AllActions <select-field/>[0..*]<order-by/>[0..*] method="string [r]" resource="string [r]" Start Choice [0..1] class="string property="string [r]" <limit-range/> [1] <limit-view/> [1] [0..1:org.ofbiz.base.util.UtilValidate]"/> field="string [r]" <use-iterator/> [1] <if-compare used in AllConditionals default="string [o]" End Choice field-name="string [r]" no-locale="(true | false) [o]" </entity-condition> operator="(less|greater|less-equals| arg-list-name="string [o]"/> <entity-one used in AllActions greater-equals|equals|not-equals| <script used in AllActions entity-name="string [r]" contains) [r]" location="string [r]"/> value-name="string [o]" value="string [r]" <service used in AllActions use-cache="(true|false) [o]" type="(PlainString|String|BigDecimal| service-name="string [r]" auto-field-map="(true|false) [o]"> Double|Float|Long|Integer|Date|Time| result-map-name="string [o]" <field-map/>[0..*] Timestamp|Boolean|Object) [o]" auto-field-map="(true|false) [o]" <select-field/>[0..*] format="string [o]"/> result-map-list-name="string [o]"> </entity-one> <if-compare-field in AllConditionals <field-map/> [0..*] <condition-expr field-name="str [r]" field-name="string [r]" </service> operator="(less|greater|less-equals| operator="(less|greater|less-equals| <set used in AllActions greater-equals|equals|not-equals|in| greater-equals|equals|not-equals| field="string [r]" between|like) [o]" contains) [r]" from-field="string [o]" ignore-if-null="(true|false) [o]" to-field-name="string [o]" value="string [o]" ignore-if-empty="(true|false) [o]" type="(PlainString|String|BigDecimal| default-value="string [o]" env-name="string [o]" Double|Float|Long|Integer|Date|Time| global="(true|false) [o]" value="string [o]"/> Timestamp|Boolean||Object) [o]" from-scope="(screen | user | <condition-list format="string [o]"/> application) [o]" [Screen Widget Only] combine="(and|or) [o]"> <if-regexp used in AllConditionals to-scope="(screen | user | Start Choice [1..*] field-name="string [r]" application) [o]" [Screen Widget Only] <condition-expr/> [1] expr="string [r]"/> type="(PlainString|String|BigDecimal| <condition-list/> [1] <if-empty used in AllConditionals Double|Float|Long|Integer|Date|Time| <condition-object/> [1] field-name="string [r]"/> Timestamp|Boolean|Object) [o]"/> End Choice </condition-list> <condition-object field-name="s[r]"/> Link/Image Flexible Syntax <field-map field-name="string [r]" env-name="string [o]"/> <link Used in values and variable names. <having-condition-list text="str [o]" id="str [o]" - "${}" Used to insert the value of a combine="(and|or) [o]"> style="str [o]" name="str [o]" variable: value="${productId}" Start Choice [1..*] target="str[o]" prefix="str[o]" - "." Used to access a sub-value, or a <condition-expr/> [1] target-window="string [o]" value in a Map: product.productId <condition-list/> [1] url-mode="(intra-app | inter-app | - "[]" Used to access a member of a <condition-object/> [1] content | plain) [o]" List: products[0]; for put replaces End Choice full-path="(true | false) [o]" the value, unless you use a + before </having-condition-list> secure="(true | false) [o]" the number: products[+0] is before 0, <limit-range encode="(true | false) [o]"> beginning of List; to put at end of start="nonNegativeInteger [r]" <image/> [0..1] List leave empty: products[]; size="nonNegativeInteger [r]"/> </link> - env-name="product.productId" <limit-view <image - value="${product.productId}" view-index="nonNegativeInteger [r]" src="str [o]" style="str [o]" - "products[${curIdx}].${curKey}" view-size="nonNegativeInteger [r]"/> width="str[o]" height="str[o]" <use-iterator/> border="string [o]" <order-by field-name="string [r]"/> url-mode="(ofbiz|content|raw) [o]" <select-field field-name="str [r]"/> id="string [o]"/> page 14 Entity Configuration Copyright © 2004-2007 HOTWAX MEDIA, INC.</p><p>Entity Field Type Entity Config 2 of 3 Entity Config 3 of 3</p><p><fieldtypemodel> <transaction-factory class="str [r]"> <datasource name="string [r]" <field-type-def/> [0..*] <user-transaction-jndi/> [0..1] helper-class="string [r]" </fieldtypemodel> <transaction-manager-jndi/> [0..1] field-type-name="string [r]" <field-type-def type="string [r]" </transaction-factory> use-schemas="(true|false) [o]" sql-type="string [r]" <user-transaction-jndi schema-name="string [o]" sql-type-alias="string [o]" jndi-server-name="string [r]" check-on-start="(true|false) [o]" java-type="string [r]"> jndi-name="string [r]"/> add-missing-on-start="(true | false) <validate/> [0..*] <transaction-manager-jndi [o]" </field-type-def> jndi-server-name="string [r]" use-pk-constraint-names="(true | <validate method="string [r]" jndi-name="string [r]"/> false) [o]" class="string <delegator name="string [r]" constraint-name-clip-length=" [0..1:org.ofbiz.base.util.UtilValidate]"/> entity-model-reader="string [r]" nonNegativeInteger [0..1:30]" entity-group-reader="string [r]" use-proxy-cursor="(true|false)[o]" entity-eca-reader="string [o]" proxy-cursor-name="str[0..1:p_cursor]" distributed-cache-clear- result-fetch-size="nonNegInt[0..1:0]" Entity Field Type Example enabled=" (true | false) [o]" use-foreign-keys="(true|false)[o]" distributed-cache-clear-class- use-foreign-key-indices="(true | [ofbiz/framework/entity/fieldtype/*.xml] name="string false) [o]" <fieldtypemodel xmlns:xsi="http://www..." [0..1:org.ofbiz.entityext.cache.EntityCacheServices]" check-fks-on-start="(true | false) xsi:noNam...="...dtds/fieldtypemodel.xsd"> distributed-cache-clear-user-login- [o]" <field-type-def type="email" sql-type="VARCHAR2(255)" id="string [0..1:system]" check-fk-indices-on-start="(true | java-type="String"> sequenced-id-prefix="string [o]"> false) [o]" <validate method="isEmail"/> <group-map/> [1..*] fk-style="(name_constraint | name_fk) </field-type-def> </delegator> [o]" </fieldtypemodel> <group-map group-name="string [r]" use-fk-initially-deferred="(true | datasource-name="string [r]"/> false) [o]" <entity-model-reader name="str [r]"> use-indices="(true | false) [o]" Entity Config 1 of 3 <resource/> [0..*] check-indices-on-start="(true | </entity-model-reader> false) [o]" <entity-config> <entity-eca-reader name="str [r]"> join-style="(ansi | ansi-no- <resource-loader/> [1..*] <resource/> [0..*] parenthesis | theta-oracle | theta- <transaction-factory/> [1] </entity-eca-reader> mssql) [o]" <delegator/> [1..*] <entity-group-reader name="str [r]" alias-view-columns="(true | false) <entity-model-reader/> [1..*] loader="string [o]" [o]" <entity-group-reader/> [1..*] location="string [o]"> always-use-constraint-keyword="(true <entity-eca-reader/> [0..*] <resource/> [0..*] | false) [o]"> <entity-data-reader/> [0..*] </entity-group-reader> <sql-load-path/> [0..*] <field-type/> [1..*] <entity-data-reader name="str [r]"> <read-data/> [0..*] <datasource/> [1..*] <resource/> [0..*] Start Choice [1] </entity-config> </entity-data-reader> <jndi-jdbc/>[0..1]<inline-jdbc/>[0..1] <resource-loader name="string [r]" <field-type name="string [r]" <tyrex-dataSource/> [0..1] class="string [r]" loader="str [r]" location="str [r]"/> End Choice prepend-env="string [o]" </datasource> prefix="string [o]"/> <sql-load-path path="string [r]" <resource loader="string [r]" prepend-env="string [o]"/> location="string [r]"/> <read-data reader-name="string [r]"/> <inline-jdbc jdbc-driver="string [r]" jdbc-uri="s[r]" jdbc-username="s[r]" jdbc-password="string [r]" Entity Config Example isolation-level="(None| ReadCommitted|ReadUncommitted| [ofbiz/framework/entity/config/entityengine.xml] RepeatableRead|Serializable) [o]" <entity-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/entity-config.xsd"> pool-maxsize="nonNegInt [0..1:50]" <resource-loader name="fieldfile" class="org.ofbiz.base.config.FileLoader" pool-minsize="nonNegInt [0..1:2]" prepend-env="ofbiz.home" prefix="/framework/entity/fieldtype/"/> pool-sleeptime="nNI [0..1:300000]" <transaction-factory class="org.ofbiz.entity.transaction.JNDIFactory"> pool-lifetime="nNI [0..1:600000]" <user-transaction-jndi jndi-server-name="default" jndi-name="java:comp/UserTransaction"/> pool-deadlock-maxwait="[0..1:300000]" <transaction-manager-jndi jndi-server-name="default" jndi-name="java:comp/UserTransaction"/> pool-deadlock-retrywait="[0..1:10000]" </transaction-factory> pool-jdbc-test-stmt="string [o]" <delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false"> pool-xa-wrapper-class="str <group-map group-name="org.ofbiz" datasource-name="localderby"/>[<--change datasource here] [0..1:org.enhydra.jdbc.standard.StandardXADataSource]"/> </delegator> <jndi-jdbc jndi-name="string [r]" <entity-model-reader name="main"/> <entity-group-reader name="main"/> jndi-server-name="string [r]" <entity-eca-reader name="main"/> <entity-data-reader name="seed"/> isolation-level="(None| <entity-data-reader name="demo"/> <entity-data-reader name="ext"/> ReadCommitted|ReadUncommitted| <field-type name="hsql" loader="fieldfile" location="fieldtypehsql.xml"/> RepeatableRead|Serializable) [o]"/> <field-type name="derby" loader="fieldfile" location="fieldtypederby.xml"/> <datasource name="localderby" helper-class="org.ofbiz.entity.datasource.GenericHelperDAO" <tyrex-dataSource schema-name="OFBIZ" field-type-name="derby" dataSource-name="string [r]" check-on-start="true" add-missing-on-start="true" use-pk-constraint-names="false"> isolation-level="(None| <read-data reader-name="seed"/><read-data reader-name="demo"/><read-data reader-name="ext"/> ReadCommitted|ReadUncommitted| <inline-jdbc jdbc-driver="org.apache.derby.jdbc.EmbeddedDriver" RepeatableRead|Serializable) [o]"/> jdbc-uri="jdbc:derby:ofbiz;create=true" jdbc-username="ofbiz" jdbc-password="ofbiz" isolation-level="ReadCommitted" pool-minsize="2" pool-maxsize="20"/>  </datasource> </entity-config> Copyright © 2004-2007 HOTWAX MEDIA, INC. Service Configuration page 15</p><p>Service Config Service Config Example</p><p><service-config> [ofbiz/framework/service/config/serviceengine.xml] <authorization/> [1] <service-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <thread-pool/> [1] <engine/> [0..*] xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/service-config.xsd"> <service-location/> [0..*] <authorization service-name="userLogin"/> <thread-pool send-to-pool="pool" purge-job-days="4" failed-retry-min="3" <startup-service/> [0..*] ttl="18000000" wait-millis="750" jobs="10" min-threads="5" max-threads="15" <resource-loader/> [0..*] poll-enabled="true" poll-db-millis="20000"> <global-services/> [0..*] <run-from-pool name="pool"/> <service-groups/> [0..*] </thread-pool> <service-ecas/> [0..*] <engine name="bsh" class="org.ofbiz.service.engine.BeanShellEngine"/> <jms-service/> [0..*] <engine name="group" class="org.ofbiz.service.group.ServiceGroupEngine"/> </service-config> <engine name="http" class="org.ofbiz.service.engine.HttpEngine"/> <engine name="interface" class="org.ofbiz.service.engine.InterfaceEngine"/> <authorization service-name="str[r]"/> <engine name="jacl" class="org.ofbiz.service.engine.BSFEngine"/> <thread-pool send-to-pool="str [r]" <engine name="java" class="org.ofbiz.service.engine.StandardJavaEngine"/> purge-job-days="nonNegInt [0..1:30]" <engine name="javascript" class="org.ofbiz.service.engine.BSFEngine"/> failed-retry-min="nonNegInt[0..1:30]" <engine name="jms" class="org.ofbiz.service.jms.JmsServiceEngine"/> ttl="nonNegativeInteger [r]" <engine name="jpython" class="org.ofbiz.service.engine.BSFEngine"/> wait-millis="nonNegativeInteger [r]" <engine name="route" class="org.ofbiz.service.engine.RouteEngine"/> jobs="nonNegativeInteger [r]" <engine name="rmi" class="org.ofbiz.service.rmi.RmiServiceEngine"/> <engine name="simple" class="org.ofbiz.minilang.SimpleServiceEngine"/> min-threads="nonNegativeInteger [r]" <engine name="soap" class="org.ofbiz.service.engine.SOAPClientEngine"/> max-threads="nonNegativeInteger [r]" <engine name="ofbiz-workflow" class="org.ofbiz.workflow.WorkflowEngine"/> poll-enabled="(true | false) [o]" <engine name="workflow" class="org.ofbiz.shark.service.SharkServiceEngine"/> poll-db-millis="nonNegInteger [r]"> <service-location name="main-rmi" location="rmi://localhost:1099/RMIDispatcher"/> <run-from-pool/> [0..*] <service-location name="main-http" </thread-pool> location="http://localhost:8080/webtools/control/httpService"/> <run-from-pool name="string [r]"/> <service-location name="entity-sync-rmi" location="rmi://localhost:1099/RMIDispatcher"/> <service-location name="entity-sync-http" <engine name="str[r]" class="str[r]"/> location="http://localhost:8080/webtools/control/httpService"/> <startup-service name="string [r]" <service-location name="rita-rmi" location="rmi://localhost:1099/RMIDispatcher"/> runtime-data-id="string [o]" <service-location name="eedcc-test" runtime-delay="nonNegInt [0..1:0]" location="http://localhost:8080/webtools/control/httpService"/> run-in-pool="string [o]"/> <startup-service name="testScv" runtime-data-id="9900" runtime-delay="0" run-in-pool="pool"/> <service-location name="string [r]" <jms-service name="serviceMessenger" send-mode="all"> location="string [r]"/> <server jndi-server-name="default" jndi-name="jms/TopicConnectionFactory" topic-queue="jms/OFBTopic" type="topic" username="admin" password="admin" listen="true"/> <resource-loader name="string [r]" </jms-service> class="string [r]" </service-config> prepend-env="string [o]" prefix="string [o]"/> <global-services loader="string [r]" Containers Example - javamail location="string [r]"/> <service-groups loader="string [r]" [ofbiz/framework/base/config/ofbiz-containers.xml] location="string [r]"/> <container name="javamail-container" class="org.ofbiz.service.mail.JavaMailContainer"> <service-ecas loader="string [r]" <property name="delegator-name" value="default"/> location="string [r]"/> <property name="dispatcher-name" value="JavaMailDispatcher"/> <jms-service name="string [r]" <property name="run-as-user" value="system"/> <property name="poll-delay" value="300000"/> send-mode="(none | all | first-  <property name="delete-mail" value="false"/> available | random | round-robin | <property name="default-listener" value="store-listener"> least-load) [o]">  <server/> [1..*] <property name="mail.store.protocol" value="imap"/> </jms-service> <property name="mail.host" value="[host]"/> <property name="mail.user" value="[user]"/> <server jndi-name="string [r]" <property name="mail.pass" value="[pass]"/> <property name="mail.debug" value="true"/> jndi-server-name="string [r]" </property> topic-queue="string [r]" </container> type="(topic | queue) [r]" username="string [o]" password="string [o]" Mail-CA (MCA) Rules client-id="string [o]" listen="(true | false) [o]" <service-mca> [Root Element] listener-class="string [o]"/> <mca/> [1..*] </service-mca> <mca mail-rule-name="string [r]"> Start Choice [0..*] <condition-field/>[1] <condition-header/>[1] <condition-service/>[1] End Choice <action/> [1..*] </mca> <condition-field field-name="string [r]" operator="(empty | not-empty | matches | not-matches | equals | not- equals) [r]" value="string [o]"/> <condition-header header-name="str[r]" operator="(empty | not-empty | matches | not-matches | equals | not- equals) [r]" value="string [o]"/> <condition-service service-name="string [r]"/> <action service="string [r]" mode="(sync|async) [r]" runAsUser="string [o]" persist="(true|false) [o]"/> page 16 Other Configuration Copyright © 2004-2007 HOTWAX MEDIA, INC.</p><p>JNDI Servers JNDI Servers Example</p><p><jndi-config> <jndi-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <jndi-server/> [0..*] xsi:noNamespaceSchemaLocation="http://www.ofbiz.org/dtds/jndi-config.xsd"> </jndi-config> <jndi-server name="default"/> <jndi-server <jndi-server name="localjndi" context-provider-url="rmi://127.0.0.1:1099" initial-context-factory="com.sun.jndi.rmi.registry.RegistryContextFactory" name="string [r]" url-pkg-prefixes="java.naming.rmi.security.manager" context-provider-url="string [o]" security-principal="username" security-credentials="password"/> initial-context-factory="str [o]" </jndi-config> url-pkg-prefixes="string [o]" security-principal="string [o]" security-credentials="str [o]"/> Component Load OFBiz Component</p><p><component-loader> <ofbiz-component Cache Properties Start Choice [0..*] name="string [r]"> <load-component/> [1] <depends-on/> [0..*] cache.file.store=data/utilcache <load-components/> [1] <resource-loader/> [0..*] default.maxSize=0 End Choice <classpath/> [0..*] default.expireTime=0 </component-loader> <entity-resource/> [0..*] default.useSoftReference=false <load-component <service-resource/> [0..*] # in milliseconds, 0 means no limit component-name="string [o]" <webapp/> [0..*] # 30 min = 1800000 component-location="string [r]"/> </ofbiz-component> my.cache.name.maxSize=1800000 <load-components <depends-on component-name="str [r]"/> parent-directory="string [r]"/> <resource-loader name="string [r]" type="(component | file | classpath | URL Properties url) [o]" Component Load Example prepend-env="string [o]" port.https.enabled=Y port.https=8443 prefix="string [o]"/> [/framework/base/config/component-load.xml] <classpath type="(jar | dir) [r]" force.https.host=dynamic.ofbiz.org <component-loader xmlns:xsi="http://www..." port.http=8080 xsi:noNam...="...component-loader.xsd"> location="string [r]"/> force.http.host=dynamic.ofbiz.org <load-component component-location="$ <entity-resource reader-name="str [r]" content.url.prefix.secure=https://akamai... {ofbiz.home}/components/party"/> loader="str [r]" location="str [r]" content.url.prefix.standard=http://akamai... <load-components parent-directory="$ type="(model|group|eca|data) [r]"/> cookie.domain=ofbiz.org {ofbiz.home}/hot-deploy"/> <service-resource loader="string [r]" </component-loader> location="string [r]" type="(model|group|eca) [r]"/> Debug Properties <test-suite loader="string [r]" Containers location="string [r]"/> # Using Avalon Exception Util <webapp name="string [r]" pack.exception=true <ofbiz-containers> title="str [o]" server="str [r]" # These top level switches are used before <container/> [1..*] calling <a href="/tags/Log4j/" rel="tag">Log4J</a>, or if Log4J is not used location="string [r]" print.verbose=ftrue </ofbiz-containers> mount-point="string [o]" print.timing=true <container name="string [r]" app-bar-display="(true|false) [o]" print.info=true class="string [r]"> base-permission="string [o]"> print.important=true <property/> [0..*] <virtual-host/> [0..*] print.warning=true </container> <init-param/> [0..*] print.error=true <property name="string [r]" </webapp> print.fatal=true value="string [o]"> # From here out standard log4j settings, see <virtual-host host-name="string [r]"/> log4j documentation for more information <property/> [0..*] <init-param name="string [r]" log4j.rootLogger=ALL, stdout, file <property-value/> [0..1] value="string [r]"/> # Options: ALL, INFO, WARN, ERROR </property> log4j.logger.NoModule=ALL <property-value>Mixed</property-value> log4j.logger.org.ofbiz=ALL log4j.logger.org.ofbiz.minerva=WARN Containers Example</p><p>Security XML [ofbiz/framework/base/config/ofbiz-containers.xml] <ofbiz-containers xmlns:xsi="http://www.w3..." xsi:noNamesp...="...dtds/ofbiz-containers.xsd"> <container name="component-container" class="org.ofbiz.base.container.ComponentContainer"/> <security-config> <container name="classloader-container" class="org.ofbiz.base.container.ClassLoaderCo..."/> <security name="default"/> <container name="jotm-container" class="org.ofbiz.jotm.container.JotmContainer"/> <security name="myCustom" <container name="beanshell-container" class="org.ofbiz.base.container.BeanShellContainer"> class="com.mycompany.security.MySecurity"/> <property name="telnet-port" value="9990"/> <property name="app-name" value="OFBiz"/> </security-config> </container> </ofbiz-containers></p><p>Security Properties OFBiz Component Example security.context=default password.length.min=5 [ofbiz/applications/product/ofbiz-containers.xml] max.failed.logins=3 <ofbiz-component name="product" xmlns:xsi="http://..." xsi:noNam...="...ofbiz-component.xsd"> # if 0, then indefinate <resource-loader name="main" type="component"/> <classpath type="dir" location="config"/> login.disable.minutes=30 <classpath type="dir" location="script"/> <classpath type="jar" location="build/lib/*"/> login.disable.global.logout=false <entity-resource type="model" reader-name="main" loader="main" store.login.history=true location="entitydef/entitymodel.xml"/> store.login.history.on.service.auth=false <entity-resource type="group" reader-name="main" loader="main" store.login.history.incorrect.password=true location="entitydef/entitygroup.xml"/> password.encrypt=true <entity-resource type="eca" reader-name="main" loader="main" location="entitydef/eecas.xml"/> # options: SHA, MD5, etc <entity-resource type="data" reader-name="seed" loader="main" password.encrypt.hash.type=SHA location="data/ProductTypeData.xml"/> password.accept.encrypted.and.plain=false <service-resource type="model" loader="main" location="servicedef/services.xml"/> username.lowercase=false <service-resource type="eca" loader="main" location="servicedef/secas.xml"/> password.lowercase=false <service-resource type="group" loader="main" location="servicedef/groups_shipment.xml"/> <webapp name="catalog" title="Catalog" server="default-server" location="webapp/catalog" base-permission="CATALOG" mount-point="/catalog"/> </ofbiz-component> Copyright © 2004-2007 HOTWAX MEDIA, INC. View-Request Flow Examples page 17</p><p>Very Simple Example Common Error Pattern Example</p><p>This is a main orderstatus request-map [no event] error form submission</p><p>This is a resonse : name success addordertocart [ShoppingCartEvents. addToCartFromOrder] This is a success view-map main</p><p> showcart</p><p>Multiplexer Style Flow Example Flow for User Process Example</p><p> ordercomplete</p><p> setBasicInfo error multiple successful requests enterShippingAddress processpayment</p><p> enterCreditCard success</p><p>finalizeOrder checkBlacklist [CheckOutEvents. failed finalizeOrderEntry] sales_order or work_order</p><p> customer processorder custsetting link shipping shipsetting checkoutreview</p><p> options success optionsetting validatePaymentMethods payment billsetting success</p><p> paysplit calcTax checkoutpayment success sales calcShipping</p><p> error finalizeOrderError [CheckOutEvents. failedBlacklist finalizeOrderEntryError]</p><p> checkouterror page 18 Artifact Reference Diagram Copyright © 2004-2007 HOTWAX MEDIA, INC. nition iew Actions .xml: <view-map .../> response type .xml: <request-map .../> Servlet Container web.xml: <servlet .../> <section><actions .../> <section><widgets .../> Control Servlet: V <section><condition .../> Screen Section Screen Section Widgets Control Servlet: Request Screen Widget: Defi Screen Section Condition nition controller controller *Screens.xml: <screen><section .../> <widgets><platform- c><html><html-include .../> <actions><script .../> <actions><service .../> *Forms.xml: <form .../> <actions><entity-one .../> Form Widget: Defi <widgets><include-form .../> specifi <widgets><include-screen .../> eb Browser Cient W CS: Request: Event http://host/app/control/request <request-map><event ../> CS: Request: Response <request-map><response ../> event return value is response name when no event default is "success" emplate T</p><p>BSH Script FTL Rule nition nition guration triggered action Database entityengine.xml: <datasource .../> secas*.xml: <eca .../> Entity Engine: Defi services*.xml: <service .../> MiniLang: simple-method Service Engine: Defi <delegator><group-map .../> entitymodel*.xml: <entity .../> Service Engine: ECA Entity Engine: Confi <simple-method><entity-one .../> <simple-method><call-service .../> *Services.xml: <simple-method .../> triggers event Java Method</p> </div> </article> </div> </div> </div> <script type="text/javascript" async crossorigin="anonymous" src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8519364510543070"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.1/jquery.min.js" crossorigin="anonymous" referrerpolicy="no-referrer"></script> <script> var docId = '94a98b775fe98ba42787b6a1637dfc85'; var endPage = 1; var totalPage = 18; var pfLoading = false; window.addEventListener('scroll', function () { if (pfLoading) return; var $now = $('.article-imgview .pf').eq(endPage - 1); if (document.documentElement.scrollTop + $(window).height() > $now.offset().top) { pfLoading = true; endPage++; if (endPage > totalPage) return; var imgEle = new Image(); var imgsrc = "//data.docslib.org/img/94a98b775fe98ba42787b6a1637dfc85-" + endPage + (endPage > 3 ? ".jpg" : ".webp"); imgEle.src = imgsrc; var $imgLoad = $('<div class="pf" id="pf' + endPage + '"><img src="/loading.gif"></div>'); $('.article-imgview').append($imgLoad); imgEle.addEventListener('load', function () { $imgLoad.find('img').attr('src', imgsrc); pfLoading = false }); if (endPage < 7) { adcall('pf' + endPage); } } }, { passive: true }); </script> <script> var sc_project = 11552861; var sc_invisible = 1; var sc_security = "b956b151"; </script> <script src="https://www.statcounter.com/counter/counter.js" async></script> </html>