Home > Aria Crescendo Documentation > Aria Release Notes > Release 11.0

Release 11.0

Table of contents
  1. Overview
  2. Release Date
    1. Production Release Date
  3. System Requirements
    1. Supported Browsers
    2. Java Settings
    3. Screen Resolution
  4. Application 
    1. Features
    2.  Fixes
  5. API
    1. Features
    2. Fixes
  6. Application Features
    1. Enhanced Account Search User Interface (DEV-8131)
      1. Search
      2. Advanced Search
      3. Search History
      4. Recently Accessed Accounts
      5. Recently Created Accounts
    2. Surcharge Enhancements (DEV-8241)
      1. Creating a Surcharge
    3. Alternate Bill Day Option Added When Generating an Invoice (DEV-7903)
    4. Chase Paymentech Soft Descriptors (DEV-8072)
      1. Configure Soft Descriptors at the Payment Gateway
      2. Configure Soft Descriptors at the Collection Group
    5. Chase Paymentech Account Updater Available (DEV-8031)
    6. Paymetric Payment Processor Moneris(CAD) Enhancement (DEV-7920)
    7. Stop Dunning Advancement on Anniversary Collections (DEV-8040)
    8. Statement Creation for Invoices Without Line Items (DEV-8078)
      1. Set the Invoices Without Line Items Client Parameter 
    9. NETS Agreement ID Displayed in User Interface When Using create_account_complete_m (DEV-7430)
    10. Statement Sequence Number Displayed on Rebill Invoices and Statements (DEV-8252)
    11. Rebill Functionality Enabled for Invoices in Current Billing Cycle (DEV-8253)
    12. Application Fixes
  7. API Features
    1. Surcharge Enhancements - API (DEV-8241)
    2. Chase Paymentech Soft Descriptors - API (DEV-8072)
    3. Purchase Power/Reserve Account Validation Removal (DEV-7921)
    4. Get_all_client_receipt_ids_m Updated to Include Receipts from Usage APIs - DEV-8055
    5. Enhancements to Validate_payment_information_m (DEV-8130)
      1. New Input Fields
      2. Validation Changes
    6. Processor Payment ID Added as a Query String Input Parameter (DEV-8144)
    7. Proration Period Fields Moved to Different Array in update_acct_plan_multi_m (DEV-8143)
    8. API Fixes
  8. WSDL File Locations 
    1. Object Query WSDL Files 

Overview

Enhancements and fixes to Aria functionality for this release are described below.

Release Date

Production Release Date

 6/7/2017

System Requirements

Supported Browsers

  • Firefox 39
  • Chrome 44
  • Internet Explorer 9, 10, 11 

Java Settings

Java 7.0​​

Screen Resolution

1024 x 768 or higher

Application 

Features

 Fixes

API

Features

Fixes


Application Features

Enhanced Account Search User Interface (DEV-8131)

This feature provides a new version of the Account Search functionality. The previous search screens have been condensed into a new streamlined search. In addition to this streamlined search, a record of recent searches is saved and made available to quickly and easily review results from recent searches without having to re-enter parameters.

Finally, to maintain backward compatibility and offer clients similar functionality to what was available previously, recently accessed accounts and recently created accounts are available in their own tabs.

Getting Here: Click Accounts > Search

The revised search user interface has five tabs.

Search

The Search tab allows you to either select an account field from the drop-down menu, or to search for one in the search box provided. The Search Value box allows you to either select or enter a value depending on the Search Field you specify. After executing a search and returning to this screen, the last search field values are displayed on the screen.

The search returns all accounts where the Search Value matches your input. If there is only one matching account, the account displays without displaying the search results screen.

acctsearch1.png

Notes: The search options that had displayed in the left navigation pane have been moved to the Search Field drop-down.

Client-Defined Fields, Plan Instance Fields, and Plan Unit Instance Fields were previously automatically available for searching. With this feature, you must now request that Aria Customer Support configure which Client-Defined Fields, Plan Instance Fields, and Plan Unit Instance Fields display in the Search Field drop-down.

Advanced Search

The Advanced Search tab allows you to specify a Condition for the Search Field. Available conditions vary depending on the Search Field you specify, but can include "Equals", "Does Not Equal", "Contains", "Is Empty" and so on.

