Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo Documentation > Aria Crescendo Release Notes > Release 17

Release 17

This article applies to:Aria Crescendo

Application Features 

Tooltips Available when Setting up a Collection Group or Payment Gateway (DEV-8729)

All currently-available tooltips are now displayed for fields to be filled in when you add or edit a collection group or payment gateway.​


Usage Accumulation Reset Months Renewal Option (DEV-8730)

This enhancement introduces functionality that enables an option to automatically reset the Alternate Usage Reset Months for an account's new or existing Master and/or Supplemental Plan Instance(s) after the current period has expired. This feature is supported via the Aria UI and API.

An account's Master and/or Supplemental Plan Instance(s), that contain a usage-based service, can be configured to accumulate usage over an extended period of months (Alternate Usage Reset Months) for subsequent rating and invoicing purposes. 

Enabling a Plan's Alternate Usage Reset Months for Usage Accumulation, AND Configuring for Auto Renewal Or One-Time Only 

Getting Here: Accounts > Search  > Account Overview > Plans

Plans Screen - Usage Accumulation Reset.jpg
 

  1. Click on an account's Master and/or Supplemental Plan Instance ID.

Usage Accumulation Hyperlink.jpg

  1. Click on the Plan's Usage Accumulation Reset Value hyperlink.

Set Alternate Usage Reset Option.jpg

  1. Click on the Alternate Usage Reset Options field's drop-down arrow and select your renewal option for this Plan's Alternate Usage Reset Months.
  • Auto-Renew - usage accumulation for this Plan's usage-based service will automatically reset to the same Alternate Usage Reset Month's value upon completion of it's usage accumulation period.
  • One-Time Only - The accumulation of usage will expire at the end of the Alternate Usage Reset Month's value upon completion of it's usage accumulation period.

Note: Auto-Renew is the default Alternate Usage Reset Month's renewal option. 

  1. Type in the number of Alternate Usage Reset Months that you want to accumulate usage for rating and invoicing purposes.

Note: The maximum allowed Alternate Usage Reset Months is 99.

  1. Click on the Save button to save your changes.

Account Overview - Comments Section.jpg

  1. Click on the View All Comments link from within the Recent Comments section on the account's Account Overview screen.

Usage Accumulation Comment.jpg

A comment is added to the account detailing the Usage Accumulation settings for the specific Plan instance including the Reset Months, and the Reset Renewal Option.  


Adyen Level 2 and 3 Data Enhancements (DEV-8749)

When applicable, Aria will send Level 2 and 3 data to Adyen, resulting in savings on transaction fees. "Level 2" data refers to customer-specific affluence indicators, and "Level 3" data is specific to invoice line items.

More information about Adyen Adyen.


Account Hierarchy / Master Plan Instance Visualization Configuration (DEV-8792)

This enhancement supports the customization of the account and plan instance hierarchy visualizations using internally-defined fields as well as a client's account/product supplemental fields.  

Note: The Account Hierarchy / Master Plan Instance Visualization Configuration functionality is an optional tenant setting. Contact Aria's Customer Support team to enable this functionality for your Aria tenant.

Enabling a Role / User To Configure Hierarchy Visualization 

Getting Here: > Configuration > Security > Roles

Access New_Existing Role.jpg

  1. Click New OR on an Existing Role.

Set Role for Hierarchy Configuration.jpg

  1. Click on the Read and Edit check boxes next to Hierarchy Configuration within the > Configuration > Client Settings section of this page to enable this Role to access and configure Hierarchy Configuration. Remember to click on the Save button at the bottom of the screen to effect this Role change.

Note: For information on assigning users to a role, see Assign a User to a Role

 

Configuring Account / Master Plan Instance Hierarchy Visualization

Getting Here: > Configuration > Client Settings > Hierarchy Visualization

Hierarchy Visualization Screen.jpg

The Hierarchy Visualization screen provides options for configuring the display of internally defined fields, and client specific account and / or product supplemental fields on Account and Plan cards. 

Note: Selected options are automatically reflected in the sample account and plan cards on the right as a visual reference. 

 

Configure Account Card.jpg

