You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ho...@apache.org on 2020/07/14 19:23:17 UTC
[ofbiz-framework] 10/11: Documented: Framework,
delete all docbook files related to migration to asciidoc
(OFBIZ-11587)
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 91fe7bf4cce245268319ca75efe365191e6867f9
Author: holivier <ho...@apache.org>
AuthorDate: Tue Apr 14 12:25:26 2020 +0200
Documented: Framework, delete all docbook files related to migration to
asciidoc
(OFBIZ-11587)
- common-sending-email: include in email
- datafile: move as a include at the end of entity-engine section
- entity-engine: list of link to OFBiz wiki about entity configuration
- service-engine: a link to OFBiz wiki Service Engine Guide
- webtools: help for main screen
- mini-lang: include a link to OFBiz wiki mini-lang-reference at the
beginning of minilang-to-groovy-manual
move minilang-to-groovy-manual to Development environment
section
- unit-test: include as Junit test, and use README to list gradle
command available (so add a tag in REAME.adoc)
- base: add a link to OFBiz wiki Configuration Guide, in deployment
section
- SingleSignOn with LDAP: move to plugin LDAP and include in deployment
section
---
framework/common/documents/FrameworkCommon.xml | 30 ---
framework/common/documents/SendingEmail.xml | 45 ----
framework/documents/DataFiles.xml | 239 -----------------
framework/documents/Framework.xml | 28 --
framework/documents/SingleSignOn.xml | 282 ---------------------
framework/documents/UnitTest.xml | 228 -----------------
framework/entity/documents/EntityEngine.xml | 48 ----
framework/minilang/documents/MiniLang.xml | 28 --
framework/service/documents/ServiceEngine.xml | 28 --
framework/webtools/data/helpdata/HELP_WEBTOOLS.xml | 22 --
.../webtools/data/helpdata/HELP_WEBTOOLS_main.xml | 48 ----
framework/webtools/documents/Webtools.xml | 30 ---
12 files changed, 1056 deletions(-)
diff --git a/framework/common/documents/FrameworkCommon.xml b/framework/common/documents/FrameworkCommon.xml
deleted file mode 100644
index ce0d252..0000000
--- a/framework/common/documents/FrameworkCommon.xml
+++ /dev/null
@@ -1,30 +0,0 @@
-<?xml version="1.0"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<chapter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Framework Common Component.</title>
- <para>
- The framework Common component contains all functions which do not justify a separate framework component.
- </para>
- <xi:include href="SendingEmail.xml" />
-</chapter>
diff --git a/framework/common/documents/SendingEmail.xml b/framework/common/documents/SendingEmail.xml
deleted file mode 100644
index f369156..0000000
--- a/framework/common/documents/SendingEmail.xml
+++ /dev/null
@@ -1,45 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>Sending Email in OFBiz</title>
- <para>
- Various parts in the OFBiz application are sending out email for various reasons. Sending out email is controlled in the
- ${ofbiz install dir}/framework/common/config/general.properties file with the following parameters:
- <orderedlist>
- <listitem><para>
- SMTP Server (relay host): mail.smtp.relay.host
- </para></listitem>
- <listitem><para>
- SMTP Username (if needed): mail.smtp.auth.user
- </para></listitem>
- <listitem><para>
- SMTP Password (if needed): mail.smtp.auth.password
- </para></listitem>
- <listitem><para>
- Turn on email notifications by setting the mail.notifications.enabled property to "Y".
- </para></listitem>
- </orderedlist>
- </para>
-</section>
-
diff --git a/framework/documents/DataFiles.xml b/framework/documents/DataFiles.xml
deleted file mode 100644
index 8b90139..0000000
--- a/framework/documents/DataFiles.xml
+++ /dev/null
@@ -1,239 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<chapter id="Working with Ofbiz Data files" version="5.0" xsi:schemaLocation="http://www.docbook.org/xml/5.0b3/xsd/docbook.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns="http://docbook.org/ns/docbook">
- <title>The OFBiz Datafiles</title>
- <section>
- <section id="Intoduction">
- <title>Intoduction</title>
- <para>There is a data import tool in OFBiz called the DataFile tool. It uses XML files that describe flat file formats (including character delimited, fixed width, etc) and parses the flat files based on those definitions. So, by design it is somewhat like the Entity Engine. It uses a generic object to represent a row in the flat file. It includes features like a line type code for each line and can support hierarchical flat files (ie where parent/child relationships are impl [...]
- </para>
- <para>The code is in the ofbiz/framework/datafile directory, and there is an XSD there to describe how the data file definition XML file should look.
- </para>
- <para>The DataFile has a web page in WebTools to parse data files and generate entity xml files (that can be imported in OFBiz) from them, and to do in/outtesting.
- </para>
- <para>both the import of fixed width flat files and character delimited files are implemented.
- </para>
- </section>
- <section id="Definitions">
- <title>Definitions</title>
- <para>Definition file*: this is an xml file that contains one or more "Data File Definition"s; the grammar of the file is defined in framework/datafile/dtd/datafile.xsd
- </para>
- <para>Data File Definition*: the definition of a data file structure (e.g. names/types of the fields/columns in a "Data File"; the same "Data File" could have more than one "Data File Definition"s (e.g. the definitions could consider different subsets of all the fields available in the data file).
- </para>
- <para>Data file*: the text file that contains all the data (a fixed width or a character delimited text file)
- </para>
- </section>
- <section>
- <title>How to use the "Work With Data Files" screen in the Webtools application</title>
- <procedure>
-
- <title>How to use the "Work With Data Files" screen in the Webtools application</title>_Prerequisites_: a definition file (containing the fields' definition of the data file) and a data file (containing the data you want to parse/import) should be available in the OFBiz server.Steps:
-
- <step performance="required">
-<para>
- connect to the Webtools application
-</para>
- </step>
- <step performance="required">
- <para>go to the "Work With Data Files" screen</para>
-
- </step>
- <step performance="required">
- <para>
- enter the path to the your definition file in the "Definition Filename or URL" input field
-</para>
- </step>
-
- <step performance="required">
- <para>
-click on the submit button>
-</para>
- </step>
- <step performance="required">
- <para>
- the "Data File Definition Name" input field will be changed into a drop down box containing all the definitions available in the definition file
-</para>
- </step>
- <step performance="required">
- <para>
- select the definition you want to use from the drop down box>
-</para>
- </step>
- <step performance="required">
- <para>
- enter the path to the your data file in the "Data Filename or URL" input field
- </para>
- </step>
- <step performance="required">
- <para>
-if you want to generate an entity xml file that can be later imported in OFBiz,
-enter a path for it in the "Save to entity xml file:
- </para>
- </step>
- <step performance="required">
- <para>
- input field and click on the submit button; the file will be created
-(see the paragraph "Tips to create Entity Xml Files" for more details)</para>
-
- </step>
- </procedure>
-
-
- </section>
- <section>The field.name attribute must contain the name of the entity field in which the records will be imported
- (for example<programlisting><![CDATA[:<field name="productId" type="String">
- </field>
- ]]></programlisting>
- </section>
- <section>
- <title>Examples</title>
- <section>
- <example>
- <title>An example of fixed width flat file import.</title>Sample fixed width CSV file posreport.csv to be imported:
-<programlisting><![CDATA[
-021196033702 ,5031BB GLITTER GLUE PENS BRIGH ,1 ,5031BB , 1, 299,
-021196043121 ,BB4312 WONDERFOAM ASSORTED ,1 ,BB4312 , 1, 280,
-021196055025 ,9905BB PLUMAGE MULTICOLOURED ,1 ,9905BB , 4, 396,
-]]></programlisting>
- </example>
-
- </section>
- <section>
- <title>Sample xml definition file for importing select columns</title>
- <example>
- <title> posschema.xml:</title>
- <programlisting><![CDATA[
- <data-files xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/datafiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <data-file name="posreport" separator-style="fixed-length" type-code="text">
- <record name="tillentry" limit="many">
- <field name="tillCode" type="String" length="16" position="0">
- </field>
- <field name="name" type="String" length="32" position="17">
- </field>
- <field name="prodCode" type="String" length="12" position="63">
- </field>
- <field name="quantity" type="String" length="8" position="76">
- </field>
- <field name="totalPrice" type="String" length="8" position="85">
- </field>
- </record>
- </data-file>
- </data-files>
- ]]></programlisting>
- </example>
-
- The types listed in this sample are simple String's but the usual types are available such as Date, Long etc
-
- </section>
- <section>
- <example>
- <title>Another example reading fixed record little endian binary files</title>
- <programlisting><![CDATA[
- <data-files xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/datafiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <data-file name="stockdata" separator-style="fixed-record" type-code="text" record-length="768">
- <record name="stockdataitem" limit="many">
- <field name="barcode" type="NullTerminatedString" length="12" position="0">
- </field>
- <field name="prodCode" type="NullTerminatedString" length="12" position="68">
- </field>
- <field name="price" type="LEInteger" length="4" position="80">
- </field>
- <field name="name" type="NullTerminatedString" length="30" position="16">
- </field>
- </record>
- </data-file>
- </data-files>
- ]]></programlisting>
- </example>
- <procedure>
-
- <title>In the interface enter something like:</title>
-
- <step performance="required">
-<para>
- Definition Filename or URL: posschema.xml
-</para>
- </step>
- <step performance="required">
-<para>
- Data File Definition Name: posreport
-</para>
- </step>
- <step performance="required">
-<para>
- Data Filename or URL: posreport.csv
-</para>
- </step>
-
- </procedure>
- </section>
- </section>
- <section>
- <example>
-
- <title>Sample xml definition file for importing select columns posschema.xml:</title>
- <programlisting><![CDATA[
- <data-files xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/datafiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <data-file name="posreport" separator-style="fixed-length" type-code="text">
- <record name="tillentry" limit="many">
- <field name="tillCode" type="String" length="16" position="0">
- </field>
- <field name="name" type="String" length="32" position="17">
- </field>
- <field name="prodCode" type="String" length="12" position="63">
- </field>
- <field name="quantity" type="String" length="8" position="76">
- </field>
- <field name="totalPrice" type="String" length="8" position="85">
- </field>
- </record>
- </data-file>
- </data-files>
- ]]></programlisting>
- </example>
-
- In the interface enter something like:* Definition Filename or URL: posschema.xml* Data File Definition Name: posreport* Data Filename or URL: posreport.csvThe types listed in this sample are simple String's but the usual types are available such as Date, Long etc.
- </section>
- <section>
- <example>
-
- <title> Another example reading fixed record little endian binary files</title>
- <programlisting><![CDATA[
- <data-files xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/datafiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <data-file name="stockdata" separator-style="fixed-record" type-code="text" record-length="768">
- <record name="stockdataitem" limit="many">
- <field name="barcode" type="NullTerminatedString" length="12" position="0">
- </field>
- <field name="prodCode" type="NullTerminatedString" length="12" position="68">
- </field>
- <field name="price" type="LEInteger" length="4" position="80">
- </field>
- <field name="name" type="NullTerminatedString" length="30" position="16">
- </field>
- </record>
- </data-file>
- </data-files>
- ]]></programlisting>
- </example>
-
- </section>
-
- </section>
-</chapter>
diff --git a/framework/documents/Framework.xml b/framework/documents/Framework.xml
deleted file mode 100644
index 31acd2e..0000000
--- a/framework/documents/Framework.xml
+++ /dev/null
@@ -1,28 +0,0 @@
-<?xml version="1.0"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<chapter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The OFBiz Framework Introduction.</title>
- <para>
- For a core configuration guide check <link xl:href="http://ofbiz.apache.org/docs/coreconfig.html">the OFBiz website.</link>
- </para>
-</chapter>
diff --git a/framework/documents/SingleSignOn.xml b/framework/documents/SingleSignOn.xml
deleted file mode 100644
index 568f53c..0000000
--- a/framework/documents/SingleSignOn.xml
+++ /dev/null
@@ -1,282 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<chapter xml:id="CASLDAP" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>OFBiz Single Sign On using CAS and LDAP</title>
- <section>
- <title>Setup the Java Key Store</title>
- <para>
- From the directory in which you want to create the keystore, run keytool with the following parameters.
- </para>
- <orderedlist>
- <listitem>
- <para>
- Generate the server certificate.
- <programlisting>
- $ keytool -genkey -alias tomcat -keyalg RSA -keypass changeit -storepass changeit -keystore keystore.jks
- </programlisting>
- When you press Enter, keytool prompts you to enter the server name, organizational unit, organization, locality, state, and country code. Note that you must enter the server name in response to keytool's first prompt, in which it asks for first and last names. For testing purposes, this can be localhost.
- </para>
- </listitem>
- <listitem>
- <para>
- Export the generated server certificate in keystore.jks into the file server.cer.
- <programlisting>
- $ keytool -export -alias tomcat -storepass changeit -file server.cer -keystore keystore.jks
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- To create the trust-store file cacerts.jks and add the server certificate to the trust-store, run keytool from the directory where you created the keystore and server certificate. Use the following parameters:
- <programlisting>
- $ keytool -import -v -trustcacerts -alias tomcat -file server.cer -keystore cacerts.jks -keypass changeit -storepass changeit
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Information on the certificate, such as that shown next, will display.
- <programlisting>
- $ keytool -import -v -trustcacerts -alias tomcat -file server.cer -keystore cacerts.jks -keypass changeit -storepass changeit
-
- Owner: CN=localhost, OU=Sun Micro, O=Docs, L=Santa Clara, ST=CA, C=US
- Issuer: CN=localhost, OU=Sun Micro, O=Docs, L=Santa Clara, ST=CA, C=US
- Serial number: 3e932169
- Valid from: Tue Apr 08
- Certificate fingerprints:
- MD5: 52:9F:49:68:ED:78:6F:39:87:F3:98:B3:6A:6B:0F:90
- SHA1: EE:2E:2A:A6:9E:03:9A:3A:1C:17:4A:28:5E:97:20:78:3F:
- Trust this certificate? [no]:
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Enter yes, and then press the Enter or Return key. The following information displays:
- <programlisting>
- Certificate was added to keystore
- [Saving cacerts.jks]
- </programlisting>
- </para>
- </listitem>
- </orderedlist>
- </section>
- <section>
- <title>CAS Server</title>
- <para>
- <orderedlist>
- <listitem>
- <para>
- Download CAS server from <link xl:href="http://www.jasig.org/cas">the CAS web site</link>.
- </para>
- </listitem>
- <listitem>
- <para>
- Deploy cas-server-webapp-[version].war to Tomcat
- </para>
- </listitem>
- <listitem>
- <para>
- Set key store file to Tomcat
- <programlisting>
- keystoreFile="path/to/keystore.jks"
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Start Tomcat
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>OFBiz Certificate</title>
- <para>
- Set trust store's file to Java Virtual Machine (JVM) before start OFBiz.
- <programlisting>
- -Djavax.net.ssl.trustStore=path/to/cacerts.jks
- </programlisting>
- </para>
- </section>
- <section>
- <title>LDAP Component</title>
- <para>
- OFBiz uses the LDAP component in the plugins to check the security in a web application. OFBiz disabled LDAP component as default, you can enable this component by take the comment out from plugins/component-load.xml file.
- </para>
- <section>
- <title>LDAP Properties</title>
- <para>
- LDAP properties file is plugins/ldap/config/ldap.xml. You can change a filter condition you want.
- </para>
- <section>
- <title>Attributes</title>
- <para>
- <orderedlist>
- <listitem>
- <para>
- Attribute : LDAP attbitue for filter e.g. uid=%u
- </para>
- </listitem>
- <listitem>
- <para>
- AuthenType : LDAP authentication method e.g. simple
- </para>
- </listitem>
- <listitem>
- <para>
- AuthenticaionHandler : CAS handler class e.g. org.apache.ofbiz.ldap.cas.OFBizCasAuthenticationHandler
- </para>
- </listitem>
- <listitem>
- <para>
- AutoPartyId : Party's id for user login e.g. admin
- </para>
- </listitem>
- <listitem>
- <para>
- AutoSecurityGroupId : Security group's id for user login e.g. FULLADMIN
- </para>
- </listitem>
- <listitem>
- <para>
- BaseDN : The top level ofbiz LDAP directory tree e.g. dc=example,dc=com
- </para>
- </listitem>
- <listitem>
- <para>
- Filter : LDAP search filter e.g. (objectclass=*)
- </para>
- </listitem>
- <listitem>
- <para>
- Scope : LDAP search scope parameter e.g. sub,one, etc.
- </para>
- </listitem>
- <listitem>
- <para>
- URL : LDAP server's url e.g. ldap://localhost:389
- </para>
- </listitem>
- <listitem>
- <para>
- UserOFBizLoginWhenLDAPFail : indicate that if LDAP fail then login with normal OFBiz's user or not. (true/false)
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>CAS</title>
- <para>
- <orderedlist>
- <listitem>
- <para>
- CasLoginUri : URI to CAS login e.g. /login
- </para>
- </listitem>
- <listitem>
- <para>
- CasLogoutUri : URI to CAS logout e.g. /logout
- </para>
- </listitem>
- <listitem>
- <para>
- CasUrl : CAS Server's URL e.g. https://localhost:8443/cas
- </para>
- </listitem>
- <listitem>
- <para>
- CasValidateUri : URI to CAS validate e.g. /validate
- </para>
- </listitem>
- <listitem>
- <para>
- CasLdapHandler : LDAP hanlder class e.g. org.apache.ofbiz.ldap.openldap.OFBizLdapAuthenticationHandler
- </para>
- </listitem>
- <listitem>
- <para>
- CasTGTCookieName : CAS TGT's cookie name e.g. CASTGC
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- </section>
- </section>
- <section>
- <title>OpenLDAP</title>
- <para>
- The LDAP component need data from LDAP server (OpenLDAP). The server needs to install, configure and populate OpenLDAP: see at <link xl:href="http://www.openldap.org">the OpenLDAP web site</link>.
- </para>
- </section>
- <section>
- <title>Web Application Security Mapping</title>
- <para>
- Every web application you need to use LDAP (single sign on) feature, you need to change the event's path of some the security request mappings to org.apache.ofbiz.ldap.LdapLoginWorker class.
- </para>
- <section>
- <title>checkLogin</title>
- <para>
- <programlisting>
- <request-map uri="checkLogin" edit="false">
- <description>Verify a user is logged in.</description>
- <security https="true" auth="false"/>
- <event type="java" path="org.apache.ofbiz.ldap.LdapLoginWorker" invoke="checkLogin"/>
- <response name="success" type="view" value="main"/>
- <response name="error" type="view" value="login"/>
- </request-map>
- </programlisting>
- </para>
- </section>
- <section>
- <title>login</title>
- <para>
- <programlisting>
- <request-map uri="login">
- <security https="true" auth="false"/>
- <event type="java" path="org.apache.ofbiz.ldap.LdapLoginWorker" invoke="login"/>
- <response name="success" type="view" value="main"/>
- <response name="requirePasswordChange" type="view" value="requirePasswordChange"/>
- <response name="error" type="view" value="login"/>
- </request-map>
- </programlisting>
- </para>
- </section>
- <section>
- <title>logout</title>
- <para>
- <programlisting>
- <request-map uri="logout">
- <security https="true" auth="true"/>
- <event type="java" path="org.apache.ofbiz.ldap.LdapLoginWorker" invoke="logout"/>
- <response name="success" type="request-redirect" value="main"/>
- <response name="error" type="view" value="main"/>
- </request-map>
- </programlisting>
- </para>
- </section>
- </section>
-</chapter>
\ No newline at end of file
diff --git a/framework/documents/UnitTest.xml b/framework/documents/UnitTest.xml
deleted file mode 100644
index f8f6304..0000000
--- a/framework/documents/UnitTest.xml
+++ /dev/null
@@ -1,228 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<chapter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title><anchor xml:id="TheOFBizUnitTest"/>The OFBiz Unit Test (Using JUnit)</title>
- <section>
- <title>How to define a unit test?</title>
- <orderedlist>
- <listitem>
- <para>
- Define test-suite in ofbiz-component.xml like this:
- </para>
- <programlisting>
- <test-suite loader="main" location="testdef/servicetests.xml"/>
- </programlisting>
- </listitem>
- <listitem>
- <para>
- Create test-case in test-suite file.
- </para>
- <programlisting>
- <test-suite suite-name="servicetests"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/test-suite.xsd">
- ....
- ....
- <test-case case-name="test-case-name">
- ...
- </test-case>
- ....
- ....
- </test-suite>
- </programlisting>
- </listitem>
- </orderedlist>
- </section>
- <section>
- <title>How to create a test case?</title>
- <para>
- Define a test-case in an XML test-suite file like this:
- <programlisting>
- <test-case case-name="test-case-name">
- ...
- </test-case>
- </programlisting>
- The test-case tag contains details of each test type:
- </para>
- <section>
- <title>1. Entity XML</title>
- <para>
- Specific entity xml and its action would like to be tested in entity-xml-url attribute and action attribute respectively like this:
- <programlisting>
- <test-case case-name="service-dead-lock-retry-assert-data">
- <entity-xml action="assert" entity-xml-url="component://service/testdef/data/ServiceDeadLockRetryAssertData.xml"/>
- </test-case>
- </programlisting>
- </para>
- </section>
- <section>
- <title>2. JUnit</title>
- <para>
- Specific class's name which will be tested, in a class-name attribute like this:
- <programlisting>
- <test-case case-name="service-tests">
- <junit-test-suite class-name="org.apache.ofbiz.service.test.ServiceEngineTests"/>
- </test-case>
- </programlisting>
- </para>
- </section>
- <section>
- <title>3. Service</title>
- <para>
- Specific service's name which will be tested in a service-name attribute like this:
- <programlisting>
- <test-case case-name="service-lock-wait-timeout-retry-test">
- <service-test service-name="testServiceLockWaitTimeoutRetry"/>
- </test-case>
- </programlisting>
- </para>
- </section>
- <section>
- <title>4. Simple Method</title>
- <para>
- Specific simple method's location and name which will be tested in a location and a name attribute respectively like this:
- <programlisting>
- <test-case case-name="auto-accounting-transaction-tests-PoReceipt">
- <simple-method-test location="component://accounting/minilang/test/AutoAcctgTransTests.xml" name="testAcctgTransOnPoReceipts"/>
- </test-case>
- </programlisting>
- </para>
- </section>
- </section>
- <section>
- <title>How to run a unit test?</title>
- <para>
- You can run unit test by run 'ant' with following target:
- </para>
- <section>
- <title>1. run-tests</title>
- <para>
- Run OFBiz default tests.
- </para>
- </section>
- <section>
- <title>2. run-test-list</title>
- <para>
- Run all configured tests, stopping/starting ofbiz between each test.
- </para>
- </section>
- <section>
- <title>3. run-single-test</title>
- <para>
- Run a single test, require two arguments:
- <orderedlist>
- <listitem>
- <para>
- 'test.component' is a name of test component.
- </para>
- </listitem>
- <listitem>
- <para>
- 'test.case' is a name of test case.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>4. run-single-test-suite</title>
- <para>
- Run a single test suite, requiring two arguments:
- <orderedlist>
- <listitem>
- <para>
- 'test.component' is a name of test component.
- </para>
- </listitem>
- <listitem>
- <para>
- 'test.suiteName' is a name of test suite.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- </section>
- <section>
- <title>Possible error messages</title>
- <para>
- Some error messages in the log are not important and often caused by the test.
- </para>
- <section>
- <title>1. Roll back</title>
- <para>
- Roll back error message occurred when transaction roll back data. This error message will be in between starting and finished test cass line like this:
- <programlisting>
- [java] 2009-12-22 16:05:28,349 (main) [ TestRunContainer.java:238:INFO ] [JUNIT] : [test case's name] starting...
- [java] 2009-12-22 16:05:28,355 (main) [ TransactionUtil.java:336:ERROR]
- ....
- ....
- ....
- [java] ---- exception report ----------------------------------------------------------
- [java] [TransactionUtil.rollback]
- [java] Exception: java.lang.Exception
- [java] Message: Stack Trace
- [java] ---- stack trace ---------------------------------------------------------------
- [java] java.lang.Exception: Stack Trace
- [java] org.apache.ofbiz.entity.transaction.TransactionUtil.rollback(TransactionUtil.java:335)
- [java] org.apache.ofbiz.entity.transaction.TransactionUtil.rollback(TransactionUtil.java:317)
- [java] org.apache.ofbiz.entity.test.EntityTestSuite.testTransactionUtilRollback(EntityTestSuite.java:437)
- [java] sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
- [java] sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
- [java] sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
- [java] java.lang.reflect.Method.invoke(Method.java:597)
- [java] junit.framework.TestCase.runTest(TestCase.java:154)
- [java] junit.framework.TestCase.runBare(TestCase.java:127)
- [java] junit.framework.TestResult$1.protect(TestResult.java:106)
- [java] junit.framework.TestResult.runProtected(TestResult.java:124)
- [java] junit.framework.TestResult.run(TestResult.java:109)
- [java] junit.framework.TestCase.run(TestCase.java:118)
- [java] junit.framework.TestSuite.runTest(TestSuite.java:208)
- [java] junit.framework.TestSuite.run(TestSuite.java:203)
- [java] junit.framework.TestSuite.runTest(TestSuite.java:208)
- [java] junit.framework.TestSuite.run(TestSuite.java:203)
- [java] org.apache.ofbiz.testtools.TestRunContainer.start(TestRunContainer.java:146)
- [java] org.apache.ofbiz.base.container.ContainerLoader.start(ContainerLoader.java:100)
- [java] org.apache.ofbiz.base.start.Start.startStartLoaders(Start.java:272)
- [java] org.apache.ofbiz.base.start.Start.startServer(Start.java:322)
- [java] org.apache.ofbiz.base.start.Start.start(Start.java:326)
- [java] org.apache.ofbiz.base.start.Start.main(Start.java:411)
- [java] --------------------------------------------------------------------------------
- [java]
- ....
- ....
- ....
- [java] 2009-12-22 16:05:28,366 (main) [ TransactionUtil.java:346:INFO ] [TransactionUtil.rollback] transaction rolled back
- [java] 2009-12-22 16:05:28,370 (main) [ TestRunContainer.java:234:INFO ] [JUNIT] : [test case's name] finished.
- </programlisting>
- </para>
- </section>
- </section>
- <section>
- <title>Test result</title>
- <para>
- After you run unit test, you can see the result of the testing. If you use run-tests target, you can see test result web page by view runtime/logs/test-results/html/index.html file in web browser
- and see JUnit Test Result files for each test suite in runtime/logs/test-results directory. If you use other target you only see JUnit Test Result file in runtime/logs/test-results.
- </para>
- </section>
-</chapter>
diff --git a/framework/entity/documents/EntityEngine.xml b/framework/entity/documents/EntityEngine.xml
deleted file mode 100644
index 2f57c1b..0000000
--- a/framework/entity/documents/EntityEngine.xml
+++ /dev/null
@@ -1,48 +0,0 @@
-<?xml version="1.0"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Entity Engine.</title>
-
- <section>
- <title>Entity Engine guide.</title>
- <para>
- <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/Entity+Engine+Guide">Entity engine Guide</link>
- </para>
- </section>
-
- <section>
- <title>Entity Engine Configuration Guide.</title>
- <para>
- <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/Entity+Engine+Configuration+Guide">entity engine configuration guide</link>
- </para>
- </section>
-
- <section>
- <title>Entity overview.</title>
- <para>
- <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/General+Entity+Overview">Entity overview</link>
- </para>
-
- </section>
-
-</section>
diff --git a/framework/minilang/documents/MiniLang.xml b/framework/minilang/documents/MiniLang.xml
deleted file mode 100644
index ba4b309..0000000
--- a/framework/minilang/documents/MiniLang.xml
+++ /dev/null
@@ -1,28 +0,0 @@
-<?xml version="1.0"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Entity Engine</title>
- <para>
- A description of the Mini Language guide can be found at the <link xl:href="http://cwiki.apache.org/confluence/display/OFBIZ/Mini-Language+Guide">OFBiz documentation site</link>
- </para>
-</section>
diff --git a/framework/service/documents/ServiceEngine.xml b/framework/service/documents/ServiceEngine.xml
deleted file mode 100644
index e56e3fb..0000000
--- a/framework/service/documents/ServiceEngine.xml
+++ /dev/null
@@ -1,28 +0,0 @@
-<?xml version="1.0"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Service Engine</title>
- <para>
- A description of the service engine can be found at the <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/Service+Engine+Guide">OFBiz documentation site</link>
- </para>
-</section>
diff --git a/framework/webtools/data/helpdata/HELP_WEBTOOLS.xml b/framework/webtools/data/helpdata/HELP_WEBTOOLS.xml
deleted file mode 100644
index 1ce2368..0000000
--- a/framework/webtools/data/helpdata/HELP_WEBTOOLS.xml
+++ /dev/null
@@ -1,22 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Webtools Introduction.</title>
- <xi:include href="HELP_WEBTOOLS_main.xml" />
-</section>
\ No newline at end of file
diff --git a/framework/webtools/data/helpdata/HELP_WEBTOOLS_main.xml b/framework/webtools/data/helpdata/HELP_WEBTOOLS_main.xml
deleted file mode 100644
index cd7f9aa..0000000
--- a/framework/webtools/data/helpdata/HELP_WEBTOOLS_main.xml
+++ /dev/null
@@ -1,48 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Webtools Main page.</title>
- <para>
- This is the default screen for the Webtools application. Several links are present on this page to access specific tool screens directly. Using the application menu you can select the tool you need.
- </para>
- <itemizedlist>
- <listitem>
- <para>The <link xl:href="">Logging</link> section is used to view and configure the OFBiz system logs.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Cache & Debug</link> section is used to monitor the OFBiz cache system status. You can even set or clear some cache content or force Garbage collection with this tool.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Artifact Info</link> section is used to navigate through all OFBiz artifact files. When accessing this section the complete OFBiz code base is scanned and a list of all artifacts is offered to the user to be navigated.
- Please note that the initial scan can take a while to be completed.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Entity Engine</link> section is used to interact with the entities defined in the system. You can view the entity structures, search for entity content, navigate though related entities, etc.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Service Engine</link> section is used to interact with the services defined in the system. You can view all services details, monitor the jobs that are running, the active threads. You can even manually run a service or schedule a periodic/delaied job execution.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Import/Export</link> section is used to transfer entity content from the OFBiz system to external systems and viceversa. Various import/export systems and formats are available.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Configuration</link> section is used to set parameters for the OFBiz system.</para>
- </listitem>
- </itemizedlist>
-</section>
diff --git a/framework/webtools/documents/Webtools.xml b/framework/webtools/documents/Webtools.xml
deleted file mode 100644
index cbdc455..0000000
--- a/framework/webtools/documents/Webtools.xml
+++ /dev/null
@@ -1,30 +0,0 @@
-<?xml version="1.0"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<chapter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Webtools, framework menus</title>
- <para>
- The Webtools option is the gateway to all the framework functions.
- </para>
- <xi:include href="../data/helpdata/HELP_WEBTOOLS.xml" />
-
-</chapter>