From 3eda737ea1b9d2f4c2bb99a03a1a58bde4908a00 Mon Sep 17 00:00:00 2001
From: David E Jones <dej@dejc.com>
Date: Mon, 9 Oct 2017 16:58:54 -0700
Subject: [PATCH 1/4] Added Employee entity with various fields moved from
 Employment; this is a breaking change that will require a number of service
 and screen updates for all to work again; see comment in Employment entity
 for fields removed

---
 entity/HumanResourcesEntities.xml | 109 +++++++++++++++++++-----------
 1 file changed, 70 insertions(+), 39 deletions(-)

diff --git a/entity/HumanResourcesEntities.xml b/entity/HumanResourcesEntities.xml
index a9c582c..d979ccd 100644
--- a/entity/HumanResourcesEntities.xml
+++ b/entity/HumanResourcesEntities.xml
@@ -182,19 +182,85 @@ along with this software (see the LICENSE.md file). If not, see
             <mantle.humanres.employment.BenefitType description="Sick Leave Paid" benefitTypeId="Sick"/>
         </seed-data>
     </entity>
+
+    <entity entity-name="Employee" package="mantle.humanres.employment" use="nontransactional">
+        <field name="partyId" type="id" is-pk="true"/>
+        <field name="distGroupEnumId" type="id"/>
+        <field name="taxFormId" type="id" enable-audit-log="update"/>
+        <field name="taxClassificationEnumId" type="id" enable-audit-log="update"/>
+
+        <field name="taxName" type="text-medium"><description>Defaults to Person or Organization name fields</description></field>
+        <field name="taxMiddleName" type="text-medium"><description>Defaults to Person.middleName if applicable</description></field>
+        <field name="taxLastName" type="text-medium"><description>Defaults to Person.lastName if applicable</description></field>
+        <field name="taxNameSuffix" type="text-medium"><description>Defaults to Person.suffix if applicable</description></field>
+        <field name="taxBusinessName" type="text-medium"/>
+        <field name="taxHomeContactMechId" type="id"/>
+
+        <field name="taxExemptPayeeCode" type="text-short"/>
+        <field name="taxExemptFatcaCode" type="text-short"/>
+        <field name="taxAccountNumbers" type="text-medium"/>
+        <field name="taxFederalStatusEnumId" type="id" enable-audit-log="update"/>
+        <field name="taxStateStatusEnumId" type="id" enable-audit-log="update"/>
+
+        <field name="taxYtdPriorIncome" type="currency-amount" enable-audit-log="update">
+            <description>Added to YTD income for starting year only (for taxes limited by YTD income)</description></field>
+        <field name="taxFederalAllowances" type="number-integer" enable-audit-log="update"/>
+        <field name="taxStateAllowances" type="number-integer" enable-audit-log="update"/>
+
+        <relationship type="one" related="mantle.party.Party"/>
+        <relationship type="one" title="PayDistributionGroup" related="moqui.basic.Enumeration" short-alias="distGroup">
+            <key-map field-name="distGroupEnumId"/></relationship>
+        <relationship type="one" title="Tax" related="moqui.screen.form.DbForm">
+            <key-map field-name="taxFormId"/></relationship>
+        <relationship type="one" title="TaxClassification" related="moqui.basic.Enumeration">
+            <key-map field-name="taxClassificationEnumId"/></relationship>
+        <relationship type="one" title="TaxHome" related="mantle.party.contact.PostalAddress">
+            <key-map field-name="taxHomeContactMechId"/></relationship>
+        <relationship type="one" title="TaxFederalStatus" related="moqui.basic.Enumeration">
+            <key-map field-name="taxFederalStatusEnumId"/></relationship>
+        <relationship type="one" title="TaxStateStatus" related="moqui.basic.Enumeration">
+            <key-map field-name="taxStateStatusEnumId"/></relationship>
+
+        <seed-data>
+            <!-- Tax Federal Status -->
+            <moqui.basic.EnumerationType description="Tax Federal Status" enumTypeId="TaxFederalStatus"/>
+            <moqui.basic.Enumeration description="Do Not Withhold" enumId="TfsDoNotWithhold" sequenceNum="1" enumTypeId="TaxFederalStatus"/>
+            <moqui.basic.Enumeration description="Married File Joint" enumId="TfsMarriedJoint" sequenceNum="2" enumTypeId="TaxFederalStatus"/>
+            <moqui.basic.Enumeration description="Single or Married File Separate" enumId="TfsSingle" sequenceNum="4" enumTypeId="TaxFederalStatus"/>
+
+            <!-- Tax State Status -->
+            <moqui.basic.EnumerationType description="Tax State Status" enumTypeId="TaxStateStatus"/>
+            <moqui.basic.Enumeration description="Do Not Withhold" enumId="TssDoNotWithhold" sequenceNum="1" enumTypeId="TaxStateStatus"/>
+            <moqui.basic.Enumeration description="Married File Joint 1 Income" enumId="TssMarriedFileJoint1" sequenceNum="2" enumTypeId="TaxStateStatus"/>
+            <moqui.basic.Enumeration description="Married File Joint 2+ Incomes" enumId="TssMarriedFileJoint2" sequenceNum="3" enumTypeId="TaxStateStatus"/>
+            <moqui.basic.Enumeration description="Married File Separate" enumId="TssMarriedSeparate" sequenceNum="4" enumTypeId="TaxStateStatus"/>
+            <moqui.basic.Enumeration description="Unmarried Head of Household" enumId="TssHeadHousehold" sequenceNum="5" enumTypeId="TaxStateStatus"/>
+            <moqui.basic.Enumeration description="Single" enumId="TssSingle" sequenceNum="6" enumTypeId="TaxStateStatus"/>
+        </seed-data>
+    </entity>
     <entity entity-name="Employment" package="mantle.humanres.employment" use="nontransactional">
         <description>This is a type of PartyRelationship so shares the ID with the related PartyRelationship record
             between employee (fromPartyId) and internal organization (toPartyId) with relationshipTypeEnumId=PrtEmployee.</description>
         <field name="partyRelationshipId" type="id" is-pk="true"/>
         <field name="emplPositionId" type="id"/>