Account Cards

  1. Click on the Title field's drop down arrow to select the title or top line that will display in the blue section of the account card. Options include:
  • User ID
  • Account Contact Company
  • Account Contact Full Name
  • Account Number
  • Use Account Field

Account Field Popup.jpg

  • Selecting Use Account Field displays a screen popup to select a customer-defined account field to display in the Title area of the account card.

Note: For information on creating an account field, see Create Account Fields.

  1. Click on the Subtitle field's drop down arrow to select the subtitle or second line that will display in the blue section of the account card. Options include:
  • Payment Responsibility
  • Account Contact Company
  • Account Created
  • Account Number
  • Account Start Date
  • Status
  • Use Account Field
  1. Click on the Left Body field's drop down arrow to select the left body detail that will display in the white section of the account card. Options include:
  • Currency
  • Days Past Due
  • Full Balance
  • Plan Instances
  • Unapplied Service Credits
  • Use Account Field
  1. Click on the Right Body field's drop down arrow to select the right body detail that will display in the white section of the account card. Options include:
  • Full Balance
  • Days Past Due
  • Full Balance
  • Plan Instances
  • Unapplied Service Credits
  • Use Account Field
  1. Click on the Details Flyout tab to configure settings for the account card's View Details flyout.

Account Card View Details Flyout.jpg

  1. Click on the various Account Details option's check boxes to include on the Account Card's View Details flyout.
  2. Click on the Cards tab to return to the main Hierarchy Configuration screen.

Plan Cards 

Configure Plan Card.jpg 

  1. Click on the Title field's drop down arrow to select the title or top line that will display in the blue section of the plan card. Options include:
  • Plan Name
  • Client Defined Identifier
  • Instance Description
  • Plan Number
  • Use Product Field

Product Field Popup.jpg

  • Selecting Use Product Field displays a screen popup to select a customer-defined product field to display in the Title area of the plan card.

Note: Only Product Fields configured for Plan objects and " for a specific instance of a Plan assigned to an account" are supported. For information on creating a product field, see Create Product Fields.

 

  1. Click on the Subtitle field's drop down arrow to select the subtitle or second line that will display in the blue section of the plan card. Options include:
  • Plan Number
  • Instance Description
  • Status
  • Use Product Field
  1. Click on the Left Body field's drop down arrow to select the left body detail that will display in the white section of the plan card. Options include:
  • Plan Units
  • Current Balance Due
  • Days Past Due
  • Full Balance
  • Rate Schedule
  • Use Product Field
  1. Click on the Right Body field's drop down arrow to select the right body detail that will display in the white section of the plan card. Options include:
  • Rate Schedule
  • Current Balance Due
  • Days Past Due
  • Full Balance
  • Plan Units
  • Use Product Field
  1. Click on the Details Flyout tab to configure settings for the plan card's View Details flyout.

Plan Card View Details.jpg

  1. Click on the various Plan Details option's check boxes to include on the Plan Card's View Details flyout.
  2. Click on the Save button to effect your changes.

Create a Service Credit for Current and Future Plan Subscriptions (DEV-8899)

In the Aria application, you can now create a service credit that applies to:

  1. A particular master plan instance (MPI) stack, which includes:
  • The selected MPI and its associated supplemental plans currently subscribed to; and
  • The customer’s supplemental plans added to the selected MPI stack in the future; and
  1. Your specified plans in your product catalog that the customer may subscribe to in the future.

Please see Create a Service Credit for more information.


Support for Adyen Account Updater (DEV-8948)

Aria has certified its support for the Adyen Account Updater. The Adyen Account Updater sends notifications to customers whose cards have approaching expiration dates, allowing the opportunity for customers to update card information and decrease the possibility of card declines.

More information about Adyen Adyen.


Ability To Update Account's Currency Prior To First Charge (DEV-8995)

You can now change an account's currency prior to its first charge. For example, a customer could create an account with a free Master Plan and a default currency of USD; then, later, the customer could enroll in a non-free plan with a different currency that matches that customer's country of residence.


