ReleaseNotes.txt

Mantle Business Artifacts Release Notes

===========================================================================
Release 1.2.1 - TBD
===========================================================================

Mantle Business Artifacts 1.2.1 is a minor new feature and bug fix release.

This release is based on Moqui Framework TODO.

TODO

New Features:

Bug Fixes:

===========================================================================
Release 1.2.0 - 17 Jan 2016
===========================================================================

Mantle Business Artifacts 1.2.0 is a major new feature and bug fix release.

This release is based on Moqui Framework 1.6.0.

There are over 740 commits since the last release and an increase in size
from around 40k lines to around 48k lines of text (primarily XML, Groovy,
and FTL files). Over 5k lines were moved to the SimpleScreens project
(report and printed doc templates, MyAccount app). Mantle has 338 entities
(plus 154 view entities), and 481 services (118 new since last release).

Mantle is focused on being a low-level business artifacts library, in other
words data model and logic but no user interface. The My Account app and
the various templates in the mantle-usl component have been moved to the
new SimpleScreens project, making Mantle more focused on this objective.
Another improvement in this direction is a well organized remotely
accessible API using the new Service REST feature in Moqui Framework.

The new Mantle REST API has 352 services. This API can be viewed and
services called through the Swagger UI with links from the Moqui Tools app.
The REST API is not only useful for remote access by dynamic web apps and
mobile or desktop client applications, but also as a reference for the
services and entities to use for common business operations.

One major area that was missing in previous releases was return processing,
and this release includes that functionality with an enhanced data model,
services for general return processing, and automated tests.

There are many advanced new features including: EDI (X12 Rec 850, Send 855,
Send 856, Send 810, and Send/Rec 997); OFX import and reconcile; NACHA
export; positive pay export for a few banks; Cash Flow Statement,
Retained Equity Statement, and Financial Ratios report services; and the
AuthorizeDotNet component is now part of Mantle.

There are also many basic accounting enhancements with improved demo GL
structure, better handling of invoice and payment cancel/void/change,
and services to adjust an invoice and post the adjustment to the GL. There
is also now GL posting for physical inventory variance, WIP inventory, and
improved period closing and time period handling. Overall the accounting
functionality is refined and more complete to handle common business needs.

With this release Mantle Business Artifacts is now a comprehensive
foundation for ERP systems.

Non Backward Compatible Changes