-        <field name="terminationReasonEnumId" type="id"/>
-        <field name="terminationTypeEnumId" type="id"/>
+        <field name="terminationReasonEnumId" type="id" enable-audit-log="update"/>
+        <field name="terminationTypeEnumId" type="id" enable-audit-log="update"/>
         <!-- not yet used: <field name="jobRequisitionId" type="id"/> -->
 
         <field name="identityTypeEnumId" type="id"/>
         <field name="emplAuthzTypeEnumId" type="id"/>
-        <field name="distGroupEnumId" type="id"/>
         <field name="timePeriodTypeId" type="id"><description>Payroll time period</description></field>
+
+        <field name="taxWorkContactMechId" type="id"/>
+        <field name="taxFederalAllowances" type="number-integer" enable-audit-log="update"/>
+        <field name="taxStateAllowances" type="number-integer" enable-audit-log="update"/>
+        <!-- don't use these, create PayrollAdjustment records for them for the employee:
+        <field name="taxFederalAddtlWithhold" type="currency-amount"/>
+        <field name="taxStateAddtlWithhold" type="currency-amount"/>
+        -->
+        <!-- Moved to Employee:
+        <field name="taxYtdPriorIncome" type="currency-amount"><description>Added to YTD income for starting year only (for taxes limited by YTD income)</description></field>
+        <field name="distGroupEnumId" type="id"/>
         <field name="taxFormId" type="id"/>
         <field name="taxClassificationEnumId" type="id"/>
 
@@ -204,19 +270,13 @@ along with this software (see the LICENSE.md file). If not, see
         <field name="taxNameSuffix" type="text-medium"><description>Defaults to Person.suffix if applicable</description></field>
         <field name="taxBusinessName" type="text-medium"/>
         <field name="taxHomeContactMechId" type="id"/>