Application Fixes 

  • Batch jobs scheduled to run between 2:00 AM to 3:00 AM, during Daylight Savings Time, now run properly and do not generate a database error. (TICKET-3244)
  • The replacement string "insertPaymentAmount," intended in Dunning email templates to display an amount due, now shows a consistent and accurate amount for each step of a Dunning process. (TICKET-16336)
  • If you have a parent-child account set up and you created a product field to be displayed in your statements, the statements for the parent account now display the product field on the correct line for the object that it is mapped to (example: a plan instance). (TICKET-16358)
  • A new generic "Non-Electronic Payment" global email template has been introduced that resolves various issues with formatting and replacement strings. (TICKET-16373)
  • When you change the status of a plan from "pending termination" to "active", the previous termination date is no longer included in event 734 (Account Master Plan Instance Status Modified). (TICKET-16376)
  • XML Statements now correctly show negative, rather than positive, usage units when negative usage units are expected for the replacement string "insertItemUnits" on an XML Statement Template. (TICKET-16385)
  • The payment surcharge is no longer added to an invoice when the application of a credit results in a $0 invoice, provided the surcharge tier has not enabled "Include zero amount". (TICKET-16431)
  • When specifying an existing account contact as a Destination Contact on multiple orders or multiple order line items, Aria no longer displays duplicate entries for that content on an account's Contacts tab. (TICKET-16445)
  • A "Client Defined Identifier is Not Unique" error message no longer displays when editing an Aria user's detail (having role / user access to multiple tenants) via the > Configuration > Security > Users tabs within the Aria UI. (TICKET-16507)
  • Corrected XML email statement templates to eliminate mismatches that were occurring between the acct_statement_m. xsd schema, and the XML statement document generated by Aria. (TICKET-16511)
  • Creating a credit memo for an invoice with multiple taxed credits or discounts no longer results in a database error. (TICKET-16521)
  • Order invoices generated from the UI now display line items on the View/Print screen. (TICKET-16535)

API Features 

Usage Accumulation Reset Months Renewal Option (DEV-8730)

Several APIs were updated to support the Usage Accumulation Reset Months Renewal Option functionality, per the below table:

API Updates

create_acct_complete_m

update_acct_complete_m

update_acct_plan_multi_m

replace_acct_plan_m

assign_acct_plan_m

update_acct_plan_m

Added new input field, <usage_accumulation_reset_months_renewal_option>.

This field determines whether the <usage_accumulation_reset_months> field value will automatically reset to the same value at the end of the current usage accumulation period or will expire at the end of the current usage accumulation period.

get_acct_plans_all_m

get_acct_plans_m

Added three new output fields,<usage_accumulation_reset_months>, <usage_accumulation_reset_months_renewal_option>, and <usage_accumulation_reset_counter>.

The <usage_accumulation_reset_months> field value indicates the number of usage accumulation reset months for each plan.

The <usage_accumulation_reset_months_renewal _option> field value denotes whether the <usage_accumulation_reset_months> field value will automatically reset to the same value at the end of the current usage accumulation period or will expire at the end of the current usage accumulation period.

The <usage_accumulation_reset_counter> field value denotes the number of months since last reset. Once this value reaches the usage_accumulation_reset_months value, it will reset to 0 (zero).

 

 

 


Visa CIT MIT Credential Framework (DEV-8833)

Several APIs were updated to support the Visa Cardholder-initiated Transaction (CIT) and Merchant-initiated Transaction (MIT) Credential Framework, with a new input and output field that specifies whether the cardholder or merchant initiates the transaction, and whether the card information is stored:

APIs Updates
  • New input field:
    <recurring_processing_model_ind>: Defines a recurring payment type for Credit Card and Tokenized Credit Cards.
    Allowable values:
    0: Cardholder-Initiated Transaction—Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
    1: Cardholder-Initiated Transaction—a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
    2: Merchant-Initiated Transaction—Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
    3: Merchant-Initiated Transaction—Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.
  • New output field:
    <proc_initial_auth_txn_id>: Transaction ID from payment processor. If received as part of an auth request, it must be retained for future settlement and match the value from the auth response. It should also be used for future recurring transaction auths/settlement.

Performance Improvement for Crescendo API Calls With the Parameter client_acct_id (DEV-8905)

Aria updated the back-end of its application to utilize database indexing for API calls that use the client_acct_id parameter.


