Atomia Billing Server

Generic Workflow configuration

139 views 0

Overview

Generic Workflow for domain, webhosting and VPS companies is a set of automated processes for billing and managing customers services. Technically, the workflow is a set of configuration options and a set of periodic processes.

General Workflow Settings

Namespace: Atomia.Billing.Plugins.GenericWorkflowPlugin.GenericWorkflowPluginBase

Example configuration:

            {
              "DnsCategoryName":"DNS",
              "DomainRegistrationCategoryName":"Domain",
              "DomainTransferCategoryName":"DomainTransfer",
              "HostingCategoryName":"Hosting",
              "OnlinePaymentUrl":
              "https://billing.example.com/Invoice/{0}/{1}/OnlinePayment",
              "OwnDomainArticleNumber":"DOM_OW",
              "RegisteredDomainsLimit":0,
              "ResetPasswordUrl":"https://my.example.com/ResetPasswords/{0}/{1}",
              "SendInvoiceByPostItem":"FEE-POST",
              "SetupFeeItem":"FEE-SETUP",
              "ApplyToSubresellers":true
            }

The general workflow configuration options are specified by JSON structure with the following entries:

  • DnsCategoryName The name of the product category of free hosting (DNS only) products.
  • DomainRegistrationCategoryName The name of the product category of domain products (domain registrations and domain renewals).
  • DomainTransferCategoryName The name of the product category of domain transfer products.
  • HostingCategoryName The name of the product category of hosting products.
  • OnlinePaymentUrl The URL to pay invoice online. For example:https://billing.example.com/Invoice/{0}/{1}/OnlinePayment Where {0} is a placeholder which will be filled in with the username of the customer and {1} is a placeholder for invoice number.
  • OwnDomainArticleNumber The article number of the fake product that will be used to record customers domain that’s registered externally and will be DNS-pointed to his hosting services.
  • RegisteredDomainsLimit The total number of domains allowed to be ordered using Billing API. Zero means no limit.
  • ResetPasswordUrl The URL of the forgot password link. For example:https://login.example.com/PasswordReset.aspx?user={0}&id={1} Where {0} is a placeholder which will be replaced with an email of the user and {1} will be replaced with the unique identifier (long, hard to guess string) of the password reset request.
  • SendInvoiceByPostItem The id (article number) of the product that represents a postal fee to be added to all invoices sent by regular post.
  • SetupFeeItem The id (article number) of the product that represents a general setup fee product. In this generic workflow this Setup fee is used only for upgrade from free (DNS) products. For new orders it is expected that the order page handles the logic of setup fees.
  • ApplyToSubresellers If set to true and this configuration is reseller specific then it also applies reseller’s sub-resellers.

Was this helpful?