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:17 UTC
[ofbiz-framework] 03/06: Documented : Migrate Employment Help to
asciidoc and include in hr-employment.adoc (OFBIZ-10261)
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'.
+