-        <field name="taxWorkContactMechId" type="id"/>
+
         <field name="taxExemptPayeeCode" type="text-short"/>
         <field name="taxExemptFatchaCode" type="text-short"/>
         <field name="taxAccountNumbers" type="text-medium"/>
         <field name="taxFederalStatusEnumId" type="id"/>
         <field name="taxStateStatusEnumId" type="id"/>
-        <field name="taxFederalAllowances" type="number-integer"/>
-        <field name="taxStateAllowances" type="number-integer"/>
-        <!-- don't use these, create PayrollAdjustment records for them for the employee:
-        <field name="taxFederalAddtlWithhold" type="currency-amount"/>
-        <field name="taxStateAddtlWithhold" type="currency-amount"/>
         -->
-        <field name="taxYtdPriorIncome" type="currency-amount"><description>Added to YTD income for starting year only (for taxes limited by YTD income)</description></field>
 
         <relationship type="one" related="mantle.party.PartyRelationship"/>
         <relationship type="one" related="mantle.humanres.position.EmplPosition"/>
@@ -225,27 +285,13 @@ along with this software (see the LICENSE.md file). If not, see
         <relationship type="one" title="TerminationType" related="moqui.basic.Enumeration">
             <key-map field-name="terminationTypeEnumId"/></relationship>
         <!-- <relationship type="one" related="mantle.humanres.recruitment.JobRequisition"/> -->
-
         <relationship type="one" title="IdentityType" related="moqui.basic.Enumeration">
             <key-map field-name="identityTypeEnumId"/></relationship>
         <relationship type="one" title="EmplAuthzType" related="moqui.basic.Enumeration">
             <key-map field-name="emplAuthzTypeEnumId"/></relationship>
-        <relationship type="one" title="PayDistributionGroup" related="moqui.basic.Enumeration" short-alias="distGroup">
-            <key-map field-name="distGroupEnumId"/></relationship>
         <relationship type="one" related="mantle.party.time.TimePeriodType"/>
-        <relationship type="one" title="Tax" related="moqui.screen.form.DbForm">
-            <key-map field-name="taxFormId"/></relationship>
-        <relationship type="one" title="TaxClassification" related="moqui.basic.Enumeration">
-            <key-map field-name="taxClassificationEnumId"/></relationship>
-
-        <relationship type="one" title="TaxHome" related="mantle.party.contact.PostalAddress">
-            <key-map field-name="taxHomeContactMechId"/></relationship>
         <relationship type="one" title="TaxWork" related="mantle.party.contact.PostalAddress">
             <key-map field-name="taxWorkContactMechId"/></relationship>
-        <relationship type="one" title="TaxFederalStatus" related="moqui.basic.Enumeration">
-            <key-map field-name="taxFederalStatusEnumId"/></relationship>
-        <relationship type="one" title="TaxStateStatus" related="moqui.basic.Enumeration">
-            <key-map field-name="taxStateStatusEnumId"/></relationship>
 
         <seed-data>
             <!-- Termination Type -->
@@ -291,21 +337,6 @@ along with this software (see the LICENSE.md file). If not, see
             <moqui.basic.Enumeration description="Native Tribal Document" enumId="EatNativeDoc" enumTypeId="EmplAuthzType"/>
             <moqui.basic.Enumeration description="Citizen ID Card" enumId="EatCitizenId" enumTypeId="EmplAuthzType"/>
             <moqui.basic.Enumeration description="Resident Citizen ID Card" enumId="EatResCitizenId" enumTypeId="EmplAuthzType"/>
