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 820f67a6355bb22beb9a2dff5e20654e8121020a Author: holivier <holiv...@apache.org> AuthorDate: Wed Feb 26 11:17:58 2020 +0100 Documented: revert remove docbook help files for humanres (OFBIZ-11420) Removing Help files in docbook format break the current online help --- 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 +++++++++++++++++++++ 18 files changed, 980 insertions(+) diff --git a/applications/humanres/data/helpdata/HELP_HR.xml b/applications/humanres/data/helpdata/HELP_HR.xml new file mode 100644 index 0000000..c280a1f --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR.xml @@ -0,0 +1,65 @@ +<?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_EditEmplPosition.xml b/applications/humanres/data/helpdata/HELP_HR_EditEmplPosition.xml new file mode 100644 index 0000000..be6adf6 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_EditEmplPosition.xml @@ -0,0 +1,107 @@ +<?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_EditEmployeeLeaves.xml b/applications/humanres/data/helpdata/HELP_HR_EditEmployeeLeaves.xml new file mode 100644 index 0000000..232dca1 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_EditEmployeeLeaves.xml @@ -0,0 +1,38 @@ +<?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 new file mode 100644 index 0000000..c35d383 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_EditEmployeeQuals.xml @@ -0,0 +1,29 @@ +<?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 new file mode 100644 index 0000000..7dd83e0 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_EditEmployeeSkills.xml @@ -0,0 +1,33 @@ +<?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 new file mode 100644 index 0000000..f3b0af1 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_EditEmployeeTrainings.xml @@ -0,0 +1,33 @@ +<?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_EditEmployment.xml b/applications/humanres/data/helpdata/HELP_HR_EditEmployment.xml new file mode 100644 index 0000000..6ccd557 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_EditEmployment.xml @@ -0,0 +1,37 @@ +<?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_EmplPositionView.xml b/applications/humanres/data/helpdata/HELP_HR_EmplPositionView.xml new file mode 100644 index 0000000..84d0501 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_EmplPositionView.xml @@ -0,0 +1,27 @@ +<?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_EmployeeProfile.xml b/applications/humanres/data/helpdata/HELP_HR_EmployeeProfile.xml new file mode 100644 index 0000000..e9d2233 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_EmployeeProfile.xml @@ -0,0 +1,73 @@ +<?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_FindEmplPositions.xml b/applications/humanres/data/helpdata/HELP_HR_FindEmplPositions.xml new file mode 100644 index 0000000..89e68f7 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_FindEmplPositions.xml @@ -0,0 +1,56 @@ +<?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_FindEmployments.xml b/applications/humanres/data/helpdata/HELP_HR_FindEmployments.xml new file mode 100644 index 0000000..ea48979 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_FindEmployments.xml @@ -0,0 +1,43 @@ +<?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_ListEmplPositions.xml b/applications/humanres/data/helpdata/HELP_HR_ListEmplPositions.xml new file mode 100644 index 0000000..16626b4 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_ListEmplPositions.xml @@ -0,0 +1,29 @@ +<?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/data/helpdata/HELP_HR_ListEmployments.xml b/applications/humanres/data/helpdata/HELP_HR_ListEmployments.xml new file mode 100644 index 0000000..8cec311 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_ListEmployments.xml @@ -0,0 +1,29 @@ +<?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/data/helpdata/HELP_HR_NewEmployee.xml b/applications/humanres/data/helpdata/HELP_HR_NewEmployee.xml new file mode 100644 index 0000000..ca6b80f --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_NewEmployee.xml @@ -0,0 +1,34 @@ +<?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 new file mode 100644 index 0000000..e4bcc97 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_PayrollHistory.xml @@ -0,0 +1,81 @@ +<?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 new file mode 100644 index 0000000..41f7498 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_findEmployees.xml @@ -0,0 +1,63 @@ +<?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/data/helpdata/HELP_HR_main.xml b/applications/humanres/data/helpdata/HELP_HR_main.xml new file mode 100644 index 0000000..276abf3 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_main.xml @@ -0,0 +1,75 @@ +<?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/data/helpdata/HELP_HR_training.xml b/applications/humanres/data/helpdata/HELP_HR_training.xml new file mode 100644 index 0000000..e1a6bb5 --- /dev/null +++ b/applications/humanres/data/helpdata/HELP_HR_training.xml @@ -0,0 +1,128 @@ +<?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>