Product Documentation

Configuring Billing Settings for the Portal

Dec 22, 2015

  1. To configure your billing settings, log in to CloudPortal Business Manager UI as Root user.
  2. Click the drop-down menu icon in the top right corner next to ROOT USER.
  3. Click Administration > Configuration > Portal.
  4. Click Billing > Configure.
  5. Click Edit and set the following values:
    Parameter Name Description
    spendBudget.firstAlert First Spend Budget alert (in percentage of Spend Budget).
    spendBudget.secondAlert Second Spend Budget alert (in percentage of Spend Budget)
    spendLimit.creditAlert Send Credit Limit alert to internal Credit personnel when this percentage of Credit Limit has been used.
    billingPeriod.type Set to 1 to bill every <x> days, 2 to bill on a certain day of the month, 3 to bill monthly on the account creation date. Set com.citrix.cpbm.portal.billing.billingPeriod.config to the desired <x> or day of the month.
    Note: After setting the configuration in com.citrix.cpbm.portal.billing.billingPeriod.type, it must not be changed.
    billingPeriod.config Billing day(s) for use with com.citrix.cpbm.portal.billing.billingPeriod.type. Allowed values: 1-28. For example, set to 28 if com.citrix.cpbm.portal.billing.billingPeriod.type is 1, 15 if com.citrix.cpbm.portal.billing.billingPeriod.type is 2. Leave empty if com.citrix.cpbm.portal.billing.billingPeriod.type is 3.
    Note: After setting the configuration in com.citrix.cpbm.portal.billing.billingPeriod.config, it must not be changed.
    generate.BillingActivity Setting it to Y will enable detailed logging of the usage, rating and billing activity, on a daily basis. Valid Values ("Y", "N").
    invoiceHandle.sequence Invoice Handle Sequence Name used for the sequence generation.
    export.fileExtension File extension for export file of usage details.
    subscription.preAuthorizationFactor Credit Card Pre-authorization factor.
    alerts.maxSpendAlertNotifications Maximum number of spend alert notifications sent on each alert trigger.
    generate.InvoiceEmail Send the invoice PDF as an attachment in the mail to the Master User and Billing Admin when the invoice generation job runs.
    roundingMode.charge Set this rounding mode if charges need to be rounded to currency precision. Value should be one of these (UP, DOWN, CEILING, FLOOR, HALF_UP, HALF_DOWN, HALF_EVEN).
    roundingMode.discount Set this rounding mode if discounts need to be rounded to currency precision. Value should be one of these (UP, DOWN, CEILING, FLOOR, HALF_UP, HALF_DOWN, HALF_EVEN).
    roundingMode.tax Set this rounding mode if taxes need to be rounded to currency precision. Value should be one of these (UP, DOWN, CEILING, FLOOR, HALF_UP, HALF_DOWN, HALF_EVEN).
    hoursIn.month Number of hours in month.
    export.URL Remote location to which the generated fille will be transfered for eg. sftp://username:password@host/directory_path.
    export.directory Local system directory where the exported file gets stored before billing stream is uploaded to remote system.
    old.usage.process.config Setting for processing of old usages: Setting the value to 0 indicates system will not process old usage. Setting the value to 1 indicates system will generate invoice feeds - invoices for old usage are generated but are not posted into any account statement. Setting the value to 2 indicates system will generate invoices for old usage which will be posted into the current account statement. Setting the value to 3 indicates the system will generate invoices for old usage which get posted to the billing period to which the usage belongs.
  6. Click Save.
  7. Click Close.