client_acct_id Now Case Insensitive For Object Query APIs (DEV-8908)

Aria updated the following Object Query API calls so that the <client_acct_id> field is no longer case sensitive:

  • get_plan_instance_information_m
  • get_account_details_m
  • get_coupon_history_m
  • get_invoice_information_m
  • get_all_invoice_information_m

Ability To Apply Coupon To Supplemental Plans (DEV-8980)

You can now use the following API calls to assign coupons to supplemental plans. In the past, coupons could only be assigned to a Master Plan Instance:


API Performance Improvements (DEV-9014)

Aria continues to improve its API/SDK offering as announced in Release 15.0. Now, all Core APIs, with the exception of send_acct_statement_email_m have undergone efforts to improve their overall performance, and response times.


API Fixes 

  • When you call the collect_from_account_m API and pass in a specific_charge_transaction_id, the corresponding amount for the specified transaction ID is now collected and you no longer encounter an error. (TICKET-14636)
  • When updating plan instance fields using update_acct_plan_multi(_m) or create_acct_complete(_m), and the same value is passed for an existing field, Aria no longer duplicates that field name/value pair, and retains single instances of those fields and values as expected. (TICKET-15557)
  • When you attempt to create an account or assign a plan using an API in which you passed in a <retroactive_start_date> and an <alt_bill_day> and you set <combine_invoices> to 1:
    • You will not encounter an error;
    • The combined invoices setting is now honored; and
    • The appropriate invoice is now generated.

      (TICKET-15880)

  • Plan product fields having a blank value are now successfully updated with a new value when passed in edit_plan_m. (TICKET-15915)
  • When you use the update_acct_plan_multi_m API to assign a master plan and supplemental plans at the same time, even if you assign the plans retroactively or with a future start date:
    • The effective dates, billing start dates, and status changes of the supplemental plans are now aligned with those of the master plan based on the date inputs passed into the API.
    • Invoices are now generated with the correct charges, regardless of whether the charges are prorated.
    • Your specified settings for invoice-related parameters and any invoicing inputs that you passed into the API are now honored.

Note: To determine the master plan's bill day when the update_acct_plan_multi_m API is called, Aria considers the following inputs in the order listed below:

  1. <override_bill_thru_date>;
  2. then whichever of these you passed in: <alt_start_date> or <alt_bill_day>;  
  3. then whichever of these you passed in: <retroactive_start_date> or <effective_date>.

For information on various scenarios involving date options in the update_acct_plan_multi_m API, see update_acct_plan_multi_m Use Cases.

(TICKET-16064)

  • When you call the authorize_electronic_payment_m API, you no longer encounter the XML Exception error: Unexpected element: CDATA and you now receive a response in the correct XML format. (TICKET-16091)
  • An Oracle error code and message is no longer exposed when an API call causes a database error. (TICKET-16249)
  • When calling edit_acct_plan_queued_changes_m with a do_write value of "false," the response no longer shows duplicate line items. (TICKET-16308)
  • When you change the status of a plan from "pending termination" to "active", the previous termination date is no longer included in event 734 (Account Master Plan Instance Status Modified). (TICKET-16376)
  • If there are multiple rollover rate schedules that apply to a contract, they are now returned in the <contract_rollover_rate_sched> array by the APIs listed below instead of blank values:
    • get_avail_plans_for_acct_m
    • get_client_plans_basic_m
    • get_master_plans_by_supp_field_m
    • get_plans_by_promo_code_all_m
    • get_plans_by_promo_code_m
    • get_supp_plans_by_promo_code_all_m
    • get_supp_plans_by_promo_code_m
    • get_supp_plans_by_supp_field_m
      (TICKET-16401)
  • The API call update_acct_invoice_m now includes the input parameter <client_acct_id>. (TICKET-16414)
  • If you use Billsoft (or any other  tax engine), you no longer encounter an unexpected error when you use any of the APIs listed below to assign a plan and you entered invalid address information. Instead, the correct error message “25001 failed to calculate taxes” is returned by these APIs:
    • cancel_acct_plan_m
    • modify_acct_univ_contract_m
    • modify_instance_contract_m
    • replace_acct_plan_m
    • update_acct_plan_m
    • update_acct_plan_multi_m
    • update_plan_unit_fulfillment_m

