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:19 UTC
[ofbiz-framework] 05/06: Documented : Migrate Training Howto Help
to asciidoc and include in hr-training.adoc (OFBIZ-10268)
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]