svn commit: r1847248 [1/3] - in /ofbiz/ofbiz-framework/branche
Locked
svn commit: r1847248 [1/3] - in /ofbiz/ofbiz-framework/branche
 
|
Author: jleroux
Date: Fri Nov 23 12:00:10 2018 New Revision: 1847248 URL: http://svn.apache.org/viewvc?rev=1847248&view=rev Log: Documented: Backport the Asciidoc documentation and means to generate it to R17 branch (OFBIZ-10657) As discussed in https://markmail.org/message/x7sv2mpvtytr4vl4 we decided to backport the Asciidoc documentation, and means to generate it, to R17 branch This is related with OFBIZ-10651 and OFBIZ-10652 tasks. So 2 parts are impacted: code in framework and plusing and Buildbot script. It's only a copy from the trunk to the R17 branch, including *.adoc files, related images and the build.gradle script. Added: ofbiz/ofbiz-framework/branches/release17.12/README.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/ ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/ ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/ ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-financial-accounts.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-global-settings.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-intro.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/accounting.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-performance-review.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/humanres.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/docs/ ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/ ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/developer-manual.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/documentation_guidelines.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/ ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/OFBiz-Logo-250w.png (with props) ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/OFBiz-Logo.svg ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/images/ofbiz-architecture.png (with props) ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/ ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/article.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/resource/source.java (with props) ofbiz/ofbiz-framework/branches/release17.12/docs/asciidoc/user-manual.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/framework/security/src/docs/ ofbiz/ofbiz-framework/branches/release17.12/framework/security/src/docs/asciidoc/ ofbiz/ofbiz-framework/branches/release17.12/framework/security/src/docs/asciidoc/_include/ ofbiz/ofbiz-framework/branches/release17.12/framework/security/src/docs/asciidoc/_include/security-impersonation.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/framework/security/src/docs/asciidoc/security.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/framework/webapp/src/docs/ ofbiz/ofbiz-framework/branches/release17.12/framework/webapp/src/docs/asciidoc/ ofbiz/ofbiz-framework/branches/release17.12/framework/webapp/src/docs/asciidoc/_include/ ofbiz/ofbiz-framework/branches/release17.12/framework/webapp/src/docs/asciidoc/_include/wa-cross-domains-SSO.adoc (with props) ofbiz/ofbiz-framework/branches/release17.12/framework/webapp/src/docs/asciidoc/webapp.adoc (with props) Modified: ofbiz/ofbiz-framework/branches/release17.12/build.gradle Added: ofbiz/ofbiz-framework/branches/release17.12/README.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/README.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/README.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/README.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,829 @@ +//// +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. +//// +[[apache-ofbiz]] += Apache OFBiz® + +Welcome to *Apache OFBiz*! A powerful top level Apache software project. OFBiz +is an Enterprise Resource Planning (ERP) System written in Java and houses a +large set of libraries, entities, services and features to run all aspects of +your business. + +For more details about OFBiz please visit the OFBiz Documentation page: + +http://ofbiz.apache.org/documentation.html[OFBiz documentation] + +http://www.apache.org/licenses/LICENSE-2.0[OFBiz License] + +____________________________________________________________________________________________________ +_Note_: If you want to use Eclipse, read the "Setup eclipse project for OFBiz" +section to set it up. +____________________________________________________________________________________________________ + +_____________________________________________________________________________________________________________________________________ +_Note_: If you want to use an external database like MySQL or PostgreSQL, read +the "Setup an external database" section to set it up. +_____________________________________________________________________________________________________________________________________ + +________________________________________________________________________________________________________________________________________ +_Note_: If you want to run OFBiz without an internet connection, read the +"Running gradle tasks without an internet connection" section. +________________________________________________________________________________________________________________________________________ + +__________________________________________________________________________________________________________________________________________ +_Note_: The directory structure and repositories have changed. For more +information read the "Repository and directory structure" section. +__________________________________________________________________________________________________________________________________________ + +[[system-requirements]] +== System requirements + +The only requirement to run OFBiz is to have the Java Development Kit (JDK) +version 8 installed on your system (not just the JRE, but the full JDK) which +you can download from the below link. Make sure of setting the $JAVA_HOME +environment variable. + +http://www.oracle.com/technetwork/java/javase/downloads/index.html[JDK download] + +[[quick-start]] +// tag::quickstart[] +== Quick start + +To quickly install and fire-up OFBiz, please follow the below instructions from +the command line at the OFBiz top level directory (folder). + +[[prepare-ofbiz]] +=== Prepare OFBiz: + +_________________________________________________________________________________________________________________________________________________________________________________________________________________ +_Note_: Depending on your Internet connection speed it might take a long time +for this step to complete if you are using OFBiz for the first time as it needs +to download all dependencies. So please be patient! +_________________________________________________________________________________________________________________________________________________________________________________________________________________ + +MS Windows: `gradlew cleanAll loadAll` + +Unix-like OS: `./gradlew cleanAll loadAll` + +[[start-ofbiz]] +=== Start OFBiz: + +MS Windows: `gradlew ofbiz` + +Unix-like OS: `./gradlew ofbiz` + +___________________________________________________________________________________________________ +_Note_: Ignore the % progress indicator because this task does not end as long +as OFBiz is running. +___________________________________________________________________________________________________ + +[[visit-ofbiz-through-your-browser]] +=== Visit OFBiz through your browser: + +https://localhost:8443/ordermgr[Order Back Office] + +https://localhost:8443/accounting[Accounting Back Office] + +https://localhost:8443/webtools[Administrator interface] + +You can log in with the user *admin* and password *ofbiz*. + +// end::quickstart[] + +[NOTE] +In case of problems visit our link:#further-reading[Further reading section]. + +[[security]] +== Security + +If you find a security issue, please report it to: security @ ofbiz.apache.org. +Once proper mitigations to the security issues are complete the OFBiz team will +disclose this information to the public mailing list. + +You can find more information about security in OFBiz at +https://cwiki.apache.org/confluence/display/OFBIZ/Keeping+OFBiz+secure[Keeping +OFBiz secure] + +[[build-system-syntax]] +== Build system syntax + +All build tasks are executed using the *Gradle* build system which is embedded +in OFBiz. To execute build tasks go to OFBiz top-level directory (folder) and +execute tasks from there. + +[[operating-system-syntax]] +=== Operating System Syntax + +The syntax for tasks differ slightly between windows and Unix-like systems + +* *Windows*: `gradlew <tasks-in-here>` +* *Unix-like*: `./gradlew <tasks-in-here>` + +For the rest of this document, we will use the windows syntax, if you are on a +Unix-like system, you need to add the `./` to gradlew + +[[types-of-tasks-in-gradle]] +=== Types of tasks in Gradle + +There are two types of tasks designed for OFBiz in Gradle: + +* *Standard tasks*: To execute general standard Gradle tasks +* *OFBiz server tasks*: To execute OFBiz startup commands. These tasks start +with one of the following words: +* *ofbiz* : standard server commands +* *ofbizDebug* : server commands running in remote debug mode +* *ofbizBackground* ; server commands running in a background forked process + +Tips: + +* OFBiz *server commands* require *"quoting"* the commands. For example: +`gradlew "ofbiz --help"` +* Shortcuts to task names can be used by writing the first letter of every word +in a task name. However, you cannot use the shortcut form for OFBiz server +tasks. Example: `gradlew loadAdminUserLogin -PuserLoginId=myadmin` = +`gradlew lAUL -PuserLoginId=myadmin` +* Dependent tasks can be skipped with the -x switch. Example: +`gradlew build -x test` does not run the tests within the build. + +[[example-standard-tasks]] +==== Example standard tasks + +`gradlew build` + +`gradlew cleanAll loadAll testIntegration` + +[[example-ofbiz-server-tasks]] +==== Example OFBiz server tasks + +`gradlew "ofbiz --help"` + +`gradlew "ofbizDebug --test"` + +`gradlew "ofbizBackground --start --portoffset 10000"` + +`gradlew "ofbiz --shutdown --portoffset 10000"` + +`gradlew ofbiz` (default is --start) + +[[example-mixed-tasks-standard-and-ofbiz-server]] +==== Example mixed tasks (standard and OFBiz server) + +`gradlew cleanAll loadAll "ofbiz --start --portoffset 10000"` + + + +[[quick-reference]] +== Quick reference + +You can use the below common list of tasks as a quick reference for controlling +the system. This document uses the windows task syntax, if you are on a +Unix-like system, you need to add the `./` to gradlew i.e. `./gradlew` + + + +[[help-tasks]] +=== Help tasks + +[[list-ofbiz-server-commands]] +==== List OFBiz server commands + +List all available commands to control the OFBiz server + +`gradlew "ofbiz --help"` + +[[list-build-tasks]] +==== List build tasks + +List all available tasks from the build system + +`gradlew tasks` + +[[list-build-projects]] +==== List build projects + +List all available projects in the build system + +`gradlew projects` + +[[gradle-build-system-help]] +==== Gradle build system help + +Show usage and options for the Gradle build system + +`gradlew --help` + + + +[[server-command-tasks]] +=== Server command tasks + +[[start-ofbiz-1]] +==== Start OFBiz + +`gradlew "ofbiz --start"` + +start is the default server task so this also works: + +`gradlew ofbiz` + +[[shutdown-ofbiz]] +==== Shutdown OFBiz + +`gradlew "ofbiz --shutdown"` + +[[get-ofbiz-status]] +==== Get OFBiz status + +`gradlew "ofbiz --status"` + +[[force-ofbiz-shutdown]] +==== Force OFBiz shutdown + +Terminate all running OFBiz server instances by calling the appropriate +operating system kill command. Use this command to force OFBiz termination if +the --shutdown command does not work. Usually this is needed when in the middle +of data loading or testing in OFBiz. + +Warning: Be careful in using this command as force termination might lead to +inconsistent state / data + +`gradlew terminateOfbiz` + +[[start-ofbiz-in-remote-debug-mode]] +==== Start OFBiz in remote debug mode + +Starts OFBiz in remote debug mode and waits for debugger or IDEs to connect on +port *5005* + +`gradlew "ofbizDebug --start"` + +OR + +`gradlew ofbizDebug` + +[[start-ofbiz-on-a-different-port]] +==== Start OFBiz on a different port + +Start OFBiz of the network port offsetted by the range provided in the argument +to --portoffset + +`gradlew "ofbiz --start --portoffset 10000"` + +[[start-ofbiz-in-the-background]] +==== Start OFBiz in the background + +Start OFBiz in the background by forking it to a new process and redirecting the +output to *runtime/logs/console.log* + +`gradlew "ofbizBackground --start"` + +OR + +`gradlew ofbizBackground` + +You can also offset the port, for example: + +`gradlew "ofbizBackground --start --portoffset 10000"` + +[[passing-jvm-runtime-options-to-ofbiz]] +==== Passing JVM runtime options to OFBiz + +You can pass JVM runtime options by specifying the project property `-PjvmArgs`. + +`gradlew ofbiz -PjvmArgs="-Xms1024M -Xmx2048M" -Dsome.parameter=hello` + +If you do not specify `jvmArgs`, a default of `-Xms128M -Xmx1024M` is set. + + + +[[data-loading-tasks]] +=== Data loading tasks + +OFBiz contains the following data reader types: + +* *seed*: OFBiz and External Seed Data - to be maintained along with source and +updated whenever a system deployment is updated +* *seed-initial*: OFBiz and External Seed Data - to be maintained along with +source like other seed data, but only loaded initially and not updated when a +system is updated except manually reviewing each line +* *demo*: OFBiz Only Demo Data +* *ext*: External General Data (custom) +* *ext-test*: External Test Data (custom) +* *ext-demo*: External Demo Data (custom) +* *tenant*: Data to load into the master tenants database "ofbiztenant". This +data is required to identify where a tenant's database is located. For more +information you can review the relevant +https://cwiki.apache.org/confluence/display/OFBIZ/Multitenancy+support[tenant +documentation] + +Available options for the --load-data server command are the following: + +* *readers=[name]*: only load data from certain readers separated by comma. e.g. +seed,seed-initial,ext +* *file=[path]*: load a single file from location or several files separated by +commas. e.g. /my/file/1,/my/file/2 +* *dir=[path]*: load all data files found in directory +* *component=[name]*: only load data from a specific component. e.g. base +* *delegator=[name]*: use the defined delegator. Default is "default". If the +value passed is *"all-tenants"* then OFBiz will load the data for all defined +tenants in the system. +* *group=[name]*: override the entity group (org.apache.ofbiz). e.g. +com.example.something +* *timeout=[millis]*: timeout in milliseconds +* *create-pks*: create primary keys +* *drop-pks*: drop primary keys +* *create-constraints*: create indexes and foreign keys after loading +* *drop-constraints*: drop indexes and foreign keys before loading +* *create-fks*: create dummy (placeholder) foreign keys +* *maintain-txs*: maintain timestamps in data file +* *try-inserts*: use mostly inserts +* *repair-columns*: repair column sizes (default is true w/ drop-constraints) +* *continue-on-failure*: By default OFBiz will fail and stop if it is unable to +load any of the files it is attempting to load. By passing this property OFBiz +will ignore failures and continue loading all files + +[[load-specific-ofbiz-data]] +==== Load specific OFBiz data + +you can choose which data readers to pass in the following syntax: + +`gradlew "ofbiz --load-data readers=<readers-here-comma-separated>"` + +Example: + +`gradlew "ofbiz --load-data readers=seed,seed-initial,ext,ext-demo"` + + Beware that copying this command in Microsoft Word will automatically transform +the double dash in en dashes (Unicode 0x2013: â) Other cases not related to Word +were also reported.So when this command does not work check that you are using +dash! text + +[[load-all-ofbiz-data]] +==== Load all OFBiz data + +Loads all data sets; meant for initial loading of generic OFBiz data. Can be +applied for development, testing, demonstration, etc. purposes. Be aware that +executing this task can result in your data being overwritten in your database +of choice. Use with caution in production environments. + +`gradlew loadAll` + +OR + +`gradlew "ofbiz --load-data"` + +[[load-seed-data]] +==== Load seed data + +Load ONLY the seed data (not seed-initial, demo, ext* or anything else); meant +for use after an update of the code to reload the seed data as it is generally +maintained along with the code and needs to be in sync for operation + +`gradlew "ofbiz --load-data readers=seed"` + +[[load-ext-data]] +==== load ext data + +Load seed, seed-initial and ext data; meant for manual/generic testing, +development, or going into production with a derived system based on stock OFBiz +where the ext data basically replaces the demo data + +`gradlew "ofbiz --load-data readers=seed,seed-initial,ext"` + +[[load-ext-test-data]] +==== load ext test data + +Load seed, seed-initial, ext and ext-test data; meant for automated testing with +a derived system based on stock OFBiz + +`gradlew "ofbiz --load-data readers=seed,seed-initial,ext,ext-test"` + +[[load-data-from-an-entity-file]] +==== load data from an entity file + +Load data from an XML file holding entity data. + +`gradlew "ofbiz --load-data file=foo/bar/FileNameHere.xml"` + +[[create-a-new-tenant]] +==== create a new tenant + +Create a new tenant in your environment, create the delegator, load initial data +with admin-user and password (needs multitenant=Y in general.properties). The +following project parameters are passed: + +* tenantId: mandatory +* tenantName: optional, default is value of tenantId +* domainName: optional, default is org.apache.ofbiz +* tenantReaders: optional, default value is seed,seed-initial,demo +* dbPlatform: optional, D(Derby), M(MySQL), O(Oracle), P(PostgreSQL) (default D) +* dbIp: optional, ip address of the database +* dbUser: optional, username of the database +* dbPassword: optional, password of the database + +`gradlew createTenant -PtenantId=mytenant` + +`gradlew createTenant -PtenantId=mytenant -PtenantName="My Name" -PdomainName=com.example -PtenantReaders=seed,seed-initial,ext -PdbPlatform=M -PdbIp=127.0.0.1 -PdbUser=mydbuser -PdbPassword=mydbpass` + +If run successfully, the system creates a new tenant having: + +* delegator: default#$\{tenandId} (e.g. default#mytenant) +* admin user: $\{tenantId}-admin (e.g. mytenant-admin) +* admin user password: ofbiz + +[[load-data-for-a-specific-tenant]] +==== load data for a specific tenant + +Load data for one specific tenant in a multitenant environment. Note that you +must set multitenant=Y in general.properties and the following project +parameters are passed: + +* tenantId (mandatory) +* tenantReaders (optional) +* tenantComponent (optional) + +`gradlew loadTenant -PtenantId=mytenant` + +`gradlew loadTenant -PtenantId=mytenant -PtenantReaders=seed,seed-initial,demo -PtenantComponent=base` + + + +[[testing-tasks]] +=== Testing tasks + +[[execute-all-unit-tests]] +==== Execute all unit tests + +`gradlew test` + +[[execute-all-integration-tests]] +==== Execute all integration tests + +`gradlew testIntegration` + +OR + +`gradlew 'ofbiz --test'` + +[[execute-integration-tests-with-a-different-log-level]] +==== Execute integration tests with a different log level + +It is possible to start integration tests with a log level different from the +default one. The log levels allowed are listed below from most verbose to least +verbose: + +* always +* verbose +* timing +* info +* important +* warning +* error +* fatal + +`gradlew "ofbiz --test loglevel=fatal"` + +[[execute-an-integration-test-case]] +==== Execute an integration test case + +run a test case, in this example the component is "entity" and the case name is +"entity-tests" + +`gradlew "ofbiz --test component=entity --test suitename=entitytests --test case=entity-query-tests"` + +[[execute-an-integration-test-case-in-debug-mode-with-verbose-log]] +==== Execute an integration test case in debug mode with verbose log + +listens on port *5005* + +`gradlew "ofbizDebug --test component=entity --test loglevel=verbose"` + +[[execute-an-integration-test-suite]] +==== Execute an integration test suite + +`gradlew "ofbiz --test component=entity --test suitename=entitytests"` + +[[execute-an-integration-test-suite-in-debug-mode]] +==== Execute an integration test suite in debug mode + +listens on port *5005* + +`gradlew "ofbizDebug --test component=entity --test suitename=entitytests"` + + + +[[miscellaneous-tasks]] +=== Miscellaneous tasks + +[[run-all-tests-on-a-clean-system]] +==== Run all tests on a clean system + +`gradlew cleanAll loadAll testIntegration` + +[[clean-all-generated-artifacts]] +==== Clean all generated artifacts + +`gradlew cleanAll` + +[[refresh-the-generated-artifacts]] +==== Refresh the generated artifacts + +`gradlew clean build` + +[[create-an-admin-user-account]] +==== Create an admin user account + +Create an admin user with login name MyUserName and default password with value +"ofbiz". Upon first login OFBiz will request changing the default password + +`gradlew loadAdminUserLogin -PuserLoginId=MyUserName` + +[[compile-java-using-xlint-output]] +==== Compile Java using Xlint output + +Xlint prints output of all warnings detected by the compiler + +`gradlew -PXlint build` + +[[run-owasp-tool-to-identify-dependency-vulnerabilities-cves]] +==== Run OWASP tool to identify dependency vulnerabilities (CVEs) + +The below command activates a gradle plugin (OWASP) and Identifies and reports +known vulnerabilities (CVEs) in OFBiz library dependencies. The task takes time +to complete, and once done, a report will be generated in +$OFBIZ_HOME/build/reports/dependency-check-report.html + +`gradlew -PenableOwasp dependencyCheckAnalyze` + +[[setup-eclipse-project-for-ofbiz]] +==== Setup eclipse project for OFBiz + +Setting up OFBiz on eclipse is done by simply running the below command and then +importing the project to eclipse. This command will generate the necessary +*.classpath* and *.project* files for eclipse and it will also make the source +code for external libraries available in eclipse (i.e. you can view source +through Ctrl + Click) + +The first time you run this command it will take a long time to execute because +it will download source packages available for project dependencies. + +`gradlew eclipse` + + + +[[ofbiz-plugin-system]] +== OFBiz plugin system + +OFBiz provides an extension mechanism through plugins. Plugins are standard +OFBiz components that reside in the plugins directory. Plugins can be added +manually or fetched from a maven repository. The standard tasks for managing +plugins are listed below. + +__________________________________________________________________________________ +_Note_: OFBiz plugin versions follow http://semver.org/[Semantic Versioning +2.0.0] +__________________________________________________________________________________ + +[[pull-download-and-install-a-plugin-automatically]] +=== Pull (download and install) a plugin automatically + +Download a plugin with all its dependencies (plugins) and install them +one-by-one starting with the dependencies and ending with the plugin itself. + +`gradlew pullPlugin -PdependencyId="org.apache.ofbiz.plugin:myplugin:0.1.0"` + +If the plugin resides in a custom maven repository (not jcenter or localhost) +then you can use specify the repository using below command: + +`gradlew pullPlugin -PrepoUrl="http://www.example.com/custom-maven" -PdependencyId="org.apache.ofbiz.plugin:myplugin:0.1.0"` + +If you need username and password to access the custom repository: + +`gradlew pullPlugin -PrepoUrl="http://www.example.com/custom-maven" -PrepoUser=myuser -PrepoPassword=mypassword -PdependencyId="org.apache.ofbiz.plugin:myplugin:0.1.0"` + +[[pull-an-official-plugin-from-source-control]] +=== Pull an official plugin from source control + +Download an official plugin from source control (currently subversion) and place +it in the plugins directory. In addition, this task also executes the "install" +task if it is defined for the plugin being downloaded. + +This task is mostly useful when working on the trunk branch as it pulls in the +latest version of a plugin. + +`gradlew pullPluginSource -PpluginId=ecommerce` + +________________________________________________________________________________________ +_Note_: This plugin will have its own .svn directory placed inside the plugin +directory. +________________________________________________________________________________________ + +[[pull-all-official-plugins-from-source-control]] +=== Pull all official plugins from source control + +Download all officially supported plugins from source control (currently +subversion) and place them inclusive of their ".svn" directory in /plugins. +WARNING! This task deletes the /plugins directory and replaces it with the +official plugins. + +`gradlew pullAllPluginsSource` + +This task makes it easy to download and develop officially supported plugins. It +is mostly used by developers or individuals working on the trunk branch. We do +not recommend using this task on releases of OFBiz, instead consider using the +"pullPlugin" task to get the correct version of a plugin compatible with your +release. + +____________________________________________________________________________________ +_Note_: All the plugins will share a .svn directory placed in the plugins +directory. +____________________________________________________________________________________ + +[[install-a-plugin]] +=== Install a plugin + +If you have a plugin called mycustomplugin and want to install it in OFBiz +follow the below instructions: + +* Extract the plugin if it is compressed +* Place the extracted directory into /plugins +* Run the below command + +`gradlew installPlugin -PpluginId=myplugin` + +The above commands executes the task "install" in the plugin's build.gradle file +if it exists + +[[uninstall-a-plugin]] +=== Uninstall a plugin + +If you have an existing plugin called mycustomplugin and you wish to uninstall +run the below command + +`gradlew uninstallPlugin -PpluginId=myplugin` + +The above command executes the task "uninstall" in the plugin's build.gradle +file if it exists + +[[remove-a-plugin]] +=== Remove a plugin + +Calls *uninstallPlugin* on an existing plugin and then delete it from the +file-system + +`gradlew removePlugin -PpluginId=myplugin` + +[[create-a-new-plugin]] +=== Create a new plugin + +Create a new plugin. The following project parameters are passed: + +* pluginId: mandatory +* pluginResourceName: optional, default is the Capitalized value of pluginId +* webappName: optional, default is the value of pluginId +* basePermission: optional, default is the UPPERCASE value of pluginId + +`gradlew createPlugin -PpluginId=myplugin` + +`gradlew createPlugin -PpluginId=myplugin -PpluginResourceName=MyPlugin -PwebappName=mypluginweb -PbasePermission=MYSECURITY` + +The above command creates a new plugin in /plugins/myplugin + +[[push-a-plugin-to-a-repository]] +=== Push a plugin to a repository + +This task publishes an OFBiz plugin into a maven package and then uploads it to +a maven repository. Currently, pushing is limited to localhost maven repository +(work in progress). To push a plugin the following parameters are passed: + +* pluginId: mandatory +* groupId: optional, defaults to org.apache.ofbiz.plugin +* pluginVersion: optional, defaults to 0.1.0-SNAPSHOT +* pluginDescription: optional, defaults to "Publication of OFBiz plugin +$\{pluginId}" + +`gradlew pushPlugin -PpluginId=myplugin` + +`gradlew pushPlugin -PpluginId=mycompany -PpluginGroup=com.mycompany.ofbiz.plugin -PpluginVersion=1.2.3 -PpluginDescription="Introduce special functionality X"` + +[[miscellaneous-documentation]] +== Miscellaneous Documentation + +[[further-reading]] +=== Further reading + +* https://cwiki.apache.org/confluence/display/OFBIZ/FAQ+-+Tips+-+Tricks+-+Cookbook+-+HowTo#FAQ-Tips-Tricks-Cookbook-HowTo-Knownissues[Known +issues] + +[[repository-and-directory-structure]] +=== Repository and directory structure + +OFBiz is split into two repositories: + +* *ofbiz-framework*: Contains the core framework and main applications in the +system like accounting, party, order, etc +* *ofbiz-plugins*: Renamed from "special-purpose" and contains optional +components that are officially supported by the community + +Furthermore, the hot-deploy directory is removed as the plugins directory works +as a replacement for both "special-purpose" and "hot-deploy". + +If you need to load the components in the plugins directory in a specific order +place a component-load.xml file in the plugins directory listing the order. + +To check out a plugin from source control use the *pullPluginSource* Gradle +task. To check out all plugins from source control use the +*pullAllPluginsSource*. *Beware* this deletes a previously existing plugins +directory. + +[[running-gradle-tasks-without-an-internet-connection]] +=== Running gradle tasks without an internet connection + +OFBiz must run with an internet connection the *first time* it is prepared on +the system because it needs to download all the required dependencies. + +After preparing OFBiz the first time correctly, it is possible to run OFBiz +without an internet connection by using the `--offline` command line switch +which tells Gradle to fetch its dependencies from the cache. + +If any dependencies are missing from the cache and you pass `--offline` switch +then the build execution will fail. + +[[setup-an-external-database-like-mysql-postgresql-etc]] +=== Setup an external database like MySQL, PostgreSQL, etc + +To setup an external database instead of the default embedded Apache Derby, you +will need to follow the following instructions: + +1. Find the JDBC driver suitable for your database using one of the following +options: + +* Search for the JDBC driver in https://bintray.com/bintray/jcenter[jcenter] and +place it in build.gradle dependencies e.g. +`runtime 'mysql:mysql-connector-java:5.1.36'` ++ +OR +* Download the JDBC driver jar and place it in $OFBIZ_HOME/lib or the lib +sub-directory of any component + +2. Modify the entityengine.xml file located in +$OFBIZ_HOME/framework/entity/config to switch the default database to the one +you selected. For more details you can read the relevant section in the +https://cwiki.apache.org/confluence/display/OFBIZ/Apache+OFBiz+Technical+Production+Setup+Guide[technical +setup guide] + +[[setup-gradle-tab-completion-on-unix-like-systems]] +=== Setup gradle tab-completion on Unix-like systems: + +To get tab completion (auto complete gradle commands by pressing tab) you can +download the script from the below link and place it in the appropriate location +for your system. + +https://edub.me/gradle-completion-bash[Gradle tab completion] + +For example, on debian based systems, you can use the following command: + +`sudo curl -L -s https://edub.me/gradle-completion-bash -o /etc/bash_completion.d/gradle-tab-completion.bash` + + +[[crypto-notice]] +== Crypto notice + +This distribution includes cryptographic software. The country in which you +currently reside may have restrictions on the import, possession, use, and/or +re-export to another country, of encryption software. BEFORE using any +encryption software, please check your country's laws, regulations and policies +concerning the import, possession, or use, and re-export of encryption software, +to see if this is permitted. See http://www.wassenaar.org/ for more information. + +The U.S. Government Department of Commerce, Bureau of Industry and Security +(BIS), has classified this software as Export Commodity Control Number (ECCN) +5D002.C.1, which includes information security software using or performing +cryptographic functions with asymmetric algorithms. The form and manner of this +Apache Software Foundation distribution makes it eligible for export under the +License Exception ENC Technology Software Unrestricted (TSU) exception (see the +BIS Export Administration Regulations, Section 740.13) for both object code and +source code. + +The following provides more details on the included cryptographic software: + +* Various classes in OFBiz, including DesCrypt, HashCrypt, and BlowFishCrypt use +libraries from the Sun Java JDK API including java.security.* and javax.crypto.* +(the JCE, Java Cryptography Extensions API) +* Other classes such as HttpClient and various related ones use the JSSE (Java +Secure Sockets Extension) API Propchange: ofbiz/ofbiz-framework/branches/release17.12/README.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/README.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/README.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,69 @@ +//// +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. +//// += Agreements + +An âagreementâ is a way of recording a business arrangement or contract that your +business makes with other companies or individuals. Some common examples of + agreements include Payment Terms (where you allow a customer up to 30 +days to pay you) or Prompt Payment Discounts (where you offer a reduction on the +amount owing if your customer pays you before a certain date) + +At the time of writing, OFBiz allows you to create the following type of agreements + + * Product + * Purchase + * Sales + * Employee + * Commission + * End User Licence + +The most common agreements you will use will be Sales Agreements (for your +Customers), Purchase Agreements (for your Suppliers) and Commission Agreements +(for your Sales Representatives). + +== Sales Agreement + +A âSales Agreementâ is an agreement between you and your customers. A customer +can also be another business. You can create a range of conditions for your +customer including giving them such as payment discounts or special payment terms +and credit limits. + +If you have installed OFBiz with the demo data then there are already examples +of Sales Agreements created for you. + +== Purchase Agreement + +A âPurchase Agreementâ is an agreement between your business and a supplier. You +may have negotiated special conditions such as delivery, volume pricing and +invoice terms. + +If you have installed OFBiz with the demo data then there are already examples +of Purchase Agreements created for you. + +== Commission Agreement + +A âCommission Agreementâ is an agreement that is used to calculate how much money +a Sales Representative will get when products they have promoted or marketed are +sold to customers. The rate paid to the Sales Representative is can be based on a +fixed or variable on a percentage of each sale they make. These amounts can be +quite small amounts so it can be easier to consolidate multiple commission +payments into one large payment that is paid monthly. + +If you have installed OFBiz with the demo data then there are already two example +Commission Agreements created for you. Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-financial-accounts.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-financial-accounts.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-financial-accounts.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-financial-accounts.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,75 @@ +//// +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. +//// += Financial Accounts + +A "Financial Account" is a tool (similar to bank account statement) that is used for monitoring monetary transactions. +Normally it will be linked to a party and the various transactions details (e.g. payments or receipts) will be shown as entries. + + +At the time of writing, OFBiz allows you to create the following type of financial accounts + + * Bank Account + * Credit Card Account + * Deposit Account + * Equity Line Account + * Gift Certificate + * Investment Account + * Loan Account + * Replenish Account + * Service Credit Account + * Store Credit Account + +== Bank Account + +A "Bank Account" is a financial account between a bank and their customer. +By default this type of financial account will post to 213500 CUSTOMER DEPOSIT ACCOUNTS. + +If you have installed OFBiz with the demo data then there are already examples +of Bank Accounts created for you. + +== Credit Card Account + +== Deposit Account + +A "Deposit Account" is a financial account which allows money to be deposited and withdrawn by the account holder. +By default this type of financial account will post to 213500 CUSTOMER DEPOSIT ACCOUNTS. + +== Equity Line Account + +== Gift Certificate + +A "Gift Certificate" is something that entitles the recipient to select merchandise up to a specified value from a store. It is usually presented as a gift. +By default this type of financial account will post to 213200 GIFT CERTIFICATES UNREDEEMED. + +== Investment Account + +An "Investment Account" is a financial account that contains deposits of funds and/or securities that are held at a at a bank, stock exchange or other financial Institution. +By default this type of financial account will post to 213500 CUSTOMER DEPOSIT ACCOUNTS. + +== Loan Account + +== Replenish Account + +== Service Credit Account + +== Store Credit Account + +A "Store Credit Account" is a financial account that is used to to maintain the refund amount +Specify the type (Billing Account or Financial Account) of Store Credit Account used for refund return. Default to Financial Account. + Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-financial-accounts.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-financial-accounts.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-financial-accounts.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-global-settings.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-global-settings.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-global-settings.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-global-settings.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,194 @@ +//// +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. +//// += Global General Ledger Settings + +The Global General Ledger Settings are master templates that we can use to setup +up our chart of accounts, default transactions or other settings that can be applied +across many OFBiz modules. + +We need settings at a global level because OFBiz is an integrated system so certain +areas like accounting are linked to many other modules. It also makes sense to have +a central place to setup things that will be used globally. + +At the time of writing, the following are available as part of the Global GL Settings: + + * Chart of Accounts - a comprehensive master template for a complete chart of +accounts. + * Custom Time Periods - a master list to display or setup financial periods + * Costs - a master list of any cost calculations to be used for assets or tasks + * Payment Method Type - a master list of the ways payments can be made (e.g. cash, +credit card etc) and the default accounts to be used for each + * Invoice Item Type - a master list of all the transaction line types that can +occur on any invoice and the default account to be used for each + * Rates - a list of rates (e.g. pay rates, overtime rates etc) that can be used +for billing work,tasks or as part of salary calculations + * Foreign Exchange Rates - a master list of exchange rates to be used and dates +they are valid + * GL Account Category - currently this is set to be a list of cost centres + * Cost Centers - a way to specify how to process percentage allocations between +cost centres for specific accounts + +== Master Template - Chart of Accounts + +If you load the demo data, then by default over 450 accounts are included as part +of the OFBiz global chart of accounts master template. + +To setup a chart of accounts in OFBiz simply means that we need to select the +accounts we want to use from the global chart of accounts master template. + +All general ledger accounts must exist in the global template before they can be + assigned to be used at the organisation level (e.g. Company) + +== Custom Time Periods + +Time periods are a defined period of time (usually a month, quarter or year) that +is used to group business transactions. It is a key part of any general accounting +setup. Time periods can be used for the definition of : + + * Company Financial Year + * Fiscal / Tax Periods (weeks, months, quarters) + * VAT / GST Periods + * Sales Periods + +== Costs + +A business is designed to be profi table. This means that you need to be able to +track all the costs involved in your business to ensure that you are not losing +money. + +Some example costs that you may want to setup and track are as follows: + + * Raw Materials Costs + * Labour Costs + * Rental Costs + * Electricity Costs + * Quality Assurance or Regulatory Costs + +=== Direct and Indirect Costs + +Costs can also be broken down into âDirectâ and âIndirectâ costs. +Direct costs are costs that are easily identifiable as directly related to what +you do to produce and sell to your customers. + +Indirect costs are costs that cannot easily be directly linked to what you on sell + to your customers. Included in this would be rent, electricity or general +administration costs. + +=== Fixed and variable Costs +Variable costs are those that rise and fall based on the amount product you produce +or sell. If you sell or produce a lot of products it will cost more than if you +produce a smaller amount. + +Fixed costs are ones that remain the same no matter how much is being produced or +sold. + +Before you can calculate costs you need to define a formula of how to do it and +in OFBiz this is called a âCost Component Calculationâ. + +== Payment Method Type + +A âPayment Methodâ is simply a way to define the ways in which payments can be made. +Examples include: + + * Cash + * Cheque + * Electronic Funds Transfer + * Billing Account + * Paypal + * Financial Account + * Gift Certificate + +Each payment method can be linked to a different General Ledger account in the +Chart of Accounts. By doing this OFBiz will be able to help us create an accounting +transaction based on how the payment wasmade. This is very useful if we want to +automate the creation of accounting transactions. + +== Invoice Item Types + +An âInvoice Item Typeâ is another way to describe the different type of individual +line items that appear on an invoice. For example an invoice is usually made up of: + + * A header - which contains details of the supplier, customer, invoice date etc + * Line items - which are the products, taxes, discounts etc on the invoice + * A footer - which summarises the totals, taxes and discounts + +Invoice item types can refer to any of these three areas on an invoice. They can +also be broken down into specific categories that allow us to classify or report +on the total or frequency of that type. + +Some examples of Invoice Item Types are: + + * Type of Product (Standard, Digital, Service) + * Shipping or Handling Charges + * Promotions (Discounted Products, Free Products) + * Discounts (Product Discount, Invoice Discount, Early Payment) + * Returned Items (Faulty, Replacement) + +OFBiz allows us to setup a code for each of the different line item types that can +appear on an invoice. We can then link each item type to a specific General Ledger +account. By doing this OFBiz will be able to help us create an accounting transactions +based on the item types that appear on the invoice. + +This is very useful if we want to automate the creation of accounting transactions. + +== Rates + +Rates are used to create a âpay rateâ or âcharge amountâ that can be used in the +calculation of a task, employee salary or a service that involves people. + +Rates are closely linked to the OFBiz Human Resources Manager application but are +also used across multiple OFBiz applications (Manufacturing, Asset Maintenance, +Project Tasks, Timesheet Entry etc) where person related work tasks are required. + +== Foreign Exchange Rates + +Foreign exchange rates are used to convert from one currency to another. A business +will usually want to work in one main currency (e.g. GBP) but will allow transactions +in other currencies (e.g. EUR, USD). These currencies will need to be converted +to the main currency in order to generate financial reports (e.g. Balance Sheet +or Income Statement) and most importantly to adhere to Tax Authority regulations. + +== GL Account Category + +A âGeneral Ledger Account Categoryâ (or GL Account Category) is a generic term to +describe the way you can segment or classify accounts. Categories can be setup and +then linked to the required accounts. + +Another way to think about it is that it is like adding an extra tag to an account +so that you can easily retrieve that account to do any additional reporting or +processing. + +In OFBiz at the time of writing, the GL Account Category has been used to implement +cost centre functionality for the Chart of Accounts. + +== Cost Centers + +A cost centre is an area or part of an organisation where costs (direct or indirect) + can be allocated . + +By default OFBiz will allocate and post 100% of any accounting value to the +specified General Ledger account. Setting up Cost Centres allows you to split the +amount across different areas using a percentage calculation. + +For example: You want to buy something that and three departments will +contribute to buying it. If the product costs $90 then each department will pay +$30 towards the cost. + +OFBiz will allow you to setup the percentage that each cost centre will contribute +so that you can view and track how much each department has contributed or spent. Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-global-settings.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-global-settings.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-global-settings.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-intro.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-intro.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-intro.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-intro.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,52 @@ +//// +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. +//// += About Accounting + +The Accounting system is organised according to generally accepted principles +such as double-entry accounting, a General Ledger with hierarchical accounts, +journals and posting of transactions and corresponding entries. + +The structure is primary based on the OMG GL standard and the work that was done +on an AR/AP extension of the OMG GL standard. This correlates well with other +standards such as ebXML and OAGIS. + +The Accounting entities are structured such that accounts for multiple +organisations can be managed. The multiple organisations could be multiple +companies, or departments or other organisations within a company. Each +organisation can have various GL Accounts associated with it so that it can +operate with its own subset of the Master Chart of Accounts. + +Each organisation can also have its own set of Journals for flexibility, even +though the use of Journals should be as minimal as possible in favour of allowing +the system to automatically create and post transactions based on business events +triggered by standard procedures and documents such as purchase and sales orders, +invoices, inventory transfers, payments, receipts, and so on. + +== Accounting Features + + * General Ledger + * Accounts Receivable + * Accounts Payable + * Agreements + * Multi-currency Support + * Billing Accounts + * Fixed Asset Accounting + +OFBiz accounting can be configured to handle multiple organisations including +an unlimited number of companies, subsidiaries and departments. Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-intro.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-intro.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/_include/acc-intro.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/accounting.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/accounting.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/accounting.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/accounting.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,35 @@ +//// +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. +//// += Accounting + +The OFBiz accounting system is a core application component and has most of the +modern features you would expect in a general purpose double-entry accounting +system. However, OFBiz goes beyond that by and seamlessly integrates with other +OFBiz applications such as Inventory, Purchasing and Manufacturing to give your +business a complete ERP solution. This makes the system as a whole robust and +integrated to provide more value than a plain accounting system. + + +include::_include/acc-intro.adoc[leveloffset=+1] + +include::_include/acc-agreements.adoc[leveloffset=+1] + +include::_include/acc-financial-accounts.adoc[leveloffset=+1] + +include::_include/acc-global-settings.adoc[leveloffset=+1] Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/accounting.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/accounting.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/accounting/src/docs/asciidoc/accounting.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,47 @@ +//// +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. +//// += Employee Positions + +An employee position is also called a job position. It is a role that has been +created to perform a specific task within the Company. This means that it has +approved funding to pay it. + +Employee positions are defined by: + +* the work description and responsibilities +* a pay structure (e.g. hourly wages, salary, contract etc) +* full-time or part-time +* the skills needed to fullfill the position + +NOTE: An employee positions is not the same as a person fullfilling the role. +A person fulfilling an employee position is called an employee + +An employee position can be fullfilled (i.e. someone is currently working in the +role) or it can be unfulfilled (i.e. a job vacancy). + +NOTE: In some cases an employee position could also be considered a full-time + equivalent (FTE) and can be assigned to more than one person (e.g. job sharing) + +In the OFBiz Human Resources application you can: + +* Create employee positions +* Fulfill employee positions +* Define the responsibilities of an employee position +* Define a tree reporting structure between employee positions +* Track employment position fulfillments over time Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,39 @@ +//// +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. +//// += Employees + +An employee is an individual that works for a company either full-time or +part-time under a formal employment contract. The company pays the employee +wages or salary. + +NOTE: Wages tend to be related to an hourly rate and can vary based on the hours +worked whereas salary is a flat rate generally paid monthly. + +The Employees feature manages information about people who have an employment +relationship with your Company or one of its departments. Details that can be +setup include an employee profile, a display of all employee related information +in a single screen and facilities for managing employee skills, qualifications, +training, leave and payroll history. + +In OFBiz Human Resources you can + +* Create a new employee +* Search for an existing employee +* View the full list of existing employees + Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,36 @@ +//// +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. +//// += Employments + +An employment is a relationship between a person and your Company. +The Human Resources application tracks employment benefits, pay history, +unemployment claims and employment agreements for each employed person. + +When you create new employee, an employee relationship is created automatically. + +NOTE: If a person was entered into the application by some other means then you +will have to create the employee relationship manually in the Party Manager application. + +The employment record includes the start and end date of the employment. +When the employment ends you include the type of termination and a reason. +For example, an employee may have been let go because of poor performance. +(In this case the 'type' could be 'fired and the reason could be 'poor performance') + +The Employments screen can be used to create an employment or search for existing +employments. Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,41 @@ +//// +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. +//// += Global HR Settings + +Global HR Settings are used to setup the basic reference data that is used +throughout the Human Resources application. Many of the screens contain fields +that have drop-down lists for selection and these drop-down list can be setup +here. + +TIP: You need to have 'administrator' or 'create privileges' to update any of +the Global HR Settings + + +== Skills Types + +A skill type is used to define a skill group. Your employees, contractors and +partners may have hundreds of different of skills so skill types allows you to +organise these skills so they are manageable. + +This is helpful for reporting on your companies skill inventory or searching for + resources with the skill types needed for a job. You can search for skills types +and assign skills to people and organisations in the Skills feature. + +TIP: You can manage the skills of an individual or an organisation in their + profile in Party Manager uisng the Party Skills feature. Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,170 @@ +//// +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 + +[#ANNUAL_REVENUE] +Annual Revenue:: +Annual revenue is the amount of revenue for a group that is reported in the Party +Group Information screenlet of the groups profile (visit Party Profile screen). + +[#BUDGET] +Budget:: +A budget is used to track spending in the company for a future period of time. +The company may have one or more budgets depending on the requirements i.e. Operating +Budget, Capital Budget. A budget has a status, type and is composed of budget line +items. + +[#EMPLOYEE] +Employee:: +An employee is a person who has an employment relationship with your Company. + +[#EMPLOYEE_POSITION_TYPE] +Employee Position Type:: +Employee Positions Type is a name that describes a position. Business Analyst, + Programmer and System Administrator are examples of position types in the OFBiz +demo data. You can define your own position types in Global HR Settings > Position +Types. + +[#EMPLOYMENT] +Employment:: +Employment defines the relationship between your Company and a person who is an + employee. The employment relationship tracks employee benefits preferences, pay +history, and unemployment claims and agreements. + +[#EXEMPT_FLAG] +Exempt Flag:: +The exempt flag can be used to indicate if an employee position is exempt or non-exempt + under the fair labor Standards Act (FLSA). + +[#FULFILLMENT] +Fulfillment:: +A fulfillment associates a person with a position. A person can fulfill more than + one position and a position can have more then one person. + +[#FULLTIME_FLAG] +Fulltime Flag:: +The fulltime flag can be used to indicate if an employee position is for a full +or part time position. + +[#HR_APP_MENU] +HR App Menu:: +The main menu that opens the high level features of the HR App i.e. Employees, +Employments, Employee Position etc. + +[#INTERNAL_ORGANIZATION] +Internal Organization:: +Internal organization is the name of a relationship between a party group and your +company. This relationship is used to filter party groups as being part of your +company to distinguish them from other groups which are external. For example your +marketing department is an internal organization while a suppliers sales department +is not. + +[#NUMBER_OF_EMPLOYEES] +Number of Employees:: +Number of employees that are reported in the Party Group Information screenlet of +the groups profile (Visit Party Profile screen). + +[#PARTY] +Party:: +Party is a term used to simplify collecting information that used in a common manner +by different people and things. The most common party types are people and groups. +Both people and groups have contact information. A party is identified by a unique +Party Id. Using this Id OFBiz can collect and find contact (and other information +and processes) for both people and groups in the same way. This is why you will +often see Party Id as a field in a form or a filter as you work in OFBiz. + +[#PARTY_ID] +Party Id:: +The unique identifier for a party. The Id is text so in some cases you will see +an Id, created by a user, that carries some meaning i.e. Party Id DemoEmployee. +In other cases the Id is created by OFBiz and is will be simply a number from a +sequence. In either case the Id is unique. + +[#Qualifications] +Qualifications:: +Qualifications for an individual person or organization are in the Employees Qualifications +menu item. To find and update the qualifications of people and organizations visit +Qualifications menu. + +[#PARTY_QUALIFICATION_TYPE] +Party Qualification Type:: +Party qualifications define a person or organizations accomplishments that indicate +their suitability to perform a job. Qualifications are organized into qualification +groups for the purpose of managing and reporting. + +[#PERSON] +Person:: +Person is a human being as distinguished from a party group which is an organization. +Human beings and organizations have different attributes i.e. People have first and +last names while groups have group names. Both person and party group are types + of parties and share information and processes common to parties. + +[#POSITION] +Position:: +A position is a job that can be filled by more then one person over time or at +the same time. Positions are defined by a type of work. For example there may +be 20 positions in an organization for a secretary. Each position is related to +a department in the organization. A position can me thought of as a full-time +equivalent employee (FTE). So an FTE may be assigned to one or more positions +and position can be assigned to more then one FTEs (job sharing). + +[#RATING] +Rating:: +Rating is a user defined numeric rating for a skill. (See Skills Menu) + +[#RESPONSIBILITY] +Responsibility:: +Responsibilities define duties assigned to a position. They are defined in +Responsibility Types and assigned in Employee Position Responsibilities. + +[#SALARY_FLAG] +Salary Flag:: +The salary flag can be used to indicate if an employee position is salaried or +paid hourly. + +[#SKILL] +Skill:: +Skill is some ability or knowledge possessed by a person or organization that is + needed to perform a job for the company. See Skills + +[#SKILL_LEVEL] +Skill Level:: +Skill level is a user defined numeric rating a skill. It is up to the user to +assign some meaning to the level. For example 1=Entry, 2=Intermediate, 3=Expert +(See Skills Menu). + +[#SKILL_GROUP] +Skill Group:: +Skill goup is a name that describes a collection of skills that have common +attributes (See Skills Menu). + +[#TEMPORARY_FLAG] +Temporary Flag:: +A temporary flag can be used to indicate if an employee position is permanent or +temporary. + +[#TERMINATION_REASON] +Termination Reason:: +The termination reason is a name describing the cause related to a termination +type e.g. Type: resigned for reason: found new job. + +[#TERMINATION_TYPE] +Termination Type:: +The termination type is a name for the kind of termination e.g. Resigned, fired, + retired, layoff. Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc?rev=1847248&view=auto ============================================================================== --- ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc (added) +++ ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc Fri Nov 23 12:00:10 2018 @@ -0,0 +1,130 @@ +//// +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. +//// += About Human Resources + +The people who work for your company are human capital and are its most important +asset. Selecting a software platform that increases the value of your companies human +capital and delivers benefits, services and opportunities to your workforce, is +critical to your companies success. +That platform must be able to accurately and reliability process worker transactions, +collect decision support information, and communicate between management, workers +and outside resources. + +The OFBiz Human Resource application (HR App) can provide a stable foundation for +building that platform. + += Human Resources Processes + +Human Resources Management can be divided into several distinct processes. + +* Job Planning and Definition +* Recruitment +* Candidate Selection and Hiring +* Employee Training and Development +* Employee Evaluation and Performance Management +* Employee Salary and Benefits + +== Job Planning and Definition + +Generally job positions are authorised by a budget and fulfilled by people. The + person fulfilling the position may be a permanent employee, a temporary employee +or a contractor. + +* Positions may be salary or hourly, fulltime or part time. +* Positions have responsibilities. +* Positions are defined by a type of work. + +For example there may be 20 job positions in an organization for a administrative +clerk. Each position is has a job definition and is authorised by a budget request +from a department in the organization. +A position can be unfulfilled. (i.e a it exists but no one is currently employed +to do it). +In some cases a position could also be considered a full-time equivalent (FTE) and +can be assigned to more than one person (e.g. job sharing) + +In the OFBiz Human Resources application you can: + +* Create positions +* Fulfill positions +* Define the responsibilities of a position +* Define a tree reporting structure between positions +* Track the positions fulfillments over time + +== Recruitment, Candidate Selection and Hiring + +Recruitment is about at attracting applicants that match the skills and experience + you are looking for in a particular job position. Candidates can apply and after +reviewing their details, those who are the best match in terms of qualifications +and experience are short listed for interview. The final step is deciding upon the + final candidate that you want to hire and the employment contract details that +are related to that. + +In the OFBiz Human Resouces application you can: + +* Create a Requisition for new job positions +* Create Internal Job Postings +* Apply for job positions +* Review Resumes / CVs +* Arrange and Grade Interviews + +== Employee Training and Development + +Training and professional development is important for an organisation because it +ensures that your employees have the knowledge they need to perform their work. +It can also help to fill any gaps in skills and improve their proficiency. + +In the OFBiz Human Resources application you can: + +* Define and create training courses +* Schedule courses on a global training calendar +* Make course available (or unavailable) for enrollment +* Review and approve requests from employees to attend + +== Performance Management and Employee Evaluation + +Evaluating and managing the performance of employees is another main Human Resources +function. Performance reviews can be created for an employee and used to evaluate +the work that they have done in a particular job position. Comments and ratings +can also be added. + +In the OFBiz Human Resources application you can: + +* Create a new Performance Review for an employee +* Add individual review items such as Attitude, Communication or Technical Skills +* Add ratings or comments to each item + +If an evaluation has gone well then the employee can be considered for promotion +to another job position, or can be given other benefits such as a salary increase. + +== Employee Salary and Benefits Administration + +Being able to manage employee salaries and associated benefits is a key part of +any Human Resources system. + +In the OFBiz Human Resources application you can: + +* Create Pay Grades +* Link Salary Steps within each Pay Grade +* Assign a Pay Grade and Salary Step to a Job Position filled by an Employee +* Manage employee holidays (leave) +* Manage associated benefits +* Calculate salaries and Generate Payslips + + + Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc ------------------------------------------------------------------------------ svn:keywords = Date Rev Author URL Id Propchange: ofbiz/ofbiz-framework/branches/release17.12/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc ------------------------------------------------------------------------------ svn:mime-type = text/plain |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |