[ofbiz-framework] branch trunk updated: Documented: Add a Global Glossary for user-documentation (OFBIZ-10303)

[holivier]

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


The following commit(s) were added to refs/heads/trunk by this push:
     new c218926  Documented: Add a Global Glossary for user-documentation (OFBIZ-10303)
c218926 is described below

commit c21892609ba593193055bc2350e1e44b602d687b
Author: holivier <[hidden email]>
AuthorDate: Mon Sep 14 15:09:43 2020 +0200

    Documented: Add a Global Glossary for user-documentation (OFBIZ-10303)
---
 .../humanres/src/docs/asciidoc/humanres.adoc       |   4 +-
 docs/asciidoc/_include/ofbiz-glossary.adoc         | 115 +++++++++++++++++++++
 docs/asciidoc/user-manual.adoc                     |   8 +-
 3 files changed, 122 insertions(+), 5 deletions(-)

diff --git a/applications/humanres/src/docs/asciidoc/humanres.adoc b/applications/humanres/src/docs/asciidoc/humanres.adoc
index 37b631f..fc8ef2b 100644
--- a/applications/humanres/src/docs/asciidoc/humanres.adoc
+++ b/applications/humanres/src/docs/asciidoc/humanres.adoc
@@ -18,8 +18,8 @@ under the License.
 ////
 = Human Resources
 
-The OFBiz Human Resources system is one of the core application components and has
-all of the functionality you need to manage your business employees as well as the
+The OFBiz Human Resources system is one of the <<CORE_APPLICATION_COMPONENTS,core application components>> and has
+all of the functionality you need to manage your business <<EMPLOYEE,employees>> as well as the
 recruitment process. It is well integrated with other components especially
 Accounting to manage Payroll and any specific  employee agreements.
 
diff --git a/docs/asciidoc/_include/ofbiz-glossary.adoc b/docs/asciidoc/_include/ofbiz-glossary.adoc
new file mode 100644
index 0000000..57d5755
--- /dev/null
+++ b/docs/asciidoc/_include/ofbiz-glossary.adoc
@@ -0,0 +1,115 @@
+////
+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.
+////
+[glossary]
+= General Glossary
+
+[glossary]
+[#APPLICATION]
+Application::
+. **for end users** , an application is a top level menu entry, it's for managing a business object:
+order, accounting GL, accounting AP, facility, project, .... +
+An application can be dedicated for a specifics business and can use part of other applications. +
+With Apache OFBiz OOTB (Out Of The Box) you will find the main application (the <<CORE_APPLICATION_COMPONENTS, Core Application>>)
+and with OFBIZ plugins you can find application more business specifics.
+. **technicaly** , an application is a part of <<COMPONENT, Component>> beginning with the ~webapp directory. +
+A single component may contain several applications each mounted on a unique URL.
+Within each component, the "ofbiz-component.xml" file defines the available applications and how those applications shall be mounted on URLs.
+
+[#COMPONENT]
+Component::
+. **for end users** , an OFBiz component, is an <<APPLICATION, application>> or a group of <<APPLICATION, applications>>. +
+Knowing which component is used by a application can be useful for "key users" to be able to set application parameters or modify configuration files.
+. **technically** , An OFBiz component is a directory used by the OFBiz framework to specify and load application server resources necessary to execute an OFBiz instance. +
+Each OFBiz component must have a unique name (typically the name of the root directory for the component) and
+a configuration file called: "ofbiz-component.xml". +
+Component resources may include, but are not limited to:
+* webapps,
+* Java source/classes,
+* classpath resources,
+* scripts, entity definitions,
+* entity data files,
+* service definitions,
+* service and entity ECA rules,
+* test suites,
+* encryption keystores.
+
+A component contains applications and/or the lower level tools and definitions needed by applications. +
+A component can be used for self-contained extensions, including applications and logic/data modifications,
+to the suite of tools and applications that come with OFBiz. +
+For more detail look at developer-manual.
+
+[#CORE_APPLICATION_COMPONENTS]
+core application components:: The core applications in Apache OFBiz are web applications that serve common
+business needs found in most enterprises. +
+They are included in the ofbiz-framework and each one has one (or more) menu entry. +
+Currently there are :
+* <<_accounting>>, +
+  menu entries: Accounting, Accounting-AP, Accounting-AR
+* Product management, to manage products, prices, promotion rules, categories, catalogs, stores and more. +
+  menu entry: Catalog
+* Content management,
+* Wharehouse management, to manage facilities, inventory, physical inventory, in and out shipment, and more. +
+  menu entry: Facility
+* <<_human_resources>> management, +
+  menu entry: HR
+* Manufacturing management: Materials Resource Planning, define production schemas and tasks, Bill of Materials, Equipment allocation,
+Workers assignment, Job Shop
+* Marketing management: Marketing Communications Management and Sales Force Automation +
+  menu entry: Marketing, SFA
+* Order management: Fully featured sales and purchase order management module, including
+  ** request
+  ** requirements
+  ** quote
+  ** order
+  ** statistics
+* Party management, enables organizations to maintain parties (human and other legal entities), their roles and user accounts, and lots more.
+* Work Effort Management, to manage work efforts, tasks, calendar, maintenance assignments and more.
+
+With these core applications multiple others can be build. In ofbiz-plugin you can find some.
+
+[#DEMO_DATA]
+Demo Data:: Demo data are loaded with the command `gradlew loadAll` or `gradlew "ofbiz --load-data readers=dDemo"` +
+ +
+Demo data are present to help understanding ofbiz application process, most of the time it's only the minimum of data,
+For a correct understanding, it's necessary to create more data to have a full functionnal OFBiz.
+
+
+[#ENTITY]
+Entity:: An entity represents an important business concept that is stored as a record in the database.
+It is used in the document and OFBiz to generalize about the behavior of persistent information.
+For example employees and employments are important business concepts for HR application, stored in the database.
+We could refer to an action directly on a particular entity by saying "Create a new employee" or "Create a new employment".
+We could alternately describe a general create action by saying "Create a new entity".
+
+[#ENTITY_DATA_MAINTENANCE]
+Entity Data Maintenance:: It's a sub-application of WebTool application, it's necessary to have specifics authorization
+to access it.  +
+Use Entity Data Maintenance to search, look, create, update and delete entities data, most of time it's really not the good solution
+to use it for other think that only looking data. +
+Exceptions are
+
+. when there was a bug and it's necessary to manually do a data correction
+. manage entities, which have'nt a user interface, main example are for StatusType, Enumeration, but there are some
+type entities, like BenefitType for HR. +
+
+[NOTE]
+For creation, as Primary keys must be entered manually apply the ID general advice. +
+In ID only standard characters and without space are authorized. ID length must be less than 20 characters. +
+Generally manual primary keys are all upper case with underscores between words and are a meaningful mnemonic i.e.
+A_PRIMARY_KEY.
diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc
index 3ddf0f4..a77d70e 100644
--- a/docs/asciidoc/user-manual.adoc
+++ b/docs/asciidoc/user-manual.adoc
@@ -121,12 +121,12 @@ update, delete, search, and do many other operations on the data model.
 
 ==== Core Applications
 
-The core applications in Apache OFBiz are web applications that serve common
+The <<CORE_APPLICATION_COMPONENTS,core applications>> in Apache OFBiz are web applications that serve common
 business needs found in most enterprises such as accounting, order management,
 party management and so on.
 
 These core applications are built on top of the data model and service library
-earlier described. The core applications are further described in the relevant
+earlier described. The <<CORE_APPLICATION_COMPONENTS,core applications>> are further described in the relevant
 section.
 
 ==== Plugins
@@ -183,4 +183,6 @@ The Webtools application is the UI-gateway to all the framework functions.
 include::../../framework/webtools/src/docs/asciidoc/_include/webtools-main.adoc[leveloffset=+3]
 // Plugins Business Applications
 
-include::../../plugins/docs/asciidoc/plugins-user-manual.adoc[leveloffset=+1]
\ No newline at end of file
+include::../../plugins/docs/asciidoc/plugins-user-manual.adoc[leveloffset=+1]
+
+include::_include/ofbiz-glossary.adoc[leveloffset=+1]