This tab also allows you to add additional Search Fields by using the Secondary Search Option. If you select  "And" or "Or" from this drop-down menu, you can specify an additional field to use in your search. After executing a search and returning to this screen, the last search field values are displayed on the screen.

Note: If you select Client-Defined Field, Plan Instance Field, or Plan Unit Instance Field from the Search Field drop-down, you cannot enter a secondary search option.

acctsearch2.png

Search History

The Search History tab displays a list of the last 10 account searches you've performed and allows you to click on any set of search criteria to perform the search again.

acctsearch3.png

Recently Accessed Accounts

The Recently Accessed Accounts tab displays the accounts you have most-recently viewed and allows you to view the account or any of its master plans.

acctsearch4.png

Recently Created Accounts

The Recently Created Accounts tab displays the accounts you have most-recently created and allows you to view the account or any of its master plans. You can sort and filter the columns on this page. See Sort and Filter Columns for more details.

acctsearch5.png


Surcharge Enhancements (DEV-8241)

This feature enhances how surcharges are created and changes how they are processed. Surcharges associated with a payment method or payment term are now calculated before taxes are applied and are then taxed with any other taxable charges. Surcharges can now be included in credit memos and rebills.

Additionally, the Create a Surcharge screens have been modified to enhance usability.

Creating a Surcharge

Getting Here: Click Products > Surcharges

  1. Upon accessing the Surcharges screen, a list of existing surcharges displays.

CreateSurchargeEOM1.png

  1. Click New. The Create New Surcharge screen displays.
 

Notes:  

1) Fields that are marked by a red asterisk are required. Be sure to enter values in all required fields on all tabs or you won't be able to save the surcharge.

2) The Translations link enables defining a translation for the field for an associated locale. Refer to Multi-language Translation for Product Elements for more information.  

surcharge1-11.png

1.png

Surcharge Name Indicates the name of the surcharge.

2.png

Client Defined Identifier A unique ID for the surcharge that you can define for future reference. If you
do not enter an ID in this field, the application defaults this value as the surcharge
name with underscores.

3.png

Description Provides a description of the surcharge. This is for internal purposes and is not visible to your customers.

4.png

External Description The description of the surcharges that your customers see on their statements.

5.png

Assignment Level Indicates if the surcharge is applied to the Account, the Master Plan Instance, or both.
6.png Application Scope

Defines the plans and charges to which the surcharge applies. By default, if a plan is not selected, the surcharge is applied to all plans and services.
Available options include:

  • All Charges
    ​Surcharge is calculated for all charges on the invoice, including all services, charges, and inventory items.

  • All Plan Charges, All Plans
    Surcharge is calculated for all plan charges on the invoice.

  • All Plan Charges, Specified Plans
    Surcharge is calculated for all charges that belong to specific plans as chosen in the surcharge definition.

  • All Plans, Specified Service Charges
    Surcharge is calculated for the services that are specified in the surcharge definition.

  • Specified Plan/Service Charges
    Surcharge is calculated for the combination of services and plans that are specified in the surcharge definition.

  • All Recurring Service Charges
    Surcharge is calculated for all the recurring services on the invoice.

  • All Usage Service Charges
    Surcharge is calculated for all usage services on the invoice.

  • All Activation Service Charges
    Surcharge is calculated for all activation services on the invoice.

  • All Item Charges
    Surcharge is calculated for all one-time item services on the invoice.

  • Specified Item Charges
    Surcharge is calculated only for the items that are specified in the surcharge configuration.

  • Payment Method
    Surcharge is available to be applied to a payment method. Note that, for this selection, the surcharge is calculated on the pre-tax total. For details, see Add a Payment Method.

  • Payment Term
    Surcharge is available to be applied to a payment term. Note that, for this selection, the surcharge is calculated on the pre-tax total. For details see Add a Payment Term.

7.png

Apply to Invoice

Allowable values are as follows:

  • Before Discounts: Surcharge amount is discounted when a discount applies to the account.
  • After Discounts: Surcharge is not discounted. Surcharge amount is applied after a discount to the account is calculated.
8.png Present the surcharge as a separate invoice line Indicates how the surcharge is displayed on the invoice. A surcharge can be included with the original line item, or it can be added to the invoice as a separate surcharge line item.
surcharge2-11.png
 
9.png

Tax Group

Defines the tax group used for calculating taxes against the surcharge. This field only displays if Present the surcharge as a separate invoice line is checked. Surcharges are always applied on pre-tax amounts unless the price is tax-inclusive. In this case, you must ensure that the surcharge applies only to tax-exclusive items, or double taxation occurs.
10.png Revenue Account GL Code Indicates the revenue account general ledger code for the surcharge. This field only displays if Present the surcharge as a separate invoice line is checked.
11.png Account Receivable GL Code Indicates the account receivable general ledger code for the surcharge.

12.png

Rate Calculation Method Indicates whether the surcharge fee is a fixed amount or a percentage of the invoice charges. The fee is calculated as the net line item total for the selected services.

13.png

Rate Schedule Name

Enter a name for the rate schedule.

14.png

Currency Enter the currency type (e.g. USD, CAD...etc.)

15.png

Minimum Surcharge to Apply Specify the minimum surcharge to apply. This amount is charged if the rate tier calculation is lower than this amount.

16.png

Rate Tiers

Provide the information for the rate tier. If the Description field does not display, set the Use Rate Tier Descriptions parameter to True (Configuration > Client Settings > Miscellaneous Settings).

Click the Add Rate Schedule button to have multiple rate schedules.

17.png

Include zero in rate tier If Yes is selected, zero value is considered in the rate tier. If No is selected, zero value is excluded from the rate tier.

Upon defining the surcharge, click Save. The surcharge is created and displays in the list view on the Surcharges screen.

 Note: The API portion of this change was implemented as part of Surcharge Enhancements - API (DEV-8241).


Alternate Bill Day Option Added When Generating an Invoice (DEV-7903)

This feature adds the option to select an alternate bill day in the user interface when generating an initial invoice for an account, billing group, or a master plan instance.  This option does not display for advanced invoices or if an invoice has already been generated for the account, billing group, or a master plan instance.  

Note: This functionality is available with the gen_invoice_m API.  This feature only adds the functionality to the user interface. 

For example, the Alternate Bill Day dropdown does not display when generating an invoice for an account if any of the billing groups for the account have already been invoiced.  The dropdown does display if no invoices have been previously generated for the account.  

Getting Here: Click Accounts > search for an account > Statements & Invoices > Invoices tab > Generate Invoice

Alt Billing Day 11.0.png

Selecting an Alternate Bill Day sets a bill day that is different from the current date.  After selecting the alternate bill date, an invoice is generated for the period between the current date and the alternate bill date.  Refer to Generate an Invoice for more information. 

Note: Information in the user documentation reflects the Production instance. Since this feature is in Stage Future, the information in the Generate an Invoice article linked above does not include the Alternate Bill Day information. 

 


Chase Paymentech Soft Descriptors (DEV-8072)

The Chase Paymentech payment gateway now supports the use of soft descriptors. Soft descriptors are an additional text field that can be specified when configuring a payment gateway. The value in this field can appear on credit card statements to replace the configured client name. This can be useful if a client has several businesses. For example, ABC Enterprises might want "ABC Hardware" to appear on their account holder statements.

The soft descriptor fields can be specified at the payment gateway and on any collection group assigned to the Chase Paymentech payment gateway. The fields are as follows:

  • Soft_descriptor: Description that appears on the account holder's statement
  • Soft_descriptor_customer_service: City or customer service phone number that appears on the account holder's statement.

Configure Soft Descriptors at the Payment Gateway

Getting Here: Click Configuration > Payments > Payment Gateways > New > Chase Paymentech

The Chase Paymentech Create New Payment Gateway screen displays with the Soft_descriptor and Soft_descriptor_customer_service fields available in the Options section.

chase1-11.png

Configure Soft Descriptors at the Collection Group

Getting Here: Click Configuration > Collection Groups > New

Any collection group assigned to the Chase Paymentech payment gateway displays with the Soft_descriptor and Soft_descriptor_customer_service fields available in the Advanced Options section.

chase2-11.png

Note: The API portion of this change was implemented as part of Chase Paymentech Soft Descriptors - API (DEV-8072.


Chase Paymentech Account Updater Available (DEV-8031)

Chase Paymentech Account Updater is now available in Aria Crescendo. Full documentation is available at the following link:

Account Updater Documentation


Paymetric Payment Processor Moneris(CAD) Enhancement (DEV-7920)

The Paymetric payment gateway now supports the Moneris processing bank cartridge for Canadian currency (CAD) transactions. Note that any clients who want to configure Moneris as their cartridge must specify this when they set up their collection group for this payment gateway.


Stop Dunning Advancement on Anniversary Collections (DEV-8040)

This feature makes two changes to how dunning is handled.

  • A billing anniversary collection attempt no longer advances the dunning process 
  • A new client parameter, COLLECT_CURRENT_MPI_ONLY_ON_DUNNING allows you to change dunning handling. This parameter limits the collection scope for billing groups with multiple master plan instances and dunning groups. Previously, all MPIs in the billing group with a balance were included in the dunning collection attempt, regardless of which dunning group they belonged to. Now you can limit that collection to only master plan instances associated with the dunning group that are also within the billing group. Allowable values for this parameter are as follows:
    • True: Dunning includes only the master plan instance associated with a dunning group, even if there are multiple master plans assigned to the billing group.
    • False: Dunning includes all master plan instances in the billing group. This has been the default behavior.

For new clients, the default value for this parameter is True. For existing clients, the initial value for this parameter is False, to maintain consistency with the previous behavior.

Contact Aria Customer Support to change the value of this parameter.


Statement Creation for Invoices Without Line Items (DEV-8078)

This feature enables statement creation for invoices without line items. An optional and configurable invoice setting has been added that designates a service to use on invoices without line items. This service is added as a zero amount line item for each plan associated with the invoice. 

Aria Crescendo uses the line item(s) in an invoice to generate statements. In some cases, a statement is needed even if the invoice does not have a line item.  For example, a client may want to send a statement for an account with usage, though no usage occurred in the billing period.

Set the Invoices Without Line Items Client Parameter 

Getting Here: Click Configuration > Billing > Invoice Settings

Invoice Line Item Setting 2 11.png

  1. Click Invoice Without Line Items. The parameter configuration displays. 
  2. From the Value dropdown, select True.
  3. Enter a service name or number in the Select a Recurring Service field, or click Browse to select a recurring service. Once selected, the service name displays with the label Selected Service

Note: The service selected must not have a rate schedule associated with it. 

Set the Invoice Line Item Setting 11.0.png

  1. Click Save.  The service displays as a line item with a zero amount on invoices which do not otherwise have a line item. 

Invoice Line Item 11.0.png


NETS Agreement ID Displayed in User Interface When Using create_account_complete_m (DEV-7430)

This feature enables the user interface to display the agreement ID even when the agreement ID is entered into the system using the create_acct_complete_m API. Previously, when using the API, the agreement ID did not display in the user interface. 

Getting Here: Click Accounts > Search for and select an account > Plans > Billing Groups tab

Agreement ID in UI 11.0.png


Statement Sequence Number Displayed on Rebill Invoices and Statements (DEV-8252)

This features add the option to include the previous statement sequence number to a rebilled invoice. To add this parameter to your email template(s), contact Aria Customer Support.  


Rebill Functionality Enabled for Invoices in Current Billing Cycle (DEV-8253)

This feature enables rebilling invoices that are in the current billing cycle.  For more information on rebilling invoices, refer to Rebill an Invoice. 


Application Fixes

  • "Unable to execute INSERT statement " error on "Create New Non-Subscription Offering" page (TICKET-13103)
  • Error when saving a plan by updating the inventory items (TICKET-13605)
  • Error when there were multiple invoices (TICKET-13675)
  • Write-off RevRec data was incorrect when the invoice had a coupon (TICKET-13693)
  • Tax calculation error with prorated service credit (TICKET-13747)
  • Financial transaction events did not match advertised schema (TICKET-13787)
  • Aria did not assign Invoice Date in parent invoices (TICKET-13905)
  • Creating a plan using a template generated an error (TICKET-13939)
  • Auto-Send Statement On Order Invoicing was not being honored (TICKET-14067)
  • Taking usage units to negative or zero balance did not trigger an event (TICKET-14159)
  • Typo in description for "Auto-Void Order on Electronic Collection Failure" client parameter (TICKET-14172)
  • Discarded Usage displayed when filtering by specific usage type (TICKET-14202)
  • Child account Invoice was not generated (TICKET-14203)
  • All Service Rates tab was still highlighted and selected when changing pages (TICKET-14228)
  • $0 invoices were not transferred (TICKET-14236)
  • Microstrategy failed to login if username was email (TICKET-14242)
  • Adding a plan with an included NSO showed all rates for the NSO instead of the single currency (TICKET-14252)
  • Statement for an order was not being sent when the order's MPI status = 32 (TICKET-14320)
  • All Service Rates page was missing some rates and services (TICKET-14327)
  • Error was generated when existing Client_Service_ID was mapped with a supplemental plan (TICKET-14346)
  • "Electronic Refund Processed Notification" was not displaying correctly (TICKET-14404)
  • "Void this Invoice and Discard Usage" was appearing twice in UI (TICKET-14420)
  • Credit proration on plan cancellation issues (TICKET-14550)

API Features

Surcharge Enhancements - API (DEV-8241)

This feature adds a new field to the create_acct_complete_m API that allows clients to assign surcharges using a client-defined surcharge ID.

Name Type Description
client_surcharge_id String Client-defined identifier for the surcharge.

This feature also enhances how surcharges are created, and how they are processed. Surcharges associated with a payment method or payment term are now calculated before taxes are applied and are then taxed with any other taxable charges. Surcharges can now be included in credit memos and rebills.  


Chase Paymentech Soft Descriptors - API (DEV-8072)

The Chase Paymentech payment gateway now supports the use of soft descriptors. Soft descriptors are an additional text field that can be specified when configuring a payment gateway. The value in this field can appear on credit card statements to replace the configured client name. This can be useful if a client has several businesses. For example, ABC Enterprises might want "ABC Hardware" to appear on their account holder statements.

The soft descriptor fields can be specified at the payment gateway and on any collection group assigned to the Chase Paymentech payment gateway. The fields are as follows:

  • <Soft_descriptor>: Transaction description shown on the buyer's statement that displays a Merchant Name or Item Description typically. This field is ignored if not supported/certified by the payment processor.
  • <Soft_descriptor_customer_service>: Transaction description shown on the buyer's statement that displays a Merchant Name or Item Description typically. This field will be ignored if not supported/certified by the payment processor.

The <soft_descriptor> field is an existing input field on several APIs. The <soft_descriptor_customer_service> field is a new input on the same set of APIs. Specifying either of these fields on an API overrides the value specified at the payment gateway or collection group. You can specify a value in either of these fields for accounts assigned to either the Chase Paymentech payment gateway, or any other payment gateway that supports soft descriptors.

Field Name Field Type Max Length Description
soft_descriptor_customer_service String 13 Transaction description shown on the buyer’s statement that displays a city for card-present transactions or a phone number for card-not-present transactions.  This field is ignored if not supported/certified by the payment processor.

APIs that use the <soft_descriptor> and <soft_descriptor_customer_service> fields are as follows:


Purchase Power/Reserve Account Validation Removal (DEV-7921)

This feature removes validation of the <bill_agreement_id> field in the create_acct_complete_m API when using Purchase Power or Reserve Account payment methods. This field is where the Reserve Account Number and Purchase Power Number fields are entered when using those payment methods. The API now allows entry of alphanumeric strings in these fields.


Get_all_client_receipt_ids_m Updated to Include Receipts from Usage APIs - DEV-8055

The get_all_client_receipt_ids_m API now includes the client-level receipt IDs created for multiple accounts using the bulk_record_usage_m  API and account-level receipt IDs created for an account using the record_usage_m API.


Enhancements to Validate_payment_information_m (DEV-8130)

This feature adds two new input fields to the validate_payment_information_m API, and updates certain field validations.

New Input Fields

Two new input fields, <billing_group_no> and <client_billing_group_id> have been added to this API. Only one of these two fields can be submitted with this API call.

Field Name Field Type Max Length Description
billing_group_no long 22 Billing group number
client_billing_group_id string 100 Client-defined unique identifier for the billing group

Validation Changes

The following changes to validation of this API have been implemented:

  • When either <billing_group_no> or <client_billing_group_id> is given in the API request and <seq_no> or <alt_pay_method> is not given, then the  primary payment billing information for the billing group is validated in the API call.
  • Values can now be entered in either uppercase or lowercase in the <currency_cd> field.
  • Only one of the following fields is used during this API call. If more than one of these fields is valued, the priority for processing is as follows:
    • <alt_pay_method>
    • <seq_no>
    • <billing_group_no>/<client_billing_group_id>
  • The values in the <acct_group_no> and <alt_pay_method> fields are now validated,
  • <Account_no> is now a required field.

Processor Payment ID Added as a Query String Input Parameter (DEV-8144)

This feature adds the ability to query customer accounts using the <processor_payment_id> field of the Object Query API get_payment_details_m


Proration Period Fields Moved to Different Array in update_acct_plan_multi_m (DEV-8143)

This feature has moved the following proration fields from the <plan_service_proration_results> array to the <invoice_item_details> array in the update_acct_plan_multi_m API: 

  • <proration_text>
  • <proration_remaining_days>
  • <proration_description>

This move supports the combined invoice feature by reflecting the "combined" invoice sub-period on each line. 


API Fixes

  • <Old_status> and <new_status> were not working in get_account_status_history_m (TICKET-13329)
  • Plan Group update APIs were generating SQL error (TICKET-13425)
  • Get_acct_preview_statement_m did not immediately include recent usage (TICKET-13452)
  • Invalid response "contract does not exist" when using cancel_instance_contract_m (TICKET-13494)
  • Update_supp_obj_field_m API issues with different response format (TICKET-13674)
  • Update_acct_plan_status_m <degrade_date> issue (TICKET-13710)
  • Set_company_profile_m API issues (TICKET-13732)
  • <Future_rate_per_unit> and <rate_tier_description> fields were not displayed in get_client_plan_service_rates_m  (TICKET-13852)
  • Create_advanced_service_credit_m API returned invalid input (TICKET-14016)
  • Update_acct_plan_multi_m did not calculate coupon when "do_write=false" (TICKET-14201)
  • Issues with new line characters in get_credit_details_m API response (TICKET-14235)
  • Assign_acct_plan_m API allowed negative custom rates (TICKET-14238)
  • 5030 Error generated after using Yen rate schedules with create_acct_complete_m (TICKET-14240)
  • Get_acct_plans_m generated error when a value was passed in the <locale_name> field (TICKET-14279)
  • Column sizes during create_acct_complete_m XML generation did not match (TICKET-14344)
  • Get_catalog_hierarchy_m API timed out (TICKET-14421)
  • Update_acct_plan_multi_m API was generating 'unexpected error' while assigning a master plan with new billing group. (TICKET-14465)
  • Update_acct_plan_multi_m failed to add child when not adding MPI (TICKET-14553)
  • Voided invoice's balance carried forward into re-generated invoice in get_invoice_information_m API (TICKET-14585)
  • Get_acct_preview_statement_m returned 500 response (TICKET-14611)
  • Create_coupon_m generated discount rules error (TICKET-14659)

WSDL File Locations 

Stage Current

US https://secure.current.stage.ariasystems.net/api/Advanced/wsdl/11.0/complete_m-doc_literal_wrapped.wsdl
EUR None

Stage Future

US https://secure.future.stage.ariasystems.net/api/Advanced/wsdl/11.0/complete_m-doc_literal_wrapped.wsdl
EUR https://secure.future.stage.cph.ariasystems.net/api/Advanced/wsdl/11.0/complete_m-doc_literal_wrapped.wsdl

Production

US https://secure.ariasystems.net/api/Advanced/wsdl/11.0/complete_m-doc_literal_wrapped.wsdl
EUR https://secure.prod.cph.ariasystems.net/api/Advanced/wsdl/11.0/complete_m-doc_literal_wrapped.wsdl
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.