You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by mb...@apache.org on 2020/02/25 20:28:14 UTC
[ofbiz-framework] branch trunk updated (8afb711 -> 13abd82)
This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a change to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git.
from 8afb711 Fixed: Fluent API Bug in getFieldList().
new 8d80909 Documented : Migrate Help to asciidoc and include in hr-intro.adoc (OFBIZ-10256)
new eddb5a7 Documented : Migrate Employee Help to asciidoc and include in hr-employees.adoc (OFBIZ-10260)
new 3d4d999 Documented : Migrate Employment Help to asciidoc and include in hr-employment.adoc (OFBIZ-10261)
new 97d15cb Documented : Migrate Employee-position Help to asciidoc and include in hr-employee-positions.adoc (OFBIZ-10259)
new f0e4db0 Documented : Migrate Training Howto Help to asciidoc and include in hr-training.adoc (OFBIZ-10268)
new 13abd82 Documented : just remove trailing space (OFBIZ-10251)
The 6 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
applications/humanres/data/helpdata/HELP_HR.xml | 65 -----------
.../data/helpdata/HELP_HR_EditEmplPosition.xml | 107 -----------------
.../data/helpdata/HELP_HR_EditEmployeeLeaves.xml | 38 ------
.../data/helpdata/HELP_HR_EditEmployeeQuals.xml | 29 -----
.../data/helpdata/HELP_HR_EditEmployeeSkills.xml | 33 ------
.../helpdata/HELP_HR_EditEmployeeTrainings.xml | 33 ------
.../data/helpdata/HELP_HR_EditEmployment.xml | 37 ------
.../data/helpdata/HELP_HR_EmplPositionView.xml | 27 -----
.../data/helpdata/HELP_HR_EmployeeProfile.xml | 73 ------------
.../data/helpdata/HELP_HR_FindEmplPositions.xml | 56 ---------
.../data/helpdata/HELP_HR_FindEmployments.xml | 43 -------
.../data/helpdata/HELP_HR_ListEmplPositions.xml | 29 -----
.../data/helpdata/HELP_HR_ListEmployments.xml | 29 -----
.../humanres/data/helpdata/HELP_HR_NewEmployee.xml | 34 ------
.../data/helpdata/HELP_HR_PayrollHistory.xml | 81 -------------
.../data/helpdata/HELP_HR_findEmployees.xml | 63 ----------
.../humanres/data/helpdata/HELP_HR_main.xml | 75 ------------
.../humanres/data/helpdata/HELP_HR_training.xml | 128 ---------------------
.../_include/HELP-hr-EditEmplPosition.adoc | 68 +++++++++++
.../asciidoc/_include/HELP-hr-EmployeeProfile.adoc | 17 ++-
.../asciidoc/_include/HELP-hr-FindEmployees.adoc | 17 ++-
.../asciidoc/_include/HELP-hr-Howto-Training.adoc | 56 +++++++++
.../asciidoc/_include/HELP-hr-NewEmployee.adoc | 14 ++-
.../asciidoc/_include/HELP-hr-PayrollHistory.adoc | 41 +++++++
.../src/docs/asciidoc/_include/HELP-hr-main.adoc | 46 ++++++++
.../asciidoc/_include/hr-employee-positions.adoc | 28 +++--
.../src/docs/asciidoc/_include/hr-employees.adoc | 51 +++++++-
.../src/docs/asciidoc/_include/hr-employments.adoc | 22 ++++
.../docs/asciidoc/_include/hr-global-settings.adoc | 10 +-
.../src/docs/asciidoc/_include/hr-glossary.adoc | 62 +++++-----
.../src/docs/asciidoc/_include/hr-intro.adoc | 68 +++++------
.../src/docs/asciidoc/_include/hr-leave.adoc | 20 ++--
.../docs/asciidoc/_include/hr-qualifications.adoc | 8 +-
.../src/docs/asciidoc/_include/hr-recruitment.adoc | 18 +--
.../src/docs/asciidoc/_include/hr-resumes.adoc | 6 +-
.../src/docs/asciidoc/_include/hr-security.adoc | 72 ++++++------
.../src/docs/asciidoc/_include/hr-skills.adoc | 18 +--
.../src/docs/asciidoc/_include/hr-training.adoc | 74 ++++++------
.../humanres/src/docs/asciidoc/humanres.adoc | 4 +-
39 files changed, 529 insertions(+), 1171 deletions(-)
delete mode 100644 applications/humanres/data/helpdata/HELP_HR.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_EditEmplPosition.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_EditEmployeeLeaves.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_EditEmployeeQuals.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_EditEmployeeSkills.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_EditEmployeeTrainings.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_EditEmployment.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_EmplPositionView.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_EmployeeProfile.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_FindEmplPositions.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_FindEmployments.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_ListEmplPositions.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_ListEmployments.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_NewEmployee.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_PayrollHistory.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_findEmployees.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_main.xml
delete mode 100644 applications/humanres/data/helpdata/HELP_HR_training.xml
create mode 100644 applications/humanres/src/docs/asciidoc/_include/HELP-hr-EditEmplPosition.adoc
copy framework/security/src/docs/asciidoc/security.adoc => applications/humanres/src/docs/asciidoc/_include/HELP-hr-EmployeeProfile.adoc (57%)
copy framework/webapp/src/docs/asciidoc/webapp.adoc => applications/humanres/src/docs/asciidoc/_include/HELP-hr-FindEmployees.adoc (54%)
create mode 100644 applications/humanres/src/docs/asciidoc/_include/HELP-hr-Howto-Training.adoc
copy framework/security/src/docs/asciidoc/security.adoc => applications/humanres/src/docs/asciidoc/_include/HELP-hr-NewEmployee.adoc (70%)
create mode 100644 applications/humanres/src/docs/asciidoc/_include/HELP-hr-PayrollHistory.adoc
create mode 100644 applications/humanres/src/docs/asciidoc/_include/HELP-hr-main.adoc
[ofbiz-framework] 01/06: Documented : Migrate Help to asciidoc and
include in hr-intro.adoc (OFBIZ-10256)
Posted by mb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 8d80909c9022a7240c721398f4acb697c338dd86
Author: holivier <ho...@apache.org>
AuthorDate: Mon Feb 24 18:51:02 2020 +0100
Documented : Migrate Help to asciidoc and include in hr-intro.adoc
(OFBIZ-10256)
remove all related Help file in docbook format
---
applications/humanres/data/helpdata/HELP_HR.xml | 65 -------------------
.../humanres/data/helpdata/HELP_HR_main.xml | 75 ----------------------
.../src/docs/asciidoc/_include/HELP-hr-main.adoc | 46 +++++++++++++
.../src/docs/asciidoc/_include/hr-intro.adoc | 68 ++++++++++----------
4 files changed, 81 insertions(+), 173 deletions(-)
diff --git a/applications/humanres/data/helpdata/HELP_HR.xml b/applications/humanres/data/helpdata/HELP_HR.xml
deleted file mode 100644
index c280a1f..0000000
--- a/applications/humanres/data/helpdata/HELP_HR.xml
+++ /dev/null
@@ -1,65 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>Human Resources Introduction</title>
-
- <para>The people who work for your company, are its most important asset.
- They are human capital. Selecting a software platform that increases the
- value of your company's human capital and delivers benefits, services and
- opportunities to your workforce, is critical to your company's success
- .</para>
-
- <para>The platform must be able to accurately and reliability process
- worker transactions, collect decision support information, and communicate
- between management, workers and outside resources.</para>
-
- <para> The OFBiz Human Resource Application (HR App) can provide a backbone for
- building that platform.</para>
-
- <para>In this section we introduce you to the organization of this
- guide and to the key business objects that are the core to Human Resources.</para>
-
- <para>In the Human Resources Application you can:</para>
-
- <itemizedlist>
- <listitem>
- <para>Create positions</para>
- </listitem>
-
- <listitem>
- <para>Fulfill positions</para>
- </listitem>
-
- <listitem>
- <para>Define the responsibilities of a position</para>
- </listitem>
-
- <listitem>
- <para>Define a tree reporting structure between positions</para>
- </listitem>
-
- <listitem>
- <para>Track the positions fulfillments over time</para>
- </listitem>
- </itemizedlist>
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_main.xml b/applications/humanres/data/helpdata/HELP_HR_main.xml
deleted file mode 100644
index 276abf3..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_main.xml
+++ /dev/null
@@ -1,75 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Human Resources Main screen.</title>
-
-
- <para>The Main window is the entry point into the Human Resources Application and displays the
- Company tree view for navigating to the main menu items.</para>
-
- <para> This screen will display the organizational setup of your Company. The top level Company is defined in a system setup file: general.properties.</para>
- <para>
- The system will also list any divisions or departments that have been setup with the role "Internal organization" as defined in the party relationships
- as a "Group member". </para>
-
- <para>The number of organizational levels can be as many as required.</para>
-
- <section>
- <title> Nodes In the Company Tree</title>
-
- <para>There are three node types in the tree, each identified by a
- different icon. The top of the tree represents your Company, the highest
- level in the organization. The Company and departments under the
- Company can have sub departments or positions. Under positions are
- the people who fulfill the position.</para>
- </section>
-
- <section>
- <title>Usage</title>
-
- <itemizedlist>
- <listitem>
- <para>Navigate the organization to view departments, positions and
- people</para>
- </listitem>
-
- <listitem>
- <para>Add or remove a department</para>
- </listitem>
-
- <listitem>
- <para>Add a person</para>
- </listitem>
-
- <listitem>
- <para>Quickly open the profile of any item in the tree</para>
- </listitem>
-
- <listitem>
- <para>If the item is a position you can add a person to fulfill the
- position</para>
- </listitem>
- </itemizedlist>
- </section>
-
-</section>
diff --git a/applications/humanres/src/docs/asciidoc/_include/HELP-hr-main.adoc b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-main.adoc
new file mode 100644
index 0000000..31db91f
--- /dev/null
+++ b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-main.adoc
@@ -0,0 +1,46 @@
+////
+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.
+////
+
+= The Human Resources Main screen.
+The Main window is the entry point into the Human Resources Application and displays the Company tree view for navigating
+ to the main menu items.
+
+This screen will display the organizational setup of your Company. +
+The top level Company is defined in a system setup file: general.properties.
+
+The system will also list any divisions or departments that have been setup with the role "Internal organization"
+ as defined in the party relationships as a "Group member".
+
+The number of organizational levels can be as many as required.
+
+== Nodes In the Company Tree
+There are three node types in the tree, each identified by a different icon.
+
+* The top of the tree represents your Company, the highest level in the organization.
+* The Company and departments under the Company can have sub departments or positions.
+* Under positions are the people who fulfill the position.
+
+== Usage
+Contextual menu is with right-clic
+
+* Navigate the organization to view departments, positions and people
+* Add or remove a department
+* Add a person
+* Quickly open the profile of any item in the tree
+* If the item is a position you can add a person to fulfill the position
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc
index 11b4e15..ae1b39a 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-intro.adoc
@@ -18,45 +18,47 @@ 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
+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.
+include::HELP-hr-main.adoc[leveloffset=+1]
+
= Human Resources Processes
-Human Resources Management can be divided into several distinct processes.
+Human Resources Management can be divided into several distinct processes.
* Job Planning and Definition
* Recruitment
-* Candidate Selection and Hiring
+* Candidate Selection and Hiring
* Employee Training and Development
* Employee Evaluation and Performance Management
-* Employee Salary and Benefits
+* Employee Salary and Benefits
-== Job Planning and Definition
+== 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.
+ 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 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)
+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:
@@ -69,25 +71,25 @@ In the OFBiz Human Resources application you can:
== 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
+ 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
+ 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:
+In the OFBiz Human Resouces application you can:
* Create a Requisition for new job positions
* Create Internal Job Postings
-* Apply for job positions
+* 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.
+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:
@@ -100,7 +102,7 @@ In the OFBiz Human Resources application you can:
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
+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:
@@ -114,8 +116,8 @@ to another job position, or can be given other benefits such as a salary increas
== Employee Salary and Benefits Administration
-Being able to manage employee salaries and associated benefits is a key part of
-any Human Resources system.
+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:
[ofbiz-framework] 02/06: Documented : Migrate Employee Help to
asciidoc and include in hr-employees.adoc (OFBIZ-10260)
Posted by mb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit eddb5a7b4166de08e5c3c97a532a37bed9978391
Author: holivier <ho...@apache.org>
AuthorDate: Tue Feb 25 11:04:09 2020 +0100
Documented : Migrate Employee Help to asciidoc and include in
hr-employees.adoc
(OFBIZ-10260)
Included all Help about Employee screen in a dedicated sub-chapter
"Employee management in UI"
Related Help file in docbook format is deleted
---
.../data/helpdata/HELP_HR_EditEmployeeLeaves.xml | 38 ----------
.../data/helpdata/HELP_HR_EditEmployeeQuals.xml | 29 --------
.../data/helpdata/HELP_HR_EditEmployeeSkills.xml | 33 ---------
.../helpdata/HELP_HR_EditEmployeeTrainings.xml | 33 ---------
.../data/helpdata/HELP_HR_EmployeeProfile.xml | 73 -------------------
.../humanres/data/helpdata/HELP_HR_NewEmployee.xml | 34 ---------
.../data/helpdata/HELP_HR_PayrollHistory.xml | 81 ----------------------
.../data/helpdata/HELP_HR_findEmployees.xml | 63 -----------------
.../asciidoc/_include/HELP-hr-EmployeeProfile.adoc | 34 +++++++++
.../asciidoc/_include/HELP-hr-FindEmployees.adoc | 34 +++++++++
.../asciidoc/_include/HELP-hr-NewEmployee.adoc | 31 +++++++++
.../asciidoc/_include/HELP-hr-PayrollHistory.adoc | 41 +++++++++++
.../src/docs/asciidoc/_include/hr-employees.adoc | 51 +++++++++++++-
13 files changed, 190 insertions(+), 385 deletions(-)
diff --git a/applications/humanres/data/helpdata/HELP_HR_EditEmployeeLeaves.xml b/applications/humanres/data/helpdata/HELP_HR_EditEmployeeLeaves.xml
deleted file mode 100644
index 232dca1..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_EditEmployeeLeaves.xml
+++ /dev/null
@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Employee Leave</title>
-
- <para>This screen is displays any leave requested by an employee.</para>
-
- <para>Any user with Human Resource Employee permission can view and
- request leave for any other employee. </para>
-
- <para>NOTE: Only users with Human Resource
- Approver permission can update or approve a leave request.</para>
-
- <para>Leave requests are managed in the 'Leave' menu option where in addition
- to requesting leave, an approver may review and approve any requests
- assigned to them.</para>
-
- <para>NOTE:Leave types and reasons are managed by the administrator in the
- Global HR Settings.</para>
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_EditEmployeeQuals.xml b/applications/humanres/data/helpdata/HELP_HR_EditEmployeeQuals.xml
deleted file mode 100644
index c35d383..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_EditEmployeeQuals.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Employee Qualifications</title>
-
- <para>In this screen you can enter details of any qualifications an employee has, to a person
- which could help track their ability to perform a particular job.</para>
-
- <para>Existing qualifications can also be updated and status codes can be used
- to help manage the process of verifying the validity of any qualifications entered.</para>
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_EditEmployeeSkills.xml b/applications/humanres/data/helpdata/HELP_HR_EditEmployeeSkills.xml
deleted file mode 100644
index 7dd83e0..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_EditEmployeeSkills.xml
+++ /dev/null
@@ -1,33 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Employee Skills</title>
-
- <para>In this screen you can assign a skill to an employee.
- Enter numeric values in 'Years Experience', 'Rating' and 'Skill Level' to provide
- objective criteria for managing resources with the same skill.</para>
-
- <para>These attributes can be used to locate
- resources with a needed skill.</para>
-
- <para>NOTE:Skills are managed in 'Global HR Settings' where new skill groups and skills
- can be created or existing ones can be amended.</para>
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_EditEmployeeTrainings.xml b/applications/humanres/data/helpdata/HELP_HR_EditEmployeeTrainings.xml
deleted file mode 100644
index f3b0af1..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_EditEmployeeTrainings.xml
+++ /dev/null
@@ -1,33 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Employee Training</title>
-
- <para>This screen lists any training for an employee. Details such as the
- type of training, date, time and also the person who needs to approve
- the training are displayed</para>
-
- <para>NOTE: You cannot enter any training details in this screen. If you
- need to enter training for an employee it can be done under the 'Training'
- menu option.</para>
-
-
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_EmployeeProfile.xml b/applications/humanres/data/helpdata/HELP_HR_EmployeeProfile.xml
deleted file mode 100644
index e9d2233..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_EmployeeProfile.xml
+++ /dev/null
@@ -1,73 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Employee Profile</title>
-
- <para>The Profile screen for an employee is a collection of screenlets
- each displaying information about a different aspect of the employee.</para>
-
- <para>In this screen you can:</para>
-
- <itemizedlist>
- <listitem>
- <para>View summary information about an employee</para>
- </listitem>
-
- <listitem>
- <para>Update employee personal information</para>
- </listitem>
-
- <listitem>
- <para>View, create, update, and expire employee contact
- information</para>
- </listitem>
-
- <listitem>
- <para>View and create a list of related accounts</para>
- </listitem>
-
- <listitem>
- <para>View training records</para>
- </listitem>
-
- <listitem>
- <para>View employment information</para>
- </listitem>
-
- <listitem>
- <para>View, create, and update login id's, update security
- group</para>
- </listitem>
-
- <listitem>
- <para>View and create party attributes</para>
- </listitem>
-
- <listitem>
- <para>Upload party content</para>
- </listitem>
-
- <listitem>
- <para>View and create notes</para>
- </listitem>
- </itemizedlist>
-
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_NewEmployee.xml b/applications/humanres/data/helpdata/HELP_HR_NewEmployee.xml
deleted file mode 100644
index ca6b80f..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_NewEmployee.xml
+++ /dev/null
@@ -1,34 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Create New Employee</title>
-
- <para>This screen allows you to create a new employee.</para>
- <para>There are some mandatory fields required and these are indicated
- on the screen</para>
- <para>To create a new employee</para>
- <itemizedlist>
- <listitem><para>Click New Employee</para></listitem>
- <listitem><para>Enter the Employee details (e.g Name, Organization, Address, Phone Number)</para></listitem>
- <listitem><para>Click Save</para></listitem>
- </itemizedlist>
- <para>The new employee will be created</para>
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_PayrollHistory.xml b/applications/humanres/data/helpdata/HELP_HR_PayrollHistory.xml
deleted file mode 100644
index e4bcc97..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_PayrollHistory.xml
+++ /dev/null
@@ -1,81 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Payroll History</title>
-
- <para>This screen displays a list of invoices for the employee. Generally these are
- payroll or commission invoices. </para>
- <para>NOTE:An employee payslip is the same as an OFBiz payroll invoice</para>
-
- <para>The invoice life cycle from creation
- through payment is done in the Accounting application.</para>
-
- <para>Fields</para>
-
- <itemizedlist>
- <listitem>
- <para>Invoice ID - The distance identifier of the invoice. This
- number can be used to find the invoice in the Accounting
- application.</para>
- </listitem>
-
- <listitem>
- <para>Invoice Type - Identifies the type of invoice. This will
- typically be Payroll.</para>
- </listitem>
-
- <listitem>
- <para>Invoice Date - Date the invoice was created.</para>
- </listitem>
-
- <listitem>
- <para>Invoice Status - Status may be In-Processes (can be edited),
- Approved (has been reviewed, can not be edited), Ready (post to GL),
- Paid (post to GL)</para>
- </listitem>
-
- <listitem>
- <para>Description - A user entered description of the
- invoice.</para>
- </listitem>
-
- <listitem>
- <para>From Party - The employee identified by the party id . The invoice is in effect from
- the employee to the company.</para>
- </listitem>
-
- <listitem>
- <para>To Party - The party the invoice is to. For payroll this will
- typically by your company identified by the party id.</para>
- </listitem>
-
- <listitem>
- <para>Total - Amount paid. For a payroll invoice this will typically
- be less then the gross amount of the invoice due to deductions for
- taxes and benefits etc</para>
- </listitem>
-
- <listitem>
- <para>Outstanding Amount - Any unpaid amount due on the
- invoice.</para>
- </listitem>
- </itemizedlist>
-
- </section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_findEmployees.xml b/applications/humanres/data/helpdata/HELP_HR_findEmployees.xml
deleted file mode 100644
index 41f7498..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_findEmployees.xml
+++ /dev/null
@@ -1,63 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Find Employees</title>
-
- <para>The Employees feature manages information about people who have an
- employment relationship with your Company or one of its departments. This includes 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</para>
-
- <para>In this screen you can create a new employee, search for an
- existing employee and view a list of employees.</para>
-
- <para>Selecting an employee in the list opens the employee's profile and
- other screens associated with the employee.</para>
-
- <para>To find an employee enter the search criteria.</para>
-
- <para>NOTE: Only Employees Are Found.If you want to locate people who are
- not employees then use the Party Manager application.</para>
-
- <para>Fields</para>
-
- <itemizedlist>
- <listitem>
- <para>Party ID - Must be the id of a party who is an
- employee.</para>
- </listitem>
-
- <listitem>
- <para>User Login - The identifier used to login to OFBiz.
- An employee may have zero or more user logins.</para>
-
- </listitem>
-
- <listitem>
- <para>Last name - Employee last name</para>
- </listitem>
-
- <listitem>
- <para>First name - Employee first name</para>
- </listitem>
- </itemizedlist>
-
-
-</section>
diff --git a/applications/humanres/src/docs/asciidoc/_include/HELP-hr-EmployeeProfile.adoc b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-EmployeeProfile.adoc
new file mode 100644
index 0000000..1e2d747
--- /dev/null
+++ b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-EmployeeProfile.adoc
@@ -0,0 +1,34 @@
+////
+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 Profile
+The Profile screen for an employee is a collection of screenlets each displaying information about a different aspect
+ of the employee.
+
+In this screen you can:
+
+* View summary information about an employee
+* Update employee personal information
+* View, create, update, and expire employee contact information
+* View and create a list of related accounts
+* View training records
+* View employment information
+* View, create, and update login id's, update security group
+* View and create party attributes
+* Upload party content
+* View and create notes
diff --git a/applications/humanres/src/docs/asciidoc/_include/HELP-hr-FindEmployees.adoc b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-FindEmployees.adoc
new file mode 100644
index 0000000..4b7fe04
--- /dev/null
+++ b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-FindEmployees.adoc
@@ -0,0 +1,34 @@
+////
+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.
+////
+
+= Find Employees
+In this screen you can create a new employee, search for an existing employee and view a list of employees.
+
+Selecting an employee in the list opens the employee's profile and other screens associated with the employee.
+
+To find an employee enter the search criteria.
+
+NOTE: Only Employees Are Found.If you want to locate people who are not employees then use the Party Manager application.
+
+Fields
+
+* Party ID - Must be the id of a party who is an employee.
+* User Login - The identifier used to login to OFBiz. An employee may have zero or more user logins.
+* Last name - Employee last name
+* First name - Employee first name
diff --git a/applications/humanres/src/docs/asciidoc/_include/HELP-hr-NewEmployee.adoc b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-NewEmployee.adoc
new file mode 100644
index 0000000..15c8dae
--- /dev/null
+++ b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-NewEmployee.adoc
@@ -0,0 +1,31 @@
+////
+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.
+////
+
+= Create New Employee
+This screen allows you to create a new employee.
+
+There are some mandatory fields required and these are indicated on the screen
+
+To create a new employee
+
+* Click New Employee
+* Enter the Employee details (e.g Name, Organization, Address, Phone Number)
+* Click Save
+
+The new employee will be created
\ No newline at end of file
diff --git a/applications/humanres/src/docs/asciidoc/_include/HELP-hr-PayrollHistory.adoc b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-PayrollHistory.adoc
new file mode 100644
index 0000000..6575d28
--- /dev/null
+++ b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-PayrollHistory.adoc
@@ -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.
+////
+
+= Payroll History
+This screen displays a list of invoices for the employee. +
+Generally these are payroll or commission invoices.
+
+NOTE: An employee payslip is the same as an OFBiz payroll invoice
+
+The invoice life cycle from creation through payment is done in the Accounting application.
+
+Fields
+
+* Invoice ID - The distance identifier of the invoice. This number can be used to find the invoice in
+ the Accounting application.
+* Invoice Type - Identifies the type of invoice. This will typically be Payroll.
+* Invoice Date - Date the invoice was created.
+* Invoice Status - Status may be In-Processes (can be edited), Approved (has been reviewed,
+ can not be edited), Ready (post to GL), Paid (post to GL)
+* Description - A user entered description of the invoice.
+* From Party - The employee identified by the party id . The invoice is in effect from the employee to the company.
+* To Party - The party the invoice is to. For payroll this will typically by your company identified by the party id.
+* Total - Amount paid. For a payroll invoice this will typically be less then the gross amount of the invoice due
+ to deductions for taxes and benefits etc
+* Outstanding Amount - Any unpaid amount due on the invoice.
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc
index e3d3c9e..091fabd 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-employees.adoc
@@ -19,7 +19,7 @@ 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
+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
@@ -37,3 +37,52 @@ In OFBiz Human Resources you can
* Search for an existing employee
* View the full list of existing employees
+== Employees management in UI
+This includes 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
+
+include::HELP-hr-NewEmployee.adoc[leveloffset=+2]
+
+include::HELP-hr-FindEmployees.adoc[leveloffset=+2]
+
+include::HELP-hr-EmployeeProfile.adoc[leveloffset=+2]
+
+=== Employee Skills
+In this screen you can assign a skill to an employee.
+
+Enter numeric values in 'Years Experience', 'Rating' and 'Skill Level' to provide objective criteria for managing resources
+ with the same skill.
+
+These attributes can be used to locate resources with a needed skill.
+
+NOTE:Skills are managed in 'Global HR Settings' where new skill groups and skills can be created
+ or existing ones can be amended.
+
+=== Employee Qualifications
+In this screen you can enter details of any qualifications an employee has, to a person which could help track
+ their ability to perform a particular job.
+
+Existing qualifications can also be updated and status codes can be used to help manage the process of verifying
+ the validity of any qualifications entered.
+
+=== Employee Training
+This screen lists any training for an employee. +
+Details such as the type of training, date, time and also the person who needs to approve the training are displayed
+
+NOTE: You cannot enter any training details in this screen.
+ If you need to enter training for an employee it can be done under the 'Training' menu option.
+
+=== Employee Leave
+This screen is displays any leave requested by an employee.
+
+Any user with Human Resource Employee permission can view and request leave for any other employee.
+
+NOTE: Only users with Human Resource Approver permission can update or approve a leave request.
+
+Leave requests are managed in the 'Leave' menu option where in addition to requesting leave,
+an approver may review and approve any requests assigned to them.
+
+NOTE: Leave types and reasons are managed by the administrator in the Global HR Settings.
+
+include::HELP-hr-PayrollHistory.adoc[leveloffset=+2]
+
[ofbiz-framework] 03/06: Documented : Migrate Employment Help to
asciidoc and include in hr-employment.adoc (OFBIZ-10261)
Posted by mb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 3d4d999e6ae57c4810594474624ebf5010c16834
Author: holivier <ho...@apache.org>
AuthorDate: Tue Feb 25 11:17:58 2020 +0100
Documented : Migrate Employment Help to asciidoc and include in
hr-employment.adoc
(OFBIZ-10261)
Included all Help about Employment screen in a dedicated sub-chapter
"Employment management in UI"
Related Help file in docbook format is deleted
---
.../data/helpdata/HELP_HR_EditEmployment.xml | 37 -------------------
.../data/helpdata/HELP_HR_FindEmployments.xml | 43 ----------------------
.../data/helpdata/HELP_HR_ListEmployments.xml | 29 ---------------
.../src/docs/asciidoc/_include/hr-employments.adoc | 22 +++++++++++
4 files changed, 22 insertions(+), 109 deletions(-)
diff --git a/applications/humanres/data/helpdata/HELP_HR_EditEmployment.xml b/applications/humanres/data/helpdata/HELP_HR_EditEmployment.xml
deleted file mode 100644
index 6ccd557..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_EditEmployment.xml
+++ /dev/null
@@ -1,37 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Create or Edit Employment</title>
-
- <para>This screen allows you to create a new employment or edit an existing
- one.</para>
- <para>To create a new employment relationship between Company and an employee</para>
- <itemizedlist>
- <listitem><para>Select the Employee Party Id</para></listitem>
- <listitem><para>Enter the start date for the employment (e.g. Hire Date)</para></listitem>
- <listitem><para>Click Create</para></listitem>
- </itemizedlist>
-
- <para>Once created the employment detail screen will be displayed where you can update
- a range of information related to the employment such as benefits, payment preferences
- and unemployment claims</para>
-
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_FindEmployments.xml b/applications/humanres/data/helpdata/HELP_HR_FindEmployments.xml
deleted file mode 100644
index ea48979..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_FindEmployments.xml
+++ /dev/null
@@ -1,43 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Employments</title>
-
- <para>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.</para>
-
- <para>When you create new employee, an employee relationship is created
- automatically. </para>
- <para> 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.</para>
-
- <para>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. </para>
- <para>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')</para>
-
- <para>The Employments screen can be used to create an employment or search for existing
- employments.</para>
-
-
- </section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_ListEmployments.xml b/applications/humanres/data/helpdata/HELP_HR_ListEmployments.xml
deleted file mode 100644
index 8cec311..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_ListEmployments.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>List Employments</title>
-
- <para>This screen displays a list of Employments for an employee.</para>
- <para>NOTE:Usually a person will have only a single employment with an employer.</para>
-
- <para>The employment details (e.g benefits, payroll preferences, etc)
- can be modified by clicking 'Edit'.</para>
-
- </section>
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc
index cad152f..cb5c642 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-employments.adoc
@@ -34,3 +34,25 @@ For example, an employee may have been let go because of poor performance.
The Employments screen can be used to create an employment or search for existing
employments.
+
+== Employments management in UI
+
+=== Create or Edit Employment
+This screen allows you to create a new employment or edit an existing one.
+
+To create a new employment relationship between Company and an employee
+
+* Select the Employee Party Id
+* Enter the start date for the employment (e.g. Hire Date)
+* Click Create
+
+Once created the employment detail screen will be displayed where you can update a range of information related
+ to the employment such as benefits, payment preferences and unemployment claims
+
+= List Employments
+This screen displays a list of Employments for an employee.
+
+NOTE:Usually a person will have only a single employment with an employer.
+
+The employment details (e.g benefits, payroll preferences, etc) can be modified by clicking 'Edit'.
+
[ofbiz-framework] 04/06: Documented : Migrate Employee-position
Help to asciidoc and include in hr-employee-positions.adoc (OFBIZ-10259)
Posted by mb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 97d15cbcb0aa3b91129f9c67e9f2ca74f8517133
Author: holivier <ho...@apache.org>
AuthorDate: Tue Feb 25 11:34:37 2020 +0100
Documented : Migrate Employee-position Help to asciidoc and include in
hr-employee-positions.adoc
(OFBIZ-10259)
Included all Help about Employee-position screen in a dedicated
sub-chapter "Employee Position management in UI"
Related Help file in docbook format is deleted
---
.../data/helpdata/HELP_HR_EditEmplPosition.xml | 107 ---------------------
.../data/helpdata/HELP_HR_EmplPositionView.xml | 27 ------
.../data/helpdata/HELP_HR_FindEmplPositions.xml | 56 -----------
.../data/helpdata/HELP_HR_ListEmplPositions.xml | 29 ------
.../_include/HELP-hr-EditEmplPosition.adoc | 68 +++++++++++++
.../asciidoc/_include/hr-employee-positions.adoc | 28 ++++--
6 files changed, 89 insertions(+), 226 deletions(-)
diff --git a/applications/humanres/data/helpdata/HELP_HR_EditEmplPosition.xml b/applications/humanres/data/helpdata/HELP_HR_EditEmplPosition.xml
deleted file mode 100644
index be6adf6..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_EditEmplPosition.xml
+++ /dev/null
@@ -1,107 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Create or Edit Employee Position</title>
-
- <para>This screen is used to create or edit and update an employee position.</para>
- <para>The main search screen it is opened in create mode by clicking the New Employee
- Position button or in update mode by clicking on the EmployeePosition Id
- column in Search Results.</para>
-
- <para>Fields</para>
-
- <itemizedlist>
- <listitem>
- <para>Employee Position Id - Unique Id for the position. May be
- user entered or if empty the system will generate sequence
- number.</para>
- </listitem>
-
- <listitem>
- <para>Status ID - One of Active/Open, Inactive/Closed or Planned
- For.</para>
- </listitem>
-
- <listitem>
- <para>Party Id - The party id of the
- internal organization authorized to fill the
- position.</para>
- </listitem>
-
- <listitem>
- <para>Budget Id - A user entered identifier for the budget
- authorizing the position.</para>
- </listitem>
-
- <listitem>
- <para>Budget Item Seq Id - A user entered identifier for the
- budget item authorizing the position.</para>
- </listitem>
-
- <listitem>
- <para>Empl Position Type Id - Select a name for the position type.
- Position types are defined in Global HR Settings
- .</para>
- </listitem>
-
- <listitem>
- <para>Estimated From Date - Enter date the position is expected to
- be filled.</para>
- </listitem>
-
- <listitem>
- <para>Estimated Thru Date - Enter date on which the positions
- budget authorization is expected to end.</para>
- </listitem>
-
- <listitem>
- <para>Salary Flag - Enter Y if this is a salaried position else
- N.</para>
- </listitem>
-
- <listitem>
- <para>Exempt Flag - Enter Y if this position exempt from a
- requirement else N</para>
- </listitem>
-
- <listitem>
- <para>Fulltime Flag - Enter Y if this is a fulltime position else
- N</para>
- </listitem>
-
- <listitem>
- <para>Temporary Flag - Enter Y if this is a temporary position
- else N</para>
- </listitem>
-
- <listitem>
- <para>Actual From Date - Enter the date the position is
- filled.</para>
- </listitem>
-
- <listitem>
- <para>Actual Thru Date - Enter the date the position is no longer
- authorized.</para>
- </listitem>
- </itemizedlist>
-
- <para>Click Create - to create the position.</para>
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_EmplPositionView.xml b/applications/humanres/data/helpdata/HELP_HR_EmplPositionView.xml
deleted file mode 100644
index 84d0501..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_EmplPositionView.xml
+++ /dev/null
@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>View Employee Position</title>
-
- <para>This screen displays summary details about an Employee Position including
- details about who currently holds the position, their responsibilities and
- the reporting structure.</para>
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_FindEmplPositions.xml b/applications/humanres/data/helpdata/HELP_HR_FindEmplPositions.xml
deleted file mode 100644
index 89e68f7..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_FindEmplPositions.xml
+++ /dev/null
@@ -1,56 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Find Employee Positions</title>
-
- <para>An Employee Position is the authorization, typically from the budget of an
- internal organization,for the Company to engage someone to do a job. </para>
-
- <para>This means that you can fill a position in a number
- of different ways. </para>
-
- <para>You can fill a position with one full time person, change the assignment of
- a position from one person to another over time, or split a position across
- more then one person at the same a time.</para>
-
- <para>Positions have a status. They can be one of: Planned For,
- Active/Open, or Inactive/Closed.</para>
-
- <para>Positions have a type, defined in Global HR Settings, which
- describes the job and its pay rates. Some examples of job types could be
- secretary, production worker, sales manager, executive vice president or
- OFBiz programmer.</para>
- <para> If more then one person is needed for a type of job then
- a position must be created for each required person i.e. If 10 secretaries
- are authorized for the Human Resource department then 10 positions are
- created with type secretary.</para>
-
- <para>Positions have a reporting structure and report to other
- positions (and not the people who hold the position). </para>
- <para>You can identify the
- position a position reports to and/or the positions(s) a position
- manages.</para>
-
-
- <para>NOTE: Be careful because it is possible to create circular reporting
- structures.</para>
-
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_ListEmplPositions.xml b/applications/humanres/data/helpdata/HELP_HR_ListEmplPositions.xml
deleted file mode 100644
index 16626b4..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_ListEmplPositions.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>List Employee Position</title>
-
- <para>This screen displays a list of positions for an employee.</para>
- <para>NOTE: Employee positions are created and managed in the 'Employee Position' menu option.</para>
- <para>Details about the position are displayed including any related dates and
- whether the position is temporary or not.</para>
-
-
-</section>
diff --git a/applications/humanres/src/docs/asciidoc/_include/HELP-hr-EditEmplPosition.adoc b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-EditEmplPosition.adoc
new file mode 100644
index 0000000..910fcc3
--- /dev/null
+++ b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-EditEmplPosition.adoc
@@ -0,0 +1,68 @@
+////
+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.
+////
+= Create or Edit Employee Position
+This screen is used to create or edit and update an employee position.
+
+In the main search screen it is opened in create mode by clicking the New Employee Position button or
+ in update mode by clicking on the EmployeePosition Id column in Search Results.
+
+An Employee Position is the authorization, typically from the budget of an internal organization,
+for the Company to engage someone to do a job.
+
+This means that you can fill a position in a number of different ways.
+
+You can fill a position with one full time person, change the assignment of a position from one person
+ to another over time, or split a position across more then one person at the same a time.
+
+Positions have a status.
+They can be one of:
+
+* Planned For,
+* Active/Open,
+* Inactive/Closed.
+
+Positions have a type, defined in Global HR Settings, which describes the job and its pay rates. +
+Some examples of job types could be secretary, production worker, sales manager, executive vice president or OFBiz programmer.
+
+If more then one person is needed for a type of job then a position must be created for each required person i.e. +
+If 10 secretaries are authorized for the Human Resource department then 10 positions are created with type secretary.
+
+Positions have a reporting structure and report to other positions (and not the people who hold the position).
+
+You can identify the position a position reports to and/or the positions(s) a position manages.
+
+NOTE: Be careful because it is possible to create circular reporting structures.
+
+== Fields
+* Employee Position Id - Unique Id for the position. May be user entered or if empty the system will generate sequence number.
+* Status ID - One of Active/Open, Inactive/Closed or Planned For.
+* Party Id - The party id of the internal organization authorized to fill the position.
+* Budget Id - A user entered identifier for the budget authorizing the position.
+* Budget Item Seq Id - A user entered identifier for the budget item authorizing the position.
+* Empl Position Type Id - Select a name for the position type. Position types are defined in Global HR Settings .
+* Estimated From Date - Enter date the position is expected to be filled.
+* Estimated Thru Date - Enter date on which the positions budget authorization is expected to end.
+* Salary Flag - Enter Y if this is a salaried position else N.
+* Exempt Flag - Enter Y if this position exempt from a requirement else N
+* Fulltime Flag - Enter Y if this is a fulltime position else N
+* Temporary Flag - Enter Y if this is a temporary position else N
+* Actual From Date - Enter the date the position is filled.
+* Actual Thru Date - Enter the date the position is no longer authorized.
+
+Click Create - to create the position.
\ No newline at end of file
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc
index 96a7147..1b6d4b9 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc
@@ -17,10 +17,9 @@ 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.
+created to perform a specific task within the Company. This means that it has
+approved funding to pay it.
Employee positions are defined by:
@@ -29,11 +28,11 @@ Employee positions are defined by:
* 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
+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).
+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)
@@ -45,3 +44,18 @@ In the OFBiz Human Resources application you can:
* Define the responsibilities of an employee position
* Define a tree reporting structure between employee positions
* Track employment position fulfillments over time
+
+== Employee Position management in UI
+=== List Employee Position
+This screen displays a list of positions for an employee.
+
+NOTE: Employee positions are created and managed in the 'Employee Position' menu option.
+
+Details about the position are displayed including any related dates and whether the position is temporary
+ or not.
+
+include::HELP-hr-EditEmplPosition.adoc[leveloffset=+2]
+
+=== View Employee Position
+This screen displays summary details about an Employee Position including details about who currently holds
+the position, their responsibilities and the reporting structure.
[ofbiz-framework] 06/06: Documented : just remove trailing space
(OFBIZ-10251)
Posted by mb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 13abd8298cd4f0b993d88809e577f076b55bf298
Author: holivier <ho...@apache.org>
AuthorDate: Tue Feb 25 11:51:29 2020 +0100
Documented : just remove trailing space
(OFBIZ-10251)
---
.../docs/asciidoc/_include/hr-global-settings.adoc | 10 +--
.../src/docs/asciidoc/_include/hr-glossary.adoc | 62 +++++++++----------
.../src/docs/asciidoc/_include/hr-leave.adoc | 20 +++---
.../docs/asciidoc/_include/hr-qualifications.adoc | 8 +--
.../src/docs/asciidoc/_include/hr-recruitment.adoc | 18 +++---
.../src/docs/asciidoc/_include/hr-resumes.adoc | 6 +-
.../src/docs/asciidoc/_include/hr-security.adoc | 72 +++++++++++-----------
.../src/docs/asciidoc/_include/hr-skills.adoc | 18 +++---
.../humanres/src/docs/asciidoc/humanres.adoc | 4 +-
9 files changed, 109 insertions(+), 109 deletions(-)
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc
index 9057b57..a10b88e 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-global-settings.adoc
@@ -18,20 +18,20 @@ under the License.
////
= Global HR Settings
-Global HR Settings are used to setup the basic reference data that is used
+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
+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
+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.
+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
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc
index 1f70743..8fd8c31 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-glossary.adoc
@@ -20,14 +20,14 @@ under the License.
[#ANNUAL_REVENUE]
Annual Revenue::
-Annual revenue is the amount of revenue for a group that is reported in the Party
+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
+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]
@@ -38,13 +38,13 @@ An employee is a person who has an employment relationship with your Company.
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
+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
+ employee. The employment relationship tracks employee benefits preferences, pay
history, and unemployment claims and agreements.
[#EXEMPT_FLAG]
@@ -64,54 +64,54 @@ 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,
+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
+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
+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
+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
+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
+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
+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
+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.
@@ -130,12 +130,12 @@ 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
+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
+The salary flag can be used to indicate if an employee position is salaried or
paid hourly.
[#SKILL]
@@ -145,23 +145,23 @@ Skill is some ability or knowledge possessed by a person or organization that is
[#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
+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
+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
+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
+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]
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc
index 632eb3f..38918d0 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-leave.adoc
@@ -18,29 +18,29 @@ under the License.
////
= Leave
-Generally each of your employees will be allowed to take a certain amount of
+Generally each of your employees will be allowed to take a certain amount of
time off work on an annual basis. This time-off work can be called leave,
-holiday or vacation. The amount and type of leave they can take may depend on
+holiday or vacation. The amount and type of leave they can take may depend on
their job position or how long they have worked for you.
-You may also allow your employees special leave such as days off when they are
-ill (sick leave), time off during pregnacy or birth of a child (maternity or
+You may also allow your employees special leave such as days off when they are
+ill (sick leave), time off during pregnacy or birth of a child (maternity or
paternity leave) or time off to attend a funeral (bereavement leave).
-OFBiz allows you to setup a range of different leave types and categories to
+OFBiz allows you to setup a range of different leave types and categories to
cover many situations.
-In all cases the employee will need to request the date (or dates) they would
-like to take as leave. Next the manager of the employee will need to approve the
+In all cases the employee will need to request the date (or dates) they would
+like to take as leave. Next the manager of the employee will need to approve the
leave request. Once approved the employee can then take the leave.
In the OFBiz Human Resources application:
-* Employees can schedule or a leave request
+* Employees can schedule or a leave request
* Managers can create leave requests on behalf of an employee
* Managers can approve, reject or delete employee leave requests
-NOTE: Users with Human Resource Approver permission can only approve a leave
-request. To update or delete a leave request, you will need to have Human
+NOTE: Users with Human Resource Approver permission can only approve a leave
+request. To update or delete a leave request, you will need to have Human
Resources Administration permission.
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc
index 0f4c6c2..990ef11 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-qualifications.adoc
@@ -23,13 +23,13 @@ Qualifications are a feature of the recruitment process that allows you to recor
employees.
During the job application process, you may want to ensure that applicants have
-a minimum set of qualifications as a requirement for a position. The details of
+a minimum set of qualifications as a requirement for a position. The details of
the qualifications for each applicant will need to be captured and if necessary,
verified.
-For existing employees, details of qualifications during their employment with
+For existing employees, details of qualifications during their employment with
your organisation can be added at any time.
-In the case where qualifications expire if not renewed, you can also add an
-expiry or renewal date.
+In the case where qualifications expire if not renewed, you can also add an
+expiry or renewal date.
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc
index 51a099e..5ada775 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-recruitment.adoc
@@ -19,23 +19,23 @@ under the License.
= Recruitment
Recruitment is an important function in any organisation. It is a set of processes
-that allow you to specify, search for candidates to fulfill the roles that you
+that allow you to specify, search for candidates to fulfill the roles that you
have available.
When you have a job position that needs to be fulfilled, you can create a Job
-Requisition. The job requisition identifies the skills, qualifications, experience
-and also the number of resources needed for a position.
+Requisition. The job requisition identifies the skills, qualifications, experience
+and also the number of resources needed for a position.
-NOTE: Currently the default assumption is that the Job Requisition is for an
+NOTE: Currently the default assumption is that the Job Requisition is for an
Internal Job posting
-Once the requisition is created, you can then create Job Posting based on the
+Once the requisition is created, you can then create Job Posting based on the
requisition. For example if the requisition was for three (3) roles then three
-job postings can be created (each with different application deadlines) one to
+job postings can be created (each with different application deadlines) one to
fulfill each of the positions.
-People can then apply for the positions and send in their CVs or Resumes. You
-can track the progress of the the application and also create details about
+People can then apply for the positions and send in their CVs or Resumes. You
+can track the progress of the the application and also create details about
various types of job interviews needed (e.g. HR, Panel, Case Study
/Practical Test etc) and link it to the requisition.
@@ -43,7 +43,7 @@ You can also track the status of people who have applied for a position.
In the OFBiz Human Resource application you can
-* Approve or reject job applications
+* Approve or reject job applications
* Manage and book job interviews
* Record the result of job interviews
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc
index c6183da..7a353a0 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-resumes.adoc
@@ -24,10 +24,10 @@ qualifications, contact information and details about why they are suitable for
a particular job position.
In OFBiz you can enter a resume as a document and then link it to a person.
-Each resume entry has a unique identifier (that currently needs to be manually
+Each resume entry has a unique identifier (that currently needs to be manually
entered!). This identifier links a person to an instance of their resume.
-NOTE: The OFBiz Content Manager application is used for the linking of resumes
-because it was designed for managing, storing and retrieving electronic data in
+NOTE: The OFBiz Content Manager application is used for the linking of resumes
+because it was designed for managing, storing and retrieving electronic data in
varying formats - such as text, images, MS Word, PDF or even web URL's.
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc
index 1cb54b4..e98c56e 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-security.adoc
@@ -18,77 +18,77 @@ under the License.
////
= Security
-OFBiz has a security model that controls access to all aspects of teh system at
-a very detailed level. This means that it is possible to manage what each user
+OFBiz has a security model that controls access to all aspects of teh system at
+a very detailed level. This means that it is possible to manage what each user
has access to and what actions they can perform.
-
+
NOTE: Security can be so fine grained to the lowest level such as a view, or the
creation, update or deletion of a single item of information
This section covers the security permissions that inlcuded as part of the Human
-Resources application and how an administrator can assign permissions to users
+Resources application and how an administrator can assign permissions to users
using the Party Manager application.
-NOTE: A person may have one or more OFBiz login id's. Each login id can be
-assigned to it's own set of Security Groups. This means that the id a user logs
+NOTE: A person may have one or more OFBiz login id's. Each login id can be
+assigned to it's own set of Security Groups. This means that the id a user logs
in with determines what applications the person can work in and what work can be
- done in the application.
+ done in the application.
== Human Resource Permissions
In OFBiz a Security Group is collection of permissions that allow a members of
- the group to use the application and any resources. The Human Resources
+ the group to use the application and any resources. The Human Resources
application has three special security groups that can be assigned Human
-Resources users. There are also other general administrative security groups
+Resources users. There are also other general administrative security groups
that let managers and administrators work in the application.
-You can use the Party Manager application to add users to one or more Security
+You can use the Party Manager application to add users to one or more Security
Groups.
-
+
The three special HR App Security Groups are named by role:
-* Employee Role - This is mandatory to be able to logon into the Human Resources
+* Employee Role - This is mandatory to be able to logon into the Human Resources
application. This is true even if user has the the other Human Resources Approver
- and Administration Roles. The employee role has the most restrictions on what a
+ and Administration Roles. The employee role has the most restrictions on what a
user may view and the actions they can take.
-* Approver Role - The Approver role gives members of the group the ability to
-approve, training and employee leave requests. The approver has all of the
-permissions included in the Employee Role and can also view and update some
+* Approver Role - The Approver role gives members of the group the ability to
+approve, training and employee leave requests. The approver has all of the
+permissions included in the Employee Role and can also view and update some
additional screens that are not available to the Employee role.
-* Administrator Role - The Human Resources Administrator Role has permission to
-do most things in the Human Resources application. They are allowed full access
-to view, create, update and delete throughout the Human Resources application.
-Please see the note below for the additional permissions required to be able to
+* Administrator Role - The Human Resources Administrator Role has permission to
+do most things in the Human Resources application. They are allowed full access
+to view, create, update and delete throughout the Human Resources application.
+Please see the note below for the additional permissions required to be able to
do everything in Human Resources.
NOTE: A person with the Human Administrator Role must also belong to the
-following Security Groups (Work Effort User, My Portal Employee, My Portal
-Customer or Scrum Team) to be able to add Training classes in the Training
-feature.
+following Security Groups (Work Effort User, My Portal Employee, My Portal
+Customer or Scrum Team) to be able to add Training classes in the Training
+feature.
+
-
== General OFBiz Permissions
-Some OFBiz users (from the demo data) may not have any of the Human Resource
+Some OFBiz users (from the demo data) may not have any of the Human Resource
permissions but can still access the Human Resouces application to be able to
perform general operations. These include:
-* Business Admin has permission for all operations in the Human Resources
+* Business Admin has permission for all operations in the Human Resources
application
-* Flexible Admin has permission to create, update, delete and view operations
+* Flexible Admin has permission to create, update, delete and view operations
in Human Resources
* Full Admin has permission for all operations in Human Resources
* Super has permission for all operations in the Human Resources
* Viewadmin has permission for viewing details in Human Resources
-
+
== Security Administration In Party Manager
-A user must be granted permission to use the Human Resources application. This
-section describes how to do this using OFBiz Party Manager. It assumes the user
-has a user login and Party administration privileges.
+A user must be granted permission to use the Human Resources application. This
+section describes how to do this using OFBiz Party Manager. It assumes the user
+has a user login and Party administration privileges.
Please do the following to grant permissions
@@ -96,13 +96,13 @@ Please do the following to grant permissions
2. User the search functionality to locate the user that you want to give Human
Resources permissions to
3. When the search results are displayed, click on the Party ID column
-4. In the User Name(s) screenlet click the Security Groups button for the User
+4. In the User Name(s) screenlet click the Security Groups button for the User
Login that will receive Human Resources permissions
5. In the Add User Login to Security Group screenlet select the HUMANRES_EMPLOYEE.
-from the Group drop-down-list.
-6. Click the Add button to use the current date for the From Date or enter dates
+from the Group drop-down-list.
+6. Click the Add button to use the current date for the From Date or enter dates
for From Date and Thru Date as needed then click Add
-7. If the person is to be allowed to approve Training add the HUMANRES_APPROVER
+7. If the person is to be allowed to approve Training add the HUMANRES_APPROVER
permission. As in the previous step enter dates as required
-8. If the person is to be allowed all access then add the HUMANRES_ADMIN
+8. If the person is to be allowed all access then add the HUMANRES_ADMIN
permission... As in the previous steps enter dates as required.
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc
index e1db0d7..d8b476d 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-skills.adoc
@@ -19,21 +19,21 @@ under the License.
= Skills
Skills are the basic foundation of any Human Resources function as it is a key
-factor in identifying the suitability of someone to perform a specific task or
-job. They can often be divided into two types; general and specific, and are
-characterised by things such as years of experience, rating or level of
+factor in identifying the suitability of someone to perform a specific task or
+job. They can often be divided into two types; general and specific, and are
+characterised by things such as years of experience, rating or level of
expertise.
-In OFBiz basic skills can be defined in Global HR Settings and then linked to
-actual individuals via the Skills menu option.
+In OFBiz basic skills can be defined in Global HR Settings and then linked to
+actual individuals via the Skills menu option.
-In the recruitment process, skills are specified as part of the job requisition
-for an employee (or job) position. This helps ensure that the recruiter can focus
+In the recruitment process, skills are specified as part of the job requisition
+for an employee (or job) position. This helps ensure that the recruiter can focus
on finding applicants with the relevant skillset.
Your employees can also gain new skills as part of their employment and so OFBiz
- allows you to record and track their newly acquired skills. It may be that
-rather than start a new recruitment process, you may be able to find someone
+ allows you to record and track their newly acquired skills. It may be that
+rather than start a new recruitment process, you may be able to find someone
with the right skills from your existing employees.
diff --git a/applications/humanres/src/docs/asciidoc/humanres.adoc b/applications/humanres/src/docs/asciidoc/humanres.adoc
index e541c8f..37b631f 100644
--- a/applications/humanres/src/docs/asciidoc/humanres.adoc
+++ b/applications/humanres/src/docs/asciidoc/humanres.adoc
@@ -19,8 +19,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
-recruitment process. It is well integrated with other components especially
+all of the functionality you need to manage your business employees as well as the
+recruitment process. It is well integrated with other components especially
Accounting to manage Payroll and any specific employee agreements.
include::_include/hr-intro.adoc[leveloffset=+1]
[ofbiz-framework] 05/06: Documented : Migrate Training Howto Help
to asciidoc and include in hr-training.adoc (OFBIZ-10268)
Posted by mb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit f0e4db047d22c8946c30b4b26b0329b9217c5947
Author: holivier <ho...@apache.org>
AuthorDate: Tue Feb 25 11:50:53 2020 +0100
Documented : Migrate Training Howto Help to asciidoc and include in
hr-training.adoc
(OFBIZ-10268)
Included the Howto as a sub-chapter
File in docbook format is deleted
---
.../humanres/data/helpdata/HELP_HR_training.xml | 128 ---------------------
.../asciidoc/_include/HELP-hr-Howto-Training.adoc | 56 +++++++++
.../src/docs/asciidoc/_include/hr-training.adoc | 74 ++++++------
3 files changed, 98 insertions(+), 160 deletions(-)
diff --git a/applications/humanres/data/helpdata/HELP_HR_training.xml b/applications/humanres/data/helpdata/HELP_HR_training.xml
deleted file mode 100644
index e1a6bb5..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_training.xml
+++ /dev/null
@@ -1,128 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>Simple Howto for the moment, work in progress...</title>
- <para>Introduction: Trainings in HR module includes Training Calendar where we can create new
- schedules from trainings available in an organization. Admin can assign trainings &
- employee can request for scheduled trainings. Employee can also check status of their training
- requests & assignments. </para>
- <para/>
- <para>Need of Trainings in HR: </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Training and development of professionals fills up the skill gaps and further improve
- the levels of proficiency. </para>
- </listitem>
- <listitem>
- <para>Training and development manages constantly changing business and industrial scenario
- and therefore, matches with the requirements or demands of changes on the organizations.
- </para>
- </listitem>
- <listitem>
- <para>Creates a learning organization culture.</para>
- </listitem>
- </itemizedlist>
- </para>
- <para>Organizational development: </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Organization decides to use certain initiatives and wants to train and develop a good
- number of people in the entire organization or the people in certain chosen departments or
- projects on those initiatives. </para>
- </listitem>
- <listitem>
- <para>Prepares the organization to meet the needs of legal/statutory requirements. Features
- of Trainings: </para>
- </listitem>
- <listitem>
- <para>New Trainings can be added/modified. </para>
- </listitem>
- <listitem>
- <para>Trainings can be scheduled in the calendar. </para>
- </listitem>
- <listitem>
- <para>Employees can apply to supervisor for available scheduled trainings but, cannot
- request same training event again to same approver </para>
- </listitem>
- <listitem>
- <para>Admin can assign trainings to Employees. </para>
- </listitem>
- <listitem>
- <para>Admin can approve/reject the trainings requested to him but, once rejected cannot be
- approved again. </para>
- </listitem>
- <listitem>
- <para>Employees can check the status of their training requests and Trainings assigned to
- them. </para>
- <para/>
- </listitem>
- </itemizedlist>
- </para>
- <para>Road Ahead: Currently we have implemented Trainings under HR module. We are working on the
- implementation of Training calendar in profile tab of Employee. We are also planning to
- introduce trainer's information in training calendar.</para>
- <para/>
- <section>
- <para>In "GlobalHRSetting" </para>
- <orderedlist>
- <listitem>
- <para>Admin can create & manage the trainings provided by the organization. </para>
- </listitem>
- </orderedlist>
- </section>
- <section>
- <para>In "Training Calendar" </para>
- <para>
- <orderedlist>
- <listitem>
- <para>Admin can schedule a training through training calender. </para>
- </listitem>
- <listitem>
- <para>Admin can assign training to an employee(right half of calendar screen). </para>
- </listitem>
- <listitem>
- <para> Employee with his login can request for Training to admin from the calendar.
- </para>
- </listitem>
- <listitem>
- <para> Employee cannot request same training event again to same approver. </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <para>In "Training Approval" tab (in case of Employee login tab name would be "Training
- Status")</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Admin can approve/reject the training requested to him </para>
- </listitem>
- <listitem>
- <para>Admin can not change the training status once it is rejected. </para>
- </listitem>
- <listitem>
- <para>Employee can check status of requested and assigned trainings. </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-</section>
diff --git a/applications/humanres/src/docs/asciidoc/_include/HELP-hr-Howto-Training.adoc b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-Howto-Training.adoc
new file mode 100644
index 0000000..6872931
--- /dev/null
+++ b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-Howto-Training.adoc
@@ -0,0 +1,56 @@
+////
+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.
+////
+= Simple Howto for Training UI
+NOTE: TO CHECK for the moment, work in progress...
+
+Introduction: Trainings in HR module includes Training Calendar where we can create new schedules from trainings
+ available in an organization.
+
+Admin can assign trainings & employee can request for scheduled trainings.
+
+Employee can also check status of their training requests & assignments.
+
+Need of Trainings in HR:
+
+* Training and development of professionals fills up the skill gaps and further improve the levels of proficiency.
+* Training and development manages constantly changing business and industrial scenario and therefore, matches with
+ the requirements or demands of changes on the organizations.
+* Creates a learning organization culture.
+
+Organizational development:
+
+* Organization decides to use certain initiatives and wants to train and develop a good number of people
+ in the entire organization or the people in certain chosen departments or projects on those initiatives.
+* Prepares the organization to meet the needs of legal/statutory requirements. Features of Trainings:
+* New Trainings can be added/modified.
+* Trainings can be scheduled in the calendar.
+* Employees can apply to supervisor for available scheduled trainings but, cannot request same training event
+ again to same approver
+* Admin can assign trainings to Employees.
+* Admin can approve/reject the trainings requested to him but, once rejected cannot be approved again.
+* Employees can check the status of their training requests and Trainings assigned to them.
+
+Road Ahead: Currently we have implemented Trainings under HR module.
+
+We are working on the implementation of Training calendar in profile tab of Employee.
+
+We are also planning to introduce trainer's information in training calendar.
+
+== In "GlobalHRSetting"
+. Admin can create & manage the trainings provided by the organization.
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc
index 06e61f6..0d27da2 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-training.adoc
@@ -17,57 +17,67 @@ specific language governing permissions and limitations
under the License.
////
= Training
-
-[#Introduction]
-Introduction::
-Training and professional development is important for an organisation because it
-can help to fill any gaps in skills and improve the proficiency of the existing
+== Introduction
+Training and professional development is important for an organisation because it
+can help to fill any gaps in skills and improve the proficiency of the existing
workforce.
-The training section of the HR module includes a Training Calendar where new
+The training section of the HR module includes a Training Calendar where new
training classes or events can be scheduled for an organisation.
-Users that have HR administration permissions can create, assign and approve
-training classes. All other users can view the list of classes available, their
-training status and any requests they have made to enroll for training.
+Users that have HR administration permissions can create, assign and approve
+training classes. All other users can view the list of classes available, their
+training status and any requests they have made to enroll for training.
-[#HR Trainiing Process Flow]
-General Process Flow::
+== General Process Flow
* Training classes are created in the Global HR Training Class Type screen
* Training classes are scheduled and added to the training calendar
* Employees can create a request to attend a training
* The employee supervisor needs to approve or reject the employee training request
* Employees can check the status of the training requests
-Training Calendar::
-The main screen in the Training feature is the Training Calendar. This is where
-you add classes and class participants. You can navigate the calendar by clicking
+== Training Calendar
+The main screen in the Training feature is the Training Calendar. This is where
+you add classes and class participants. You can navigate the calendar by clicking
the navigation text for day, week and month views located in the calendar title bar.
-Add New Training Event::
-Training classes are created in the Training Calendar by clicking the Add New text
-command located in each calendar day cell. This action opens a small window above
+. Admin can schedule a training through training calender.
+. Admin can assign training to an employee(right half of calendar screen).
+. Employee with his login can request for Training to admin from the calendar.
+. Employee cannot request same training event again to same approver.
+
+== Add New Training Event
+Training classes are created in the Training Calendar by clicking the Add New text
+command located in each calendar day cell. This action opens a small window above
the calendar to enter the training class details.
-NOTE: If you try to create a class and do not have correct User permissions, you
-will get an error. After a class is created a numeric class identifier and text
+NOTE: If you try to create a class and do not have correct User permissions, you
+will get an error. After a class is created a numeric class identifier and text
identifier description appear in the calendar for the day of the class.
-Request Training / Add a Training Participant ::
-Participants can be added to a class by clicking on the class identifier. If you
+== Request Training / Add a Training Participant
+Participants can be added to a class by clicking on the class identifier. If you
are the creator of the class the Participants window above and to the right of the
calendar opens. You can add participants by entering their party id and clicking
- the Add button. The list of participants is displayed and updated.
-After a new participant is added to a training class or event, they are given the
-default status ‘Assigned’.
+ the Add button. The list of participants is displayed and updated.
+After a new participant is added to a training class or event, they are given the
+default status ‘Assigned’.
-Approve Training::
-To approve a request for training, tor training administrator navigates to the
-Training Approvals screen and locates all requests with a status of "Assigned".
-They look up the person listed as the approver party. After checking with the
-approver they click update button to open the approval screen. In the approval
-screen the administrator sets the Approver Status and adds a reason for the
-decision. The user can see the status of their training schedule by clicking on
+== Approve Training
+To approve a request for training, tor training administrator navigates to the
+Training Approvals screen and locates all requests with a status of "Assigned".
+They look up the person listed as the approver party. After checking with the
+approver they click update button to open the approval screen. In the approval
+screen the administrator sets the Approver Status and adds a reason for the
+decision. The user can see the status of their training schedule by clicking on
the Training Status menu.
-WARNING: Something isn’t working correctly in 16.11. The there is no update
+In "Training Approval" tab (in case of Employee login tab name would be "Training Status")
+
+. Admin can approve/reject the training requested to him
+. Admin can not change the training status once it is rejected.
+. Employee can check status of requested and assigned trainings.
+
+
+WARNING: TO CHECK Something isn’t working correctly in 16.11. The there is no update
button to click to approve a participant for training.
+include::HELP-hr-Howto-Training.adoc[leveloffset=+1]