(TICKET-16415)

  • When replacing a plan via replace_acct_plan_m in the middle of a billing period, with an <alt_proration_start_date> of the account's billing anniversary, Aria no longer incorrectly generates an additional line item charge for a service on the old plan (that also exists on the new plan). (TICKET-16454)
  • When you use the update_acct_plan_multi_m API to assign a plan with an activation fee, as expected: a) the activation units are included in the <line_units> output in the API response and b) the activation units are displayed on the Invoice Details page in the Aria application. (TICKET-16462)
  • The appropriate error message (25020: Fields with a type of "String" cannot contain the following characters: < >) is now returned when API input fields with a type of "string" such as first_name, last_name, comments, plan_instance_description, etc. contain the following illegal characters <, >. (TICKET-16476)
  • When you attempt a collection using an API that provides proration options (examples: assign_acct_plan_m or update_acct_complete_m), Aria now includes Level II and Level III data in the payment request sent to your payment gateway. Level II and Level III (also known as Data Rate 2 and Data Rate 3) are interchange categories designed by Visa and MasterCard to give qualified businesses a discount on their interchange fees. (TICKET-16520)
  • Calling create_cm_m to create a credit memo for an invoice with multiple taxed credits or discounts no longer results in a 1001 error. (TICKET-16521)
  • Usage is now successfully loaded for a Supplemental Plan Instance when passing the <userid> or <client_acct_id>, and <client_plan_instance_id> as input parameters in the record_usage_m API. (TICKET-16528) 
  • Aria now sends <client_acct_id> parameter specified in get_acct_payment_history_m to sub-call to get_payment_application_dtls_m, and get_acct_payment_history_m no longer returns an error when <client_acct_id> and <details_flag> = 1 are specified. (TICKET-16529)
  • When assigning a Master Plan and mandatory Supplemental Plan with a retroactive start date and <assignment_directive> = 3 (perform the requested plan change immediately, ignoring pre-configured proration rule and forcing NO PRORATION) via update_acct_plan_multi_m or assign_acct_plan_m, Aria now updates the Supplemental Plan Next Bill Date(s) properly.(TICKET-16540)
  • When you pass an <application_id> or <application_date> into APIs that take those inputs, the values in those fields are now displayed in the Recent Comments section under Accounts > Account Overview in the Aria application. (TICKET-16556)

WSDL File Locations

Stage Current

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

Stage Future

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

Production

US https://secure.ariasystems.net/api/Advanced/wsdl/17/complete_m-doc_literal_wrapped.wsdl
EUR https://secure.prod.cph.ariasystems.net/api/Advanced/wsdl/17/complete_m-doc_literal_wrapped.wsdl
AUS https://secure.prod.aus.ariasystems.net/api/Advanced/wsdl/17/complete_m-doc_literal_wrapped.wsdl

Object Query WSDL Files

Stage Current

US https://secure.current.stage.ariasystems.net/api/AriaQuery/wsdl/17/integration_services_m-doc_literal_wrapped.wsdl
EUR None
AUS https://secure.current.stage.aus.ariasystems.net/api/AriaQuery/wsdl/17/integration_services_m-doc_literal_wrapped.wsdl

Stage Future

US https://secure.future.stage.ariasystems.net/api/AriaQuery/wsdl/17/integration_services_m-doc_literal_wrapped.wsdl
EUR https://secure.future.stage.cph.ariasystems.net/api/AriaQuery/wsdl/17/integration_services_m-doc_literal_wrapped.wsdl
AUS https://secure.future.stage.aus.ariasystems.net/api/AriaQuery/wsdl/17/integration_services_m-doc_literal_wrapped.wsdl

Production

US https://secure.ariasystems.net/api/AriaQuery/wsdl/17/integration_services_m-doc_literal_wrapped.wsdl
EUR https://secure.prod.cph.ariasystems.net/api/AriaQuery/wsdl/17/integration_services_m-doc_literal_wrapped.wsdl
AUS https://secure.prod.aus.ariasystems.net/api/AriaQuery/wsdl/17/integration_services_m-doc_literal_wrapped.wsdl
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.