-
-            <!-- Tax Federal Status -->
-            <moqui.basic.EnumerationType description="Tax Federal Status" enumTypeId="TaxFederalStatus"/>
-            <moqui.basic.Enumeration description="Do Not Withhold" enumId="TfsDoNotWithhold" sequenceNum="1" enumTypeId="TaxFederalStatus"/>
-            <moqui.basic.Enumeration description="Married File Joint" enumId="TfsMarriedJoint" sequenceNum="2" enumTypeId="TaxFederalStatus"/>
-            <moqui.basic.Enumeration description="Single or Married File Separate" enumId="TfsSingle" sequenceNum="4" enumTypeId="TaxFederalStatus"/>
-
-            <!-- Tax State Status -->
-            <moqui.basic.EnumerationType description="Tax State Status" enumTypeId="TaxStateStatus"/>
-            <moqui.basic.Enumeration description="Do Not Withhold" enumId="TssDoNotWithhold" sequenceNum="1" enumTypeId="TaxStateStatus"/>
-            <moqui.basic.Enumeration description="Married File Joint 1 Income" enumId="TssMarriedFileJoint1" sequenceNum="2" enumTypeId="TaxStateStatus"/>
-            <moqui.basic.Enumeration description="Married File Joint 2+ Incomes" enumId="TssMarriedFileJoint2" sequenceNum="3" enumTypeId="TaxStateStatus"/>
-            <moqui.basic.Enumeration description="Married File Separate" enumId="TssMarriedSeparate" sequenceNum="4" enumTypeId="TaxStateStatus"/>
-            <moqui.basic.Enumeration description="Unmarried Head of Household" enumId="TssHeadHousehold" sequenceNum="5" enumTypeId="TaxStateStatus"/>
-            <moqui.basic.Enumeration description="Single" enumId="TssSingle" sequenceNum="6" enumTypeId="TaxStateStatus"/>
         </seed-data>
     </entity>
     <entity entity-name="EmploymentApplication" package="mantle.humanres.employment" use="nontransactional">

From 003998c121103434979b7f44103da237c064f900 Mon Sep 17 00:00:00 2001
From: Solomon Bessire <sib@sssonline.com>
Date: Tue, 10 Oct 2017 14:54:58 -0700
Subject: [PATCH 2/4] Allow the classification and tax form back.  May need to
 override per employment for an employee that is also a contractor.

---
 entity/HumanResourcesEntities.xml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/entity/HumanResourcesEntities.xml b/entity/HumanResourcesEntities.xml
index d979ccd..9bab921 100644
--- a/entity/HumanResourcesEntities.xml
+++ b/entity/HumanResourcesEntities.xml
@@ -261,8 +261,10 @@ along with this software (see the LICENSE.md file). If not, see
         <!-- Moved to Employee:
         <field name="taxYtdPriorIncome" type="currency-amount"><description>Added to YTD income for starting year only (for taxes limited by YTD income)</description></field>
         <field name="distGroupEnumId" type="id"/>
+        -->
         <field name="taxFormId" type="id"/>
         <field name="taxClassificationEnumId" type="id"/>
+        <!--
 
         <field name="taxName" type="text-medium"><description>Defaults to Person or Organization name fields</description></field>
         <field name="taxMiddleName" type="text-medium"><description>Defaults to Person.middleName if applicable</description></field>

From 4fd96228c27da7f6b546c7bd39291ae1966ba700 Mon Sep 17 00:00:00 2001
From: Solomon Bessire <sib@sssonline.com>
Date: Tue, 17 Oct 2017 14:07:31 -0700
Subject: [PATCH 3/4] Added short aliases as well as a comment on the
 RateAmount timePeriodUomId that it is not necessarily time related.

---
 entity/HumanResourcesEntities.xml | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/entity/HumanResourcesEntities.xml b/entity/HumanResourcesEntities.xml
index 9bab921..7333dfc 100644
--- a/entity/HumanResourcesEntities.xml
+++ b/entity/HumanResourcesEntities.xml
@@ -873,7 +873,7 @@ along with this software (see the LICENSE.md file). If not, see
         <field name="rateTypeEnumId" type="id"/>
         <field name="ratePurposeEnumId" type="id"/>
         <field name="rateCurrencyUomId" type="id"/>
-        <field name="timePeriodUomId" type="id"/>
+        <field name="timePeriodUomId" type="id"/> <!-- The Uom of the rate; may or may not be time related. e.g. TF_hr or OTH_ea -->
         <!-- filter by if any records have these not null matching the current TimeEntry values -->
         <field name="workEffortId" type="id"/>
         <field name="partyId" type="id"/>
