|
Added: ofbiz/branches/webhelp-2012-12-07/applications/content/data/helpdata/docbookhelp/humanres_en/humanres.xml
URL: http://svn.apache.org/viewvc/ofbiz/branches/webhelp-2012-12-07/applications/content/data/helpdata/docbookhelp/humanres_en/humanres.xml?rev=1418622&view=auto ============================================================================== --- ofbiz/branches/webhelp-2012-12-07/applications/content/data/helpdata/docbookhelp/humanres_en/humanres.xml (added) +++ ofbiz/branches/webhelp-2012-12-07/applications/content/data/helpdata/docbookhelp/humanres_en/humanres.xml Sat Dec 8 08:21:03 2012 @@ -0,0 +1,9410 @@ +<?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. +--> + + +<book version="5.0" xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:m="http://www.w3.org/1998/Math/MathML" + xmlns:html="http://www.w3.org/1999/xhtml" + xmlns:db="http://docbook.org/ns/docbook"> + <info> + <title>OFBiz Human Resource Guide</title> + + <pubdate>July 1, 2012</pubdate> + </info> + + <chapter xml:id="HUMANRES_about"> + <title>About OFBiz Human Resources</title> + + <para>The people who work for your company, it's human capital, are it's + most important asset. Selecting a software platform that increases the + value of your companies human capital and delivers benefits, services and + opportunities to your workforce, is critical to your companies success + .</para> + + <para>That platform must be able to accurately and reliability process + worker transactions, collect decision support information, and communicate + between management, workers and outside resources. The OFBiz Human + Resource application (HR App) can provide a backbone for building that + platform.</para> + + <para>In this chapter you are introduced to the organization of this + document and to the key business objects that are the core to HR + App.</para> + + <sect1> + <title>Document Organization</title> + + <para>Chapter numbers are used here to refer to parts of the document. + Chapters numbers are not displayed in the on line help version of the + document. Hopefully this will not be to confusing to the online + reader.</para> + + <para>Chapter 1 is this introduction chapter. It lays out the purpose of + the remaining chapters and introduces some of the core HR App + features.</para> + + <para>Chapter 2 has instructions to get you started using HR App. A + list, in logical order, describes some activities you can preform to get + up and running.</para> + + <para>Chapters 3 thru 15 of provide the help documents that can be + invoked from the HR App in a context sensitive manner. When you work in + any of the HR App screens you can click on the Help icon in the menu bar + and the help browser will open to the relevant page in the + document.</para> + + <para>Each feature in the <glossterm linkend="G_HR_APP_MENU">HR App + Menu</glossterm> has in it's own chapter, screens within the feature are + sections within the chapter. Introductions to the chapters describe how + the screens work together to implement an important application feature. + Each screen is pictured and documented consistently with:</para> + + <itemizedlist> + <listitem> + <para>A picture of the screen.</para> + </listitem> + + <listitem> + <para>Breadcrumbs to show where to find the screen.</para> + </listitem> + + <listitem> + <para>A brief description of the screen usage.</para> + </listitem> + + <listitem> + <para>A list of fields in the screen.</para> + </listitem> + + <listitem> + <para>A list of actions that can be performed from the + screen.</para> + </listitem> + </itemizedlist> + + <para>Chapter 16 discuses OFBiz security settings for HR App</para> + + <para>Chapter 17 <link linkend="INTRA_APPL_INTEGRATION">HR App + Intra-Application Integration</link> covers usage scenarios for other + OFBiz applications. The HR Application is part of the larger OFBiz back + office set of administrative applications and is often dependent on + these other applications.</para> + + <para>Important terms in the documentation are defined in a Glossary. In + order to promote a consistent usage and understanding of terms, links to + the Glossary definitions are placed throughout the document.</para> + + <para>Notes in the document describe behavior that is not intuitive. + Links between document sections are used liberally tie together concepts + that cross chapter boundaries. For example screens that use information + managed in Global HR Settings are linked to the screens where they are + used.</para> + </sect1> + + <sect1> + <title>Introduction HR App</title> + + <para>The HR App data design, like most of the OFBiz back office + administration applications, was inspired by the data models in The Data + Model Resource Books by Len Silverston (see <command + xlink:href="http://silverston.wiley.com/index.html" + xlink:show="new">Silverston Data Model Resource Companion + Site</command>.) The sections below introduces some of the concepts in + HR App that were derived from the models.</para> + + <sect2> + <title>Positions</title> + + <para>Generally positions are authorized by a budget and fulfilled by + people. The person may be a company employee, or contract employee. + Positions may be salary or hourly, fulltime or part time. Positions + have responsibilities.</para> + + <para>Positions are defined by a type of work.</para> + + <para>For example there may be 20 positions in an organization for a + type secretary. Each position is authorized by a budget request from a + department in the organization. A position can me thought of as a + full-time equivalent employee (FTE). So an FTE may be assigned to one + or more positions and position can be assigned to more then one FTEs + (job sharing).</para> + + <para>In the HR App 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> + + <para>See: <link + linkend="HUMANRES_FindEmplPositions">Position</link></para> + </sect2> + + <sect2> + <title>People and Employees</title> + + <para>People may be employees of your Company, a company you do + business with, or unaffiliated contract employees. Any of these people + may be applicants for and assigned to positions in your + Company.</para> + + <para>If OFBiz a <glossterm linkend="G_PERSON">person</glossterm>is a + type of <glossterm linkend="G_PARTY">party</glossterm>. One of the + strengths of OFBiz is the rich set of features it has build up to + manage information and relationships for parties. This makes OFBiz a + great platform for HR services because managing people and + organizations is a core OFBiz technology.</para> + + <para>In the HR App you can:</para> + + <itemizedlist> + <listitem> + <para>View employee profiles</para> + </listitem> + + <listitem> + <para>Manage recruitment</para> + </listitem> + + <listitem> + <para>Create employees</para> + </listitem> + + <listitem> + <para>Track an employees performance, positions, skills, + qualifications, training, and leave</para> + </listitem> + </itemizedlist> + + <para>See: <link + linkend="HUMANRES_FindEmplLeaves">Employees</link></para> + </sect2> + + <sect2> + <title>Employments</title> + + <para>An employee is a person who works for your company. The terms + and history of this relationship between this person and your company + are managed in the Employments feature. Employments track the + benefits, pay preferences, pay history, unemployment claims and + agreements for the employment.</para> + + <para>In the HR App you can:</para> + + <itemizedlist> + <listitem> + <para>Create employments</para> + </listitem> + + <listitem> + <para>Track employment benefits, pay history, unemployment claims + and employment agreements</para> + </listitem> + </itemizedlist> + + <para>See: <link + linkend="HUMANRES_FindEmplPositions">Employments</link></para> + </sect2> + + <sect2> + <title>Department Organization</title> + + <para>Many companies organize departments<footnote> + <para>There is no special meaning attached to the word department. + It is used to describe any sub-division of a business + organization.</para> + </footnote> in a tree structure. Your Companies organizational tree + is shown on the main page of the HR App.</para> + + <para>In the HR App you can:</para> + + <itemizedlist> + <listitem> + <para>Add and remove departments</para> + </listitem> + + <listitem> + <para>View department profiles</para> + </listitem> + + <listitem> + <para>Assign positions to departments</para> + </listitem> + + <listitem> + <para>Manage department employments</para> + </listitem> + </itemizedlist> + </sect2> + </sect1> + </chapter> + + <chapter> + <title>Getting Started</title> + + <para>The Getting Started chapter discusses the common usage pattern + followed in the HR App UI, offers some links to general OFBiz getting + started documentation and most importantly provides a list of activities + you can perform to get the HR App up and running.</para> + + <sect1> + <title>The User Interface</title> + + <para>This guide was written based on the OFBiz trunk in the Summer of + 2012 using the default Tomahawk theme. The information should be useful + for users of earlier versions and other themes. The screen shots may + look different from what you see in your version but not so much so that + you can not understand the gist of the features.</para> + + <para>With close to 100 screens, some which link to applications outside + of the HR App, it is easy for a new user to get lost. Knowing the common + UI pattern used in HR App, as described here, will help you stay + oriented.</para> + + <para>In OFBiz screens are collection of graphical user interface (GUI) + elements that provide an intuitive way to interact with applications. In + the back office applications, like Accounting, Marketing and Human + Resource, menus are the primary method of navigation between GUI + screens. The Application menu is the top level menu and links to a back + office administration application. Each application has an application + sub menu that is the top level menu within the application.</para> + + <para>The HR App Menu in the diagram, which we will refer as the HR App + menu in this document, is such a sub menu. The pattern of navigation + from the HR App menu is depicted in the diagram below.</para> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="../humanres_en_images/OFBizMainScreen.gif" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para>Typically, but not always, HR App Menu items take their name from + an important application <glossterm + linkend="G_ENTITY">entity</glossterm>. For example you have Employees, + Employments, Employee Positions etc. All important information subjects + in human resource departments.</para> + + <para>Many of these menu items open a screen, we will call a <glossterm + linkend="G_MAIN_SEARCH_SCREEN">Main Search Screen</glossterm>, the top + layout in the above diagram. It has three screenlets 1. A link to a + screen for creating a new entity 2. A Search Options screenlet for + building a search filter 3. A search results screenlet that has columns + with navigation widgets to open other application areas.</para> + + <para>One of these navigation columns will open a screen we will call a + Feature Menu Screen. It has menu items for displaying / editing the + feature entity and it's supporting entities. The lower layout in the + diagram is an example of a Feature Menu Screen that shows a default + screen with summary information about the entity. The default screen is + sometimes an edit screen where the main entity can be edited and + updated.</para> + + <para>HR App Features that follow this pattern include:</para> + + <itemizedlist> + <listitem> + <para><link linkend="HUMANRES_FindEmployee">Employees</link></para> + </listitem> + + <listitem> + <para><link + linkend="HUMANRES_FindEmployments">Employments</link></para> + </listitem> + + <listitem> + <para><link linkend="HUMANRES_ListEmplPositions">Employee + Position</link></para> + </listitem> + + <listitem> + <para><link linkend="HUMANRES_FindPerfReviews">Performance + Review</link></para> + </listitem> + + <listitem> + <para><link linkend="HUMANRES_FindPartySkills">Skills</link> + <footnote> + <para>This entity does not link to a Feature Menu Screen. Entity + editing and update are done in the Search Results.</para> + </footnote></para> + </listitem> + + <listitem> + <para><link linkend="HUMANRES_FindPartyQuals">Qualifications</link> + <superscript>1</superscript></para> + </listitem> + + <listitem> + <para><link + linkend="HUMANRES_FindJobRequisitions">Recruitment</link></para> + </listitem> + + <listitem> + <para><link linkend="HUMANRES_FindEmploymentApps">Employment + Applications</link> <superscript>1</superscript></para> + </listitem> + + <listitem> + <para><link + linkend="HUMANRES_FindPartyResumes">Resumes</link></para> + </listitem> + + <listitem> + <para><link linkend="HUMANRES_FindEmplLeaves">Leave</link></para> + </listitem> + </itemizedlist> + </sect1> + + <sect1> + <title>Getting Started With OFBiz</title> + + <para>If you are just getting started with OFBiz you will want to read + the <command + xlink:href="https://cwiki.apache.org/OFBADMIN/demo-and-test-setup-guide.html" + xlink:show="new">Demo and Test Setup Guide</command>. If you are + reviewing the application you will likely want to run the load-demo ant + task for this purpose. This will load the seen HR data for Global HR + Settings plus demo users and selected user HR data.</para> + + <para>If you are setting up for production you should have read <command + xlink:href="https://cwiki.apache.org/confluence/display/OFBTECH/Apache+OFBiz+Technical+Production+Setup+Guide#ApacheOFBizTechnicalProductionSetupGuide-InitialDataLoading" + xlink:show="new">Apache OFBiz Technical Production Setup + Guide</command>. Follow the instructions on Initial Data Loading. If you + run the ant task load-seed the data for the HR Portlet, <link + linkend="HUMANRES_EditSkillType">Global HR2 Settings</link>, and the + Human Resource security settings admin, view, create, update, and delete + are loaded.</para> + + <para>If you are going to be writing pay checks you will need to set up + the Accounting feature, see <command + xlink:href="https://cwiki.apache.org/confluence/display/OFBIZ/Quick+Start+-+Basic+Accounting+Setup" + xlink:show="new">Quick Start - Basic Accounting Setup.</command></para> + </sect1> + + <sect1> + <title>Getting Started With HR App</title> + + <para>Here is a list of activities you can follow that will help you get + HR App up and running in your company.</para> + + <sect2> + <title>Reference Data</title> + + <para>Reference data in the HR App are the items used in + drop-down-list for the purpose of classifying other information or + limiting user selections. These list are managed in <link + linkend="HUMANRES_EditSkillType">Global HR Settings</link>, review all + of the information in that feature to make sure the list items make + sense for your business. Some list items in HR App are not exposed in + Global HR Settings. To customize those list use <link + linkend="INTRA_APPL_INTEGRATION_ENTITY_DATA_MAINT">Entity Data + Maintenance</link> described in the HR App Intra-Application + Integration chapter.</para> + </sect2> + + <sect2> + <title>People</title> + + <para>In this section we will set up information about people. After + completing this section you will be able to answer questions about + people and their skills, qualifications and experience.</para> + + <itemizedlist> + <listitem> + <para>Add employees and people who may be applicants or contract + employees. You add employees using the <link + linkend="HUMANRES_FindEmployee">New Employee</link> screen. Add + other people to your system using the Party Manager application. + See HR App Intra-Application Integration <link + linkend="INTRA_APPL_INTEGRATION_CREATE_PERSON">Create + Person</link>.</para> + </listitem> + + <listitem> + <para>Add the skills and qualifications for the people you added + in the prior step. For employees you can use the <link + linkend="HUMANRES_EditEmployeeSkills">Skills</link> menu item and + <link linkend="HUMANRES_EditEmployeeQuals">Qualifications</link> + menu item in the Employees Feature Menu Screen. For non employees + (and employees) you can use the <link + linkend="HUMANRES_EditEmployeeSkills">Skills</link> and <link + linkend="HUMANRES_EditEmployeeQuals">Qualifications</link> + features.</para> + </listitem> + + <listitem> + <para>Add employee resumes using <link + linkend="HUMANRES_EditPartyResume">Resume</link> feature.</para> + </listitem> + + <listitem> + <para>Add training classes in the <link + linkend="HUMANRES_TrainingCalendar">Training</link> feature and + class participants</para> + </listitem> + </itemizedlist> + </sect2> + + <sect2> + <title>Department Organization</title> + + <para>In this section we will set up your organization structure using + the GUI tree interface in the <link linkend="HUMANRES_main">Main + Window</link>.</para> + + <para><itemizedlist> + <listitem> + <para>In the HR App your organization structure is a tree built + of <link linkend="G_INTERNAL_ORGANIZATION">internal + organizations.</link> You will create the internal organizations + using the Party application and then link them together using + the HR App GUI Tree in <link linkend="HUMANRES_main">Main + Window</link>. See <link + linkend="INTRA_APPL_INTEGRATION_CREATE_INTERNAL_ORG">Create + Internal Organization</link> to learn how to create Internal + Organizations.</para> + </listitem> + + <listitem> + <para>After creating your Internal Organizations link them + together into an organization structure using the context menu + in the tree widget. Right click on an organization icon. Select + a internal organization from the drop-down list. The + organization is added to the tree beneath the selected + node</para> + </listitem> + </itemizedlist></para> + </sect2> + + <sect2> + <title>Employments</title> + + <para>Now that we have people and organizations in our application we + can bring them together in an employment. An employment is a + relationship between person (who must be an employee) to an internal + organization. The employment relationship tracks information about + employees benefits, preferences and employment agreement.</para> + + <itemizedlist> + <listitem> + <para>Create an employment using the <link + linkend="HUMANRES_EditEmployment">Employments</link> + feature.</para> + </listitem> + + <listitem> + <para>Add <link + linkend="HUMANRES_EditPartyBenefits">Benefits</link> and <link + linkend="HUMANRES_EditPayrollPreferences">Preferences</link></para> + </listitem> + + <listitem> + <para>You can establish a formal agreement for the employment in + the <link + linkend="HUMANRES_EditAgreementEmploymentAppls">Agreement + Employment Applications</link> screen</para> + </listitem> + </itemizedlist> + </sect2> + + <sect2> + <title>Positions</title> + + <para>At this point we have people and organizations and an employment + agreement that specifies the terms of the employment. It's time to + give the employee something to do so in this section you will set up + positions (jobs). As you set up your positions you can add + responsibilities and reporting structure.</para> + + <itemizedlist> + <listitem> + <para>Add jobs in the <link + linkend="HUMANRES_EditEmplPosition">Employee Position</link> + feature.</para> + </listitem> + + <listitem> + <para>You can list the responsibilities of a position over time + using the <link + linkend="HUMANRES_EditEmplPositionResponsibilities">Responsibilities</link> + screen.</para> + </listitem> + + <listitem> + <para>You can set up a reporting structure for positions using the + <link + linkend="HUMANRES_EditEmplPositionReportingStructs">Reporting + Structure</link> screen.</para> + </listitem> + + <listitem> + <para>After you have created a job you bind it to a person (who be + an employee or a contract employee) using <link + linkend="HUMANRES_EditEmplPositionFulfillments">Fulfillments</link></para> + </listitem> + </itemizedlist> + </sect2> + + <sect2> + <title>Recruiting</title> + + <para>The business is growing and you need help. Hear is how you can + recruit new employees.</para> + + <itemizedlist> + <listitem> + <para>User the <link + linkend="HUMANRES_FindJobRequisitions">Recruitment</link> feature + to requisition new jobs.</para> + </listitem> + + <listitem> + <para>After a requisition is created you post the job using <link + linkend="HUMANRES_FindInternalJobPosting">Internal Job + Posting</link>.</para> + </listitem> + + <listitem> + <para>Applicants can apply for positions in the <link + linkend="HUMANRES_FindEmploymentApps">Employment + Applications.</link></para> + </listitem> + </itemizedlist> + </sect2> + + <sect2> + <title>Security</title> + + <para>HR App display and usage is controlled by OFBiz security which + depending on a users role allows or prevents a user from seeing + information in or taking action on HR App features. General + information about Security is discussed in the <link + linkend="SECURITY">Security</link> chapter.</para> + </sect2> + </sect1> + </chapter> + + <chapter xml:id="HUMANRES_main"> + <title>Main Window</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/MainCompanyTreeView.jpg" + format="jpg" scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs -</emphasis> Applications > + HR</para> + + <para>The Main window is the entry point into the HR App and displays the + Company tree view for navigating to key HR App items.</para> + + <para><emphasis role="bold"> Nodes In the Company Tree</emphasis></para> + + <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 HR App organization. The Company and departments under the + Company can have children departments or positions. Under positions are + the people who fulfill the position.</para> + + <para>See: <command + xlink:href="https://cwiki.apache.org/OFBENDUSER/apache-ofbiz-business-setup-guide.html#ApacheOFBizBusinessSetupGuide-generalCompanySetup" + xlink:show="new">OFBiz General Company Setup</command> for directions on + replacing the root "Your Company Name Here [Company]" with the name of + your company.</para> + + <para><emphasis role="bold">Usage</emphasis></para> + + <itemizedlist> + <listitem> + <para>Navigate the HR 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> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Click on an tree node to open the profile view of the item + represented by the node</para> + </listitem> + + <listitem> + <para>Right click on a node to open a pop up context menu</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Context Menu Actions</emphasis></para> + + <para>Right click on a node in the Company tree to open the context + menu.</para> + + <para><emphasis role="bold">Organization Node Options</emphasis></para> + + <itemizedlist> + <listitem> + <para>Add Employee Position: Select to open the <link + linkend="HUMANRES_EditEmplPosition">Employee Position</link> + screenlet</para> + </listitem> + + <listitem> + <para>Add Internal Organization: Select opens a drop down list of + internal organization Id's. Select an id and click create. The + organization name is added below the current node.</para> + </listitem> + + <listitem> + <para>Remove Internal Organization: Select Remove Internal + Organization. You are prompted to confirm. Click OK. The organization + is remove from the tree.</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Position Node Option:</emphasis> Add Person: + Select to open the <link + linkend="HUMANRES_EditEmplPositionFulfillments">Add Position + Fulfillment</link> screenlet.</para> + </chapter> + + <chapter xml:id="HUMANRES_FindEmployee"> + <title>Employees</title> + + <para>The Employees feature manages information about people who have an + <glossterm linkend="G_EMPLOYMENT">employment</glossterm> relationship with + your Company or one of it's departments. This features include an + <glossterm linkend="G_EMPLOYEE">employee</glossterm> 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> + + <sect1> + <title>Find Employee</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmployeesMain.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis> - HR Human Resources + > Employees</para> + + <para><emphasis role="bold">Usage</emphasis> - In the Employees 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 + employees profile and other screens associated with the employee. The + Employees screen is divided in three screenlets, they are described in + the following sections.</para> + + <sect2 xml:id="HUMANRES_NewEmployee"> + <title>New Employee</title> + + <mediaobject> + <imageobject> + <imagedata fileref="../humanres_en_images/EmployeeNewEmployee.png" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources + > Employees - Click New Employee</para> + + <para><emphasis role="bold">Usage</emphasis> - Create a new + Employee.</para> + + <para><emphasis role="bold">Actions</emphasis> - Click so save a new + Employee.</para> + </sect2> + + <sect2> + <title>Find an employee</title> + + <para><emphasis role="bold">Breadcrumbs - </emphasis>Human Resources + > Employees</para> + + <para><emphasis role="bold">Usage -</emphasis> Find an employee using + search criteria.</para> + + <note> + <para>Only Employees Are Found.</para> + + <para>Use the Party Manager application to get information about + people who are not employees.</para> + + <para>To do this: In the Applications menu select Party, enter + search criteria to search for the person, to return the HR App + select HR from the Applications menu.</para> + </note> + + <para><emphasis role="bold">Fields</emphasis></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</para> + + <note> + <para>An employee may have zero or more user logins.</para> + </note> + </listitem> + + <listitem> + <para>Last name - Employee last name</para> + </listitem> + + <listitem> + <para>First name - Employee first name</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <para>Actions are described from the left to right, top to bottom of + the Find an employee screen.</para> + + <itemizedlist> + <listitem> + <para>Contact Information radio buttons - Displays or hides + additional criteria fields.</para> + </listitem> + + <listitem> + <para>Lookup Party button (title bar): Opens a list of employees + based on the criteria entered.</para> + </listitem> + + <listitem> + <para>Hide Fields / Show Lookup Fields button (title bar): Hides / + shows the filter fields in the "Find an employee" + screenlet.</para> + </listitem> + + <listitem> + <para>Lookup Party icon (right of Party Id field): Opens a pop up + search form that finds a Party Id. Use the form to find employees + by id or first and last name when you do not know the employee id. + Remember the search is only for employees and not all people are + employees.</para> + </listitem> + + <listitem> + <para>Lookup Party button(button center of "Find an employee" + footer): Opens a list of employees using the criteria in the "Find + an employee" screenlet (same as Lookup Party in the title + bar).</para> + </listitem> + + <listitem> + <para>Show all records button: Opens a list of all employees (same + as selecting Lookup Party without entering a criteria).</para> + </listitem> + </itemizedlist> + </sect2> + + <sect2> + <title>Parties found</title> + + <para>This section list the employees found by the Find an employee + search.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>PARTY ID: The unique identifier for the employee.</para> + </listitem> + + <listitem> + <para>USER LOGIN: The user login for the employee. May be + "(None)", "(Many)" in the case where an employee has no or more + then one login.</para> + </listitem> + + <listitem> + <para>NAME: The last name, first name of the employee.</para> + </listitem> + + <listitem> + <para>TYPE: The party type of the employee. Typically + "Person"</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Party Id link (left column in Parties Found list): Opens the + employees profile.</para> + </listitem> + + <listitem> + <para>DETAILS button (right column in Parties Found list): Opens + the employees profile (same as clicking the Party Id link).</para> + </listitem> + </itemizedlist> + </sect2> + </sect1> + + <sect1 xml:id="HUMANRES_EmployeeProfile"> + <title>Profile (Employee)</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmployeeProfile.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para>The Profile screen for an employee is a collection of screenlets + each presenting information about a different aspect of the employee. It + is the first item on a menu that has screens for other information + related to the employee.</para> + + <para>Usage</para> + + <itemizedlist> + <listitem> + <para>View a summary of information on an employee in a single + screen</para> + </listitem> + + <listitem> + <para>Update 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> + + <para><emphasis role="bold">Each of the Profile screenlets are described + in the sections that follow.</emphasis></para> + + <sect2> + <title>Personal Information Screenlet</title> + + <para>The Personal Information screenlet has only a few of the fields + available in OFBiz for recording information about an employee. You + can collect and edit additional information by clicking the Update + link in the title bar.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>Party Id: The id of a employee associated with the profile + information</para> + </listitem> + + <listitem> + <para>Name: The first and last name of the employee</para> + </listitem> + + <listitem> + <para>Comments: A comment associated with the employee</para> + </listitem> + + <listitem> + <para>External Id: The id of an external login system e.g. An LDAP + server</para> + </listitem> + + <listitem> + <para>Status ID: Available status: Enabled, Disabled, and + Assigned.</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Action </emphasis>Update title bar button: + Edit Personal Information</para> + </sect2> + + <sect2> + <title>Contact Information Screenlet</title> + + <para>The Contact Information screenlet summarizes contact details for + multiple channels including:</para> + + <itemizedlist> + <listitem> + <para>Electronic Address</para> + </listitem> + + <listitem> + <para>Postal Address</para> + </listitem> + + <listitem> + <para>Phone Number</para> + </listitem> + + <listitem> + <para>Email Address</para> + </listitem> + + <listitem> + <para>Internet IP Address</para> + </listitem> + + <listitem> + <para>Internet Domain Name</para> + </listitem> + + <listitem> + <para>Web URL/Address</para> + </listitem> + + <listitem> + <para>Internal Party Note</para> + </listitem> + + <listitem> + <para>LDAP Address</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Create New - Opens the Create New Contact Information + screen</para> + </listitem> + + <listitem> + <para>Update - Click to change information or add a contact + purpose. You can add a contact purpose when you create and Email + Address, Phone Number or LDAP Address. Use Update to add a contact + purpose to Postal Address or Web URL/Address. You can not add a + purpose to Electronic Address, Internet IP Address, Internet + Domain Name and Internal Party Note</para> + </listitem> + + <listitem> + <para>Expire - Click to sets the through date (not visible the + user) on the contact item. The item is no longer displayed in + Contact Information.</para> + </listitem> + + <listitem> + <para>lookup:anywho.com (only in Phone Number)- Click opens + http://www.anywho.com/reverse-lookup in a new browser + window</para> + </listitem> + + <listitem> + <para>Look up White pages (only in Phone Number) - Click opens + http://www.whitepages.com/search in a new browser window</para> + </listitem> + + <listitem> + <para>Send Mail (only in Email Address) - Opens a new + communications event. For help see Send Email in the OFBiz Support + Apps document.</para> + </listitem> + + <listitem> + <para>open page in new window (only in Web URL/Address) - Click to + open the address in a new browser window.</para> + </listitem> + </itemizedlist> + </sect2> + + <sect2> + <title>List Related Accounts Screenlet</title> + + <para>Accounts are created in the SFA Manger application See SFA + Manager Accounts SFA. Listing an account in the Profile provides a + quick link in the HR App to the profile of the account.</para> + + <para><emphasis role="bold"> To Add a Related + Account:</emphasis></para> + + <orderedlist> + <listitem> + <para>Click Create New to add an account to your Profile</para> + </listitem> + + <listitem> + <para>Click the Lookup Icon</para> + </listitem> + + <listitem> + <para>Select from the list of Id's.</para> + </listitem> + + <listitem> + <para>Click Add</para> + </listitem> + + <listitem> + <para>The Account is added to the list of Related Accounts in your + profile.</para> + </listitem> + </orderedlist> + + <para><emphasis role="bold">Action</emphasis> Click the From Party Id + field (in brackets and bold) to open the Related Account + profile.</para> + </sect2> + + <sect2> + <title>Training Screenlet</title> + + <para>The Training screenlet displays a list of classes that have been + assigned to this person.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>From Date - Start date time for training</para> + </listitem> + + <listitem> + <para>Thru Date - End date time for training</para> + </listitem> + + <listitem> + <para>Training Class Type - Name describing class category. See : + <link linkend="HUMANRES_EditTrainingTypes">Training Class + Type</link></para> + </listitem> + + <listitem> + <para>Approver Status - One of Applied, Approved, Assigned, + Proposed or Rejected</para> + </listitem> + + <listitem> + <para>Approver Party - Person with authority to approve + training</para> + </listitem> + </itemizedlist> + + <para>For more information see: <link + linkend="HUMANRES_TrainingCalendar">Training</link></para> + </sect2> + + <sect2> + <title>Current Employment information Screenlet</title> + + <para><emphasis role="bold">Usage -</emphasis> This screenlet shows + the employee's department, position and salary.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>Company - The organization unit to which the employee is + assigned</para> + </listitem> + + <listitem> + <para>Position - Position(s) held by the employee</para> + </listitem> + + <listitem> + <para>Salary - Employee salary</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Company [some text]: Click to open Company profile<note> + <para>The Profile opened is in the Party Manager application. + To return to the HR App select Applications > HR</para> + </note></para> + </listitem> + + <listitem> + <para>Position [some text]: Click to open position Summary + screen.</para> + </listitem> + </itemizedlist> + </sect2> + + <sect2> + <title>User Name(s) Screenlet</title> + + <para><emphasis role="bold">Usage -</emphasis> The User Name(s) + screenlet manages user logins and security settings. Logins give a + user the ability log into an OFBiz application while security settings + control what the user can do while logged on.</para> + + <para>Users with create privileges in the Party Manager application + have the ability to create user logins and then to manage the login + password and security setting. Others will see a list user login names + and status (ENABLED or DISABLED).</para> + + <para>Users may have no user login or multiple logins. Each login has + it's own set of security settings so multiple logins provide + flexibility in controlling a users connection to OFBiz + applications.</para> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Create New text in title bar: Opens the Create User Login + screenlet.</para> + </listitem> + + <listitem> + <para>Edit button: Opens the Edit Login screen where a user can + update the login or change the password.</para> + </listitem> + + <listitem> + <para>Security Groups button: Opens the + AddUserLoginToSecurityGroup screenlet where you can add, update or + delete <glossterm linkend="G_SKILL_GROUP">Security + Groups</glossterm>.</para> + </listitem> + </itemizedlist> + </sect2> + + <sect2> + <title>Party Attribute(s) Screenlet</title> + + <para><emphasis role="bold">Usage -</emphasis> Party Attributes + provide an ability for users to attach arbitrary names and values to + people. These name value pairs can be used in different ways to extend + the information collected about a person without having to make + changes to the database.</para> + + <para>For example, a name could be added "On Company Team" with a + value "Football". A report could be created for employees grouped by + Company Team.</para> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Create New title bar button: Opens the Party Attribute + screenlet where you can create name value pairs for the + party.</para> + </listitem> + + <listitem> + <para>Edit button: Click to open Party Attribute screenlet where + you can update name value pairs for the party.</para> + </listitem> + </itemizedlist> + </sect2> + + <sect2> + <title>Party Content Screenlet</title> + + <para><emphasis role="bold">Usage -</emphasis> The Party Content + screenlet provides a means to load content to the OFBiz Content + Manager application. You can use this feature to load your picture for + display in your profile.</para> + + <para><emphasis role="bold">Action -</emphasis> To load an image for + display in the Personal Information screenlet:</para> + + <orderedlist> + <listitem> + <para>Click Browse and select an image using the native file + search</para> + </listitem> + + <listitem> + <para>In the drop-down list select Logo Image URL</para> + </listitem> + + <listitem> + <para>In Is Public select Yes</para> + </listitem> + + <listitem> + <para>Click Upload.</para> + </listitem> + </orderedlist> + + <para>After a screen refresh the selected image will appear above + Party Id in the Personal Information as Personal Image</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>Content Id - A unique content identifier linking the + employee to the content</para> + </listitem> + + <listitem> + <para>Content Type - One of Internal Content, User Defined + Content, Logo Image URL, or Vendor Shipping Info</para> + </listitem> + + <listitem> + <para>Content Name - A user defined name for the content</para> + </listitem> + + <listitem> + <para>Content Description - A user defined description of the + content</para> + </listitem> + + <listitem> + <para>Content mime type - One of application/octet-stream, + application/pdf, image/gif, image/jpeg, text/html, text/plain, or + text/x-diff</para> + </listitem> + + <listitem> + <para>Status- One of Available Deactivated, Final Draft, In + Progress, Initial Draft, Published, or Revised Draft</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Content Id button: Opens the dedicated Party Content + screen.</para> + </listitem> + + <listitem> + <para>View button: Click to open content. Content will open in a + viewer appropriate for the content type.</para> + </listitem> + + <listitem> + <para>Remove button: Deletes the record</para> + </listitem> + + <listitem> + <para>Browse button: Opens system file upload</para> + </listitem> + + <listitem> + <para>Upload button: Uploads file to OFBiz runtime > upload + folder. A record is created in Content Manager.</para> + </listitem> + </itemizedlist> + + <note> + <para>You can manage the uploaded content in OFBiz content manager. + To find the content:</para> + + <orderedlist> + <listitem> + <para>In the main Applications menu select Content.</para> + </listitem> + + <listitem> + <para>In the Content Manager Menu select Content</para> + </listitem> + + <listitem> + <para>In the content id filed enter the content id as displayed + in the Party Content list.</para> + </listitem> + + <listitem> + <para>Click Find</para> + </listitem> + </orderedlist> + </note> + </sect2> + + <sect2> + <title>Notes Screenlet</title> + + <para><emphasis role="bold">Usage -</emphasis> In the Notes screenlet + you can create and display notes. Notes may not be updated after they + are created.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>Note Name - Required name for the note. The text of the node + is to the right of the name.</para> + </listitem> + + <listitem> + <para>By - Name of the person who created the note.</para> + </listitem> + + <listitem> + <para>At - Date time note was entered</para> + </listitem> + </itemizedlist> + </sect2> + </sect1> + + <sect1 xml:id="HUMANRES_ListEmployments"> + <title>Employments</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmployeeEmployments.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employees > Click Lookup Party > Click Details > Click Menu + Item Employments</para> + + <para><emphasis role="bold">Usage -</emphasis> This screen displays a + convenient list of <glossterm + linkend="G_EMPLOYMENT">Employments</glossterm> for an employee, however + usually a person will have only a single employment. You can navigate to + the employee profile to view summary information on the employee or to + the employment edit page in the <link + linkend="HUMANRES_FindEmployments">Employments</link> feature to edit + the employment.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para><glossterm linkend="G_INTERNAL_ORGANIZATION">Internal + Organization</glossterm></para> + </listitem> + + <listitem> + <para>Employee Party Id - The <glossterm linkend="G_PARTY_ID">party + Id</glossterm> of the employee.</para> + </listitem> + + <listitem> + <para>From Date - Hire date</para> + </listitem> + + <listitem> + <para>Thru Date - Last day of employment.</para> + </listitem> + + <listitem> + <para><glossterm linkend="G_TERMINATION_REASON">Termination + Reason</glossterm> Id - The reason for the. Reasons are defined in + Global HR Settings <link + linkend="HUMANRES_EditTerminationReasons">Termination + Reasons</link>.</para> + </listitem> + + <listitem> + <para><glossterm linkend="G_TERMINATION_TYPE">Termination + Type</glossterm> Id - The type of termination. Types are defied in + Global HR Settings <link + linkend="HUMANRES_EditTerminationTypes"><link + linkend="HUMANRES_EditTerminationTypes">Termination + Type</link></link>.</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>DemoEmployee button: Opens the PROFILE screen<note> + <para>This action is the same as clicking on the Profile menu + item adjacent to this item.</para> + </note></para> + </listitem> + + <listitem> + <para>Edit button: Opens the Edit Employment screen in the <link + linkend="HUMANRES_FindEmployments">Employments</link> + feature.</para> + </listitem> + </itemizedlist> + </sect1> + + <sect1 xml:id="HUMANRES_ListEmplPositions"> + <title>Employee Position</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmployeeListEmplPositions.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employees > Click Lookup Party > In Parties Found Click Details + > Click Menu Item Employee Position</para> + + <para>Usage - This screen displays a convenient list of <glossterm + linkend="G_POSITION">positions</glossterm> for an employee. Employee + positions are created and managed in the <link + linkend="HUMANRES_EditEmplPosition">Employee Position</link> feature. + From this screen you can navigate to the employee position profile + screen of the employee to view summary information on the employees + position. Click the link button in the party id column to navigate to + the profile of the <link linkend="G_INTERNAL_ORGANIZATION">internal + organization</link> authorized to fill the position.</para> + + <para>To edit position information see <link + linkend="HUMANRES_EditEmplPosition">Edit Employee Position</link></para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>Status ID - One of Active/Open, Inactive/Closed or Planed + For.</para> + </listitem> + + <listitem> + <para><glossterm><glossterm linkend="G_PARTY_ID">Party + Id</glossterm></glossterm></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para><glossterm linkend="G_BUDGET_ID">Budget Id</glossterm></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para><glossterm linkend="G_BUDGET_SEQUENCE_ID">Budget Item Sequence + Id</glossterm></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para><glossterm linkend="G_EMPLOYEE_POSITION_TYPE">Employee + Position Type</glossterm></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Estimate From Date - May be used for budgeting</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Estimate Thru Date - May be used for budgeting</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para><glossterm linkend="G_SALARY_FLAG">Salary + Flag</glossterm></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para><glossterm linkend="G_EXEMPT_FLAG">Exempt + Flag</glossterm></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para><glossterm linkend="G_FULLTIME_FLAG">Fulltime + Flag</glossterm></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para><glossterm linkend="G_TEMPORY_FLAG">Temporary + Flag</glossterm></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Actual From Data - May be used for financial and regulatory + reporting</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Actual Thru Data - May be used for financial and regulatory + reporting</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Employee Position Id text link: Click to open the Summary + screen (profile) in the Employee Position feature for the employee + position</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Party Id button: Click to open profile screen of the + organization assigned to the position</para> + </listitem> + </itemizedlist> + </sect1> + + <sect1 xml:id="HUMANRES_EditEmployeeSkills"> + <title>Skills</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmployeeSkills.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employees > Click Lookup Party > In Parties Found Click Details + > Click Menu Item Skills</para> + + <para><emphasis role="bold">Usage -</emphasis> You can assign a skill to + an employee or organization in the Skills screen. Assign numeric values + to <link linkend="G_YEARS_EXPERIENCE">Years Experience</link>, <link + linkend="G_RATING">Rating</link> and <link linkend="G_SKILL_LEVEL">Skill + Level</link> to provide objective criteria for discriminating between + resources with the same skill. These attributes can be used in the <link + linkend="HUMANRES_FindPartySkills">Skills</link> feature to locate + resources with a needed skill.</para> + + <para>You manage skill in <link linkend="HUMANRES_EditSkillType">Global + HR Settings</link> by creating new skill groups and skills or editing + existing skills. You can search for employees skills as well as manage + employee skills in the <link + linkend="HUMANRES_FindPartySkills">Skills</link> feature.</para> + + <para><emphasis role="bold">. Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>Person Id - The unique identifier of the person assigned the + skill.</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Skill - The skill name from <link + linkend="HUMANRES_EditSkillType">Global HR Settings</link></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para><link linkend="G_YEARS_EXPERIENCE">Years Experience</link> - A + numeric value identifying the number of years of experience.</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para><link linkend="G_RATING">Rating</link> - A numeric value that + can be used as a filter for finding and reporting on skills in the + company.</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para><link linkend="G_SKILL_LEVEL">Skill Level</link> - A numeric + value that can be used as a filter for finding and reporting on + skills in the company</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Create button - Click to add a skill to an employees list of + skills</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Update button - Click to update changes Years Experience, + Rating and Skill Level</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Delete button - Click to delete a skill from the employee's + skill list. Deleted skills can not</para> + </listitem> + </itemizedlist> + </sect1> + + <sect1 xml:id="HUMANRES_EditEmployeeQuals"> + <title>Qualifications</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmployeeEditEmployeeQuals.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employees > Click Lookup Party > In Parties Found Click Details + > Click Menu Item Qualifications</para> + + <para><emphasis role="bold">Usage - </emphasis>You can assign a <link + linkend="G_PARTY_QUALIIFICATION_TYPE">qualification</link> to a person + or an organization to track their ability to perform a job.</para> + + <para>You can search and also assign qualifications in the + Qualifications feature. You can manage qualification groups and types in + Global Settings Qualification Type.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para><link + linkend="G_PARTY_QUALIIFICATION_TYPE">Qualification</link> - The + Qualification name.</para> + </listitem> + + <listitem> + <para>From Date - The start date of the qualification.</para> + </listitem> + + <listitem> + <para>Qualification Desc - A user defined description of the + qualification.</para> + </listitem> + + <listitem> + <para>Title - A user defined title of the qualification</para> + </listitem> + + <listitem> + <para>Status - One of completed, deferred or incomplete may be used + to indicate if state of the qualification for the party.</para> + </listitem> + + <listitem> + <para>Verify Status - Indicates if the validity of the qualification + has be checked.</para> + </listitem> + + <listitem> + <para>Thru Date - The end date of the qualification i.e. The + expiration date of a drivers license</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Update button: Click to save changes to the + qualification.</para> + </listitem> + + <listitem> + <para>Delete button: Click to delete the qualification. The + qualification is deleted and can not be restored.</para> + + <note> + <para>Instead of deleting a qualification it is better to set the + thru date.</para> + </note> + </listitem> + + <listitem> + <para>Create button: Click to create a new qualification for the + party.</para> + </listitem> + </itemizedlist> + </sect1> + + <sect1 xml:id="HUMANRES_EditEmployeeTrainings"> + <title>Training</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmployeeTraining.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employees > Click Lookup Party > In Parties Found Click Details + > Click Menu Item Training</para> + + <para><emphasis role="bold">Usage </emphasis>- This screen presents a + list of a persons training status. Training is managed in the <link + linkend="HUMANRES_FindTrainingStatus">Training Status</link> screen in + the Calendar feature. Classes classes can be created and participants + assigned in <link linkend="HUMANRES_TrainingCalendar">Training + Calendar</link>.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>Employee Party Id - The unique identifier for person + associated with the training list.</para> + </listitem> + + <listitem> + <para>Training Request Id - The identifier for the request for this + person to attend the training.</para> + </listitem> + + <listitem> + <para>Training Class Type - The name of the training class.</para> + </listitem> + + <listitem> + <para>Work Effort Id - This field can be ignored by the user.</para> + </listitem> + + <listitem> + <para>From Date - The date and time the training starts</para> + </listitem> + + <listitem> + <para>Thru Date - The date and time the training ends.</para> + </listitem> + + <listitem> + <para>Status - The approval status for the person for this class. + May be one of</para> + </listitem> + + <listitem> + <para>Reason - Reason for training</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Employee Party Id button: Click to open the employees profile + in the OFBiz Party Manager application.</para> + </listitem> + + <listitem> + <para>Approver Party button: Click to open the approvers profile in + the OFBiz Party Manager application.</para> + </listitem> + </itemizedlist> + + <warning> + <para>The OFBiz Party Manager application is separate from the HR App. + To return to the HR App Select HR from the Applications menu. You will + be returned to the main <link linkend="HUMANRES_main">Main</link> + screen.</para> + </warning> + </sect1> + + <sect1 xml:id="HUMANRES_EditEmployeeLeaves"> + <title>Leave</title> + + <para>Payroll history displays a list of invoices</para> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmployeeEditEmployeeLeaves.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employees > Click Lookup Party > In Parties Found Click Details + > Click Menu Item Training Leave</para> + + <para><emphasis role="bold">Usage - </emphasis>An employee can use this + screen to request leave. The List Leave screenlet is a list all of the + leave records for the employee. An employee can also create a leave + request in the Add Employee Leave screenlet.</para> + + <para>Any user with Human Resource Employee permission can view and + request leave for any other employee. Only users with Human Resource + Approver permission can update or approve a leave request.</para> + + <para>Leave request are managed in the <link + linkend="HUMANRES_FindEmplLeaves">Leave</link> feature where in addition + to requesting leave an approver may review and approve assigned request. + Leave types and reasons are managed by the administrator in the <link + linkend="HUMANRES_EditEmplLeaveTypes">Global Settings Employee Leave + Type</link> feature.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>Leave Type Id - The name of a leave type. Leave types are + defined in <link linkend="HUMANRES_EditEmplLeaveTypes">Global + Settings</link></para> + </listitem> + + <listitem> + <para>From Date - The data the leave starts.</para> + </listitem> + + <listitem> + <para>Thru Date - The data the leave ends.</para> + </listitem> + + <listitem> + <para>Approver Party - The <link linkend="G_PARTY_ID">party + id</link> of the <link linkend="G_PERSON">person</link> with + authority to approve the leave.</para> + </listitem> + + <listitem> + <para>Description - A user entered description of the leave.</para> + </listitem> + + <listitem> + <para>Leave Reason Type - The name of a leave type reason. Leave + types reasons are defined in <link + linkend="HUMANRES_EditEmplLeaveTypes">Global Settings</link></para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Update button: Click to save changes to a leave record.<note> + <para>You must have update or administrator permission to update + a leave request.</para> + </note></para> + </listitem> + + <listitem> + <para>Create button: Create button: Click to create a leave + request.</para> + </listitem> + + <listitem> + <para>Employee Party Id button: Click to open the employees profile + in the OFBiz Party Manager application.</para> + </listitem> + + <listitem> + <para>Approver Party button: Click to open the approvers profile in + the OFBiz Party Manager application.</para> + + <warning> + <para>The OFBiz Party Manager application is separate from the HR + App. To return to the HR App Select HR from the Applications menu. + You will be returned to the main Main screen.</para> + </warning> + </listitem> + </itemizedlist> + </sect1> + + <sect1 xml:id="HUMANRES_PayrollHistory"> + <title>Payroll History</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmployeePayrollHistory.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employees > Click Lookup Party > In Parties Found Click Details + > Click Menu Item Payroll History</para> + + <para><emphasis role="bold">Usage -</emphasis> The Payroll History + screen displays a list of invoices for the employee. Generally these are + payroll or commission invoices. The invoices life cycle from creation + through payment is done in the Accounting application.</para> + + <para><emphasis role="bold">Fields</emphasis></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 <link + linkend="G_PARTY_ID">party id</link> . 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 <link + linkend="G_PARTY_ID">party id</link> .</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> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Invoice Id - Click to open the invoices Overview screen in the + Accounting application.</para> + </listitem> + + <listitem> + <para>From Party - Click to open the Fin. History screen for the + From Party party id the OFBiz Party Manager application.</para> + </listitem> + + <listitem> + <para>To Party - Click to open the Fin. History screen for the To + Party party id the OFBiz Party Manager application.</para> + </listitem> + </itemizedlist> + + <warning> + <para>The OFBiz Accounting and Party Manager applications are separate + from the HR App. To return to the HR App Select HR from the + Applications menu. You will be returned to the main Main + screen.</para> + </warning> + + <sect2> + <title>Invoice Overview</title> + + <note> + <para>Description of the Invoice Overview screen is outside the + scope of this document.</para> + </note> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="../humanres_en_images/AccountingSetInvoiceStatus.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + </sect2> + + <sect2> + <title>Party Financial History</title> + + <note> + <para>Description of the Party Financial History screen is outside + the scope of this document.</para> + </note> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="../humanres_en_images/PartyManagerPartyFinancialHistory.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + </sect2> + </sect1> + </chapter> + + <chapter> + <title>Employments</title> + + <para>An employment is a relationship between a person and your Company. + The HR App tracks employment benefits, pay history, unemployment claims + and employment agreements for each employed person.</para> + + <para>When you create new employee using the <link + linkend="HUMANRES_NewEmployee">New Employee</link> screen the employee + relationship is created for you automatically. If there is an a person + that was entered into the application by some other means 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 reason. For example and employee may have been let go for poor + performance. The type would be fired the reason incompetence.</para> + + <sect1 xml:id="HUMANRES_FindEmployments"> + <title>Search Employments</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmploymentSearch.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employments</para> + + <para><emphasis role="bold">Usage - </emphasis>Use the Employments + screen to create an <glossterm + linkend="G_EMPLOYMENT">employment</glossterm>, search for an existing + employments. Use Search Options to refine the search. Selecting an + employment from the list opens the Edit Employment screen.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para><link linkend="G_INTERNAL_ORGANIZATION">Internal + Organization</link></para> + </listitem> + + <listitem> + <para>Employee Party Id - The <glossterm linkend="G_PARTY_ID">party + id</glossterm> of the employee.</para> + </listitem> + + <listitem> + <para>From Date - Hire date</para> + </listitem> + + <listitem> + <para>Thru Date - Last day of employment.</para> + </listitem> + + <listitem> + <para>Termination Reason Id - The reason for the. Reasons are + defined in Global HR Settings <link + linkend="HUMANRES_EditTerminationReasons">Termination + Reasons</link>.</para> + </listitem> + + <listitem> + <para>Termination Type Id - The type of termination. Types are + defied in Global HR Settings <link + linkend="HUMANRES_EditTerminationTypes"><link + linkend="HUMANRES_EditTerminationTypes">Termination + Type</link></link>.</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>New Employment button: Click to open the screen to create a + new employment for a person or organization.</para> + </listitem> + + <listitem> + <para>Find button: Click for a list of employments. Displays a list + of employments in the Search Results screenlet.</para> + </listitem> + + <listitem> + <para>Employee Party Id button: Click to open the employees <link + linkend="HUMANRES_EmployeeProfile">Profile</link>.</para> + </listitem> + + <listitem> + <para>Edit button: Opens the Edit Employment screen. This is a + gateway to the other employment screens: benefits, pay history, + unemployment claims and employment agreements</para> + </listitem> + </itemizedlist> + + <sect2> + <title>New Employment</title> + + <mediaobject> + <imageobject> + <imagedata fileref="../humanres_en_images/EmploymentNewEmployment.png" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources + > Employments Click New Employment</para> + + <para><emphasis role="bold">Usage -</emphasis> Create a New Employment + relationship between and <glossterm + linkend="G_INTERNAL_ORGANIZATION">internal organization</glossterm> + and an <glossterm linkend="G_EMPLOYEE">employee.</glossterm> Sets the + start date for the employment.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para><glossterm linkend="G_INTERNAL_ORGANIZATION">internal + organization</glossterm></para> + </listitem> + + <listitem> + <para>Employee Party Id - The <glossterm + linkend="G_PARTY_ID">party id</glossterm> of the employee.</para> + </listitem> + + <listitem> + <para>From Date - Hire date</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Action - </emphasis>Create button: Click + to create the employment.</para> + </sect2> + </sect1> + + <sect1 xml:id="HUMANRES_EditEmployment"> + <title>Edit Employments</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmploymentEdit.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employments > In the Search Results Click Edit</para> + + <para><emphasis role="bold">Usage - </emphasis>This screen is used to + create or edit and update an employment. In the Main Search Screen it is + opened in create mode by clicking the New Employment button or update + mode by clicking the Edit button in Search Results.</para> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>From Date - Hire date</para> + </listitem> + + <listitem> + <para>Thru Date - Last day of employment.</para> + </listitem> + + <listitem> + <para>Termination Reason Id - The reason for the. Reasons are + defined in Global HR Settings <link + linkend="HUMANRES_EditTerminationReasons">Termination + Reasons</link>.</para> + </listitem> + + <listitem> + <para>Termination Type Id - The type of termination. Types are + defied in Global HR Settings <link + linkend="HUMANRES_EditTerminationTypes"><link + linkend="HUMANRES_EditTerminationTypes">Termination + Type</link></link>.</para> + </listitem> + </itemizedlist> + + <para><emphasis role="bold">Action - </emphasis> Update button: Click to + create or update changes to a employment record.</para> + </sect1> + + <sect1 xml:id="HUMANRES_EditPartyBenefits"> + <title>Party Benefits</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmploymentCreatePartyBenefit.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employments > In the Search Results Click Edit > Click Party + Benefits</para> + + <para><emphasis role="bold">Usage</emphasis></para> + + <itemizedlist> + <listitem> + <para>Add an employee benefit</para> + </listitem> + + <listitem> + <para>Update an employee benefit</para> + </listitem> + + <listitem> + <para>Delete an employee benefit</para> + </listitem> + </itemizedlist> + + <note> + <para>At this time Party benefits are not integrated with the OFBiz + Accounting application.</para> + </note> + + <para><emphasis role="bold">Fields</emphasis></para> + + <itemizedlist> + <listitem> + <para>Benefit Type Id - A name describing the benefit. See <link + linkend="INTRA_APPL_INTEGRATION_ENTITY_DATA_MAINT">Entity Data + Maintenance</link> to manage Benefit Type Id .</para> + </listitem> + + <listitem> + <para>Thru Date - The date the benefit ends.</para> + </listitem> + + <listitem> + <para>Period Type Id - The time period covered by the cost.</para> + </listitem> + + <listitem> + <para>Cost - Cost of the benefit over the Period Type.</para> + </listitem> + + <listitem> + <para>Actual Employer Paid Percentage</para> + </listitem> + + <listitem> + <para>Available Time - Use to track time off for vacation, sick + leave and other benefits of that nature</para> + </listitem> + </itemizedlist> + + <note> + <para>Use Web Tools <link + linkend="INTRA_APPL_INTEGRATION_ENTITY_DATA_MAINT">Entity Data + Maintenance</link> to manage Benefit Type Id. The entity name is + BenefitType.</para> + </note> + + <para><emphasis role="bold">Actions</emphasis></para> + + <itemizedlist> + <listitem> + <para>Add button: Click to add a benefit.</para> + </listitem> + + <listitem> + <para>Delete button: Click to delete the benefit. The benefit is + deleted and can not be restored.</para> + </listitem> + + <listitem> + <para>Submit button: Click to save changes in the list above.</para> + </listitem> + </itemizedlist> + </sect1> + + <sect1 xml:id="HUMANRES_EditPayrollPreferences"> + <title>Payroll Preferences</title> + + <screenshot> + <mediaobject> + <imageobject> + <imagedata align="center" + fileref="../humanres_en_images/EmploymentPayrollPreferences.jpg" + scalefit="1" width="100%"/> + </imageobject> + </mediaobject> + </screenshot> + + <para><emphasis role="bold">Breadcrumbs</emphasis>: Human Resources > + Employments > In the Search Results Click Edit > Payroll + Preferences</para> + + <para><emphasis role="bold">Usage</emphasis></para> + + <itemizedlist> + <listitem> + <para>Add a payroll preference</para> + </listitem> + + <listitem> [... 6919 lines stripped ...] |
| Free forum by Nabble | Edit this page |