- Removed the MyAccount screens, now in the SimpleScreens project
- Removed the template directory, now in the SimpleScreens project (can
  search for component://mantle-usl/template and replace with
  component://SimpleScreens/template)
- The Payment.paymentMethodTypeEnumId field is replaced with the
  paymentInstrumentEnumId field; PaymentMethodType enums are simplified to
  represent only the various types of PaymentMethod records, and the actual
  instrument used for a Payment by the new paymentInstrumentEnumId
- The PaymentMethodTypeGlAccount is replaced by PaymentInstrumentGlAccount
  corresponding with the Payment.paymentMethodTypeEnumId field replacement
  by Payment.paymentInstrumentEnumId
- The EftAccount entity is replaced by the new BankAccount entity
- The name fields on BankAccount (was EftAccount) and CreditCard are
  replaced by name fields on PaymentMethod as they may apply to all types
  of PaymentMethod (new fields are: titleOnAccount, firstNameOnAccount,
  middleNameOnAccount, lastNameOnAccount, suffixOnAccount,
  companyNameOnAccount)
- GlAccountType enumeration keys have been changed to camel case to
  eliminate redundancy and demo GL Account data and code updated; for
  existing systems th gl accounts demo data will need to be reloaded, all
  AcctgTransEntry.glAccountTypeEnumId values updated, and old GlAccountType
  Enumeration records removed; no known systems using this in production so
  no automation is in place to do this.
- OrderContactMech is removed, replaced with OrderPartContactMech so
  contact mechanisms are associated with each OrderPart instead of header
- OrderTerm is removed, replaced with OrderPartTerm so terms are associated
  with each OrderPart instead of header

New Features:

- Mantle REST API
  - Uses new Service REST API feature in Moqui Framework
  - See entity op and service mappings in the mantle.rest.xml file
  - Has REST services for parties, facilities, products, assets, work
    efforts, orders, shipments, returns, invoices, payments, financial
    accounts, general ledger
  - Has 301 resources with 352 methods (services), 507 definitions
  - Use Moqui feature to generate Swagger file and view in Swagger UI
    - see https://github.com/swagger-api/swagger-ui
    - use a URL like http://localhost:8080/rest/service.swagger/mantle
- Added Return Functionality
  - Create and process general returns or from order
  - Supported all the way through to GL postings
  - Process return responses: credit, refund, replace, manual
  - Immediate response or after item receipt
  - Spock tests for return process and various responses
- The AuthorizeDotNet project is now a component within Mantle
- Added EDI integrations (through Moqui SystemMessage) in the mantle-edi
  component for:
  - Receive X12 850 Purchase Order
  - Send X12 855 Purchase Order Acknowledgement
  - Send X12 856 Ship Notice/Manifest
  - Send X12 810 Invoice
  - Receive and Send X12 997 Functional Acknowledgement
- Accounting: Payment and Invoice
  - Introduced Payment Instrument concept to distinguish instrument used
    from PaymentMethodType for a PaymentMethod
  - Added OFX V1 (and QFX) bank statement import (to PaymentMethodTrans)
  - Manual or automatic match/reconcile PaymentMethodTrans to Payment
    and AcctgTransEntry records
  - Added NACHA file generation for ACH incoming and outgoing payments
  - Added Positive Pay file generation (check reconciliation/etc); file
    formats are bank-specific, initially supported banks include Bank of
    America, City Bank, SunTrust, Wachovia, and Wells Fargo
  - Added PaymentMethodContent entity to support per-account signature images
    and other content related to payment methods
  - When Payment status set to Void, Cancelled or Refunded un-apply from
    invoices (through SECA rule); also added void#Payment service that can be
    called directly
  - When Invoice set to Cancelled status un-apply payments (through SECA
    rule); also added cancel#Invoice service that can be called directly
  - When Invoice status goes from Payment Sent/Receive to Approved/Finalized
    un-apply payments (through SECA rule); also added unpay#Invoice service
    that can be called directly
  - Added adjust#Invoice service to add adjusting items to closed invoices
    (already posted to GL, but not yet paid) for write-offs, prompt payment
    discounts, late payment fees, and return of items not yet paid for
  - Implemented local payment gateway services for Financial Account
  - Added credit limit for Financial Account, included in available amount
  - Added NSF checks for Financial Account authorize and withdraw
- Accounting: Ledger
  - Demo GL structure and class/type improvements for reporting, etc needs
  - GL posting for physical inventory variance
  - GL posting for WIP (work in progress) inventory for production runs, both
    on issuance (consume) and receipt (produce)
  - Added fields to track AcctgTrans reversed by and reverse of related
    transactions, and that transaction has been reversed or is reverse
  - Revert GL posting for Invoice on cancel (through SECA rule)
  - Revert GL posting for Invoice when status change from Finalized or Sent
    to In Process (to resume editing)
  - Revert GL posting for Payment status set to Void, Cancelled or Refunded
    (through SECA rule)
  - Financial Time Period closing now recalculates all posted amounts and
    updates the GlAccountOrgTimePeriod records, creates or updates
    GlAccountOrgTimePeriod records for next period (creating next period
    if needed)
  - New and improved services for managing TimePeriod records
  - During Acctg Trans posting if no TimePeriods found automatically
    creates based on previous or assuming calendar fiscal year
- Accounting: Reporting
  - Improvements to Income Statement and Balance Sheet reports: formatting,
    code cleanups, optionally show detail (balance by GL Account)
  - Added Cash Flow Statement, Retained Equity Statement, and Financial
    Ratios (Liquidity, Activity, Leverage, and Profitability) reports
- Import time summary and detail files (from external systems like Kronos)
- Added components.xml file to specify which mantle components to load and
  component.xml files in each component to specify consistent name
  (regardless of directory name) and component dependencies

Bug Fixes:

- Fixed issue in LedgerServices.get#OrganizationFiscalTimePeriods where no
  results were returned when filterDate is not specified
- Fixed Income Statement to show amounts posted, not ending balance
- Fixed Net Income value in Income Statement report
- Fixed more duplicate GL Account types and classes, all GL Account Type
  IDs are now camel cased and reviewed, various added to demo GL accounts

===========================================================================
Release 1.1.0 - 11 Sep 2015
===========================================================================

Mantle Business Artifacts 1.1.0 is a new feature and bug fix release with
primary key and other changes not backward compatible with the previous
release.

Mantle 1.1.0 is based on Moqui Framework 1.5.3.

There are over 650 commits since the last release and an increase in size
from around 30k lines to over 40k lines of text (primarily XML, Groovy,
and FTL files). The My Account app has 15 screens and 34 forms. Mantle has
330 entities (plus 137 view entities), and 363 services. Mantle supports a
wide range of business information and processes with this small code base.

Significant new features include expanded time entry, human resources,
and payroll functionality. There are now entities and services in place to
handle salary and hourly/piece employees (contract and permanent, etc), and
all employee and tax authority details to calculate payroll taxes and
create and pay payroll invoices and payments.

There is new functionality for Financial Accounts to better support
deposits and withdrawals and related GL postings.

Improved Inventory and Fixed Asset GL postings and account mapping
configuration options based on asset type and class. Implemented fixed
asset depreciation calculation and GL posting.

There are a number of improvements to the Product data model with more
options for structured data and content across defined product classes.

Non Backward Compatible Changes:

- This version requires an update to existing databases to add the
  isPayable field as a PK field for the PaymentMethodTypeGlAccount entity.
- The demo GL Accounts have been restructured and expanded (see notes in
  ZaaGlAccountsDemoData.xml).
- Item Types (order, invoice, etc) have been simplified for easier invoice
  entry (removed ItemAsset variations) and expanded for payroll, etc.
- Added assetTypeEnumId and assetClassEnumId to Product entity and
  simplified ProductType enumerations (productTypeEnumId); some changes
  to data and code may be necessary to populate properly, see the notes
  in the comments under the Product entity in ProductDefinitionEntities.xml
- The PK of ProductDimension has the new dimensionTypeId field instead
  of the dimensionTypeEnumId field.
- The ProductContent, PartyContent, and WorkEffortContent entities have
  been changed to use a single sequenced primary key field and restructured
  for consistency.
- The AssetTypeGlAccount entity now uses a single PK, added classEnumId.

New Features:

- Added Travis CI configuration for continuous integration testing, now
  setup for the moqui/mantle project with a badge reporting status
- New XSL-FO templates and data prep services for Printed Checks (based on
  Payment records), Financial Account Statements, Order, Shipment Pick,
  Shipment Pack, Shipment Load Pick, Shipment Load Picklist and Pack Sheets
- Expanded PartyContent and other *Content entities, added upload/etc
  services, changed to single PK field
- Various new view entities and cleanups
- Added various name/ID templates for DB configurable formatting using the
  L10nFacade with the new "default" locale (universal fallback)
- Removed Picklist entity, using Shipment Load/Ship purpose WorkEffort
  instead to combine picklist management with shipping scheduling
- HR and Payroll
  - Significant enhancements and cleanups for Human Resources entities
    related to employment and payroll (including payroll adjustments for
    tax and other withholdings, pay grade and salary, and much more)
  - Services for payroll including calculating salary and hourly/piece pay
    amounts for a payroll period, calculating payroll adjustments
    (including bonuses, garnishments, income/FICA/other from multiple tax
    authorities), creating payroll invoices (and closing a payroll period),
    and authorizing payroll invoices then creating payments; with check
    printing payroll checks with details is also supported
- Work
  - Improved TimeEntry for piece counts, various service enhancements
  - Added time entry screens in MyAccount app (general and for task)
  - Added duration fields to WorkEffort, used for calendar time as opposed to
    existing time fields which are total across all parties for cost and
    budgeting purposes; changed various services to use these
- Ledger
  - GL posting for Financial Account Transactions
  - GL Account cleanups and reorg so that third-party holdings accounts are
    under a new class under current liability and not accounts payable
  - GL posting for payment method types (PaymentMethodTypeGlAccount) can
    vary by payable/receivable with the new isPayable field (Y for payable,
    N for receivable, E for either); this is a PK field, modifying the PK
    of this entity and requiring an update to existing databases
- Product
  - New ProductDimensionType entity so that unitTypeEnumId can be specified
  - New ProductClass concept with Product.productClassEnumId field and the
    ProductClassDimension and ProductClassFeature entities to specify which
    dimensions and features apply to a given product class
  - Added Product.assetTypeEnumId and assetClassEnumId fields, set in demo
    data, used when creating Assets (in receive#Asset) for products,
    cleaned up product types and used asset types and classes to simplify
    code and resolve some issues
- Asset
  - Significant enhancements in accounting for fixed and inventory assets,
    including some corrections of inventory posting and more flexible
    configuration of posting for classes of inventory assets
  - Implemented fixed asset depreciation calculation and GL postings
  - Implemented fixed asset purchase and sale/disposal support

Bug Fixes:

- Fixed issue with conflicting use of enumId CURRENT_LIABILITY for both GL
  account class and type
- Fixed concurrency issue when reserving inventory for the same product
  from multiple threads running at the same time, plus test case to verify
- Fixed issue with accounting transaction posting on last day in a period
  not updating time period totals per account, etc

===========================================================================
Release 1.0.1 - 2 May 2015
===========================================================================

Mantle Business Artifacts 1.0.1 is a minor new feature and bug fix release.

Mantle 1.0.1 is based on Moqui Framework 1.5.2.

New Features:

- Added DataDocument definitions for current and projected inventory data
  including assets, order items, production run consume and produce
  estimates and production estimates
- Added mantle.product.InventoryReportServices.get#InventoryProjectedInfo
  service to query indexed inventory data documents and get summary data
  by product; much more could be done with the indexed documents, including
  graphs of data over time
- Added Facility.pseudoId field, like those on Party, Product, etc;
  populated from facilityId by default, can be edited by user and used to
  display a more friendly ID
- Better support for accounting for sales of third party inventory
- Purchase Orders are now automatically set to complete when the last item
  is received, just like Sales Orders are when the last item is packed

Bug Fixes:

- Fixed issue updating task (WorkEffort) time from TimeEntry when the last
  one is removed
- Fixed quantity type lost on find#ProductPriceRecord (used in calc price)

===========================================================================
Release 1.0.0 - 07 Mar 2015
===========================================================================

Mantle Business Artifacts 1.0.0 is a major new feature and bug fix release.

Mantle 1.0.0 is based on Moqui Framework 1.5.0.

This release is a major milestone for Mantle as a foundation for ERP
systems. Most new features in this release were done as part of development
of an industry-specific ERP application using the approach of putting all
general data and logic artifacts in Mantle. This has driven design and
implementation of entities and services to manage various common end-to-end
processes and a wide variety of business scenarios.

With this release there is general functionality for: Invoice, Payment,
GL Transaction/Journal/Period, Financial (balance) Account, Asset
(inventory, equipment, supplies, etc), Production (manufacturing),
Purchasing, Receiving, Sales, Shipping, and the configuration to manage
related settings. There are also significant flexibility improvements to
provide extension points for industry specific functionality.

There are new features based on project management and accounting features
from HiveMind and another project management application that is being
built based on Mantle.

New Features:

- My Account app with screens for contact information, password change,
  messages, calendar/events, tasks, and expenses; this is the only user
  interface in Mantle, an exception to the general no UI direction
- Various enhancement for more flexible inventory handling, passing through
  all Asset fields and a number of new options
- Handling of inventory allocation on receipt, explicit Asset reservation,
  adjusting reservations on order change/cancel, etc
- Basic production run support with inventory consume and produce
- Services for physical inventory adjustments
- More product data handling including automatic variant creation
- Support for equipment products along with maintenance schedule and
  history, and meters/readings
- Various product feature handling services
- Clone services for Product, Order, WorkEffort
- A few GL enhancements including semi-automatic reverse postings
- Service to lookup from most major records by ID
- Data Document, feed, and search configuration for Party, Product,
  Facility, WorkEffort (Project/Task), and Request
- Various reusable screen forms and transitions
- Service to get event data for the FullCalendar JS widget, for events
  associated with parties, facilities, and assets (equipment, etc); also
  calendar data for tasks by estimated start date
- Expanded entities and service for content for orders, shipments, etc
- Better support for purchase orders and sales orders with no ProductStore
- Services for financial (balance) accounts such as deposit, withdraw,
  and authorize
- New support for general concepts such as facility certification and
  production estimation
- GL Journal management and posting services
- GL time period closing
- Services to handle promised payments associated with an invoice, such as
  those on sales orders with a specified payment method/type
- Introduced editable pseudoId fields for Product, ProductCategory,
  Facility, Party, etc; defaults to ID but can be changed
- Added various display info services such as Shipment, Invoice, Asset, etc
- Improved handling of time and money budget and progress values for
  projects and tasks; service to get project progress/status info
- Various improvements to Shipment handling and receiving
- Various improvements to order editing and processing
- Introduced party role group concept for dynamic configuration of roles to
  use for different purposes in the system such as projects, tasks,
  requests, etc; replaces old/inflexible approach of using parent roles
- Various view-entities for reporting and general user interfaces


===========================================================================
Release 0.5.2 - 1 Aug 2014
===========================================================================

Mantle Business Artifacts 0.5.2 is a minor new feature and bug fix release.
This release is based on Moqui Framework. The main improvements are to
payment processing as part of the development of the first payment
processing gateway integration for Authorize.net (see the AuthorizeDotNet
repository).

New Features:

- Various improvements from development of first payment processing
  gateway for Authorize.Net AIM and CIM. See
  https://github.com/jonesde/AuthorizeDotNet for more information.
- Changed Payment creation to track the Visit in which payment created
- Added delete#CreditCard service to purge credit card info
- Added release#SinglePayment and refund#SinglePayment services to complete
  the main set of payment processing services (for returns, customer
  service, etc)

Bug Fixes:

- Made payment processing services more resilient to gateway errors

===========================================================================
Release 0.5.1 - 21 Mar 2014
===========================================================================

Mantle Business Artifacts 0.5.1 is a minor new feature and bug fix release.
This release is based on Moqui Framework 1.4.0.

The main new features in this release are ecommerce related including
product pricing rules, shipping charge calculation by rules, and tax
calculation by rules.

New Features:

- Added kie directory to component with skeleton for KIE module including
  Drools rules, jBPM workflows, etc
- The get#ProductPrice service now executes the ProductPriceKS KIE session;
  there is one example rule but this is mostly infrastructure for custom
  pricing rules
- Added calculate#OrderShipping and calculate#OrderPartShipping services to
  call shipping gateway rate service (as configured on the ProductStore)
  for an order/part
- Added get#OrderShippingRateLocal service to calculate order shipping
  charges using the OrderShippingRateKS KIE session with a decision table
  spreadsheet to easily configure shipping rates
- Added calculate#OrderSalesTax service to call the tax gateway service
  for tax calculation as configured on the ProductStore
- Added calculate#SalesTaxLocal service as an impl of calculate#SalesTax
  service interface to call through local tax gateway and calc taxes using
  a decision table in Drools
- The set#OrderBillingShippingInfo service now calls the shipping
  (calculate#OrderPartShipping) and tax (calculate#OrderSalesTax)
  services recently implemented
- Added create#Person service and improved create#Organization
- Enhanced PostalAddress services to handle GeoPoint fields
- Added Facility ContactMech services like the Party ones
- Added create#PurchaseRequestOrder service to create a purchase order
  from a purchase request
- Merged SupplierProduct into ProductPrice; NOTE: this change is not
  backwards compatible, any SupplierProduct records will need to be moved
- Added get#ShipmentDisplayInfo service

Bug Fixes:

- Inventory reservation and packing services now ignore OrderItems with no
  productId or that are not physical products
- Fixed time zone issues with various Timestamp in parameters
- Updated automated tests to run at any date, not before a coded date

===========================================================================
Release 0.5.0 - 20 Nov 2013
===========================================================================

This is the initial release of Mantle Business Artifacts (version 0.5.0).
It is based on Moqui Framework 1.3.2. This version covers procure to pay,
order to cash, and work plan to cash processes including:

- Purchase and Sales Orders (for goods, services, materials, etc; POs for
  inventory and equipment/supplies/etc)
- Project, Task, and Request management with time and expense recording,
  billable/payable rates by project/task/client/worker/etc
- Incoming and Outgoing Invoices with a wide variety of item types and an
  XSL:FO template for print or email
- Automatic invoice generation for purchase orders (AP), sales orders (AR),
  project client time and expenses (AR), project vendor/worker time and
  expenses (AP)
- Payments, both manually recorded and automatic through payment processing
  interfaces; applying payments to invoices
- Fulfillment of sales orders (including basic picking and packing) and
  receiving of purchase orders
- Inventory management including issuance and receipt, and inventory
  reservation for sales orders
- Automated GL account posting of incoming and outgoing invoices, outgoing
  and incoming payments, payment application, and inventory receipt and
  issuance
- General GL functionality for time periods, validation of transactions to
  post, time period closing
- Balance Sheet and Income Statement reports (and basic posted amounts and
  account balance by time period summaries)

The automated tests are a great example of functionality and a good
reference for where data ends up. They include complete flows with service
calls and data validation for purchase orders (procure to pay), sales
orders (order to cash), and billable projects with client and vendor/worker
invoice/payment (work plan to cash).

===========================================================================
Long Term To Do List
===========================================================================

- OAGIS 10.1 integrations
  - http://www.oagi.org
  - Somehow get/buy OAGIS 10.1 Enterprise Edition? $1299 USD for non-members
  - integration/mantle-oagis component
  - at least matching supported EDI messages
    - Receive Purchase Order
    - Send Purchase Order Acknowledgement
    - Send Ship Notice/Manifest
    - Send Invoice
  - more general process support
    - receive Shipment Receipt Notice
    - see UBPL "OAGIS Order to Cash.cwiki"
    - see UBPL "OAGIS Procure to Pay.cwiki"
    - see UBPL "OAGIS Work Plan to Cash.cwiki"
- UBL 2.1 integrations
  - https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=ubl
  - integration/mantle-ubl component
  - at least matching supported EDI messages
- Braintree Payment Processor
  - https://www.braintreepayments.com
  - https://developers.braintreepayments.com/start/hello-server/java
  - https://developers.braintreepayments.com/start/hello-client/javascript/v2
  - payment/Braintree component
- Shopping Cart Integrations
  - API2Cart
    - https://www.api2cart.com
    - https://www.api2cart.com/supported-platforms/
    - http://docs.api2cart.com
- GL REST API
  - http://subledger.com
  - https://api.subledger.com/v2/index.html
- SaaS/Tenant REST API
  - http://knowledgecenter.zuora.com/BC_Developers/REST_API/B_REST_API_reference