@@ -884,21 +884,21 @@ along with this software (see the LICENSE.md file). If not, see
         <!-- what we're looking for -->
         <field name="rateAmount" type="number-decimal"/>
 
-        <relationship type="one" title="RateType" related="moqui.basic.Enumeration">
+        <relationship type="one" title="RateType" related="moqui.basic.Enumeration" short-alias="type">
             <key-map field-name="rateTypeEnumId"/></relationship>
-        <relationship type="one" title="RatePurpose" related="moqui.basic.Enumeration">
+        <relationship type="one" title="RatePurpose" related="moqui.basic.Enumeration" short-alias="purpose">
             <key-map field-name="ratePurposeEnumId"/></relationship>
-        <relationship type="one" title="RateCurrency" related="moqui.basic.Uom">
+        <relationship type="one" title="RateCurrency" related="moqui.basic.Uom" short-alias="currencyUom">
             <key-map field-name="rateCurrencyUomId"/></relationship>
-        <relationship type="one" title="TimePeriod" related="moqui.basic.Uom">
+        <relationship type="one" title="TimePeriod" related="moqui.basic.Uom" short-alias="timePeriod">
             <key-map field-name="timePeriodUomId"/></relationship>
 
-        <relationship type="one" related="mantle.work.effort.WorkEffort"/>
-        <relationship type="one" related="mantle.party.Party"/>
+        <relationship type="one" related="mantle.work.effort.WorkEffort" short-alias="workEffort"/>
+        <relationship type="one" related="mantle.party.Party" short-alias="party"/>
 
-        <relationship type="one" related="mantle.humanres.rate.PayGrade"/>
-        <relationship type="one" related="mantle.humanres.position.EmplPositionClass"/>
-        <relationship type="one" title="WorkType" related="moqui.basic.Enumeration">
+        <relationship type="one" related="mantle.humanres.rate.PayGrade" short-alias="payGrade"/>
+        <relationship type="one" related="mantle.humanres.position.EmplPositionClass" short-alias="positionClass"/>
+        <relationship type="one" title="WorkType" related="moqui.basic.Enumeration" short-alias="workType">
             <key-map field-name="workTypeEnumId"/></relationship>
 
         <seed-data>

From 60cb8c955d297aaf7a72ded0482dd24c76a71014 Mon Sep 17 00:00:00 2001
From: David E Jones <dej@dejc.com>
Date: Fri, 20 Oct 2017 16:08:13 -0700
Subject: [PATCH 4/4] Enable optimistic-lock on Payment and Invoice, will add
 to various other core entities over time

---
 entity/AccountingAccountEntities.xml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/entity/AccountingAccountEntities.xml b/entity/AccountingAccountEntities.xml
index c79159d..21b0e2c 100644
--- a/entity/AccountingAccountEntities.xml
+++ b/entity/AccountingAccountEntities.xml
@@ -309,7 +309,7 @@ along with this software (see the LICENSE.md file). If not, see
     <!-- mantle.account.invoice -->
     <!-- ========================================================= -->
 
-    <entity entity-name="Invoice" package="mantle.account.invoice" short-alias="invoices" cache="never">
+    <entity entity-name="Invoice" package="mantle.account.invoice" short-alias="invoices" cache="never" optimistic-lock="true">
         <field name="invoiceId" type="id" is-pk="true"/>
         <field name="invoiceTypeEnumId" type="id"/>
         <field name="fromPartyId" type="id"/>
@@ -1170,7 +1170,7 @@ along with this software (see the LICENSE.md file). If not, see
             <key-map field-name="deductionTypeEnumId"/></relationship>
         <relationship type="one" related="Payment"/>
     </entity>
-    <entity entity-name="Payment" package="mantle.account.payment" short-alias="payments" cache="never">
+    <entity entity-name="Payment" package="mantle.account.payment" short-alias="payments" cache="never" optimistic-lock="true">
         <field name="paymentId" type="id" is-pk="true"/>
         <field name="paymentTypeEnumId" type="id"/>
         <field name="fromPartyId" type="id" enable-audit-log="update"/>