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:18 UTC
[ofbiz-framework] 04/06: Documented : Migrate Employee-position
Help to asciidoc and include in hr-employee-positions.adoc (OFBIZ-10259)
This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 97d15cbcb0aa3b91129f9c67e9f2ca74f8517133
Author: holivier <ho...@apache.org>
AuthorDate: Tue Feb 25 11:34:37 2020 +0100
Documented : Migrate Employee-position Help to asciidoc and include in
hr-employee-positions.adoc
(OFBIZ-10259)
Included all Help about Employee-position screen in a dedicated
sub-chapter "Employee Position management in UI"
Related Help file in docbook format is deleted
---
.../data/helpdata/HELP_HR_EditEmplPosition.xml | 107 ---------------------
.../data/helpdata/HELP_HR_EmplPositionView.xml | 27 ------
.../data/helpdata/HELP_HR_FindEmplPositions.xml | 56 -----------
.../data/helpdata/HELP_HR_ListEmplPositions.xml | 29 ------
.../_include/HELP-hr-EditEmplPosition.adoc | 68 +++++++++++++
.../asciidoc/_include/hr-employee-positions.adoc | 28 ++++--
6 files changed, 89 insertions(+), 226 deletions(-)
diff --git a/applications/humanres/data/helpdata/HELP_HR_EditEmplPosition.xml b/applications/humanres/data/helpdata/HELP_HR_EditEmplPosition.xml
deleted file mode 100644
index be6adf6..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_EditEmplPosition.xml
+++ /dev/null
@@ -1,107 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Create or Edit Employee Position</title>
-
- <para>This screen is used to create or edit and update an employee position.</para>
- <para>The main search screen it is opened in create mode by clicking the New Employee
- Position button or in update mode by clicking on the EmployeePosition Id
- column in Search Results.</para>
-
- <para>Fields</para>
-
- <itemizedlist>
- <listitem>
- <para>Employee Position Id - Unique Id for the position. May be
- user entered or if empty the system will generate sequence
- number.</para>
- </listitem>
-
- <listitem>
- <para>Status ID - One of Active/Open, Inactive/Closed or Planned
- For.</para>
- </listitem>
-
- <listitem>
- <para>Party Id - The party id of the
- internal organization authorized to fill the
- position.</para>
- </listitem>
-
- <listitem>
- <para>Budget Id - A user entered identifier for the budget
- authorizing the position.</para>
- </listitem>
-
- <listitem>
- <para>Budget Item Seq Id - A user entered identifier for the
- budget item authorizing the position.</para>
- </listitem>
-
- <listitem>
- <para>Empl Position Type Id - Select a name for the position type.
- Position types are defined in Global HR Settings
- .</para>
- </listitem>
-
- <listitem>
- <para>Estimated From Date - Enter date the position is expected to
- be filled.</para>
- </listitem>
-
- <listitem>
- <para>Estimated Thru Date - Enter date on which the positions
- budget authorization is expected to end.</para>
- </listitem>
-
- <listitem>
- <para>Salary Flag - Enter Y if this is a salaried position else
- N.</para>
- </listitem>
-
- <listitem>
- <para>Exempt Flag - Enter Y if this position exempt from a
- requirement else N</para>
- </listitem>
-
- <listitem>
- <para>Fulltime Flag - Enter Y if this is a fulltime position else
- N</para>
- </listitem>
-
- <listitem>
- <para>Temporary Flag - Enter Y if this is a temporary position
- else N</para>
- </listitem>
-
- <listitem>
- <para>Actual From Date - Enter the date the position is
- filled.</para>
- </listitem>
-
- <listitem>
- <para>Actual Thru Date - Enter the date the position is no longer
- authorized.</para>
- </listitem>
- </itemizedlist>
-
- <para>Click Create - to create the position.</para>
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_EmplPositionView.xml b/applications/humanres/data/helpdata/HELP_HR_EmplPositionView.xml
deleted file mode 100644
index 84d0501..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_EmplPositionView.xml
+++ /dev/null
@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>View Employee Position</title>
-
- <para>This screen displays summary details about an Employee Position including
- details about who currently holds the position, their responsibilities and
- the reporting structure.</para>
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_FindEmplPositions.xml b/applications/humanres/data/helpdata/HELP_HR_FindEmplPositions.xml
deleted file mode 100644
index 89e68f7..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_FindEmplPositions.xml
+++ /dev/null
@@ -1,56 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>Find Employee Positions</title>
-
- <para>An Employee Position is the authorization, typically from the budget of an
- internal organization,for the Company to engage someone to do a job. </para>
-
- <para>This means that you can fill a position in a number
- of different ways. </para>
-
- <para>You can fill a position with one full time person, change the assignment of
- a position from one person to another over time, or split a position across
- more then one person at the same a time.</para>
-
- <para>Positions have a status. They can be one of: Planned For,
- Active/Open, or Inactive/Closed.</para>
-
- <para>Positions have a type, defined in Global HR Settings, which
- describes the job and its pay rates. Some examples of job types could be
- secretary, production worker, sales manager, executive vice president or
- OFBiz programmer.</para>
- <para> If more then one person is needed for a type of job then
- a position must be created for each required person i.e. If 10 secretaries
- are authorized for the Human Resource department then 10 positions are
- created with type secretary.</para>
-
- <para>Positions have a reporting structure and report to other
- positions (and not the people who hold the position). </para>
- <para>You can identify the
- position a position reports to and/or the positions(s) a position
- manages.</para>
-
-
- <para>NOTE: Be careful because it is possible to create circular reporting
- structures.</para>
-
-
-</section>
diff --git a/applications/humanres/data/helpdata/HELP_HR_ListEmplPositions.xml b/applications/humanres/data/helpdata/HELP_HR_ListEmplPositions.xml
deleted file mode 100644
index 16626b4..0000000
--- a/applications/humanres/data/helpdata/HELP_HR_ListEmplPositions.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <title>List Employee Position</title>
-
- <para>This screen displays a list of positions for an employee.</para>
- <para>NOTE: Employee positions are created and managed in the 'Employee Position' menu option.</para>
- <para>Details about the position are displayed including any related dates and
- whether the position is temporary or not.</para>
-
-
-</section>
diff --git a/applications/humanres/src/docs/asciidoc/_include/HELP-hr-EditEmplPosition.adoc b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-EditEmplPosition.adoc
new file mode 100644
index 0000000..910fcc3
--- /dev/null
+++ b/applications/humanres/src/docs/asciidoc/_include/HELP-hr-EditEmplPosition.adoc
@@ -0,0 +1,68 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Create or Edit Employee Position
+This screen is used to create or edit and update an employee position.
+
+In the main search screen it is opened in create mode by clicking the New Employee Position button or
+ in update mode by clicking on the EmployeePosition Id column in Search Results.
+
+An Employee Position is the authorization, typically from the budget of an internal organization,
+for the Company to engage someone to do a job.
+
+This means that you can fill a position in a number of different ways.
+
+You can fill a position with one full time person, change the assignment of a position from one person
+ to another over time, or split a position across more then one person at the same a time.
+
+Positions have a status.
+They can be one of:
+
+* Planned For,
+* Active/Open,
+* Inactive/Closed.
+
+Positions have a type, defined in Global HR Settings, which describes the job and its pay rates. +
+Some examples of job types could be secretary, production worker, sales manager, executive vice president or OFBiz programmer.
+
+If more then one person is needed for a type of job then a position must be created for each required person i.e. +
+If 10 secretaries are authorized for the Human Resource department then 10 positions are created with type secretary.
+
+Positions have a reporting structure and report to other positions (and not the people who hold the position).
+
+You can identify the position a position reports to and/or the positions(s) a position manages.
+
+NOTE: Be careful because it is possible to create circular reporting structures.
+
+== Fields
+* Employee Position Id - Unique Id for the position. May be user entered or if empty the system will generate sequence number.
+* Status ID - One of Active/Open, Inactive/Closed or Planned For.
+* Party Id - The party id of the internal organization authorized to fill the position.
+* Budget Id - A user entered identifier for the budget authorizing the position.
+* Budget Item Seq Id - A user entered identifier for the budget item authorizing the position.
+* Empl Position Type Id - Select a name for the position type. Position types are defined in Global HR Settings .
+* Estimated From Date - Enter date the position is expected to be filled.
+* Estimated Thru Date - Enter date on which the positions budget authorization is expected to end.
+* Salary Flag - Enter Y if this is a salaried position else N.
+* Exempt Flag - Enter Y if this position exempt from a requirement else N
+* Fulltime Flag - Enter Y if this is a fulltime position else N
+* Temporary Flag - Enter Y if this is a temporary position else N
+* Actual From Date - Enter the date the position is filled.
+* Actual Thru Date - Enter the date the position is no longer authorized.
+
+Click Create - to create the position.
\ No newline at end of file
diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc
index 96a7147..1b6d4b9 100644
--- a/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc
+++ b/applications/humanres/src/docs/asciidoc/_include/hr-employee-positions.adoc
@@ -17,10 +17,9 @@ specific language governing permissions and limitations
under the License.
////
= Employee Positions
-
An employee position is also called a job position. It is a role that has been
-created to perform a specific task within the Company. This means that it has
-approved funding to pay it.
+created to perform a specific task within the Company. This means that it has
+approved funding to pay it.
Employee positions are defined by:
@@ -29,11 +28,11 @@ Employee positions are defined by:
* full-time or part-time
* the skills needed to fullfill the position
-NOTE: An employee positions is not the same as a person fullfilling the role.
-A person fulfilling an employee position is called an employee
+NOTE: An employee positions is not the same as a person fullfilling the role.
+A person fulfilling an employee position is called an employee
-An employee position can be fullfilled (i.e. someone is currently working in the
-role) or it can be unfulfilled (i.e. a job vacancy).
+An employee position can be fullfilled (i.e. someone is currently working in the
+role) or it can be unfulfilled (i.e. a job vacancy).
NOTE: In some cases an employee position could also be considered a full-time
equivalent (FTE) and can be assigned to more than one person (e.g. job sharing)
@@ -45,3 +44,18 @@ In the OFBiz Human Resources application you can:
* Define the responsibilities of an employee position
* Define a tree reporting structure between employee positions
* Track employment position fulfillments over time
+
+== Employee Position management in UI
+=== List Employee Position
+This screen displays a list of positions for an employee.
+
+NOTE: Employee positions are created and managed in the 'Employee Position' menu option.
+
+Details about the position are displayed including any related dates and whether the position is temporary
+ or not.
+
+include::HELP-hr-EditEmplPosition.adoc[leveloffset=+2]
+
+=== View Employee Position
+This screen displays summary details about an Employee Position including details about who currently holds
+the position, their responsibilities and the reporting structure.