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 <holiv...@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]
+
