Emersion - User contributions [en]

PackagePlans/Advanced

2021-08-24T02:15:03Z

Dcowan: fixed links

= Advanced Tutorials - Packages and Plans =

This section is for learning about the advanced features of the Package Plans module. Click on any article link below to explore that feature. May of these articles include short video tutorials to help you learn fast.

Note: Many of these features require a separate subscription. If you are interested in any of these features and they are not part of your current Emersion subscription, please contact the Emersion Sales team who will be more than pleased to help you.

== Tutorials ==

* [https://resources.emersion.com/display/EKB/Advanced+Access+Fees+Tutorial Advanced Access Fees] - It's one thing to know how to add an access fee to a package plan or a service plan. This video explains access fees in greater detail to show users how to leverage some of the lesser known capabilities to achieve more advanced billing outcomes. For example, how to set up the system to discount the access fee based on volume.

* [https://resources.emersion.com/display/EKB/Product+Order+Map Product Order Map] - Bind Products and Packages so related products can be offered to customers while completing an order for a service.

* [https://resources.emersion.com/display/EKB/First+Subscription+Period+End+Date First Period End Date] - This article will describe the usage of the [[PackagePlans/PackagePlans#Honour_First_Period_End_Date_if_Set|Honour First Period End Date flag]] on the package plan creation page, as well as the usage while activating a service.

* [https://resources.emersion.com/display/EKB/Package+Subscription+Groups Package Subscription Groups] - This article details the Package Subscription Group function. This permits linking of package subscriptions together, and bulk cancellation of linked packages when the primary package is cancelled.

Package Subscription Migrations

2021-07-07T03:49:06Z

Dcowan: corrected false statements about when migrations can occur

{{DISPLAYTITLE: Package Migrations}}
= Overview =
A package migration is a type of order that gives end users the ability to transition from one package plan to another package plan within the same [https://resources.emersion.com/display/EKB/Service+Types service type].

To understand migrations, it is a good idea to have an awareness of the related billing objects.
* Customers order (subscribe to) a [https://resources.emersion.com/display/EKB/Package+Plans package plan].
* When the order is submitted, an 'instance' of the package plan that the customer subscribes to, is created.
* This 'instance' is called the customer's ''package subscription''. It binds the package plan with the customer.
* Customers may subscribe to several package plans, creating a set of package subscriptions for each plan they subscribe to.

Package migrations work in conjunction with the [[PackagePlans/Contract#Package_Pools|package pool]] that stores the contractual benefits and penalties incurred when customers upgrades, cross-grades or downgrade their plan. This ensures customers are charged the appropriate contract break out fees or discounts as they defined in the [https://resources.emersion.com/display/EKB/Contracts contract].

Migrations can be paused at any time and returned to later. Any information saved up until this point will be retained, and other users will be prevented from starting another migration while there is already one in progress.

To continue with an incomplete migration:

Nav: '''Service > Migrations'''

The following page will be displayed showing a list of all migrations that have occurred, or are in progress. For those in progress, click the Order ID to resume the migration. The system will take the user to the last page within the migration process where it was saved.

[[File:Pkg-sub-migrations-main.png|1200px|]]

= The Migration Wizard =

=== Start the Migration ===
New package subscription migrations is started from the customer level under the [[Account_Management/Customer_Screen/Package_Subscriptions|'''Customer > Package Subscription''']] screen.

Under the ''Package Subscription Actions'' section, press the '''Migrate Package Subscription''' button.

[[file:Pkg-sub-migrations-start.png|1200px|]]

=== Add Service Types ===
The first step in a migration is to choose the service types to add, if any. The list of available service types is based on the service types contained in the ''current subscription''.

Tick any that apply and click '''Submit'''.

=== Package Selection ===
Choose which service types to keep under the new package. If the package subscription contains a single service then it cannot be cancelled in this screen.

Then, select a package from the available packages list. If the package plan cannot be found, you may need to step through the troubleshooting article below to determine why.

Press the '''Select''' button to proceed.

=== Service Allocation ===
This screen will present to the user the source pacakge and the desination package and will prompt users to configure any new services that may be contained in their new package.

=== Set the Date of Migration ===
Choose what date the migration will occur.

'''''! IMPORTANT !''''' Setting a future date for a migration to occur will not result in the system automatically processing the migration when the date arrives. By default, a service type will still require a user to process the migration manually via the [[Semi_Manual_Provisioning|'''Manual Provisioning''']] section of Cumulus. The future date is used by the Manual Provisioning page as a filter so users can see what service activation need to be done on a given date.

Some service types are configured to automatically process future-dated service activations and/or future-dated migrations. Check the help page for your service type if you are not sure. Service types configured to override the default behaviour will specifically note this information.

To find the page for a specific service type, use the search facility and enter the name of the service type.

=== Set the Agent ===
If an agent needs to be assigned to the order, select the agent from the commissions fields (requires [[Agent_Management|Agents]] and [[Commissions|Commissions]])

=== Submit the Migration ===
Once you have completed all fields, and you are satisfied all the infomration is correct, press '''Complete Migration'''. The migration order will be closed and will not be editable.

The system will create new package and service subscriptions for the new plan under the customer. This will be referred to as the ''destination'' subscription.

= Migration Business Rules =
Different rules apply to migrations depending on several factors.

== Manually Provisioned Services ==
If the migration is not future-dated:

* the source subscriptions will be '''Cancelled'''
* the destination subscriptions will be '''Active'''
* No further work needs to be done to finish the migration.

If the migration is future-dated:
* the source subscriptions will remain '''Active'''
* the destination subscription will be '''Preactive'''.
The destination subscription will be available to manually activate via the the [[Semi_Manual_Provisioning|'''Manual Provisioning''']] page.

== Automatically Provisioned Services ==
This only applies when a customer:

* moves away from a package that contained services they no longer want
* moves to a new package plan that contains additional services they do not have
* the service lost or gained is automatically provisioned.

=== Cancelling Services ===
# The source subscriptions will be initially placed into the status of '''PendingProvCancel'''.
# The provisioning sub-system (affectionately called 'Cyclone') initiates the relevant interactions with the carrier.
# The carrier system tells Emersion when the services are cancelled on the network
# The subscription statuses will be updated to '''Cancelled'''.

=== Additional Services ===
# The destination subscriptions will be initially placed into the status of ''PreActive'''.
# The provisioning sub-system initiates the relevant interactions with the carrier.
# The carrier system tells Emersion when the services are connected and active on the network.
# The subscription statuses will be updated to '''Active'''.

= Aborting a Migration =
Aborting of a migration is possible prior to it being finalised via Services > Manual Provisioning (for semi-manual service types) or where the migration date is in the future. To abort a migration:

Go to the source package subscription under the customer and click the '''Abort Migration'''

[[file: Pkg-sub-abort-migration.png|1200px|]]

Users will be asked to confirm the action. Once confirmed the system will:

* remove all preactive subscriptions that have been created
* revert the source subscriptions back to '''Active'''.

If a migration has completed automatically or been manually finalised, you cannot abort or reverse this action. You will be required to 
- migrate back to the original package plan (where the migration was performed in error) or 
- perform an additional migration to the correct plan (where the destination plan was incorrect). This may not be possible if package plans are not in correct contract pools. 

In the case that contract break fees and/or new plan setup fees have been charged, you may be required to manually delete or modify cardlines.

= Troubleshooting Migrations =
These articles address common issues found when attempting to perform a migration.

* [[Services/Orders/Troubleshooting_Orders/01|Why can't I migrate the customer's subscription?]]
* [[Services/Orders/Troubleshooting_Orders/02|Why can't I find the destination package plan I want to migrate the customer to?]]

= See Also =
* [[Account_Management/Customer_Screen/Package_Subscriptions/Contract| Customer contracts for package subscriptions]]
* [[Main Page/Provisioning/Service Type Migrate | Service Type Migrations]]
* [[Data_Import/Package_Migration|Got a bunch of migrations to do? We have a bulk update tool that may help.]]

Semi Manual Provisioning

2021-06-07T06:36:44Z

Dcowan:

== Emersion Semi Manual Provisioning ==

Semi Manual Provisioning is used for service types configured to be "provisioned" by either an upstream account (for example: a wholesale account) or by the same service provider account. This is useful in scenarios where services can be ordered in Cumulus ahead of time and then activated with a carrier at a later time. It can also be used in backdating scenarios whereby services are already active with a carrier.

NAV: '''Services > Manual Provisioning'''

Different service transfer types are supporter by the manual provisioning page as follows;
* [[Services/Orders|CHOWN / UPGRADE]] (Manage Provisioning --> Activate)
* NEW (Manage Provisioning --> Activate)
* CANCEL (Manage Provisioning --> Finalise Cancellation)
* MIGRATE (Manage Provisioning --> Finalise Migration)

'''Note''': For CHOWN & UPGRADE the manual provisioning ''Service Start Date'' date picker will not allow backdating a service to a date that falls within a '''closed''' source package subscription ''period''.
----

For service types that have been set up with the semi-manual provisioning type in Emersion, the semi-manual provisioning process is:

1. The Retail Service Provider ('RSP') creates an order for a new service for a customer in Cumulus. Alternatively if the RSP subscribes to the Customer Sign Up portal, the end user themselves may create & submit the order.

If the RSP orders a service from a Wholesaler who is an Emersion Wholesale Service Provider ('WSP'):
*a) Order is received by the Wholesale Service provider and appears in '''Services > Manual Provisioning'''.
*b) The WSP views the order, checks the details, and updates any details as required.
*c) The WSP performs manual provisioning actions with their service provider/supplier as required, outside of the Emersion system.
*d) Once order is complete, the WSP activates the service using the Emersion '''Manual Provisioning''' page.

If the RSP orders a service directly from the Service Supplier, Carrier or a Wholesale Service Provider who is not in Emersion:
*a) The order appears in '''Services > Manual Provisioning''' within the RSP account.
*b) The RSP views the order, checks the details, and updates any details as required.
*c) The RSP performs manual provisioning actions with their service provider/supplier as required, outside of the Emersion system.
*d) Once order is complete, the RSP activates the service using the Emersion '''Manual Provisioning''' page.

Once these steps are complete, the service will be activated and billing of the service to the Customer/End User (customer of the Retail Service Provider) will commence. The Customer/End User will see the service as Active if they log into Emersion via Cumulus or the End User Portal, which ever is appropriate for the customer.

If the provisioning request cannot be completed, Emersion now allows the Wholesaler to mark the order as '''Provisioning Halted'''. This will then update the order and service status so the Customer can see the details. The Customer may then re-submit the provisioning request, if appropriate.

== Marking an Order as Provisioning Halted ==

To mark a service as Provisioning Halted:
'''Navigate: Services > Manual Provisioning'''.
The Services where a provisioning action is required will be displayed. This page shows all orders submitted that require manual provisioning.

[[File:manual-provisioning-landing.png]]

Locate the order that is required to be halted and click the '''Manage Provisioning''' link in the list. The Manage Provisioning page will be displayed.

[[File:manual-provisioning-manage-provisioning.png]]

Click the Mark Provisioning as Halted button. The Mark Semi Manual Provisioning as Halted page will be displayed.

Enter the details of why the provisioning request could not be completed in the Rejection Details text box. This information will appear to the downstream customer (i.e. RSP).

Click the '''Save''' button. A message will appear at the top of the page confirming that the provisioning has been halted.

Services/Orders/Services/Cancel

2021-06-07T06:34:03Z

Dcowan: Replaced content with "This article is no longer relevant."

This article is no longer relevant.

Products/Purchases/Recurring Purchases

2021-05-06T23:51:47Z

Dcowan: added instalment outright purchase links

= Overview =
This article explains how to create a recurring purchase. Recurring purchases are designed to be a simple way to charge a customer a nominated fee at regular intervals for a period of time. Recurring purchased are a standalone feature with no integration with the rest of the Emersion system.

Before users can sell products, they need to be set up in the [[Products]] module and made available for sale.

= Create Recurring Purchase =

After [[Product/Purchases|starting the purchase process]], click on the ''Recurring Purchase'' tab. The following screen will be displayed.

[[File: Recurring-purchase.png|1200px|The Recurring Purchase screen]]

Under the ''Product Purchase'' section:
# Choose a '''product category''' from the list
# Choose a '''product''' from the list
# The '''price''' for the product will be populated automatically. This price will be used for the lifetime of the recurring product purchase.
# If the default ''product ledger code'' is not the one you want to use, choose the correct ledger code from the list.

Under the ''Purchase Configuration'' section:
# Select the first recurring purchase date. This is the date that the first recurring amount will be generated.
# Select an '''invoicing method'''.
## ''Create Invoice'' will
## ''Next Invoice'' will
# Select the recurring period length. This is the amount of time between a charge being generated by the system.

Under the ''Product Information'' section:
'''Serial/Product Instance Code''': If individual stock items for this product are being managed via the [[Products/Serialised_Products|product inventory]], and depending on the product's configuration, you may be required to do one of two things:
# select a product instance from the inventory
# Enter the serial number of the item.
If you are not using the inventory, leave this field blank.

Lastly, enter a '''purchase description''' for the cardline. When you are happy the information entered is correct, press the '''Submit''' button. A popup box will ask you to confirm or cancel the purchase.

=See Also=
* [[Products]]
* [[Products/Serialised_Products/Selling|Selling serialised products to customers]]
* [[Products/Purchases/Instalment_Plans|Installment Plans]]
* [[Products/Purchases/Outright_Purchase|Outright Purchases]]
* [[Account_Management/Customer_Screen/Purchase|See a customer's purchase history]]

Glossary

2021-03-18T05:19:59Z

Dcowan: added some words

==Glossary of Terms and Abbreviations==

=== A ===
;ABN
Australian Business Number.

;ACN
Australian Company Number.

;ACMA
the Australian Communications and Media Authority, a Commonwealth regulatory authority for telecommunications and radio communications established under the Australian Communications Authority Act 1997. The ACMA Controls Access Numbering, radio spectrum, enforces Carrier license conditions and service provider rules.

;ACCC
The Australian Competition and Consumer Commission, a Commonwealth regulatory body with responsibilities derived from the ''Trade Practices Act 1974''. The ACCC enforces the trade practises act (TPA) and its related codes.

;ACIF
The Australian Communications Industry Forum. ACIF is a member-funded organisation established to facilitate communications self-regulation in the interests of both industry and consumers. ACIF is responsible for developing standards, codes of practice and service specifications.

;ACIF Code
An industry code registered with the ACMA under the ''Telecommunications Act 1997. ''

;Acceptance Test
The set of tests conducted by the Customer as set out in Schedule 2 or any subsequent work order of the Customer Agreement.

;Access Number
An IP Address, PSTN, ISDN, Mobile or VOIP number, or the like, for providing access to a Network.

;Access Port
A physical connection at the network boundary that is to be connected to an Access Tail.

;Access Tail or Access Link
A transmission service for carrying communications by means of guided or unguided electromagnetic or optical energy, to deliver Voice Traffic or Data Bandwidth to a Customer Premises or Customer Equipment.

;Access Transmission Rate or Access Rate
In respect of an Access Port, the maximum data transfer capacity (measured in kilobits per second) that the Access Port has been configured.

;Account
A billing account held with a party which is identifiable by an Account Number.

;Account Number
Means the numbers in the system, or other parties billing system, against which Charges for Products or Services, products or services are charged.

;Account Type
The category of an account, either an individual or organisation.

;Account Profile
A grouping of accounts for reporting purposes, as well as for invoice template setup and event mapping.

;Account Period
The frequency that the account is invoiced e.g. monthly, quarterly etc.

;ADSL
Asymmetrical Digital Subscriber Line, a technology for the transmission of digital information at high bandwidths on twisted metallic pairs.

;AEST
Australian Eastern Standard Time.

;API
An Application Programming Interface to Emersion’s or other parties’ software Systems.

=== B ===
;B2B
Business to Business.

;B-End or B-Party'
The Customer specified second or other site, or terminating party to a transaction such as a telephone call.

;Bandwidth
The Access Transmission Rate relative to the size of the Access Tail and / or the Access Port.

;Bar
Blocking the supply of one or more services (e.g. on a phone line) so that the End user is unable to acquire the blocked service(s), Barring has a corresponding meaning.

;Bill Issue Date
The date that any bill or invoice shall be issued to the Account.

;Billing Day
The date set for each Customer at which the Billing Period Starts.

;Billing Dispute
A dispute relating to a charge or an invoice issued.

;Billing Period
The period from the Billing Day to the next Billing Day as defined in months by for each Account.

;Bill Run
A group of the Account invoices processed on the same day.

;Bit
The smallest unit of information, which is a computational quantity that can take on one of two values, 0 and 1.

;BMS
Batch Management System, part of the Emersion Architecture.

;BPAY
The Australian banking industry's network of electronic payment services.

;Broadband
an always-on Broadband Service over Unconditioned Local Loop (ULL) aggregating data to/from customers to a state or national point-of-interconnect.

;Broadband Churn
A Churn Order to transfer a Broadband Service from one service provider to another.

;Business Day
Any day from Monday to Friday (inclusive) other than a day which is gazetted or otherwise declared or made a Public Holiday.

;Business Hours
09:00 to 17:00 Australian Eastern Standard Time (GMT +10 hours) or Australian Eastern Daylight Saving Time (GMT +11 hours) when in effect, in Melbourne, Victoria, Australian on Business Days.

;Byte
A sequence of 8 Bits (enough to represent one character of alphanumeric data) processed as a single unit of information.

=== C ===
;CA
Customer Authorisation.

;Calendar
The Gregorian calendar.

;Calendar Day
The period of time commencing at midnight and ending 24 hours later.

;Calendar Month
One of the twelve (12) divisions of the Calendar Year.

;Calendar Year
The year (reckoned from January 1 to December 31) according to Gregorian calendar.

;Call
A communication carried by a Network or a system and where the context permits, includes an attempt to establish communication.

;Call Details Record
a data record that contains information related to a telephone call, such as the origination and destination addresses of the call, the time the call started and ended, the duration of the call, the time of day the call was made and any toll charges that were added through the network or charges for operator services, among other details of the call.

;Caller
The person originating a call using a telecommunications service.

;Cancel Order
An order created to terminate an existing service.

;Calling Line Identity
The data generated by a network which relates to the telecommunications Service of the originating call. Also known as Calling Line Identification.

;Calling Number Display
The option available to a customer regarding whether they would like their number to be shown or kept hidden from the party they are calling. Also known as Caller ID.

;Cardline
An item within the system used to record any financial action, such as charges, payments, credits, fees etc. that appears on a customer’s invoice.

;Carriage Service
A carriage service as defined in section 7 of the Telecommunications Act.

;Carriage Service Provider (CSP)
A carriage service provider as defined in section 87 in the Telecommunications Act.

;Carrier
A carrier as defined in section 7 of the Australian Telecommunications Act. A Carrier is the holder of a telecommunications carrier licence in force under the Telecommunications Act.

;CDR
Call Details Record.

;Change Order
The option available to change an existing order.

;Churn
The transfer (authorised or unauthorised) of a service from one Service Provider to another.

;Churn CA
A Local Call Churn CA and/or a Broadband CA.

;Churn Order
An order created where the customer wishes to transfer a Local Service and/or Broadband.

;CLI
Calling Line Identity or Calling Line Identification.

;Clear Business Day
A period of time commencing at 09.00 on the next Business Day.

;CND
Calling Number Display.

;CND Code
ACIF Code C5222:'' Calling Number Display'' as registered by the ACMA.

;Cooling Off Period
Any period available by law to a customer to rescind or otherwise avoid any agreement under which that customer agrees to acquire the Service.

;Contract
A contract entered into by the party with another.

;Credit
A refund to Account for a billing error or omission.

;Credit Limit
The maximum amount the Account may be outstanding.

;Critical Information Summary (CIS)
All telcos that sell products, plans and services must provide a Critical Information Summary (CIS). ACMA [https://www.acma.gov.au/critical-information-summaries requirement].

;CSG
Customer Service Guarantee.

;Customer
Any party that acquires or purchases from another party products or services (or part thereof) and uses those services with or without The Client Authorisation. E.g. The Client is a Customer of Emersion and an End User would be a Customer of the Client, the Customer may or may not be an End User.

;Customer Authorisation
An authorisation by the customer, or their authorised agent, containing the minimum mandatory required information as required by the relevant ACIF code.

;Customer Service Guarantee
The ''Telecommunications (Customer Service Guarantee) Standard 2000 (No. 2) ''which is legislation aimed at encouraging improvements in Service and to guard against poor Service by requiring phone companies to meet minim standards for Service connection, fault rectification and appointment keeping in relation to the supply of Standard Telephone Services.

=== D ===
;Data
Numbers, characters, images, or other method of recording, in a form which can be assessed by a human or (especially) input into a computer, stored and processed there, or transmitted on some digital channel. Computers nearly always represent data in binary.

;Directory Listing
A listing in a telephone directory including, but not limited to, the White Pages.

;Directory Preference means the preference stated by the customer with respect to whether they want a Directory Listing or an Unlisted Number.

;Dispute
Any dispute or claim raised against an invoice for charges believed to be in error.

;DSL
Digital Subscriber Line. See also ADSL.

;DSL Tail
A DSL Access Tail

;Dynamic IP Address
An IP Address that is not guaranteed to remain allocated to the same End User or Access Tail, and may therefore change at any time.

;DSLAM
Digital Subscriber Line Access Multiplexer, a mechanism at a phone company's central location that links many customer DSL connections to a single high-speed line.

=== E ===
;EFT
Electronic Funds Transfer.

;Email
Electronic Mail, the system for sending and receiving messages electronically over a computer network or the Internet.

;EPS
A system module, the Electronic Payment System, which integrates to the system to enable automated collection of payment from the customers.

;Emersion
The system described in this user manual, which is the system used to provision and bill individual services for customers.

;End customer / Customer
The person whose name is on the account and has authorised the provision of the Service through a Customer Authorisation.

;End User Portal (EUP)
The End User Portal is the user interface used by your end customer that allows you to offer your customers a branded web-based account management and self-care tool where your customers can securely login from your website to view & edit their account information, view invoices & service usage and make payments to you.

;Event
A set of pre-defined triggers that automatically initiate system actions when the particular condition is detected, such as send an email when an invoice is overdue etc.

=== F ===
;FNN
Service Number or Full National Number - a fully qualified (10-digits in Australia including the Area Code or other calling prefix) the telephone number which is an alphanumeric number that uniquely identifies a Service Number.

;FTP
File Transfer Protocol.

=== G ===
;Gaining Service Provider (GSP)
The Service Provider that receives the customer’s service as a result of a port or churn.

;Gigabyte (GB)
A unit of data where 1 GB = 1024 megabytes (MB).

;GST and GST Law
As defined in ''A New Tax System (Goods and Services Tax) Act 1999 ''(Cth), subject to any amendment to that definition made pursuant to applicable rulings, determinations or advice issued by the Commissioner of Taxation or a decision from any tribunal or court.

;GNAF
G-NAF is a database of all the physical addresses in Australia. See https://www.psma.com.au/products/g-naf 
Because there is no single organisation that is responsible for assigning and collating addresses in Australia, G-NAF is built from addresses supplied by ten contributors including the land agencies in each state and territory of Australia. 
As each contributor collects and stores addresses differently, the G-NAF production process involves independently examining and validating every candidate address, then textual and spatial matching. 
Addresses from different sources found to be identical are merged into a single G-NAF record with feature level metadata capturing its linage and quality.
Through this process over 30 million contributed addresses are distilled into over 13.5 million G-NAF addresses.

=== H ===
=== I ===
;Installation Charge
A once-off charge for labour, equipment, Number connection and associated cabling to cover the expense for initial installation of the Products or Services.

;Integrated Public Number Database
The database contemplated in schedule 2, Part 4 of the Act that contains specified customer information for all public numbers as defined in the IPND Code.

;IPND
Integrated Public Number Database.

;IPND Code
ACIF Code C555:2002 ''Integrated Public Number Database (IPND) Data Provider, Data user and IPND Manager'' as registered by the ACMA as amended from time to time.

;Internet
The interconnected system of networks that connects computers around the world via the TCP/IP protocol.

;Internet Access or Internet Traffic
Access to Internet Content via a TCP/IP connection.

;Invoice
The bill sent to customers for products and services received

;Invoice Template
The logo, colours, billing information, and company information that appear on your invoices.

;IP Address(es)
Internet Protocol Address(es), the Internet addressing standard which describes the address of all devices physically located within the global Internet.

;ISDN
Integrated Services Digital Network means a digital transmission technique for both voice and data.

=== J ===
=== K ===
=== L ===
;LD
Long Distance.

;LD Carrier
Long Distance Carrier.

;LD Churn
A change in LD Pre-selection.

;LD Reseller
Non-carrier providers of Pre-selection services, using equipment owned by existing carriers.

;Ledger
The principal book or computer file for recording and totalling monetary transactions by account, with debits and credits etc.

;Ledger Code
An accounting code used to record transactions depending on financial accounts involved in different transaction type, assigned to account groups such as receivables and payables etc.

;Line Blocking Status
The status of a particular telecommunications Service in relation to whether it has in place a Permanent Line Block or enabled CND.

;Listed Number
A telecommunications Service Number which is listed in a public number directory.

;LNP
Local Number Portability.

;LNP Code
ACIF C540:2006.

;Local Number
Portability Code as registered by the ACMA.

;Local Call/Broadband
Local Call and/or Broadband Services.

;Local Call/Broadband Churn Reversal
The reinstatement of a customer’s Service to a Losing service Provider following an Unauthorised Local Call/Broadband Churn.

;Local Call Churn
The transfer of a Local Service (including service number) between service providers.

;Local Call/Broadband Churn
Local Call Churn and/or Broadband Churn.

;Local Number Portability (LNP)
The Porting of a Service Number associated with the provision of a Local Service between different Carrier networks.

;Local Service
The same meaning as given in the ''Telecommunications Numbering Plan 1997''.

;Local Time
The time in the state or territory in which the Customer Premises are located.

;Long Distance
Long Distance Pre-selection.

;Long Distance Carrier
a Carrier that provides carriage of Pre-selectable Calls originating from a Local Service.

;Long Distance Pre-selection
The ability of a customer to automatically have their lines switched to the LD Provider of their choice for Pre-selectable calls.

;Long Distance Provider
An SP that resells LD.

;Losing Service Provider or'' ''LSP
The Service Provider that loses the customer’s service as a result of a port or churn.

=== M ===
;MBps
Megabits per second - a unit of data where 1 Mbps = 1,048,576 Bits per second.

;Mbyte or MB
Means a unit of data where 1 Mb = 1, 048,576 bytes.

;MDF
Main Distributor Frame. This is where the incoming telephone lines from the street terminate within a building. Depending on the size of the building the MDF could be a small plastic box on the wall or a large room.

;MDU
Multiple Dwelling Unit e.g. apartment building of more than 3 floors, or block of units greater than 10 units.

;Miscellaneous Charge
Any charge other than the core charges for a Products or Services, usually for moves, additions or changes to a Service.

=== N ===
;NBP
The Network Boundary Point.

;Network Boundary Point
The customer’s first and main socket for houses, or the Main Distributor Frame for a Multi Dwelling Unit (MDU).

;New Service Order
A request, made by the SP, to provision service to a customer address.

=== O ===
;Order
One of the following:

a) New Service Order.

b) Churn Order.

;Order Number
The reference number supplied to the SP following the submission of an order. Also referred to as Reference Number.

;Order Process
The process by which you can request a Telstra service to a customer location.

;Order Reference Number
The reference number supplied following the submission of an order. Also Referred to as Order Number.

=== P ===
;Package Plan
A collection of one or more Service Plans grouped together and sold as a Package.

;Pending Order
An order which has been submitted but not yet completed.

;Period
The increment of time specified by Emersion during which Charges will accrue and the subsequent frequency of the Client Invoice (generally a Calendar Month).

;Ping
A protocol that sends a message to another computer and waits for acknowledgement, often used to check if another computer on a network is reachable.

;POTS
Plain Old Telephony Service.

;Point to Point Protocol
Protocol that allows the transport of packets between the customer and the Retail Carrier. The Retail carrier can authenticate the user with PAP or CHAP authentication.

;Pre-selectable Call
The same meaning as given in ACIF C515:2003 Pre-selection'' ''Industry Code and includes calls from a local Service to:

# A geographic number or local number that is not a local call;
# An international direct dial service;
# Operator service for which the ''Telecommunication Number Plan 1997 ''specifies the use of a shared selectable number;
# A carriage service that is both a ring back price service and an international service;
# A public mobile telephone service.

;Pre-selection
The selection of a carrier for Pre-selectable Calls and includes service made available by you to a customer for a Local Service which will:

# permit designation by the customer of a LD Provider for that Local Service;
# allow billing for Pre-selectable Calls by the Long Distance Provider;
# allow billing for calls made using and Access Override Code to LD Providers;
# allow the customer to change from time to time designation of their LD Provider for that Local Service.

;Pre-selection Code
ACIF Code C522: ''Pre-selection ''as registered by the ACMA.

;Products
The products sold to a customer, such as physical items like hardware, or other billable items.

;PSTN
The Public Switched Telecommunications Network'' ''- A public telecommunications network for which a carrier is responsible and which provides services to the public.

;Public Holiday
Any day on which transfer activity is not available. Public Holidays will be issues via the service review on an annual basis.

=== Q ===
=== R ===
;Rate
Defines, for a given call type, what and how the system should charge for this usage.

;Rate Card
A group of rates'' and'' charging metrics to be applied to the usage data.

;RC
Retail Carrier.

;Recurring Charge
Any Charge that occurs regularly per Period.

;Relocation Order
An order created to initiate the relocation of a customer Service to a new customer address.

;Remote Authentication Dial-In User Service (RADIUS)
A client/server protocol and software that enables remote access servers to communicate with a central server to authenticate users and authorise (authenticate) their access (by verifying user names and passwords) to the requested system or service.

;Retail Carrier
The same meaning as a "Service Provider" as defined in section 86 of the Telecommunications Act 1997.

=== S ===
;Services
The services provided to the customer, which may include land line telephony, mobile phone, pre-selection, data access etc.

;Service Bolt On
A method of providing bonus features on a particular service, such as a certain amount of free usage.

;Service Number
An identifier for a service, such as land line or mobile phone number''. ''

;Service Plan
A billing object that is used to control billing for a single service.

;Service Provider
The party that is a customer of a wholesaler or aggregator (such as Telstra) that sells products and services to end customers directly or through the use of sales agents i.e. re-seller of telephony and/or broadband services.

;Service Qualification
The determination of whether means the act of checking whether a service is able to be provided.

;Setup Fees
The relevant charges or fees to install or activate a service.

;Simple Telephone Service
A local service which comprises a:

:(a) Standard Telephone Service; and

:(b) Service number

::where a one-to-one relationship exists between the service number and the relevant access line to the Standard Telephone Service.

;SIR’s
Service Information Records

;SLA
Service Level Agreement.

;SP
A Service Provider.

;Standard Telephone Service
The same meaning given by section 6 of the ''Telecommunications (Consumer Protection and Service Standards) Act 1999. ''

;Standard Time

:(a) Eastern Standard Time (GMT +10 hours); or

:(b) Eastern Daylight Saving Time (GMT + 11 hours) when in effect in Victoria.

;Static IP Address
an IP Address that has a fixed value for the term of the individual services session of the connection.

;SQ
Service Qualification.

;Supplier
Any provider of products or services to a party. Emersion is, for the purposes of this Agreement, the Supplier of Products or Services to The Client.

=== T ===
;Telecommunications Act
The Australian Telecommunications Act 1997 (Cth).

;Telecommunications (CPSS) Act
The Australian Telecommunications (Consumer Protection and Service Standards) Act 1999.

; Telecommunications Consumer Protection (TCP) Code
The Telecommunications Consumer Protections Code (TCP Code) contains rules for providers. The code protects customers who use mobile phone, landline and internet services, including NBN. ACMA [https://www.acma.gov.au/telecommunications-consumer-protection-code requirement].

;Telstra
Telstra Corporation Limited.

;TIO
The Telecommunications Industry Ombudsman - An industry-funded independent dispute resolution service for consumers who are unable to resolve individual complaints with their telecommunications carriers and carriage service providers. The TIO manages complaints from consumers (residential and small business about telecommunications services).

;TPA
The Australian Trade Practices Act 1974 (Cth).

;Trading Terms
The terms of trade (with respect to the financial relationship) between the Client and Emersion. These may include the time to pay, Credit Limit, Security required and any other special clauses, as detailed in the MSA - Trading Terms Schedule.

=== U ===
;ULL
Unconditioned Local Loop, a pair of wires (normally copper) from the Exchange to the End User Premises. A ULL is used to deliver voice services and potentially DSL or other data services to the end customer.

;ULLS
Unconditioned Local Loop Service.

;ULLS Code
ACIF C569: 2005 ''Unconditioned Local Loop Service Ordering, Provisioning, and Customer Transfer ''as registered by the ACMA.

;Unauthorised Broadband Churn
A Broadband Churn Order that has been submitted without a valid CA:

:(a) Which resulted from a processing error;

:(b) A CA is determined to be unauthorised

;Unauthorised Local Call Churn
A Local Call Churn Order that has been submitted without a valid CA:

(a) Which resulted from a processing error;

(b) Where a CA is determined to be unauthorised.

;Unauthorised Local Call/Broadband Churn
Unauthorised Local Call Churn and/or Unauthorised Broadband Churn.

;Unauthorised LD Churn
An LD Churn that has been submitted without a valid CA as described in this manual:

(a) Which resulted from a processing error;

(b) Where a CA is determined to be unauthorised.

;Unauthorised Port
A Port Order that has been submitted without a valid CA:

(a) Which resulted from a processing error;

(b) Where a CA is determined to be unauthorised.

;Unauthorised ULL Churn
the acquisition of a new copper pair in association with a Port, Relocation or New Service Order where the order has been submitted without a valid ULL CA:

:(a) Which resulted from a processing error;

:(b) Where a CA is determined to be unauthorised.

;Unlisted Number
A Service Number that the customer has requested not be listed in public telephone directory (including, but not limited to, the White Pages).

;Unwelcome Call
The use of a Standard Telephone Service in a menacing, offensive or harassing manner, but which is not currently a Life Threatening Call, and which may be intentional on the part of the caller or unintentional.

;USB
Universal Serial Bus, a widely used hardware interface for attaching peripheral devices.

;User
A natural person or System that uses the Systems or Services.

;User ID
A unique, personal, identifier of a User or System, on that System.

;User Interface (UI)
A system interface that provides access to the services and is interacted with by a natural person.

;Username
A User ID for a natural person.

=== V ===
;Voice Traffic
The load on a telecommunications device or System. Traffic is generally the movement of voice Packets or streams carrying communications by means of guided or unguided electromagnetic or optical energy.

;VoIP
Voice over Internet Protocol.

=== W ===
;Wholesale Account Number
The account number between the Losing carrier and another service provider who is rebilling the customer.

;WLMS
White Label Managed Service, a totally rebranded Cumulus interface.

=== X ===
;xDSL
A general term for digital subscriber line (DSL) technologies. Different versions of a family of DSL technologies, such as ADSL, HDSL, SDSL, VDSL and similar solutions that provide a high bandwidth digital connection over communications cable.

=== Y ===
=== Z ===

Admin/Security Types

2020-11-10T22:40:51Z

Dcowan: added default price instructions

{{DISPLAYTITLE:Security Types}}
=Overview=
The Security Types page is where service providers can configure security products to accept a security deposit (or payment) from a customer.

The configuration of securities involves 2 steps:

# Build a Security Product
# Create a Security Type

Once these steps are complete an [[Securities|Account Security]] can be applied to a customer.

==Build a Security Product==
If you have not built a product before, please see our [[Products/Create_Product|Create a Product]] guide in the [[Products]] section. Users who are familiar with creating products can skip that guide. To create a Security product, users must:

* set the [[Products/Categories|product category]] to ''Security''.
* set the product type to ''Billable Item''.

This is a prerequisite for creating Security Types.

== Create a Security Type ==
To create a security type, log in to Emersion and navigate to the following path:

'''Nav: Admin > Security Types'''

[[File: Security_types_main.png|1200px|Security Types Main Page]]

From this page, users can create a single security type per security product. To add a new security type:

# Click the '''Add New Security Type''' button. The ''Add New Security Types'' page will be displayed
# Select your Security product from the list. Only products in the Security product category marked as ''Billable Items''' will be shown in the list if there is no security type for the product already.
# Enter the default deposit amount. Tick the box if the amount includes tax.
# Enter an optional description.
# When you are finished, press '''Save'''.

== Creating A Default Security Product Price ==
It is also a mandatory requirement that you create a default price for your new security product - otherwise, it will not be accessible and you will not be able to take a security deposit. 
See [[Products/Pricing/Price_Books]] for more information on default price books and [[Products/Pricing/Price_Points]] for instructions on how to add price points to a price book.

== Editing a Security Type ==
If you need to alter the security type settings, click the '''Edit''' link to the right of the security type you want to edit. Edit the fields as needed and press '''Save''' when you are finished to save the changes.

== Deleting a Security Type ==
It is not possible to remove a security type once it's created. To avoid an unwanted security type being used to take a deposit from a customer, Emersion recommends changing the name of the security product to '''Do Not Use''' and add a price of $10,000 to ensure it visually stands out.

= See Also =
* [[Products/Create_Product | Create a Product]]
* [[Securities|Account Securities]]

API/Services/TokeniseCreditCard

2020-06-18T01:18:43Z

Dcowan: added notes about additional accoutn feature - SR-13408

'''Purpose '''

This allow customer to store credit card in to EPS and generate token for a secure way of making / requesting payment.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:TokeniseCreditCardRequest>
<ser:TokeniseCreditCard account_id="511596" card_type="Visa" card_name="Customer Name" card_number="4444333322221111" card_expiry="6/2015" card_cvv="123" automated_payment_configuration="1" />
</ser:TokeniseCreditCardRequest>
</soapenv:Body>

'''Description'''

Required attribute:
* automated_payment_configuration = Type positive integer option:
** 1 = One off payment (Default).
** 2 = One off payment and set as default payment.
** 3 = Set as default payment and enable recurring charges.
* account_id = Type positive integer
* Card_type = Type Option
** Visa
** MasterCard
** American Express
** Diners
* card_name = Type string at least 1 character
* card_number = Type string must be a valid card credit card number based on the card_type
* card_expiry = Type date format mm/YYYY
* card_cvv = Type non negative integer

'''Output'''
<SOAP-ENV:Body>
<ns1:TokeniseCreditCardResponse>
<ns1:CreditCardTokenResponse>
305889725747721480112620601729009174294547589547C
</ns1:CreditCardTokenResponse>
</ns1:TokeniseCreditCardResponse>
</SOAP-ENV:Body>

'''Error String'''

148.Payment gateway has not been initialised

149.Required TokeniseCreditCard' element

150.Invalid account ID ['.$requestDetails->account_id.'].

151.Account provided is not currently active.

152.Required credit card type

153.Required credit card number

154.Required credit card holder name

155.Required credit card expiry date

156.Credit Card provided expired.

157.Invalid credit card expiry date

158.Required credit card security number / cvv

159.Credit card type ['.$requestDetails->card_type.'] is currently not supported. Please try another card.

160.Invalid Credit Card Details.

161.Unable to process credit card. '.$request->getError());

* Please note: This API call requires access to an additional Account Feature (''Integration Payment''). Please contact [https://resources.emersion.com/display/EKB/Getting+Support+and+Help+from+Emersion | Emersion Support] if you are receiving the following message;
Tokenise Credit Card feature is currently not enable for this account. Please contact support for more details.

PackagePlans/PackagePlans

2020-02-21T01:26:08Z

Dcowan:

= Overview =
A package plan is one of several billing objects used in Emersion.

This article covers how to create a package plan.

If you would like to understand what the package plan is and how it works with other Emersion billing objects, see our [https://resources.emersion.com/display/EKB/The+Emersion+Billing+Objects Introduction to Emersion's Billing Objects article].
== Prerequisites ==
You can create a package plan on its own as an independent object. But it cannot be subscribed to by a customer until the following prerequisites are met:

* The service plan(s) are linked to the package plan.
* The service Plan(s) are in a ''saleable'' state.
* The plan has a product rate card linked that is in a saleable state
* Rate cards have at least 1 rate and are in a saleable state (for telephony plans only)
* The Data Billing tab has been configured (for data plans)
* Package Plans and service plans (both BUY and SELL) are all linked together.

This article's scope is limited to creating the package plan. Other articles cover the other steps above. See the links at the bottom of this page for assistance in these tasks.

= Package Plan Searching =
Package Plans are created and maintained in Cumulus via the following path

Nav: '''Packages and Plans > Management > Package Plans'''

When the page loads, the following screen will appear listing all package plans that have been created.

[[File:Package-plan-list.png|1200px|The Package Plan List Screen]]

= Create a Package plan =
To create a new Package Plan, click the '''Create New''' button. The following page will be displayed.

[[File:Package-plan-create-new.png|1200px|The ''Create a New Package Plan'']]

There are 3 columns of settings. Complete all fields as required.

; Name : The internal name for the Package. This name is only visible in Cumulus.

; External Name : This is the External Name for the Package. This is what is printed on customer's invoices if ledger cardlines (eg Package Plan Access Fees), related to this Package, are created.

; Description : An optional description for the Package. Internal use only

; Reference Name : A way of providing a link to an External 3rd party. This could be represented as the name of a prior billing system if one existed. The field is entirely optional.

; Reference Key : A way of providing a link to an External 3rd party. This may be the name of this plan, as it existed in the old system if this were the case. This field is entirely optional.

; Buy or Sell : Indicates whether this is a Buy Plan or a Sell Plan. Please see the [[#Buy_and_Sell_Plans | Buy and Sell Plans]] section above for further information.

; Default Contract Type : Defines the default Contract that will be created when this Package is sold to downstream Customers. For a Contract to appear here, this Package must be part of a Contract Pool. Due to this, when initially creating a Package Plan, only the default Option, 'None' will be available. For more information on contract types & their configuration, please click [[PackagePlans/Contract|here]].

; Customer Contract Required : Indicates whether a mandatory physical customer contract document must be uploaded during the Order Confirmation & Finalise page. If this is enabled, you MUST upload a physical customer contract. If disabled, it is not mandatory to upload a physical customer contract. Not to be confused with 'Default Contract Type' above which refers to the contract instance that is created when an order is completed.

== Package Plan Fee Setup ==

; Setup Fee : The fee charged when a Subscription of this Package is created.
; Access Fee : A Rental or Service fee generated each period for the life of the Package Subscription.

Please be aware of both the '''Override''' tick boxes and also the note: ''Where a package access fee is not empty, it will override any service plan access fees that are defined''. It's possible to define a Setup Fee and an Access Fee at both the Package Plan and Service Plan level. If either the Access Fee or Setup Fee (or both) are empty, with the Override button unchecked, the system will create the Access Fees based on the attached Service Plans.

If the override button is ticked but no value is entered, please note that $0 will be saved (so effectively, you are creating a $0 plan).

; Period Length : The Period length defines how far in advance (or arrears) the system will generate access fees. It also defines how frequently the access fees are created.

; Periods in Advance : determines how many PERIODS in advance the system should generate Access Fees. By default, it's set to 1. In other words, generate the access fee for a period when that period starts. In a real world example, if you have a Package that bills monthly and the date is 01/03/2011, it will generate access fees for 01/03/2011 to 31/03/2011 on 01/03/2011.If you set that value to 2 on a plan whose period length is 1 month, it would generate access fees for the period 01/04/2011 to 30/04/2011 on 01/03/2011. This works irrespective of the period length, so if you have 6 or 12 months periods on a Package with a 'Periods in Advance' setting of anything higher than 1, your customers will receive Package Access Fees well in advance of the current Period.

; Enable package subscription access fee overrides : Checking this flag enables subscribers to the plan to be given a different package plan access fee than the default access fee. This fee override is applied at the package subscription for the customer. A default package plan access fee must be set for any override to be applied. This flag cannot override service plan fees.

; Honour First Period End Date if Set : This setting permits a user (who is granted the relevant power) to set the end date of the first package subscription period when the package is activated during the [[Semi_Manual_Provisioning | Semi manual provisioning]] phase. This is designed for service providers who wish to control both the start date of the service (service activation date) and control when the first period will lapse separately. It requires a subscription to the feature '''Set first period end date'''. If you would like to enquire regarding this feature, please raise a sales ticket in the [https://resources.emersion.com/display/EKB/Getting+Support+and+Help+from+Emersion Emerson Support Portal].

; Bill Access Fees in : Specifies if you are billing access fees in arrears or in advance. This applies to package plan access fees, service plan access fees, service feature product charges & bolt on access fees. If '''advance''' is used, access fees will generate automatically at the start of the associated subscription period. If '''arrears''' is used, access fees will generate and the end of the associated subscription period (and only once the period is approved - either automatically or [https://resources.emersion.com/display/EKB/Period+Approval manually])

; Bill Months in Advance: Specifies how many months prior to the start of the next period you generate a cardline. The total periods billed is determine by the '''Periods in Advance''' setting.

To clarify the difference between Periods in Advance and Bill Months in Advance, it can be thought of in the following way
* Periods in Advance refers to how many periods you are going to bill when the cardline is generated.
* Bill Months in Advance is when you are going to bill.
In other words, Periods in Advance refers to the volume of periods you are going to bill, and Bill Months in Advance refers to how far in advance, or "when", you are going to bill these periods.

For example, imagine you have:

<li> A monthly account invoice period </li>
<li> Periods Length is 3 months. </li>
<li> Periods in Advance is set to 2.</li>
<li> Bill Access Fees is set to: Advance </li>
<li> Bill in Advance is: 2 months. </li>

In this example, today is the 1st of April, and the subscription is to start on the 1st of May.
In this case what will happen is that because you are billing access fees 2 months in advance, the cardline will be generated today, on the 1st of April, not on the 1st of May.
In addition, because you are billing 2 periods in advance, both periods 3 months in length each, the cardlines generated will cover the next *six* months in advance.

; Pro Rata : Determines whether or not the first set of Access Fees generated for this plan will be pro-rated. The 'Pro Rata' setting will also determine whether Period adjustment credits will be produced in the event that the period is adjusted for any reason. Period adjustment will generally be due to a package cancellation effective as of mid period. This setting is ignored for periods that have been billed in advance; they will be credited back regardless.

; Align Pkg Period to Invoice Period : This flag will align any newly created package subscriptions to this package plan to the underlying account invoice period of the given customer. This will ensure all access fees and usage fees are aligned to when an invoice is rendered. It is important to note that overriding this setting at this point may conflict with the account level setting [[Account/AccountCreation#Wizard_Screen_1:_Data_Definition | Align Pkgs to Account]], producing undesirable billing results. You must be certain you wish to over ride this setting when creating a new package plan.
For example, a package bundle comprising month-to-month billing for an ADSL service and web hosting. These services will align to the underlying account invoice period nicely, as they are billed monthly. However if the package plan also contains a Domain Registration service (for 1 year, 2 years, or 3 years), it is not desirable for this to be aligned to the customer's account invoice period.

; Disable Migrations during Period : This flag will stop users carrying out migrations on package subscriptions associated with the package plan, within a package subscription period. Users will only be permitted to migrate at the end of the period. This setting is useful for service providers who do not want pro rata charges generated as a result of a migration.

; Created date : The date the service plan was initially created.

; Created by : Displays the user who created the plan.

; Date modified : Displays the date when the last modification was made to the service plan.

; Modified by : Displays the name of the user who last updated the service plan's.

; Saleable from : The date from which the plan is or was available to order.

; Saleable to : After this date passes, a plan is unavailable to the orders screens.

; Approval status : Status of the plan.
* Draft - Initial state for when the plan is being set up.
* Pending - The plan has been set up but needs review and is not ready for sale.
* Approved - The plan has been approved and is ready for sale.
* Saleable - the plan is able to be sold
* Grandfathered - the plan is no longer used. There maybe customers with active subscriptions on this plan, but it cannot be sold.

; Saleable in Signup Portal : Enable to allow this package plan to be visible in the [https://resources.emersion.com/display/EKB/The+Sign+Up+Portal End User Signup Portal].

= See Also =
* [[PackagePlans/LinkingPackageAndServicePlans|Linking Package Plans and Service Plans]]
* [[PackagePlan/Advanced | Package Plans - Advanced features and functions]]

InvoiceReSend

2020-02-14T05:34:16Z

Dcowan:

==Re-Send Invoices==

Approved Invoices may be re-sent to the customer for whatever reason e.g. customer misplaces their original invoice etc. Invoices can be re-sent individually, or in bulk to re-send many invoices at once. Once initiated, the system will automatically re-send the invoices to the customers via the invoice delivery method set up in the customers' account.

===To Re-Send an Invoice===

# Display the required Approved invoice. The ''Manage Invoice'' page will display showing the options available for approved invoices.
# Click the '''Resend / Repost''' button.
# Alternately, you can click to ReSend/Re-Post button (icon) from the Customer > Invoice list
# A message at the top of the screen stating that the invoice has been queued for re-delivery.

===To Bulk Re-Send Multiple Invoices===

# Select '''Finance''' > '''Accounts Receivable '''>''' Invoice List '''from the '''Menu.''' The ''Invoice List'' page will appear.
# Filter the invoices shown by selecting ''Approved'' in the ''Approval Status'' drop list and clicking the '''Search''' button. The ''Invoice List'' page will update to show only approved invoices, and show the ''Bulk Actions'' below the list.
# Tick the check box beside each invoice you wish to re-send. Multiple invoices can be selected.
# Click the '''Re-Send Selected '''button. A message will display prompting you to confirm you wish to re-send all the selected invoices.
# Click the '''Yes''' button to confirm the bulk invoice re-send. The ''Invoice List'' page will re-display showing a message at the top of the screen stating that the Bulk re-send has been initiated.
# Click the '''No''' button to cancel the bulk invoice re-send.

===See also ===
* [[InvoiceManageInvoice|Manage Invoices]]
* [[InvoiceCardlineManagement|Invoice Cardline Management]]
* [[InvoiceBulkApprove|Bulk Approve]]
* [[InvoiceBulkReject|Bulk Reject]]
* [[InvoiceReRender|Re-render Invoices]]
* [[InvoiceReRate|Re-rate Invoices]]

InvoiceReSend

2020-02-14T05:29:59Z

Dcowan:

==Re-Send Invoices==

Approved Invoices may be re-sent to the customer for whatever reason e.g. customer misplaces their original invoice etc. Invoices can be re-sent individually, or in bulk to re-send many invoices at once. Once initiated, the system will automatically re-send the invoices to the customers via the invoice delivery method set up in the customer accounts’ records.

===To Re-Send an Invoice===

# Display the required Approved invoice. The ''Manage Invoice'' page will display showing the options available for approved invoices.
# Click the '''Repost''' button.
# Alternately, you can click to ReSend/Re-Post button (icon) from the Customer > Invoice list
# A message at the top of the screen stating that the invoice has been queued for re-delivery.

===To Bulk Re-Send Multiple Invoices===

# Select '''Finance''' > '''Accounts Receivable '''>''' Invoice List '''from the '''Menu.''' The ''Invoice List'' page will appear.
# Filter the invoices shown by selecting ''Approved'' in the ''Approval Status'' drop list and clicking the '''Search''' button. The ''Invoice List'' page will update to show only approved invoices, and show the ''Bulk Actions'' below the list.
# Tick the check box beside each invoice you wish to re-send. Multiple invoices can be selected.
# Click the '''Re-Send Selected '''button. A message will display prompting you to confirm you wish to re-send all the selected invoices.
# Click the '''Yes''' button to confirm the bulk invoice re-send. The ''Invoice List'' page will re-display showing a message at the top of the screen stating that the Bulk re-send has been initiated.
# Click the '''No''' button to cancel the bulk invoice re-send.

===See also ===
* [[InvoiceManageInvoice|Manage Invoices]]
* [[InvoiceCardlineManagement|Invoice Cardline Management]]
* [[InvoiceBulkApprove|Bulk Approve]]
* [[InvoiceBulkReject|Bulk Reject]]
* [[InvoiceReRender|Re-render Invoices]]
* [[InvoiceReRate|Re-rate Invoices]]

API/RetailServices/UpdateFlatFile

2020-01-23T02:18:00Z

Dcowan: added detail about export file

'''Purpose '''

The UpdateFlatFile function allows you get RADIUS information supplied as a CSV file. 
A file named '''radius_service_information.csv''' will be exported to your SFTP location in the '''/outbound/RadiusCSV/''' directory.
Subsequent API calls will generate a new file and overwrite the old. As will our automated scheduled poller.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ret:UpdateFlatFile/>
</soapenv:Body>

'''Output'''
<SOAP-ENV:Body>
<ns1:UpdateFlatFileResponse>
<ns1:result>Success: 1</ns1:result>
</ns1:UpdateFlatFileResponse>
</SOAP-ENV:Body>

Credits

2019-12-09T23:36:51Z

Dcowan: removed the incorrect statement

{{DISPLAYTITLE: Credits}}
= Overview =

There are several ways in Emersion to credit an amount of funds to a customer account. These include:

# raising a cardline with a negative value - This is best used when the credit needs to be applied before the invoice is sent to the customer.
# using Emersion's Credit feature - This is best used to credit an account after the invoice has approved and sent to the customer. Uses a single ledger code that cannot be changed.
# creating a product with a negative value - This is best used when a credit needs to adopt a different ledger codes.

This article is for Emersion's Credit feature only. Please see the links at the end of this article if you are interested in other ways to apply a credit.

Emersion's credit feature gives users the ability to raise a credit against a customer’s account. The amount can be automatically allocated so the system applies the credit amount against the oldest invoice(s) first, or you can manually apply to an invoice.

Credits reduce the customer’s outstanding balance immediately. Credits also create a [[Transactions|transaction]] in the ledger.

'''''All credits use the same ledger code for a credit.''''' This cannot be changed by the user.

You can also create a credit on an account by raising a [[InvoicePendingLedgerCardlines|manual cardline]] for a negative amount. This method allows the credit to be raised without allocating the credit amount against an invoice.

== To Create a Credit ==
# Select '''Finance''' > '''Accounts Receivable > Credit '''from the '''Menu.''' The ''Customer Search list ''page will appear showing all customers.
# Locate the required customer in the list, and click the '''Credit''' link in the ''Action'' column. The ''Credit ''page will display, showing a list of all outstanding invoices for the selected customer, with the oldest invoice shown first. Invoices that have been paid in full will not appear.
# Enter the credit amount in the ''Total (Inc Tax)'' field. The system will automatically calculate the credit ''Amount (Ex tax) ''and'' the Tax Amount'' and display in the corresponding fields''.''
# Alternately, enter the credit amount in the ''Total (Ex Tax)'' field. The system will automatically calculate the credit ''Total (Inc tax) ''and the ''Tax Amount''.
# Select the ''Tax Type'' applicable to the credit in the drop list. By default, this is set to ‘Australian GST’.
# Tick the ''Auto Allocate'' check box to prompt the system to automatically allocate the credit against the customer’s outstanding invoices. The system will allocate the credit amount against the oldest outstanding invoice.
#: If the credit amount is greater than the oldest outstanding invoice, the system will allocate the credit against the next oldest outstanding invoice, and so on, until the total credit amount is fully allocated.
#Alternately, clear the ''Auto Allocate'' check box to manually assign the credit amount against the required invoice(s). Enter the amount(s) in the ''Allocated Amount'' field beside each invoice as required.
# Enter the ''Credit Reference''. This will appear on the customer’s invoice with the credit amount.
# Select the ''Credit Type'' from the drop list. Options include: Misc (miscellaneous), SLA (Service Level Agreement), Marketing, and CSG (Customer Service Guarantee).
# Enter the ''Credit Date''. A Calendar tool will appear to allow you to select the required date.
# Enter any notes or other details in the ''Credit Note'' field.
# Click the '''Submit''' button. A window will appear showing the credit details entered to confirm the credit.
# Click the '''Yes''' button to confirm the credit. The ''Credit customer list'' page will appear with an information box showing the credit has been applied to the account.
#: The system will record the credit against the selected invoice(s), update the account balance, and create a transaction in the ledger.
# Click the '''No''' button to cancel the credit and return to the ''Credit'' page to make any changes as required.

=See Also=
* [[Products/Create_Product| Creating Products]]
* [[Payments|Payments]]

PackagePlans/PackagePlans

2019-10-30T23:43:31Z

Dcowan: clarified advance/arrears access fees

= Overview =
A package plan is one of several billing objects used in Emersion.

This article covers how to create a package plan.

If you would like to understand what the package plan is and how it works with other Emersion billing objects, see our [https://resources.emersion.com/display/EKB/The+Emersion+Billing+Objects Introduction to Emersion's Billing Objects article].
== Prerequisites ==
You can create a package plan on its own as an independent object. But it cannot be subscribed to by a customer until the following prerequisites are met:

* The service plan(s) are linked to the package plan.
* The service Plan(s) are in a ''saleable'' state.
* The plan has a product rate card linked that is in a saleable state
* Rate cards have at least 1 rate and are in a saleable state (for telephony plans only)
* The Data Billing tab has been configured (for data plans)
* Package Plans and service plans (both BUY and SELL) are all linked together.

This article's scope is limited to creating the package plan. Other articles cover the other steps above. See the links at the bottom of this page for assistance in these tasks.

= Package Plan Searching =
Package Plans are created and maintained in Cumulus via the following path

Nav: '''Packages and Plans > Management > Package Plans'''

When the page loads, the following screen will appear listing all package plans that have been created.

[[File:Package-plan-list.png|1200px|The Package Plan List Screen]]

= Create a Package plan =
To create a new Package Plan, click the '''Create New''' button. The following page will be displayed.

[[File:Package-plan-create-new.png|1200px|The ''Create a New Package Plan'']]

There are 3 columns of settings. Complete all fields as required.

; Name : The internal name for the Package. This name is only visible in Cumulus.

; External Name : This is the External Name for the Package. This is what is printed on customer's invoices if ledger cardlines (eg Package Plan Access Fees), related to this Package, are created.

; Description : An optional description for the Package. Internal use only

; Reference Name : A way of providing a link to an External 3rd party. This could be represented as the name of a prior billing system if one existed. The field is entirely optional.

; Reference Key : A way of providing a link to an External 3rd party. This may be the name of this plan, as it existed in the old system if this were the case. This field is entirely optional.

; Buy or Sell : Indicates whether this is a Buy Plan or a Sell Plan. Please see the [[#Buy_and_Sell_Plans | Buy and Sell Plans]] section above for further information.

; Default Contract Type : Defines the default Contract that will be created when this Package is sold to downstream Customers. For a Contract to appear here, this Package must be part of a Contract Pool. Due to this, when initially creating a Package Plan, only the default Option, 'None' will be available. For more information on contract types & their configuration, please click [[PackagePlans/Contract|here]].

; Customer Contract Required : Indicates whether a mandatory physical customer contract document must be uploaded during the Order Confirmation & Finalise page. If this is enabled, you MUST upload a physical customer contract. If disabled, it is not mandatory to upload a physical customer contract. Not to be confused with 'Default Contract Type' above which refers to the contract instance that is created when an order is completed.

== Package Plan Fee Setup ==

; Setup Fee : The fee charged when a Subscription of this Package is created.
; Access Fee : A Rental or Service fee generated each period for the life of the Package Subscription.

Please be aware of both the '''Override''' tick boxes and also the note: ''Where a package access fee is not empty, it will override any service plan access fees that are defined''. It's possible to define a Setup Fee and an Access Fee at both the Package Plan and Service Plan level. If either the Access Fee or Setup Fee (or both) are empty, with the Override button unchecked, the system will create the Access Fees based on the attached Service Plans.

If the override button is ticked but no value is entered, please note that $0 will be saved (so effectively, you are creating a $0 plan).

; Period Length : The Period length defines how far in advance (or arrears) the system will generate access fees. It also defines how frequently the access fees are created.

; Periods in Advance : determines how many PERIODS in advance the system should generate Access Fees. By default, it's set to 1. In other words, generate the access fee for a period when that period starts. In a real world example, if you have a Package that bills monthly and the date is 01/03/2011, it will generate access fees for 01/03/2011 to 31/03/2011 on 01/03/2011.If you set that value to 2 on a plan whose period length is 1 month, it would generate access fees for the period 01/04/2011 to 30/04/2011 on 01/03/2011. This works irrespective of the period length, so if you have 6 or 12 months periods on a Package with a 'Periods in Advance' setting of anything higher than 1, your customers will receive Package Access Fees well in advance of the current Period.

; Enable package subscription access fee overrides : Checking this flag enables subscribers to the plan to be given a different package plan access fee than the default access fee. This fee override is applied at the package subscription for the customer. A default package plan access fee must be set for any override to be applied. This flag cannot override service plan fees.

; Honour First Period End Date if Set : This setting permits a user (who is granted the relevant power) to set the end date of the first package subscription period when the package is activated during the [[Semi_Manual_Provisioning | Semi manual provisioning]] phase. This is designed for service providers who wish to control both the start date of the service (service activation date) and control when the first period will lapse separately. It requires a subscription to the feature '''Set first period end date'''. If you would like to enquire regarding this feature, please raise a sales ticket in the [https://resources.emersion.com/display/EKB/Getting+Support+and+Help+from+Emersion Emerson Support Portal].

; Bill Access Fees in : Specifies if you are billing access fees in arrears or in advance. This applies to package plan access fees, service plan access fees, service feature product charges & bolt on access fees. If '''advance''' is used, access fees will generate automatically at the start of the associated subscription period. If '''arrears''' is used, access fees will generate and the end of the associated subscription period (and only once the period is approved - either automatically or [https://resources.emersion.com/display/EKB/Period+Approval manually])

; Bill Months in Advance: Specifies how many months prior to the start of the next period you generate a cardline. The total periods billed is determine by the '''Periods in Advance''' setting.

To clarify the difference between Periods in Advance and Bill Months in Advance, it can be thought of in the following way
* Periods in Advance refers to how many periods you are going to bill when the cardline is generated.
* Bill Months in Advance is when you are going to bill.
In other words, Periods in Advance refers to the volume of periods you are going to bill, and Bill Months in Advance refers to how far in advance, or "when", you are going to bill these periods.

For example, imagine you have:

<li> A monthly account invoice period </li>
<li> Periods Length is 3 months. </li>
<li> Periods in Advance is set to 2.</li>
<li> Bill Access Fees is set to: Advance </li>
<li> Bill in Advance is: 2 months. </li>

In this example, today is the 1st of April, and the subscription is to start on the 1st of May.
In this case what will happen is that because you are billing access fees 2 months in advance, the cardline will be generated today, on the 1st of April, not on the 1st of May.
In addition, because you are billing 2 periods in advance, both periods 3 months in length each, the cardlines generated will cover the next *six* months in advance.

; Pro Rata : Determines whether or not the first set of Access Fees generated for this plan will be pro-rated. The 'Pro Rata' setting will also determine whether Period adjustment credits will be produced in the event that the period is adjusted for any reason. Period adjustment will generally be due to a package cancellation effective as of mid period. This setting is ignored for periods that have been billed in advance; they will be credited back regardless.

; Align Pkg Period to Invoice Period : This flag will align any newly created package subscriptions to this package plan to the underlying account invoice period of the given customer. This will ensure all access fees and usage fees are aligned to when an invoice is rendered. It is important to note that overriding this setting at this point may conflict with the account level setting [[Account/AccountCreation#Wizard_Screen_1:_Data_Definition | Align Pkgs to Account]], producing undesirable billing results. You must be certain you wish to over ride this setting when creating a new package plan. This setting may also impact the ability of the
For example, a package bundle comprising month-to-month billing for an ADSL service and web hosting. These services will align to the underlying account invoice period nicely, as they are billed monthly. However if the package plan also contains a Domain Registration service (for 1 year, 2 years, or 3 years), it is not desirable for this to be aligned to the customer's account invoice period.

; Created date : The date the service plan was initially created.

; Created by : Displays the user who created the plan.

; Date modified : Displays the date when the last modification was made to the service plan.

; Modified by : Displays the name of the user who last updated the service plan's.

; Saleable from : The date from which the plan is or was available to order.

; Saleable to : After this date passes, a plan is unavailable to the orders screens.

; Approval status : Status of the plan.
* Draft - Initial state for when the plan is being set up.
* Pending - The plan has been set up but needs review and is not ready for sale.
* Approved - The plan has been approved and is ready for sale.
* Saleable - the plan is able to be sold
* Grandfathered - the plan is no longer used. There maybe customers with active subscriptions on this plan, but it cannot be sold.

; Saleable in Signup Portal : Enable to allow this package plan to be visible in the [https://resources.emersion.com/display/EKB/The+Sign+Up+Portal End User Signup Portal].

= See Also =
* [[PackagePlans/LinkingPackageAndServicePlans|Linking Package Plans and Service Plans]]
* [[PackagePlan/Advanced | Package Plans - Advanced features and functions]]

AccountDiscountPlans

2019-10-08T22:36:27Z

Dcowan: clarified rate in cap setting

= Account Discount Plans =

== Introduction ==

Account Discount Plans are a feature which enables you to sell 'Packs' of calls to customers. These call 'Packs' are applied to any Service Subscription under the selected customer. Usage which falls into these packs can be rated separately and a cap value can be applied independently of the Package Plan or Service Plan cap configuration.

Where there is an Account Discount Plan, you will link a new ''Rate Card'' to the Account Discount Plan, which has your overriding rates. This Rate Card is referred to as the ''Replacement'' Rate Card.

=== How the packs can be used ===

Account Discount Plans are very flexible and allow for a number of different use cases. For example:
* You wish to provide a cap value amount across the entire account - not just the service or package subscription.
* You resell a PSTN service and, ordinarily, calls to China are rated at $2 flagfall and 68 cents per minute. For some customers, though, you wish to simply provide an override which means that calls to China are $1.50 flagfall and 45 cents per minute. An Account Discount Plan can allow you to set this globally for your account in question, without the need to set up individual Rate Overrides on each Service Subscription

== Configuration ==

Account Discount Plans require 3 things to be configured:
* The Account Discount Plan itself
* The Rate Card which will be used against the plan
* The Account Discount Subscription on the customer's account

You will also need to ensure you have one or more of the following
; Permissions: Account Discount Plans or Packages And Plans
; Powers: Account Discount Plan View

=== Configuring the Account Discount Plan ===

Account Discount Plans are configured in '''Packages and Plans > Management > Account Discount Plans'''.

When creating a new Account Discount Plan, the following fields will be required:
; Internal Name : The name of the Account Discount Plan as it is displayed in Cumulus.
; External Name : The name of the Account Discount Plan as it is displayed on Customer Invoices.
; Description : A free text description of the Account Discount Plan
; Service Type Category : The ''Service Type Category'' for which the Account Discount Plan is effective (similar to creating a new Rate Card or Product Rate Card)
; Service Type : The ''Service Type'' for which the Account Discount Plan is effective. Note that this is an optional field.
; Rate Selection Method : Defines the behaviour of the billing engine with relation to how aggressive it will be in finding a rate within the Account Discount Plan Rate Card. There are one of 3 different Behaviours:
:: '''1''' - Use Replacement Rate Card Only - If no rate is found on the replacement rate card, then the call will fall into quarantine. 
This setting will allow you to set rates for either an individual mediated tariff or for a group/parent tariff above it. If neither is found, the usage record will fall straight to Rating Quarantine.
:: '''2''' - Exact Rate Required on Replacement Rate Card - Only an exact-rate-match on the replacement rate card can be used, if not found it will fall back to the underlying rate card.
This setting will allow you to set rates specifically for an individual mediated tariff. If a rate for this tariff is not found, the usage record will fall into Rating Quarantine.
:: '''3''' - Use Replacement Rate card if no rate fall back - The replacement rate card is used to find a rate, if no rate is found, then the call will fall back to the underlying rate card.
This setting will allow you to set rates for either an individual mediated tariff or for a group/parent tariff above it. If neither is found, it will fall back to the underlying service plan rate card.
; Billing Type : Arrears or Advance. Use Arrears for standard telephony calls.
; Weight : Customers may have multiple Account Discount Subscriptions applied against their account. In order to facilitate this, the Account Discount Plan has a WEIGHT - which determines which Account Discount Plan takes priority if there are multiple ones that usage could potentially fall against. The WEIGHT is such that lower numbers take priority over higher numbers. So an Account Discount Plan with a WEIGHT value of 10 would take precedence over an account discount with a WEIGHT value of 20. 
This setting will not have any effect if the below 'Cap not required?' checkbox is checked/enabled.
; Cap not Required : Ordinarily, an Account Discount Plan is used to provide an account level cap on specific calls. If you simply wish to provide a mechanism for rating calls against specific tariffs without there being a cap in place, ensure you check this box. 
If enabled, all rates on the replacement rate card must be be marked In Cap (Do not select any Included Value Slot in the drop-down list - this is use for Service Plan level Included Value). 
Also note that if this setting is enabled, the WEIGHT of an Account Discount Plan will not have any effect.
; Cap Amount : With the ''Cap not Required'' checkbox disabled, you can elect to provide this account discount plan with an "Included Value" amount in dollars and cents.
; Setup Fee : Like other plans in the system, you can choose to charge a (once off) setup fee. This is applied at the start of the account discount subscription.
; Access Fee: Like other plans in the system, you can choose to charge a (recurring) access fee. This is applied at the start of the account discount subscription in advance.
; Approval Status: Gives you the opportunity to configure your account discount plan prior to approving for sale. Only approved account discount plans can be subscribed to.
; Saleable From: Cannot be backdated via the UI. Can only create a plan as of today. Only those plans with a date today or less than today can be subscribed to.
; Saleable To: For automatic expiration of an account discount plan - similar to grandfathering a package plan. Only those plans with an empty or saleable to date greater than today can be subscribed to.

Example:
[[File:Account disc plans 001.png]]

= See Also =
[[Account Management/Customer Screen/Account Discount Subscriptions|Account Discount Subscriptions]]

Quarantine/Rating Quarantine

2019-09-30T07:22:56Z

Dcowan: moved stuff around. clarified some things

==Rating Quarantine==

Rating quarantine lists all rating, billing and invoicing issues identified by the Billing and Rating engine other than those identified during the supplier file mediation process by the BMS process.

===Rating Quarantine Reasons and Error Codes===

The following table lists all Rating Quarantine reasons and the recommended action for each:

{| border="1" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-
|
'''Quarantine Reason'''

|
'''Description'''

|
'''Recommended Action'''

|-
|
Missing Rate Card

|
A Rate card has not been allocated to Service Plan

|
Add a Rate Card to the required service plan and then cleanse

If you need to backdate the usage, submit an Emersion Support Ticket to assist

|-
|
Missing Rate

|
Although the Rate Card exists in the system, no rate is found for this tariff or any tariff above it

|
Add a Rate to the appropriate Rate Card and then cleanse
 

Where rates were missing from a BUY rate card, you may also need to investigate any SELL rate cards for the same tariff (or any above it)

|-
|
Invalid Rate

|
An error has been detected in the rate configuration.

|
Review the rate card configuration. 
The most common cause is a "markup" rate profile configured with no markup. This is not possible in the user interface and is usually the result of a bad rate import. 
If attempting to "pass through" a rate from a carrier (or upstream supplier), simply use the '''Passthrough''' rate profile.

If required, submit an Emersion Support Ticket to assist

|-
|
Invalid Service Type

|
The Service Type is not set correctly for the usage data received from the supplier

|
Submit an Emersion Support Ticket to rectify

|-
|
Missing Service Subscription

|
Service exists in the system but the Service Subscription is missing

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid Package Period

|
The service exists in the system but the Package Period is outside the usage date

|
Submit an Emersion Support Ticket to change the package periods and then cleanse

|-
|
Invalid Rounding Type

|
The underlying Service Plan setup is incorrect

|
Submit an Emersion Support Ticket to rectify

|-
|
Rating Failed – Unknown Reason

|
Internal Issue

|
Emersion to rectify the cause and cleanse

|-
|
Invalid Carrier Cost

|
A missing or invalid carrier cost is found in the record where one should exist

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid Usage Hierarchy

|
Internal Issue

|
Emersion to rectify the cause and cleanse

|-
|
Bolting Failed – Unknown Reason

|
Internal Issue

|
Emersion to rectify the cause and cleanse

|-
|
Invalid Bolt On

|
Bolt on type is not valid for the Service Plan

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid Bolt On Subscription

|
Bolt on subscription exists in the system but the bolt on has been removed

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid Bolt On – Markup Set On Underlying Rate

|
Internal Issue

|
Submit an Emersion Support Ticket to rectify

|-
|
Charging Failed – Unknown Reason

|
Internal Issue

|
Emersion to rectify the cause and cleanse

|-
|
Invalid Charging Attribute

|
An invalid charging attribute was detected

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid Charging Attribute – Mark-up Set on Underlying Rate

|
Internal Issue

|
Submit an Emersion Support Ticket to rectify

|-
|
Invoicing Failed – Unknown Reason

|
Internal Issue

|
Emersion to rectify the cause and cleanse

|-
|
Invalid Cap Attribute

|
The Plan Cap has not been set however the Rate Card has capped tariffs

|
Add the required Cap amount to the Plan and then cleanse

|-
|
Invalid MaxType Cap Attribute – Mark-up Set on Underlying Rate

|
Internal Issue

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid MaxType Cap Attribute

|
Mismatched cap type was detected (e.g. tariff is in seconds but the Cap type is KB)

|
Correctly set the Cap Max type attribute and then cleanse

|}

===To View Rating Quarantine Records===

# Select '''Billing''' > '''Quarantine '''from the '''Menu.''' The ''Quarantine ''page will appear.
# Click the '''Rating''' tab on the ''Quarantine'' page. The ''Rating Quarantine'' page will appear.

Note that the page may take a few moments to appear.

'''Search'''

You can locate Rating quarantine records by using the ''Search'' function. The following fields can be used to search for records:

* Quarantine ID the system generated quarantine record ID
* Service Identifier the service’s unique identifier, such as the phone number
* Call Date From allows date selection via a Calendar tool
* Call Date To allows date selection via a Calendar tool
* Batch File Number the system generated batch file number
* Batch File name as received from the supplier
* Tariff Key the tariff key of the usage record
* Status see the ''Rating Quarantine Reasons'' table above

===To Cleanse Records in Rating Quarantine===

Once you, or the Emersion Billing Operations team, have made the necessary changes in the system to resolve the issue, the ''Rating Quarantine'' record must be updated as cleansed so it is marked as ready to be re-processed by the billing and rating engine, which will place the charge on the appropriate account’s invoice.

# After reviewing the quarantine records and correcting the issues, locate the required records in the list on the ''Rating Quarantine'' page. Use the search fields as required.
# Tick the check box beside each required quarantine record in the list.
#:To select all records on the current page of the list, tick the check box in the column heading row. All recorded will be ticked.
# Click the '''Cleanse''' button. The system will update the selected records and display a message at the top of the page showing the records have been cleansed.

The records will now be ready to be re-processed by the billing and rating engine.

===See also===
* [[BMS_Quarantine|BMS Quarantine]]
* [[InvoiceProcess|Rating, Billing and Invoice Process]]

Quarantine/BMS Quarantine

2019-09-30T07:18:55Z

Dcowan: moved stuff around. clarified some things

==BMS Quarantine==

The Telephony BMS, Data BMS and Misc BMS quarantine pages list issues identified during the supplier file mediation process for your telephony services, data services, and miscellaneous service charges respectively. These issues will only appear if you receive service files (e.g. CDRs, usage feeds etc) directly from your supplier. If you are reselling services through an Emersion Wholesale Service Provider, you may not see any BMS quarantine issues.

===BMS Quarantine Reasons===

The following table lists all BMS Quarantine reasons and the recommended action for each:

{| border="1" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-
|
'''Quarantine Reason'''

|
'''Description'''

|
'''Recommended Action'''

|-
|
Non Existent Service Fault

|
Service usage data has been received from the supplier that contains charges but the Service could not be located in the system.

Also see '''Non Existent Service Fault - Common Reasons''' below
|
Add the Service to the appropriate account and then cleanse

|-
|
No Rate Card Found

|
A Rate Card either does not exist on the Service Plan, or the attached rate card effective date is after the usage record start date.

|
Write Off the record. Alternatively, contact Emersion Support for possible options.

|-
|
Bucketer Called on Records With Rated Records

|
A duplicate usage fault

|
Submit an Emersion Support Ticket to rectify

|-
|
Could not process all Accounts

|
An account was not able to be processed.

|
Submit an Emersion Support Ticket to rectify

|-
|
Duplicate Usage Fault

|
The record received from the supplier satisfies the criteria for a duplicate record

|
Write Off

|-
|
Fatal Exception Thrown

|
Internal Error

|
Submit an Emersion Support Ticket to rectify

|-
|
Incorrect Duration Fault

|
Incorrect usage duration found in the record (ie. duration is 0)

Emersion maintains an internal exception list that determines which usage items can have 0 duration (e.g. SMS) - usage items not in the exception list are put into quarantine

|
If you believe the usage should be charged, the internal exception list may need to be updated

Submit an Emersion Support Ticket or Write Off

|-
|
Mismatched Service Account Fault

|
Service is in the system but is not owned by you

|
Write Off and make a claim with your service supplier

|-
|
No Accounts to Bill

|
Service is in the system but is not owned by you

|
Write Off and make a claim with your service supplier

|-
|
No Package Available

|
The service is assigned to a Package ID that does not exist in the system.

|
Submit an Emersion Support Ticket to rectify

|-
|
No Tariff Found

|
The billing system is unable to allocate a tariff to apply the charge

|
Submit an Emersion Support Ticket to add the missing tariff and then cleanse

|-
|
No Valid Package Period

|
The service exists in the system but the Package Period is outside the usage date

|
Submit an Emersion Support Ticket to investigate and rectify

|-
|
No Valid Service Subscription Period

|
The service exists in the system but the Service Period is outside the usage date

|
Submit an Emersion Support Ticket to change the service periods and then cleanse.

|-
|
Non Existent Tariff Key Fault

|
The billing system is unable to allocate a tariff to the usage to apply a charge

|
Submit an Emersion Support Ticket to add the missing tariff and then cleanse.

Emersion do add many tariffs a couple of times a month internally so you may only need to Cleanse.
Also see: *Report > List > Quarantine > New Tariffs Created in last 1,7,30 Days - #1188* or *Report > List > Reference > Tariff List by Service Type Category with Keys - #1012*

If asking Emersion to add a tariff, you'll need to obtain appropriate information from your carrier to enable us to correctly allocate this new tariff to the correct location within the tariff tree. For example: Providing a sample destination number called, country/location, and possibly a similar tariff ID that you believe is similar may help in this identification.

|-
|
Obsolete Usage Fault

|
The usage is in excess of the service supplier’s back billing threshold (usually 180 days)

|
Write Off and make a claim with your service supplier

|-
|
Product Does Not Exist

|
Product is not found for the miscellaneous charge received from the supplier

|
Submit an Emersion Support Ticket to rectify (we will ask for information about the Product)

|-
|
Unmatched Withdrawal Fault

|
A Withdrawal record cannot be matched to the original CDR

|
Investigate with supplier then Cleanse or Write Off

|}

=== Non Existent Service Fault - Common Reasons===
On of the most common quarantine reasons is the Non Existent Service Fault. The most common reasons for this type of fault is as follows;

Also see [[Quarantine/Non Existent Service]]

* A Package subscription at one or more tiers is not active.
* A service subscription at one or more tiers is not active.
* A service at one more tiers is not active
* The service is end dated.
* The start date on the package subscription, the service subscription, the service, or the service identifier does not cover the date of the usage.
* The service identifier does not match that of the service identifier which the carrier has sent through.
* The Service Identifier is end dated.
* The service type category of the service does not match that service type category on the mediated tariff.

===To View BMS Quarantine Records===

# Select '''Billing''' > '''Quarantine '''from the '''Menu.''' The ''Quarantine ''page will appear showing the ''BMS Usage Telephony Quarantine'' page by default.
# To view quarantine information for your telephony services, select the '''Telephony BMS''' tab. The ''BMS Usage Telephony Quarantine'' page will appear.
# To view quarantine information for your data services, select the '''Data BMS''' tab. The ''BMS Usage Data Quarantine'' page will appear.
# To view quarantine information for miscellaneous service charges (e.g. telephony products etc), select the '''Misc BMS''' tab. The ''BMS Usage Misc Quarantine'' page will appear.

----
'''Note:''' The Telephony BMS, Data BMS and Misc BMS quarantine pages all look the same and operate in the same manner.
----

'''Search'''

You can locate BMS quarantine records by using the ''Search'' function. The following fields can be used to search for records:

* Quarantine ID the system generated quarantine record ID
* Batch number the system generated batch file number
* Carrier Name the service supplier
* Date Filtering No Date Filtering, Date Updated, or Date Released
* From allows date selection per the ''Date Filtering'' option via a Calendar tool
* To allows date selection per the ''Date Filtering'' option via a Calendar tool
* Service Identifier the service’s unique identifier, such as the phone number
* Batch File name as received from the supplier
* Carrier File Type dependant on the ''Carrier Name'' option selected
* Tariff Key the tariff key of the usage record
* Status All, Quarantine, Cleansed, Completed, Withdrawn, Write off, or Pending
* Quarantine Reason see the ''BMS Quarantine Reasons'' table above.

===To Process records in BMS Quarantine===

# After reviewing the quarantine records and determining the required action, locate the required records in the list on the ''BMS Usage Telephony Quarantine ''page, the ''BMS Usage Data Quarantine'' ''BMS ''page, or the'' Usage Telephony Quarantine'' page. Use the search fields as required.
# Tick the check box beside each required record in the list.
#:To select all records on the current page of the list, tick the check box in the column heading row. All recorded will be ticked.
# Select the required action to update the selected records in the ''Update To'' drop list, which is located below the list of records.
# Click the '''Submit''' button. The system will update the selected records and display a message at the top of the page showing the records have been updated.

The Actions and their results are as follows:

{| border="1" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-
|
'''Action'''

|
'''Result'''

|-
|
Cleansed

|
You have made the necessary changes in the system to resolve the issue. The record will be marked as ready to be re-processed by the billing and rating engine, which will place the charge on the appropriate account’s invoice.

|-
|
Action Pending

|
Places the item into a ''pending'' status. This can be used to mark the record as being actioned where it may take a few days for you to resolve the issue.

|-
|
Write off

|
The record will be flagged in the system as not billed and ignored by the billing and rating engine. These records will appear in the write off report.

|-
|
Quarantined

|
Leaves the record in the list for further investigation.

|}

===See also===
* [[Quarantine/Non Existent Service]]
* [[Rating_Quarantine|Rating Quarantine]]
* [[InvoiceProcess|Rating, Billing and Invoice Process]]

PackagePlans/PackagePlans

2019-09-25T06:57:32Z

Dcowan:

{{DISPLAYTITLE:Package Plans}}
{{DISPLAYTITLE:Creating Package Plans}}
= Overview =
A package plan is one of several billing objects used in Emersion.

This article covers how to create a package plan.

If you would like to understand what the package plan is and how it works with other Emersion billing objects, see our [https://resources.emersion.com/display/EKB/The+Emersion+Billing+Objects Introduction to Emersion's Billing Objects article].
== Prerequisites ==
You can create a package plan on its own as an independent object. But it cannot be subscribed to by a customer until the following prerequisites are met:

* The service plan(s) are linked to the package plan.
* The service Plan(s) are in a ''saleable'' state.
* The plan has a product rate card linked that is in a saleable state
* Rate cards have at least 1 rate and are in a saleable state (for telephony plans only)
* The Data Billing tab has been configured (for data plans)
* Package Plans and service plans (both BUY and SELL) are all linked together.

This article's scope is limited to creating the package plan. Other articles cover the other steps above. See the links at the bottom of this page for assistance in these tasks.

= Package Plan Searching =
Package Plans are created and maintained in Cumulus via the following path

Nav: '''Packages and Plans > Management > Package Plans'''

When the page loads, the following screen will appear listing all package plans that have been created.

[[File:Package-plan-list.png|1200px|The Package Plan List Screen]]

= Create a Package plan =
To create a new Package Plan, click the '''Create New''' button. The following page will be displayed.

[[File:Package-plan-create-new.png|1200px|The ''Create a New Package Plan'']]

There are 3 columns of settings. Complete all fields as required.

; Name : The internal name for the Package. This name is only visible in Cumulus.

; External Name : This is the External Name for the Package. This is what is printed on customer's invoices if ledger cardlines (eg Package Plan Access Fees), related to this Package, are created.

; Description : An optional description for the Package. Internal use only

; Reference Name : A way of providing a link to an External 3rd party. This could be represented as the name of a prior billing system if one existed. The field is entirely optional.

; Reference Key : A way of providing a link to an External 3rd party. This may be the name of this plan, as it existed in the old system if this were the case. This field is entirely optional.

; Buy or Sell : Indicates whether this is a Buy Plan or a Sell Plan. Please see the [[#Buy_and_Sell_Plans | Buy and Sell Plans]] section above for further information.

; Default Contract Type : Defines the default Contract that will be created when this Package is sold to downstream Customers. For a Contract to appear here, this Package must be part of a Contract Pool. Due to this, when initially creating a Package Plan, only the default Option, 'None' will be available. For more information on contract types & their configuration, please click [[PackagePlans/Contract|here]].

; Customer Contract Required : Indicates whether a mandatory physical customer contract document must be uploaded during the Order Confirmation & Finalise page. If this is enabled, you MUST upload a physical customer contract. If disabled, it is not mandatory to upload a physical customer contract. Not to be confused with 'Default Contract Type' above which refers to the contract instance that is created when an order is completed.

== Package Plan Fee Setup ==

; Setup Fee : The fee charged when a Subscription of this Package is created.
; Access Fee : A Rental or Service fee generated each period for the life of the Package Subscription.

Please be aware of both the '''Override''' tick boxes and also the note: ''Where a package access fee is not empty, it will override any service plan access fees that are defined''. It's possible to define a Setup Fee and an Access Fee at both the Package Plan and Service Plan level. If either the Access Fee or Setup Fee (or both) are empty, with the Override button unchecked, the system will create the Access Fees based on the attached Service Plans.

If the override button is ticked but no value is entered, please note that $0 will be saved (so effectively, you are creating a $0 plan).

; Period Length : The Period length defines how far in advance (or arrears) the system will generate access fees. It also defines how frequently the access fees are created.

; Periods in Advance : determines how many PERIODS in advance the system should generate Access Fees. By default, it's set to 1. In other words, generate the access fee for a period when that period starts. In a real world example, if you have a Package that bills monthly and the date is 01/03/2011, it will generate access fees for 01/03/2011 to 31/03/2011 on 01/03/2011.If you set that value to 2 on a plan whose period length is 1 month, it would generate access fees for the period 01/04/2011 to 30/04/2011 on 01/03/2011. This works irrespective of the period length, so if you have 6 or 12 months periods on a Package with a 'Periods in Advance' setting of anything higher than 1, your customers will receive Package Access Fees well in advance of the current Period.

; Enable package subscription access fee overrides : Checking this flag enables subscribers to the plan to be given a different package plan access fee than the default access fee. This fee override is applied at the package subscription for the customer. A default package plan access fee must be set for any override to be applied. This flag cannot override service plan fees.

; Honour First Period End Date if Set : This setting permits a user (who is granted the relevant power) to set the end date of the first package subscription period when the package is activated during the [[Semi_Manual_Provisioning | Semi manual provisioning]] phase. This is designed for service providers who wish to control both the start date of the service (service activation date) and control when the first period will lapse separately. It requires a subscription to the feature '''Set first period end date'''. If you would like to enquire regarding this feature, please raise a sales ticket in the [https://resources.emersion.com/display/EKB/Getting+Support+and+Help+from+Emersion Emerson Support Portal].

; Bill Access Fees in : Specifies if you are billing access fees in arrears or in advance.

; Bill Months in Advance: Specifies how many months prior to the start of the next period you generate a cardline. The total periods billed is determine by the '''Periods in Advance''' setting.

To clarify the difference between Periods in Advance and Bill Months in Advance, it can be thought of in the following way
* Periods in Advance refers to how many periods you are going to bill when the cardline is generated.
* Bill Months in Advance is when you are going to bill.
In other words, Periods in Advance refers to the volume of periods you are going to bill, and Bill Months in Advance refers to how far in advance, or "when", you are going to bill these periods.

For example, imagine you have:

<li> A monthly account invoice period </li>
<li> Periods Length is 3 months. </li>
<li> Periods in Advance is set to 2.</li>
<li> Bill Access Fees is set to: Advance </li>
<li> Bill in Advance is: 2 months. </li>

In this example, today is the 1st of April, and the subscription is to start on the 1st of May.
In this case what will happen is that because you are billing access fees 2 months in advance, the cardline will be generated today, on the 1st of April, not on the 1st of May.
In addition, because you are billing 2 periods in advance, both periods 3 months in length each, the cardlines generated will cover the next *six* months in advance.

; Pro Rata : Determines whether or not the first set of Access Fees generated for this plan will be pro-rated. The 'Pro Rata' setting will also determine whether Period adjustment credits will be produced in the event that the period is adjusted for any reason. Period adjustment will generally be due to a package cancellation effective as of mid period. This setting is ignored for periods that have been billed in advance; they will be credited back regardless.

; Align Pkg Period to Invoice Period : This flag will align any newly created package subscriptions to this package plan to the underlying account invoice period of the given customer. This will ensure all access fees and usage fees are aligned to when an invoice is rendered. It is important to note that overriding this setting at this point may conflict with the account level setting [[Account/AccountCreation#Wizard_Screen_1:_Data_Definition | Align Pkgs to Account]], producing undesirable billing results. You must be certain you wish to over ride this setting when creating a new package plan. This setting may also impact the ability of the
For example, a package bundle comprising month-to-month billing for an ADSL service and web hosting. These services will align to the underlying account invoice period nicely, as they are billed monthly. However if the package plan also contains a Domain Registration service (for 1 year, 2 years, or 3 years), it is not desirable for this to be aligned to the customer's account invoice period.

; Created date : The date the service plan was initially created.

; Created by : Displays the user who created the plan.

; Date modified : Displays the date when the last modification was made to the service plan.

; Modified by : Displays the name of the user who last updated the service plan's.

; Saleable from : The date from which the plan is or was available to order.

; Saleable to : After this date passes, a plan is unavailable to the orders screens.

; Approval status : Status of the plan.
* Draft - Initial state for when the plan is being set up.
* Pending - The plan has been set up but needs review and is not ready for sale.
* Approved - The plan has been approved and is ready for sale.
* Saleable - the plan is able to be sold
* Grandfathered - the plan is no longer used. There maybe customers with active subscriptions on this plan, but it cannot be sold.

; Saleable in Signup Portal : Enable to allow this package plan to be visible in the [https://resources.emersion.com/display/EKB/The+Sign+Up+Portal End User Signup Portal].

= See Also =
* [[PackagePlans/LinkingPackageAndServicePlans|Linking Package Plans and Service Plans]]
* [[PackagePlan/Advanced | Package Plans - Advanced features and functions]]

Commissions/Commission Management/Apply Commission Rules

2019-08-26T06:43:08Z

Dcowan: clarified contract age - see DE-3706

= Applying the Commissions Rules =

You can apply commissions rules to:
* Products
* Service-based subscriptions
** Package Plans
** Service Plans
** Service Features
** Bolt-Ons

Emersion does not currently support commissions on:

* Rate Cards and Rates
* Bolt-on Add-ons

== Apply a Set of Commission rules to Products ==

If products attract commissions, after setting up the commissions tier you will then need to apply a set of rules to the relevant products.

Rules for product-based commission are configured for each product.

Perform the following steps for each product or package plan that an Agent can sell in which commissions are accrued.

'''Navigate: Products > Product management'''

# Select a product that an Agent can generate a commission from when sold by clicking on its ID.
# This will display the Product details page. On the right of the screen, click the '''Commission Tier''' button.
# The '''Commissions for a Product page''' for this product will be displayed. If you have any existing or past rule sets, these will be displayed in the list.
# Click the '''Add Commission Rules''' button
# Select the Commission Tier from the list
# Select when the Commission is to be granted to the agent from the '''Grant Type''' list.
# Choose when the rules apply from and to using the Effective Dates fields
# Enter the amount ($) that will be paid to the agent AND/OR the percentage of the sale price that will be paid to the Agent.
# If you wish for the system to auto-approve the commissions, tick the '''Auto Approve Cardline''' box. If you wish to manually approve commissions, leave this box unchecked.
# When you are finished, click '''Submit'''.

Multiple rule sets for a product is common when different Agents get different commissions for selling a product or a service. However for a given Commission tier, rule sets cannot overlap.

If the commission plan is varied for an Agent, Emersion recommends you set the effective to date to the final date where the existing plan applies. Then create a new rule set with the start date of when the change applies.

Commissions only apply to outright purchases of products. Commissions on products purchased under an instalment plan is not currently supported by Emersion.

''Note: If you do not set up commission business rules for a product, an Agent cannot be assigned a commission when they create a product purchase in Cumulus. Similarly, users entering product purchases on behalf of an Agent will not see the fields that allow the user to attribute the sale of the product to an Agent''.

== Apply a Set of Commission rules to Subscription-based Services ==

If the sale of a Package plan, Service plan, Service feature or Bolt-on attract commissions, after setting up the commissions tier you will then need to apply a set of rules to the relevant products.

Rules for subscription-based commission are configured for each Package plan, Service plan, Service feature or Bolt-on respectively.

The following steps contain the instructions for setting up the rules for a package plan. These steps need to be completed for each package plan that an Agent can sell for which commissions are accrued.

'''Navigate: Packages & Plans > Management'''
# Select a SELL Package Plan that an Agent can generate a commission from when sold by clicking on its ID.
# This will display the '''Package Plan details page'''. Click the '''Commission Tier''' sub tab.
# The '''Manage Rule Sets''' page for this package plan will be displayed. If you have any existing or past rule sets, these will be displayed in the list.
# Click the '''Define new rule set for Tier''' button
# Select the Commission Tier from the list of available service commission tiers.
# Choose when the rules apply from and to using the Effective Dates fields.
# Enter an optional description
# When you are finished, click '''Submit'''.

''Note: If you do not set up commission business rules for a package plan, service plan, bolt-on or service feature, an Agent cannot be assigned a commission when they submit an order in Cumulus. Similarly, users entering orders on behalf of an Agent will not see the fields that allow the user to attribute the order to an Agent.''

[[file:3. Commissions Management - RuleSet.png]]

== Setting Bounties and Trailing Commissions ==

Once you have saved the rules you have set in the steps above, a section underneath will appear where you can define the values and rules for the bounties and trails.

A bounty is a type of commission which applies once only when the service, package or otherwise is created. It differs from a trail which provides recurring commission each time a service, package or otherwise is billed.

A bounty can be provided as a fixed amount and it can also take a percentage of a fee that is applied. If both bounty and trail commissions are set, then ''both'' will apply. Multiple bounties can also apply if you wish.

To add a Bounty commission:

# Click the '''Add Bounty''' button.
# The '''Manage Bounty''' screen will be displayed
# Choose when the bounty will be granted to the Agent.
# Enter the amount ($) that will be paid to the agent AND/OR the percentage of the sale price that will be paid to the Agent.
# If the bounty to be paid requires a contract to be valid at the time the commission is generated for a, tick the '''Requires Active Contract''' box.
# Enter a number into the ''Contract Age'' in months if you wish to define how many months the customer’s contract must be Active before the bounty is paid to the Agent. If you do not enter anything into this field, a default value of '0' will be used. This means a commissions will be able to be processed as long as a contract exists - regardless of age. When a commission is generated, it will not be processed until the contract age has been met.
# If you wish for the system to auto-approve the commissions, tick the '''Bounty Auto Approve Cardline''' box. If you wish to manually approve commissions, leave this box unchecked.
# When you are finished, click '''Submit'''.

To add a Trail commission:

# Click the '''Add Trail''' button.
# The '''Manage Trails''' screen will be displayed.
# Choose when the trail will be granted to the Agent. All 3 options can be used if needed.
# If the trail amount is a fixed dollar amount ($), enter it into the '''Trail Amount''' field.
# If a percentage of the access fee forms part of the Agents’ commission, enter the % amount into the '''Trail Access Fee''' field.
# If a percentage of the usage charges forms part of the Agents’ commission, enter the % amount into the '''Trail Usage''' field.
# If the trail applies for a limited duration, not the life of the service subscription and applies for a set number of billing periods, enter the number of months into the '''Trail Duration''' field.
# If the trail to be paid requires a contract to be valid at the time the commission is generated, tick the '''Requires Active Contract''' box.
# Enter a number into the ''Contract Age'' in months if you wish to define how many months the customer’s contract must be Active before the bounty is paid to the Agent. If you do not enter anything into this field, a default value of '0' will be used. This means a commissions will be able to be processed as long as a contract exists - regardless of age. When a commission is generated, it will not be processed until the contract age has been met.
# If you wish for the system to auto-approve the commissions, tick the '''Trail Auto Approve Cardline''' box. If you wish to manually approve commissions, leave this box unchecked.

The trail can be:
* a fixed amount
* a percentage of an access fee
* a percentage of a usage charge.

[[file:2. Commissions Management - PackPlan-RuleSetFullConfig.png]]

== Service Plans, Service Features and Boltons ==
The steps above are identical for other service-based subscriptions (Service Plans, Service features and Bolt-ons). The only difference is where to locate the settings for each of them.

* For '''Service Plans''':

Navigation: '''Packages & Plans > Management > Service Plans''' 
Drill down into a Service Plan by clicking the ID > Commissions Tier tab

* For '''Service Features''':

Navigation: '''Packages & Plans > Management > Product Rate Cards''' 
Drill down into a Product Rate Card by clicking the ID > Product Rate tab 
For each rate with a Service Feature type, a Commissions Tier link will be available.

[[file:5. Commissions Management - ServiceFeature-RuleSet-CommTierLink.png]]

* For '''Bolt-Ons''':

Navigation: '''Packages & Plans > Management > Bolt Ons''' 
Drill down into a bolt-on by clicking the ID > Commissions Tier button

[[file:4. Commissions Management - Bolton-RuleSet-CommTierButton.png]]

Quarantine/BMS Quarantine

2019-08-08T02:07:50Z

Dcowan: added No Rate Card Found

==BMS Quarantine==

The Telephony BMS, Data BMS and Misc BMS quarantine pages list issues identified during the supplier file mediation process for your telephony services, data services, and miscellaneous service charges respectively. These issues will only appear if you receive service files (e.g. CDRs, usage feeds etc) directly from your supplier. If you are reselling services through an Emersion Wholesale Service Provider, you may not see any BMS quarantine issues.

===BMS Quarantine Reasons===

The following table lists all BMS Quarantine reasons and the recommended action for each:

{| border="1" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-
|
'''Quarantine Reason'''

|
'''Description'''

|
'''Recommended Action'''

|-
|
No Rate Card Found

|
A Rate Card either does not exist on the Service Plan, or the attached rate card effective date is after the usage record start date.

|
Write Off the record. Alternatively, contact Emersion Support for possible options.

|-
|
Bucketer Called on Records With Rated Records

|
A duplicate usage fault

|
Submit an Emersion Support Ticket to rectify

|-
|
Could not process all Accounts

|
An account was not able to be processed.

|
Submit an Emersion Support Ticket to rectify

|-
|
Duplicate Usage Fault

|
The record received from the supplier satisfies the criteria for a duplicate record

|
Write Off

|-
|
Fatal Exception Thrown

|
Internal Error

|
Emersion to rectify the cause and cleanse the CDR

|-
|
Incorrect Duration Fault

|
Incorrect usage duration found in the record

Emersion maintains an internal exception list that determines which usage items can have 0 duration (e.g. SMS) - usage items not in the exception list are put into quarantine

|
If you believe the usage should be charged, the internal exception list may need to be updated

Submit an Emersion Support Ticket or Write Off

|-
|
Mismatched Service Account Fault

|
Service is in the system but is not owned by you

|
Write Off and make a claim with your service supplier

|-
|
No Accounts to Bill

|
Service is in the system but is not owned by you

|
Write Off and make a claim with your service supplier

|-
|
No Package Available

|
The service is assigned to a Package ID that does not exist in the system.

|
Submit an Emersion Support Ticket to rectify

|-
|
No Tariff Found

|
The billing system is unable to allocate a tariff to apply the charge

|
Submit an Emersion Support Ticket to add the missing tariff and then cleanse

|-
|
No Valid Package Period

|
The service exists in the system but the Package Period is outside the usage date

|
Submit an Emersion Support Ticket to change the package periods and then cleanse

|-
|
No Valid Service Sub Period

|
The service exists in the system but the Service Period is outside the usage date

|
Submit an Emersion Support Ticket to change the service periods and then cleanse.

|-
|
No Valid Service Subscription Period

|
The service exists in the system but the Service Period is outside the usage date

|
Submit an Emersion Support Ticket to change the service periods and then cleanse.

|-
|
Non Existent Service Fault

|
Service usage data has been received from the supplier that contains charges but the Service could not be located in the system.

Also see '''Non Existent Service Fault - Common Reasons''' below
|
Add the Service to the appropriate account and then cleanse

|-
|
Non Existent Tariff Key Fault

|
The billing system is unable to allocate a tariff to the usage to apply a charge

|
Submit an Emersion Support Ticket to add the missing tariff and then cleanse.

Emersion do add many tariffs a couple of times a month. Have a look through [[New Tariffs]] too see if your tariff key has been added.

If asking Emersion to add a tariff, you'll need to obtain appropriate information from your carrier to enable us to correctly allocate this new tariff to the correct location within the tariff tree. For example: Providing a sample destination number called, country/location, and possibly a similar tariff ID that you believe is similar may help in this identification.

|-
|
Obsolete Usage Fault

|
The usage is in excess of the service supplier’s back billing threshold (usually 180 days)

|
Write Off and make a claim with your service supplier

|-
|
Product Does Not Exist

|
Product is not found for the miscellaneous charge received from the supplier

|
Add the Product in the system and then cleanse

|-
|
Unmatched Withdrawal Fault

|
A Withdrawal record cannot be matched to the original CDR

|
Investigate with supplier then Cleanse or Write Off

|}

=== Non Existent Service Fault - Common Reasons===
On of the most common quarantine reasons is the Non Existent Service Fault. The most common reasons for this type of fault is as follows;

Also see [[Quarantine/Non Existent Service]]

* A Package subscription at one or more tiers is not active.
* A service subscription at one or more tiers is not active.
* A service at one more tiers is not active
* The service is end dated.
* The start date on the package subscription, the service subscription, the service, or the service identifier does not cover the date of the usage.
* The service identifier does not match that of the service identifier which the carrier has sent through.
* The Service Identifier is end dated.
* The service type category of the service does not match that service type category on the mediated tariff.

===To View BMS Quarantine Records===

# Select '''Billing''' > '''Quarantine '''from the '''Menu.''' The ''Quarantine ''page will appear showing the ''BMS Usage Telephony Quarantine'' page by default.
# To view quarantine information for your telephony services, select the '''Telephony BMS''' tab. The ''BMS Usage Telephony Quarantine'' page will appear.
# To view quarantine information for your data services, select the '''Data BMS''' tab. The ''BMS Usage Data Quarantine'' page will appear.
# To view quarantine information for miscellaneous service charges (e.g. telephony products etc), select the '''Misc BMS''' tab. The ''BMS Usage Misc Quarantine'' page will appear.

----
'''Note:''' The Telephony BMS, Data BMS and Misc BMS quarantine pages all look the same and operate in the same manner.
----

'''Search'''

You can locate BMS quarantine records by using the ''Search'' function. The following fields can be used to search for records:

* Quarantine ID the system generated quarantine record ID
* Batch number the system generated batch file number
* Carrier Name the service supplier
* Date Filtering No Date Filtering, Date Updated, or Date Released
* From allows date selection per the ''Date Filtering'' option via a Calendar tool
* To allows date selection per the ''Date Filtering'' option via a Calendar tool
* Service Identifier the service’s unique identifier, such as the phone number
* Batch File name as received from the supplier
* Carrier File Type dependant on the ''Carrier Name'' option selected
* Tariff Key the tariff key of the usage record
* Status All, Quarantine, Cleansed, Completed, Withdrawn, Write off, or Pending
* Quarantine Reason see the ''BMS Quarantine Reasons'' table above.

===To Process records in BMS Quarantine===

# After reviewing the quarantine records and determining the required action, locate the required records in the list on the ''BMS Usage Telephony Quarantine ''page, the ''BMS Usage Data Quarantine'' ''BMS ''page, or the'' Usage Telephony Quarantine'' page. Use the search fields as required.
# Tick the check box beside each required record in the list.
#:To select all records on the current page of the list, tick the check box in the column heading row. All recorded will be ticked.
# Select the required action to update the selected records in the ''Update To'' drop list, which is located below the list of records.
# Click the '''Submit''' button. The system will update the selected records and display a message at the top of the page showing the records have been updated.

The Actions and their results are as follows:

{| border="1" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-
|
'''Action'''

|
'''Result'''

|-
|
Cleansed

|
You have made the necessary changes in the system to resolve the issue. The record will be marked as ready to be re-processed by the billing and rating engine, which will place the charge on the appropriate account’s invoice.

|-
|
Action Pending

|
Places the item into a ''pending'' status. This can be used to mark the record as being actioned where it may take a few days for you to resolve the issue.

|-
|
Write off

|
The record will be flagged in the system as not billed and ignored by the billing and rating engine. These records will appear in the write off report.

|-
|
Quarantined

|
Leaves the record in the list for further investigation.

|}

===See also===
* [[Quarantine/Non Existent Service]]
* [[Rating_Quarantine|Rating Quarantine]]
* [[InvoiceProcess|Rating, Billing and Invoice Process]]

Products/Create Product

2019-07-12T03:21:59Z

Dcowan: added info on product instance import

= Overview =

This article guides users on how to create a product in Emersion.

== Create a Product ==

To create a product in Cumulus, follow the steps below.

'''Nav: Product > Product Management'''

Click the '''Create New Product''' button. The New Product screen will be displayed.

[[File: Create-product.png|1200px|Creating a new product]]

# Choose a ''Product Type'' from the drop list. ('''Mandatory''')
# Select a ''Product Category'' from the drop down list. ('''Mandatory''')
# Select the ''Product Subcategory'' from the drop down list.
# Enter the ''Product Name''. ('''Mandatory''')
# Enter a ''Description'' for the product. ('''Mandatory''')
# By default, the ''Use Default Ledger Code'' check box will be ticked. This will assign the default product ledger code to this product when it is sold. This ledger code is recorded in the resulting cardline. If you wish to assign a different ledger code, uncheck the box and select the correct ''Custom default ledger code'' to use, or enter a new ledger code in the ''New Ledger Code'' text box.
# If this product will be serialised, or if you wish to use the product inventory to track the sale of product instances, tick both the ''Inventory'' checkbox AND the ''Is Serialised'' checkbox.
## Note: In addition to having a product with the ''Is Serialsed'' flag enabled, you will also be required to [https://resources.emersion.com/display/EKB/Product+Inventory+Import|import serial numbers] (product instances) if you wish to sell this product via the instalment purchase method.
# If the product being sold allows fractional values (such as hours, square meters or alike) check the ''Allow Fractional Quantity''. Note this is not applicable to serialised products.
# The ''Notify Upon Paid Purchase'' flag, if checked, will send an email notification to a nominated recipient when this item is sold under an instalment plan and the final instalment has been paid. This function relies on the [[Event| '''Notify Upon Paid Purchase''' event]] to be enabled. If a template is set up, but the event is not enabled, no notification will be sent.
# The ''Can Assign Service'' option gives service providers a way to relate a product and a service. For example, a 4G service and a SIM. Or a DSL service and a modem. Service providers can make these relationships mandatory or optional.
##'''Products of type 'Credit' cannot be linked to services - as such this field will be hidden if you select product type Credit. Additionally, this field requires an account feature - please contact Emersion Support if you wish to enable this.'''
# Enter the manufacturer of the product.
# Choose a colour of the product, if applicable.
# Enter the model of the product.
# If you would like to include a product image, press the '''Choose File''' button, find your image and upload it here. Product Images will display as thumbnails in the Products list under '''Product Management''' and also in the Order process where the [[PackagePlans/Advanced/Product_Order_Map|product is mapped to a Package Plan]].
# Enter a ''Stock Keeping Unit (SKU)''. ('''Mandatory''' since Dec 2018)
# Enter a Supplier Name, if applicable.
# Enter a Supplier Product ID, if applicable.
# Choose a barcode type from the list of options, if applicable.
# Enter the number of the barcode, if applicable.

When you are happy with the product information, press '''Create Product'''. To cancel without saving, click the '''Back''' button.

Once the product is saved, the page will refresh to the Product details page.

==Editing a Product==

# From the main Product List page, click the ''Product ID'' of the product you want to change. The main page of the product will be displayed in read mode.
# Click the '''Edit''' button to put the product into Edit mode.
# Change the product information as needed.
# Click the '''Save '''button. An information box showing the product has been saved will be shown to the user.

= See Also =
* [[Credit_Products|Credit Products]]
* [[SystemEvents/Templates | Event templates]]
* [[ProductPricing|Product Pricing]]
* [[ProductCategoriesAndSubCategories|Product Categories and Sub Categories]]
* [[ProductPurchase|Create Purchase]]
* [[OutrightPurchase|Outright Purchase]]
* [[InstallmentPlan|Installment Plan]]
* [[PurchaseManagement|Purchase Management]]
* [http://wiki.emersion.com/wiki/index.php/ProductManagement/Serialized_SIM_Management Serialised SIM Management]

PackagePlans/PackagePlans

2019-05-15T06:50:27Z

Dcowan: clarified Bill Months in Advance

{{DISPLAYTITLE:Package Plans}}
{{DISPLAYTITLE:Creating Package Plans}}
= Overview =
A package plan is one of several billing objects used in Emersion.

This article covers how to create a package plan.

If you would like to understand what the package plan is and how it works with other Emersion billing objects, see our [https://resources.emersion.com/display/EKB/The+Emersion+Billing+Objects Introduction to Emersion's Billing Objects article].
== Prerequisites ==
You can create a package plan on its own as an independent object. But it cannot be subscribed to by a customer until the following prerequisites are met:

* The service plan(s) are linked to the package plan.
* The service Plan(s) are in a ''saleable'' state.
* The plan has a product rate card linked that is in a saleable state
* Rate cards have at least 1 rate and are in a saleable state (for telephony plans only)
* The Data Billing tab has been configured (for data plans)
* Package Plans and service plans (both BUY and SELL) are all linked together.

This article's scope is limited to creating the package plan. Other articles cover the other steps above. See the links at the bottom of this page for assistance in these tasks.

= Package Plan Searching =
Package Plans are created and maintained in Cumulus via the following path

Nav: '''Packages and Plans > Management > Package Plans'''

When the page loads, the following screen will appear listing all package plans that have been created.

[[File:Package-plan-list.png|1200px|The Package Plan List Screen]]

= Create a Package plan =
To create a new Package Plan, click the '''Create New''' button. The following page will be displayed.

[[File:Package-plan-create-new.png|1200px|The ''Create a New Package Plan'']]

There are 3 columns of settings. Complete all fields as required.

; Name : The internal name for the Package. This name is only visible in Cumulus.

; External Name : This is the External Name for the Package. This is what is printed on customer's invoices if ledger cardlines (eg Package Plan Access Fees), related to this Package, are created.

; Description : An optional description for the Package. Internal use only

; Reference Name : A way of providing a link to an External 3rd party. This could be represented as the name of a prior billing system if one existed. The field is entirely optional.

; Reference Key : A way of providing a link to an External 3rd party. This may be the name of this plan, as it existed in the old system if this were the case. This field is entirely optional.

; Buy or Sell : Indicates whether this is a Buy Plan or a Sell Plan. Please see the [[#Buy_and_Sell_Plans | Buy and Sell Plans]] section above for further information.

; Default Contract Type : Defines the default Contract that will be created when this Package is sold to downstream Customers. For a Contract to appear here, this Package must be part of a Contract Pool. Due to this, when initially creating a Package Plan, only the default Option, 'None' will be available. For more information on contract types & their configuration, please click [[PackagePlans/Contract|here]].

; Customer Contract Required : Indicates whether a mandatory physical customer contract document must be uploaded during the Order Confirmation & Finalise page. If this is enabled, you MUST upload a physical customer contract. If disabled, it is not mandatory to upload a physical customer contract. Not to be confused with 'Default Contract Type' above which refers to the contract instance that is created when an order is completed.

== Package Plan Fee Setup ==

; Setup Fee : The fee charged when a Subscription of this Package is created.
; Access Fee : A Rental or Service fee generated each period for the life of the Package Subscription.

Please be aware of both the '''Override''' tick boxes and also the note: ''Where a package access fee is not empty, it will override any service plan access fees that are defined''. It's possible to define a Setup Fee and an Access Fee at both the Package Plan and Service Plan level. If either the Access Fee or Setup Fee (or both) are empty, with the Override button unchecked, the system will create the Access Fees based on the attached Service Plans.

If the override button is ticked but no value is entered, please note that $0 will be saved (so effectively, you are creating a $0 plan).

; Period Length : The Period length defines how far in advance (or arrears) the system will generate access fees. It also defines how frequently the access fees are created.

; Periods in Advance : determines how many PERIODS in advance the system should generate Access Fees. By default, it's set to 1. In other words, generate the access fee for a period when that period starts. In a real world example, if you have a Package that bills monthly and the date is 01/03/2011, it will generate access fees for 01/03/2011 to 31/03/2011 on 01/03/2011.If you set that value to 2 on a plan whose period length is 1 month, it would generate access fees for the period 01/04/2011 to 30/04/2011 on 01/03/2011. This works irrespective of the period length, so if you have 6 or 12 months periods on a Package with a 'Periods in Advance' setting of anything higher than 1, your customers will receive Package Access Fees well in advance of the current Period.

; Enable package subscription access fee overrides : Checking this flag enables subscribers to the plan to be given a different package plan access fee than the default access fee. This fee override is applied at the package subscription for the customer. A default package plan access fee must be set for any override to be applied. This flag cannot override service plan fees.

; Honour First Period End Date if Set : This setting permits a user (who is granted the relevant power) to set the end date of the first package subscription period when the package is activated during the [[Semi_Manual_Provisioning | Semi manual provisioning]] phase. This is designed for service providers who wish to control both the start date of the service (service activation date) and control when the first period will lapse separately. It requires a subscription to the feature '''Set first period end date'''. If you would like to enquire regarding this feature, please raise a sales ticket in the [https://resources.emersion.com/display/EKB/Getting+Support+and+Help+from+Emersion Emerson Support Portal].

; Bill Access Fees in : Specifies if you are billing access fees in arrears or in advance.

; Bill Months in Advance: Specifies how many months prior to the start of the next period you generate a cardline. The total periods billed is determine by the '''Periods in Advance''' setting.

To clarify the difference between Periods in Advance and Bill Months in Advance, it can be thought of in the following way
* Periods in Advance refers to how many periods you are going to bill when the cardline is generated.
* Bill Months in Advance is when you are going to bill.
In other words, Periods in Advance refers to the volume of periods you are going to bill, and Bill Months in Advance refers to how far in advance, or "when", you are going to bill these periods.

For example, imagine you have:

<li> A monthly account invoice period </li>
<li> Periods Length is 3 months. </li>
<li> Periods in Advance is set to 2.</li>
<li> Bill Access Fees is set to: Advance </li>
<li> Bill in Advance is: 2 months. </li>

In this example, today is the 1st of April, and the subscription is to start on the 1st of May.
In this case what will happen is that because you are billing access fees 2 months in advance, the cardline will be generated today, on the 1st of April, not on the 1st of May.
In addition, because you are billing 2 periods in advance, both periods 3 months in length each, the cardlines generated will cover the next *six* months in advance.

; Pro Rata : Determines whether or not the first set of Access Fees generated for this plan will be pro-rated. The 'Pro Rata' setting will also determine whether Period adjustment credits will be produced in the event that the period is adjusted for any reason. Period adjustment will generally be due to a package cancellation effective as of mid period. This setting is ignored for periods that have been billed in advance; they will be credited back regardless.

; Align Pkg Period to Invoice Period : This flag will align any newly created package subscriptions to this package plan to the underlying account invoice period of the given customer. This will ensure all access fees and usage fees are aligned to when an invoice is rendered. It is important to note that overriding this setting at this point may conflict with the account level setting [[Account/AccountCreation#Wizard_Screen_1:_Data_Definition | Align Pkgs to Account]], producing undesirable billing results. You must be certain you wish to over ride this setting when creating a new package plan. This setting may also impact the ability of the
For example, a package bundle comprising month-to-month billing for an ADSL service and web hosting. These services will align to the underlying account invoice period nicely, as they are billed monthly. However if the package plan also contains a Domain Registration service (for 1 year, 2 years, or 3 years), it is not desirable for this to be aligned to the customer's account invoice period.

; Created date : The date the service plan was initially created.

; Created by : Displays the user who created the plan.

; Date modified : Displays the date when the last modification was made to the service plan.

; Modified by : Displays the name of the user who last updated the service plan's.

; Saleable from : The date from which the plan is or was available to order.

; Saleable to : After this date passes, a plan is unavailable to the orders screens.

; Approval status : Status of the plan.
* Draft - Initial state for when the plan is being set up.
* Pending - The plan has been set up but needs review and is not ready for sale.
* Approved - The plan has been approved and is ready for sale.
* Saleable - the plan is able to be sold
* Grandfathered - the plan is no longer used. There maybe customers with active subscriptions on this plan, but it cannot be sold.

; Saleable in Signup Portal : Enable to allow this package plan to be visible in the [[End User Portal and Customer Sign Up Portal|End User Signup Portal]].

= See Also =
* [[PackagePlans/LinkingPackageAndServicePlans|Linking Package Plans and Service Plans]]
* [[PackagePlan/Advanced | Package Plans - Advanced features and functions]]

API/Services/PurchaseProduct

2019-05-02T07:32:46Z

Dcowan: added createimmediateinvoice notes

===Purchase Product===

'''Purpose'''
This method is used to create a product purchase on behalf of an existing client. This call supports creating pending cardline items for charging to next invoice.
For Products of type Credit, please enter a negative quantity.

'''Inputs'''
<nowiki>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api" xmlns:urn1="urn:emersion:types">
<soapenv:Header/>
<soapenv:Body>
<urn:PurchaseProducts>
<urn:AccountID>?</urn:AccountID>
<urn:ShoppingCart>

<urn1:PurchaseItem>
<urn1:ProductID>?</urn1:ProductID>
<urn1:Quantity>?</urn1:Quantity>
<urn1:ExTaxPrice>?</urn1:ExTaxPrice>
<urn1:Tax>?</urn1:Tax>
<urn1:Note_Details>?</urn1:Note_Details>
<urn1:Note_Customer_Visible>?</urn1:Note_Customer_Visible>
</urn1:PurchaseItem>
</urn:ShoppingCart>
<urn:DeliveryAddress>
<urn1:PrimaryAddressID>?</urn1:PrimaryAddressID>
<urn1:Address ID="?">
<urn1:IsPrimary>?</urn1:IsPrimary>
<urn1:Details/>
<urn1:NearestCrossStreet>?</urn1:NearestCrossStreet>
<urn1:Country>?</urn1:Country>
<urn1:FormattedAddress>?</urn1:FormattedAddress>
<urn1:IsValidated>?</urn1:IsValidated>
<urn1:Type>?</urn1:Type>
<urn1:DateFrom>?</urn1:DateFrom>
<urn1:DateTo>?</urn1:DateTo>
<urn1:GnafPid ID="?">?</urn1:GnafPid>
<urn1:DPID>?</urn1:DPID>
<urn1:Barcode>?</urn1:Barcode>
<urn1:ExternalReferences>

<urn1:ExternalReference Type="?">?</urn1:ExternalReference>
</urn1:ExternalReferences>
<urn1:UploadSource>?</urn1:UploadSource>
<urn1:UploadSourceRef>?</urn1:UploadSourceRef>
<urn1:ImportIdentifier>?</urn1:ImportIdentifier>
<urn1:LastUpdated>?</urn1:LastUpdated>
</urn1:Address>
</urn:DeliveryAddress>
<urn:CreateImmediateInvoice>?</urn:CreateImmediateInvoice>
</urn:PurchaseProducts>
</soapenv:Body>
</soapenv:Envelope>
</nowiki>

'''Important notes'''
* ''ProductID'' needs to be the ID of the Product in the Emersion system
* ''Quantity'' has to be non-zero and an integer
* ''ExTaxPrice'' and Tax are floating point numbers however tax is optional – a sale can be tax free.
* ''CreateImmediateInvoice'' defaults to 1 (and therefore attempts to create an immediate invoice if no Pending invoices exist).

'''Example Validation Error'''
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode>
<faultstring>Validation Error</faultstring>
<faultactor>http://emersion.com.au/Services</faultactor>
<detail>Invalid or Missing Account ID</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>

'''Output'''

<SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://emersion.com.au/ServiceObjects">
<SOAP-ENV:Body>
<ns1:PurchaseProductResponse>
<ns1:AccountID>399301</ns1:AccountID>
<ns1:InvoiceID/>
<ns1:Cardlines/>
</ns1:PurchaseProductResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

'''Error Strings'''

* Invalid or Missing Account ID

* Could not find Account ID!

* You do not have permission to modify this Account

* No items have been provided to purchase in transaction.

* Cart item missing mandatory ProductID

* Cart item missing mandatory quantity

* Product purchase failed with an exception: '.$e->getMessage());

The following errors can only occur if a Delivery Address is provided.

* Provided Primary Address ID does not exist in system

* Primary Address ID should be Integer

* Missing Primary Address Post Code from Delivery Address

* Post Code should consist of 4 digits

* Post Code should contain digits only

* Missing Primary Address Suburb from Delivery Address

* Missing Primary Address Street Name from Delivery Address

* Missing Primary Address Street Name from Delivery Address

* Missing Primary Address Street Type ID from Delivery Address

* Invalid Value for Street Type ID (means that Street Type ID does not exist in the system)

* Street Type ID should be Integer

* Missing Primary Address Lot Number from Delivery Address

* Missing Primary Address Unit Number from Delivery Address

* Missing Primary Address State from Delivery Address

* Invalid Value for State (means that State ID does not exist in the system)

* State should be Integer

* Missing Primary Address Level from Delivery Address

* Missing Primary Address Level Type ID from Delivery Address

* Invalid Value for Level Type ID (means that Level Type ID does not exist in the system)

* Level Type ID should be Integer

* Missing Primary Address Unit Type ID from Delivery Address

* Invalid Value for Unit Type ID (means that Unit Type ID does not exist in the system)

* Unit Type ID should be Integer

* Missing Primary Address P.O. Box Number from Delivery Address

* Missing Primary Address Site Name from Delivery Address

* Missing Primary Address Street Type Suffix ID from Delivery Address

* Invalid Value for Street Type Suffix ID (means that Street Type Suffix ID does not exist in the system)

* Street Type Suffix ID should be Integer

Data Import/Import Inventory

2019-04-03T04:58:38Z

Dcowan:

{{DISPLAYTITLE: Product Inventory}}
=This Content Has Moved House=

This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base.

We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to out new home.

[https://resources.emersion.com/display/EKB/Product+Inventory+Import Take me to the Emersion Knowledge Base article]

[[file:new_home_sm.jpg|900px]]

API/Services/TokeniseCreditCard

2019-03-17T23:17:34Z

Dcowan: apaprently code wrong. reverted Amex string back. See DE-3420

Quarantine/Rating Quarantine

2019-03-15T00:21:57Z

Dcowan: added stuff

==Rating Quarantine==

Rating quarantine lists all rating, billing and invoicing issues identified by the Billing and Rating engine other than those identified during the supplier file mediation process by the BMS process.

===Rating Quarantine Reasons and Error Codes===

The following table lists all Rating Quarantine reasons and the recommended action for each:

{| border="1" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000; padding: 0"
|-
|
'''Quarantine Reason'''

|
'''Description'''

|
'''Recommended Action'''

|-
|
Invalid Service Type

|
The Service Type is not set correctly for the usage data received from the supplier

|
Submit an Emersion Support Ticket to rectify

|-
|
Missing Service Subscription

|
Service exists in the system but the Service Subscription is missing

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid Package Period

|
The service exists in the system but the Package Period is outside the usage date

|
Submit an Emersion Support Ticket to change the package periods and then cleanse

|-
|
Invalid Rounding Type

|
The underlying Service Plan setup is incorrect

|
Submit an Emersion Support Ticket to rectify

|-
|
Rating Failed – Unknown Reason

|
Internal Issue

|
Emersion to rectify the cause and cleanse

|-
|
Invalid Carrier Cost

|
A missing or invalid carrier cost is found in the record where one should exist

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid Usage Hierarchy

|
Internal Issue

|
Emersion to rectify the cause and cleanse

|-
|
Missing Rate Card

|
A Rate card has not been allocated to Service Plan

|
Add a Rate Card to the required service plan and then cleanse

If you need to backdate the usage, submit an Emersion Support Ticket to assist

|-
|
Missing Rate

|
Although the Rate Card exists in the system, no rate is found for this tariff

|
Add a Rate appropriate Rate Card and then cleanse

|-
|
Invalid Rate

|
An error has been detected in the rate configuration.

|
Review the rate card configuration. 
The most common cause is a "markup" rate profile configured with no markup. This is not possible in the user interface and is usually the result of a bad rate import. 
If attempting to "pass through" a rate from a carrier (or upstream supplier), ensure your rate profile is Markup and the rate is 0%.

If required, submit an Emersion Support Ticket to assist

|-
|
Bolting Failed – Unknown Reason

|
Internal Issue

|
Emersion to rectify the cause and cleanse

|-
|
Invalid Bolt On

|
Bolt on type is not valid for the Service Plan

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid Bolt On Subscription

|
Bolt on subscription exists in the system but the bolt on has been removed

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid Bolt On – Markup Set On Underlying Rate

|
Internal Issue

|
Submit an Emersion Support Ticket to rectify

|-
|
Charging Failed – Unknown Reason

|
Internal Issue

|
Emersion to rectify the cause and cleanse

|-
|
Invalid Charging Attribute

|
An invalid charging attribute was detected

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid Charging Attribute – Mark-up Set on Underlying Rate

|
Internal Issue

|
Submit an Emersion Support Ticket to rectify

|-
|
Invoicing Failed – Unknown Reason

|
Internal Issue

|
Emersion to rectify the cause and cleanse

|-
|
Invalid Cap Attribute

|
The Plan Cap has not been set however the Rate Card has capped tariffs

|
Add the required Cap amount to the Plan and then cleanse

|-
|
Invalid MaxType Cap Attribute – Mark-up Set on Underlying Rate

|
Internal Issue

|
Submit an Emersion Support Ticket to rectify

|-
|
Invalid MaxType Cap Attribute

|
Mismatched cap type was detected (e.g. tariff is in seconds but the Cap type is KB)

|
Correctly set the Cap Max type attribute and then cleanse

|}

===To View Rating Quarantine Records===

# Select '''Billing''' > '''Quarantine '''from the '''Menu.''' The ''Quarantine ''page will appear.
# Click the '''Rating''' tab on the ''Quarantine'' page. The ''Rating Quarantine'' page will appear.

Note that the page may take a few moments to appear.

'''Search'''

You can locate Rating quarantine records by using the ''Search'' function. The following fields can be used to search for records:

* Quarantine ID the system generated quarantine record ID
* Service Identifier the service’s unique identifier, such as the phone number
* Call Date From allows date selection via a Calendar tool
* Call Date To allows date selection via a Calendar tool
* Batch File Number the system generated batch file number
* Batch File name as received from the supplier
* Tariff Key the tariff key of the usage record
* Status see the ''Rating Quarantine Reasons'' table above

===To Cleanse Records in Rating Quarantine===

Once you, or the Emersion Billing Operations team, have made the necessary changes in the system to resolve the issue, the ''Rating Quarantine'' record must be updated as cleansed so it is marked as ready to be re-processed by the billing and rating engine, which will place the charge on the appropriate account’s invoice.

# After reviewing the quarantine records and correcting the issues, locate the required records in the list on the ''Rating Quarantine'' page. Use the search fields as required.
# Tick the check box beside each required quarantine record in the list.
#:To select all records on the current page of the list, tick the check box in the column heading row. All recorded will be ticked.
# Click the '''Cleanse''' button. The system will update the selected records and display a message at the top of the page showing the records have been cleansed.

The records will now be ready to be re-processed by the billing and rating engine.

===See also===
* [[BMS_Quarantine|BMS Quarantine]]
* [[InvoiceProcess|Rating, Billing and Invoice Process]]

API/Services/TokeniseCreditCard

2019-03-14T03:04:43Z

Dcowan:

'''Purpose '''

This allow customer to store credit card in to EPS and generate token for a secure way of making / requesting payment.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:TokeniseCreditCardRequest>
<ser:TokeniseCreditCard account_id="511596" card_type="Visa" card_name="Customer Name" card_number="4444333322221111" card_expiry="6/2015" card_cvv="123" automated_payment_configuration="1" />
</ser:TokeniseCreditCardRequest>
</soapenv:Body>

'''Description'''

Required attribute:
* automated_payment_configuration = Type positive integer option:
** 1 = One off payment (Default).
** 2 = One off payment and set as default payment.
** 3 = Set as default payment and enable recurring charges.
* account_id = Type positive integer
* Card_type = Type Option
** Visa
** MasterCard
** Amex
** Diners
* card_name = Type string at least 1 character
* card_number = Type string must be a valid card credit card number based on the card_type
* card_expiry = Type date format mm/YYYY
* card_cvv = Type non negative integer

'''Output'''
<SOAP-ENV:Body>
<ns1:TokeniseCreditCardResponse>
<ns1:CreditCardTokenResponse>
305889725747721480112620601729009174294547589547C
</ns1:CreditCardTokenResponse>
</ns1:TokeniseCreditCardResponse>
</SOAP-ENV:Body>

'''Error String'''

148.Payment gateway has not been initialised

149.Required TokeniseCreditCard' element

150.Invalid account ID ['.$requestDetails->account_id.'].

151.Account provided is not currently active.

152.Required credit card type

153.Required credit card number

154.Required credit card holder name

155.Required credit card expiry date

156.Credit Card provided expired.

157.Invalid credit card expiry date

158.Required credit card security number / cvv

159.Credit card type ['.$requestDetails->card_type.'] is currently not supported. Please try another card.

160.Invalid Credit Card Details.

161.Unable to process credit card. '.$request->getError());

API/Services/TokeniseCreditCard

2019-03-14T02:44:22Z

Dcowan: corrected American Express string value - code does not support "American Express" - rather "AMEX"

'''Purpose '''

This allow customer to store credit card in to EPS and generate token for a secure way of making / requesting payment.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:TokeniseCreditCardRequest>
<ser:TokeniseCreditCard account_id="511596" card_type="Visa" card_name="Customer Name" card_number="4444333322221111" card_expiry="6/2015" card_cvv="123" automated_payment_configuration="1" />
</ser:TokeniseCreditCardRequest>
</soapenv:Body>

'''Description'''

Required attribute:
* automated_payment_configuration = Type positive integer option:
** 1 = One off payment (Default).
** 2 = One off payment and set as default payment.
** 3 = Set as default payment and enable recurring charges.
* account_id = Type positive integer
* Card_type = Type Option (''not case sensitive'')
** Visa
** MasterCard
** Amex
** Diners
* card_name = Type string at least 1 character
* card_number = Type string must be a valid card credit card number based on the card_type
* card_expiry = Type date format mm/YYYY
* card_cvv = Type non negative integer

'''Output'''
<SOAP-ENV:Body>
<ns1:TokeniseCreditCardResponse>
<ns1:CreditCardTokenResponse>
305889725747721480112620601729009174294547589547C
</ns1:CreditCardTokenResponse>
</ns1:TokeniseCreditCardResponse>
</SOAP-ENV:Body>

'''Error String'''

148.Payment gateway has not been initialised

149.Required TokeniseCreditCard' element

150.Invalid account ID ['.$requestDetails->account_id.'].

151.Account provided is not currently active.

152.Required credit card type

153.Required credit card number

154.Required credit card holder name

155.Required credit card expiry date

156.Credit Card provided expired.

157.Invalid credit card expiry date

158.Required credit card security number / cvv

159.Credit card type ['.$requestDetails->card_type.'] is currently not supported. Please try another card.

160.Invalid Credit Card Details.

161.Unable to process credit card. '.$request->getError());

Semi Manual Provisioning

2019-03-01T01:35:59Z

Dcowan: added some clarity on chown/upgrade

== Emersion Semi Manual Provisioning ==

Semi Manual Provisioning is used for service types configured to be "provisioned" by either an upstream account (for example: a wholesale account) or by the same service provider account. This is useful in scenarios where services can be ordered in Cumulus ahead of time and then activated with a carrier at a later time. It can also be used in backdating scenarios whereby services are already active with a carrier.

NAV: '''Services > Manual Provisioning'''

Different service transfer types are supporter by the manual provisioning page as follows;
* [[Services/Orders|CHOWN / UPGRADE]] (Manage Provisioning --> Activate)
* NEW (Manage Provisioning --> Activate)
* CANCEL (Manage Provisioning --> Finalise Cancellation)
* MIGRATE (Manage Provisioning --> Finalise Migration)

'''Note''': For CHOWN & UPGRADE the manual provisioning ''Service Start Date'' date picker will not allow backdating a service to a date that falls within a '''closed''' source package subscription ''period''. You must complete your backdated CHOWN or UPGRADE
----

For service types that have been set up with the semi-manual provisioning type in Emersion, the semi-manual provisioning process is:

1. The Retail Service Provider ('RSP') creates an order for a new service for a customer in Cumulus. Alternatively if the RSP subscribes to the Customer Sign Up portal, the end user themselves may create & submit the order.

If the RSP orders a service from a Wholesaler who is an Emersion Wholesale Service Provider ('WSP'):
*a) Order is received by the Wholesale Service provider and appears in '''Services > Manual Provisioning'''.
*b) The WSP views the order, checks the details, and updates any details as required.
*c) The WSP performs manual provisioning actions with their service provider/supplier as required, outside of the Emersion system.
*d) Once order is complete, the WSP activates the service using the Emersion '''Manual Provisioning''' page.

If the RSP orders a service directly from the Service Supplier, Carrier or a Wholesale Service Provider who is not in Emersion:
*a) The order appears in '''Services > Manual Provisioning''' within the RSP account.
*b) The RSP views the order, checks the details, and updates any details as required.
*c) The RSP performs manual provisioning actions with their service provider/supplier as required, outside of the Emersion system.
*d) Once order is complete, the RSP activates the service using the Emersion '''Manual Provisioning''' page.

Once these steps are complete, the service will be activated and billing of the service to the Customer/End User (customer of the Retail Service Provider) will commence. The Customer/End User will see the service as Active if they log into Emersion via Cumulus or the End User Portal, which ever is appropriate for the customer.

If the provisioning request cannot be completed, Emersion now allows the Wholesaler to mark the order as '''Provisioning Halted'''. This will then update the order and service status so the Customer can see the details. The Customer may then re-submit the provisioning request, if appropriate.

== Marking an Order as Provisioning Halted ==

To mark a service as Provisioning Halted:
'''Navigate: Services > Manual Provisioning'''.
The Services where a provisioning action is required will be displayed. This page shows all orders submitted that require manual provisioning.

[[File:manual-provisioning-landing.png]]

Locate the order that is required to be halted and click the '''Manage Provisioning''' link in the list. The Manage Provisioning page will be displayed.

[[File:manual-provisioning-manage-provisioning.png]]

Click the Mark Provisioning as Halted button. The Mark Semi Manual Provisioning as Halted page will be displayed.

Enter the details of why the provisioning request could not be completed in the Rejection Details text box. This information will appear to the downstream customer (i.e. RSP).

Click the '''Save''' button. A message will appear at the top of the page confirming that the provisioning has been halted.

Account/Account Status

2019-02-22T02:55:11Z

Dcowan:

{{DISPLAYTITLE:Account Status Information}}
== Account Status ==
{| class="wikitable"
|+Account Status
|Status ID ||Name ||Description
|-
|1 ||Active ||An Active account is one that is being used actively or regularly by the Customer. Permissions not withstanding, there are no limitations on access to features or functionality for these accounts.
|-
|2 ||Inactive ||The account is not active. '''Will not bill and cannot order services'''.
|-
|3 ||Cancelled ||The account is cancelled and will not be reactivated. Ready for archiving. '''Will not bill and cannot order services'''.
|-
|4 ||Restricted by Parent ||The parent service provider has placed restrictions on the downstream service provider. Restrictions cannot be removed or altered by the downstream service provider. Functions that are limited are primarily around ordering services and product purchases. '''Cannot order services'''.
|-
|5 ||Suspended ||Limits access to some functions for the customer, but preserving its content and configuration. Can be done by either the parent service provider or by automated means. '''Cannot order services'''.
|-
|6 ||Preactive ||Not yet active and has never been active in the past. The customer account has been partially completed but the minimum requirements for an Active account have not been met. '''Will not bill and cannot order services'''. (This is an internal status used by the system and cannot be selected.)
|-
|7 ||System Suspended ||The account is suspended by Emersion. Will not bill and cannot order services. (This is an internal status used by the system and cannot be selected.)
|-
|8 ||Suspended - Billing and Ordering ||The account is suspended. '''Will not bill and cannot order services'''.
|}

Late Fees will apply to Statuses (1,4,5,6)

== Account Status Reason ==

When changing an account status, you may want to include a reason for the change. The following options are available.

{| class="wikitable"
|+Account Status Reason
|Status ID ||Name
|-
|1 ||Account closure
|-
|2 ||Non-payment
|-
|3 ||Other
|-
|4 ||Credit Limit Exceeded
|-
|5 ||Unbilled Credit Limit Exceeded
|-
|6 ||Debt Collection - Pending
|-
|7 ||Debt Collection - Submitted
|-
|8 ||Invalid or Missing Contact Details
|-
|9 ||Invalid or Missing Phone
|-
|10 ||Invalid or Missing Address
|-
|11 ||Referred to Legal
|-
|12 ||Payment Plan
|-
|13 ||Contract Breach
|-
|14 ||Legal Action in Progress
|-
|15 ||Administrator Appointed
|-
|18 ||Liquidator Appointed
|-
|}

Products/Purchases/Instalment Plans

2019-02-20T03:02:08Z

Dcowan: clarity on create invoice

Note: Creating an instalment purchase plan for a product that is not [[Products/Serialised Products|serialised]] is NOT SUPPORTED. 
If the product that you wish to sell under an instalment plan does not have legitimate "serial numbers", you may [[Data Import/Import Inventory|import]] / create fake ones to use. For example: MYPRODUCT0001, MYPRODUCT0002, MYPRODUCT0004, etc.

==To Create an Instalment Plan==
[[File:installment.jpg|500px|thumb||The ''instalment Plan'' page]]
# '''Purchases > Add New Purchase > Instalment Plan'''. The ''Instalment Plan'' area will appear showing additional fields and information.
# Select the required ''Product Category'' from the drop list.
# Select the required ''Product'' from the drop list. The product price will display in the ''Base Price'' field.
# Tick the ''Use Product Ledger Code'' tick box to assign the sale to the product ledger code set up in the product details.
# If you wish to assign the sale to another ledger code, un-tick the ''Use Product Ledger Code'' check box. The ''Custom Ledger Code'' drop list will be enabled. Select the required ledger code from the drop list.
# In the ''Instalment Plan Configuration'' section, select the ''Instalment Offcycle Payment Handling'' method required in the drop list. This option controls how the system processes customer payments that are made outside of the regular billing cycle.
#:The options include:
#:* '''Auto Prorata''' - the payment amount is automatically pro-rated resulting in the instalment payment amounts being reduced.
#:* '''Reduce Payments''' - the number of payments may be reduced but the instalment payment amount will remain the same.
#:* '''No Off Cycle Payments''' - off cycle payments are not permitted.
#:* '''Off Cycle payment acts as credit''' - Payments are treated as payment in advance and appear as a credit on the customer's account
# Select the ''Invoicing Method'' required for the first instalment charge cardline(s) from the drop list.
#:The options include:
#:* '''Create Invoice''' - a pending invoice will be created containing the instalment setup charge cardline only once the instalment plan purchase is confirmed (If a pending invoice already exists on the account, a new instalment purchase will NOT create a new invoice - rather it will create pending cardline(s) only)
#:* '''Next Invoice''' - a pending cardline will be created for the both the instalment setup and first instalment charge cardline
# If the product has been provided to the customer:
## Select ''Product supplied, payment to begin immediately'' form the drop down list. The ''Serial / Product Instance Code'', ''Product Instance Description'' and ''First instalment Date'' fields will be enabled for entry - but are not mandatory, especially for [[Products/Serialised Products|Serialised]] where you will select the serial (product instance) from your current inventory
## ''(optional)'' Enter the product's serial number or other unique ID (e.g. IMIE etc) in the ''Serial / Product Instance Code '' field.
## ''(optional)'' Enter the description in the ''Product Instance Description'' field.
## ''(optional)'' Enter the date the first instalment of the plan is due in the ''First Instalment Date'' field. A calendar tool will appear to allow you to select the required date. The '''start date''' of the instalment plan needs to be considered as future card lines will be created based on the first instalment date: You need to control the first instalment purchase transaction date by setting the '''First Instalment Date''' field either forward or backward, depending on when you are trying to get a cardline to generate, From there, each subsequent instalment will be ''n'' frequency forward of that date (this depends on the ) For example; - Create a new product instalment purchase today - 11/Feb/2019 - Set the '''First Instalment Date''' to 1/Feb/2019 (backdate) - The system will generate a cardline for the 1st instalment amount today - transaction date will be 1/Feb/2019 - The system will then generate the 2nd instalment transaction as at 1/March/2019 and a cardline will generate on 1/March/2019 - The system will then continue generating transaction (and associated cardlines) on this same frequency until the instalment purchase is finished

#: Note : The instalment plan processing will not commence until the product has been provided to the customer. You can use the ''View / Manage instalment Plan'' function to update the details after the instalment plan has been saved.
# Select a pricing method to apply to the product from the ''Instalment Pricing Method'' option radio buttons. The system provides a variety of methods to calculate the final product total and instalment payment amounts based on a several attributes as follows:
#:* Specify markup percentage, total amount of instalments, and the instalment period length
#:* Specify markup percentage, amount per instalment, and the instalment period length
#:* Specify total cost, total amount of instalments, and the instalment period length
#:* Specify total cost, amount per instalment, and the instalment period length.
# Depending on the ''instalment Pricing Method'' option selected, the system will enable or disable the ''instalment Details'' fields. The product ''Base Price'' will display showing the original base price, which cannot be modified.
#:*For the ''Specify markup percentage, total amount of instalments, and the instalment period length ''and'' Specify markup percentage, amount per instalment'' ''and the instalment period length'' pricing methods, enter the markup percentage in the ''Markup'' field. For no markup, you can leave the value as zero (0).
#:*For the ''Specify markup percentage, total amount of instalments, and the instalment period length ''and the ''Specify total cost, total amount of instalments, and the instalment period length'' pricing methods, enter the number of instalments for the plan in the ''Total instalments'' field. The system will automatically create the specified number of payment instalments on the subsequent customer's invoices until the instalment plan is complete.
#:*For the ''Specify markup percentage, amount per instalment'' ''and the instalment period length'' and the ''Specify total cost, amount per instalment, and the instalment period'' ''length'' pricing methods, enter the amount of each instalment payment in the ''Charge per instalment'' field. The system will automatically create the payment instalments of the entered amount on the subsequent customer's invoices.
#:*For the ''Specify total cost, total amount of instalments, and the instalment period length ''and the ''Specify total cost, amount per instalment, and the instalment period'' ''length'' pricing methods, enter the total cost for the product including any additional fees or charges in the ''Final Cost for instalment Plan'' field. The system will use this figure to calculate each payment instalment amount.
# Select the frequency of the instalment payments from the ''instalment Period Length ''drop list. Options include 1, 3, 6, 9, 12, 18, 24 and 36 months.
# Click the '''Continue''' button. The ''Purchase'' page will display showing all details of the instalment plan entered.
# This is where you will select a serial from your available inventory. This is the only supported method for creating an instalment purchase.
# Click on the '''Search Serials''' button and select an appropriate serial. Click '''Select'''. This will automatically populate Serial Number field.
## If your product has the ''Can assign service'' flag set to either Mandatory or Optional, you may select the service to link to from the 'Active Service' field.
## Enter a product instance date and an appropriate description.
# Review all information on this page to confirm it is correct. If you need to modify anything, please click '''Modify'''
# When ready to create the instalment plan, click the '''Create Instalment Purchase''' button. A message will display at the top of the screen showing "Instalment Plan created".

= See Also =
* [[Product/Product Purchases|Product Purchases]]
* [[Products]]

Products/Purchases/Instalment Plans

2019-02-18T03:28:55Z

Dcowan: just some formatting changes and minor corrections

Note: Creating an instalment purchase plan for a product that is not [[Products/Serialised Products|serialised]] is NOT SUPPORTED. 
If the product that you wish to sell under an instalment plan does not have legitimate "serial numbers", you may [[Data Import/Import Inventory|import]] / create fake ones to use. For example: MYPRODUCT0001, MYPRODUCT0002, MYPRODUCT0004, etc.

==To Create an Instalment Plan==
[[File:installment.jpg|500px|thumb||The ''instalment Plan'' page]]
# From the ''Purchase Type'' page, select the ''instalment Plan'' option. The'' Instalment Plan'' area will appear showing additional fields and information.
# Select the required ''Product Category'' from the drop list.
# Select the required ''Product'' from the drop list. The product price will display in the ''Base Price'' field.
# Tick the ''Use Product Ledger Code'' tick box to assign the sale to the product ledger code set up in the product details.
# If you wish to assign the sale to another ledger code, un-tick the ''Use Product Ledger Code'' check box. The ''Custom Ledger Code'' drop list will be enabled. Select the required ledger code from the drop list.
# In the ''Instalment Plan Configuration'' section, select the ''Instalment Offcycle Payment Handling'' method required in the drop list. This option controls how the system processes customer payments that are made outside of the regular billing cycle.
#:The options include:
#:* Auto Prorata - the payment amount is automatically pro-rated resulting in the instalment payment amounts being reduced.
#:* Reduce Payments - the number of payments may be reduced but the instalment payment amount will remain the same.
#:* No Off Cycle Payments - off cycle payments are not permitted.
#:* Off Cycle payment acts as credit off cycle - payments are treated as payment in advance and appear as a credit on the customer's account
# Select the ''Invoicing Method'' required for the first instalment from the drop list.
#:The options include:
#:* Create Invoice - a pending invoice will be created containing the first instalment once the instalment plan purchase is confirmed
#:* Next Invoice - a pending cardline will be created for the first instalment to be processed at the next bill run
# If the product has been provided to the customer:
## Select ''Product supplied, payment to begin immediately'' form the drop down list. The ''Serial / Product Instance Code'', ''Product Instance Description'' and ''First instalment Date'' fields will be enabled for entry - but are not mandatory, especially for [[Products/Serialised Products|Serialised]] where you will select the serial (product instance) from your current inventory
## ''(optional)'' Enter the product's serial number or other unique ID (e.g. IMIE etc) in the ''Serial / Product Instance Code '' field.
## ''(optional)'' Enter the description in the ''Product Instance Description'' field.
## ''(optional)'' Enter the date the first instalment of the plan is due in the ''First Instalment Date'' field. A calendar tool will appear to allow you to select the required date. The '''start date''' of the instalment plan needs to be considered as future card lines will be created based on the first instalment date: You need to control the first instalment purchase transaction date by setting the '''First Instalment Date''' field either forward or backward, depending on when you are trying to get a cardline to generate, From there, each subsequent instalment will be ''n'' frequency forward of that date (this depends on the ) For example; - Create a new product instalment purchase today - 11/Feb/2019 - Set the '''First Instalment Date''' to 1/Feb/2019 (backdate) - The system will generate a cardline for the 1st instalment amount today - transaction date will be 1/Feb/2019 - The system will then generate the 2nd instalment transaction as at 1/March/2019 and a cardline will generate on 1/March/2019 - The system will then continue generating transaction (and associated cardlines) on this same frequency until the instalment purchase is finished

#: Note : The instalment plan processing will not commence until the product has been provided to the customer. You can use the ''View / Manage instalment Plan'' function to update the details after the instalment plan has been saved.
# Select a pricing method to apply to the product from the ''Instalment Pricing Method'' option radio buttons. The system provides a variety of methods to calculate the final product total and instalment payment amounts based on a several attributes as follows:
#:* Specify markup percentage, total amount of instalments, and the instalment period length
#:* Specify markup percentage, amount per instalment, and the instalment period length
#:* Specify total cost, total amount of instalments, and the instalment period length
#:* Specify total cost, amount per instalment, and the instalment period length.
# Depending on the ''instalment Pricing Method'' option selected, the system will enable or disable the ''instalment Details'' fields. The product ''Base Price'' will display showing the original base price, which cannot be modified.
#:*For the ''Specify markup percentage, total amount of instalments, and the instalment period length ''and'' Specify markup percentage, amount per instalment'' ''and the instalment period length'' pricing methods, enter the markup percentage in the ''Markup'' field. For no markup, you can leave the value as zero (0).
#:*For the ''Specify markup percentage, total amount of instalments, and the instalment period length ''and the ''Specify total cost, total amount of instalments, and the instalment period length'' pricing methods, enter the number of instalments for the plan in the ''Total instalments'' field. The system will automatically create the specified number of payment instalments on the subsequent customer's invoices until the instalment plan is complete.
#:*For the ''Specify markup percentage, amount per instalment'' ''and the instalment period length'' and the ''Specify total cost, amount per instalment, and the instalment period'' ''length'' pricing methods, enter the amount of each instalment payment in the ''Charge per instalment'' field. The system will automatically create the payment instalments of the entered amount on the subsequent customer's invoices.
#:*For the ''Specify total cost, total amount of instalments, and the instalment period length ''and the ''Specify total cost, amount per instalment, and the instalment period'' ''length'' pricing methods, enter the total cost for the product including any additional fees or charges in the ''Final Cost for instalment Plan'' field. The system will use this figure to calculate each payment instalment amount.
# Select the frequency of the instalment payments from the ''instalment Period Length ''drop list. Options include 1, 3, 6, 9, 12, 18, 24 and 36 months.
# Click the '''Continue''' button. The ''Purchase'' page will display showing all details of the instalment plan entered.
# This is where you will select a serial from your available inventory. This is the only supported method for creating an instalment purchase.
# Click on the '''Search Serials''' button and select an appropriate serial. Click '''Select'''. This will automatically populate Serial Number field.
## If your product has the ''Can assign service'' flag set to either Mandatory or Optional, you may select the service to link to from the 'Active Service' field.
## Enter a product instance date and an appropriate description.
# Review all information on this page to confirm it is correct. If you need to modify anything, please click '''Modify'''
# When ready to create the instalment plan, click the '''Create Instalment Purchase''' button. A message will display at the top of the screen showing "Instalment Plan created".

= See Also =
* [[Product/Product Purchases|Product Purchases]]
* [[Products]]

Products/Serialised Products/Product Instance Locking

2019-02-14T06:50:46Z

Dcowan: added clarity oin product instance unlock power

{{DISPLAYTITLE: Product Instance Locking}}
= Overview =

This feature is used by two processes in Emersion
* [[Services/Orders|Orders]]
* [[Main_Page/Provisioning/Service_Type_Migrate|Service Type Migration]]

For this article only, the term 'order' is used to refer to both an [[Services/Orders|order for a service]] and a [[Main_Page/Provisioning/Service_Type_Migrate|service type migration]].

When an order is commenced and the order includes a product that is [[serialised]], the process reserves a product instance once the service qualification (SQ) has been performed. The SQ is the second step when commencing a order in Emersion, either via the [https://resources.emersion.com/display/EKB/The+Sign+Up+Portal Sign Up portal] or in Cumulus.

Whilst the product instance is reserved, or 'locked', another order can not be allocated that particular product instance. This locking activity occurs to allow an order to progress to submission without another user unknowingly 'stealing' the product instance for their own order which can lead to a less than desirable experience for both the user and/or the end user customer.

[[File:Product-instance-lock-sq.png|1200px|The Service Qualification page that reserves a SIM until the order is submitted]]

Should a product instance be unavailable in the order process, users should check to see if the product instance is currently locked. Product instances are not released back into the product inventory for re-use automatically. Locked product instances will remain locked until they are unlocked manually by a user.

Users can view locked product instances at the '''Products > Product Lock''' page.

[[File:Product-instance-lock-main.png|1200px|A list of product instances that have been locked]]

= Unlock a Product Instance =

Note: You're logged in user must have the ''Can Unlock Product Instance'' power enabled.

From the '''Products > Product Lock''' page:

# Search for your instance identifier (otherwise known as "serial")
# Click the '''Force Unlock''' link.
# '''Confirm''' or '''Cancel''' the action.

Upon unlocking the product instance the screen will refresh and the product instance will again be available.

= See Also =
* [[Services/Orders|Orders]]
* [[Main_Page/Provisioning/Service_Type_Migrate|Service Type Migration]]

ServicePlans/ServicePlans

2019-02-13T07:07:58Z

Dcowan: corrected links

{{DISPLAYTITLE:Service Plans}}

== Introduction ==
[[File:PlanMap.png|thumb]]
A ''Service Plan'' is a billing object that is used to control billing for a single service. Service Plans are bound to [[Service Types|''Service Types'']]. Service Plans are also then linked to [[PackagePlans/PackagePlans|Package Plans]]. A Service Plan may be attached to multiple Package Plans

Depending on the ''Service Type'' of the particular Service Plan, a Service Plan may have the following objects attached to it:

* [[ServicePlans/RateCard|Rate Card]] - A list of rates and call costs for available call types per Service Type
* Product Rate Card - A list of additional products and rates that can be turned on and off against a Service. These vary from Service Type to Service Type
* Bolt-on - A bolt-on is a way of providing bonus features (ie 50 free local calls, or free data) to a particular service without having to produce new Rate Cards.
* Data Billing - See [[ServicePlans/Data]] for Volume, Time & Rolling 30 Day data usage configuration

An instance of a Service Plan that is sold to a customer is referred to as a ''Service Subscription''.

== Buy and Sell ==
As with [[PackagePlans/PackagePlans|Package Plans]], Service Plans can either be created as ''Buy'' or ''Sell'' Plans. A ''Buy'' Service Plan must be linked with a Buy Package Plan, and a ''Sell'' Service Plan must be linked to a Sell Package Plan.

For further information on Buy and Sell Plans, please see the [[PackagePlans/LinkingPackageAndServicePlans|Linking Package Plans and Service Plans]] article.

== Managing Service Plans ==

Service Plans are managed through Cumulus via '''Packages and Plans > Management > Service Plans'''.
[[File:ServicePlans_List.jpg|500px|center|The Package Plan List Screen]]

As with Package Plans, the list page provides a basic search functionality and also offers the ability to Create a New Service Plan.

== Creating a New Service Plan ==

To create a new Service Plan:

1. Click on '''Create New'''. 
2. Select a Service Type. The service type will affect services can be added and also provisioning. 
:'''IMPORTANT: Please note that once you have chosen a service type and saved the service Plan, you will not be able to go back and change this. Please ensure that the correct service type is chosen before continuing. '''

[[File:ServicePlans_CreateNew_ChooseServiceType.jpg|500px|center|The first stage in creating a Service Plan]]

3. Once you have chosen the new Service Type desired, click '''Continue'''. You will be taken to a new page where you will be able to configure the Service Plan's basic settings.

== Basic Settings for a Service Plan ==

''Please note that All prices here are '''exclusive''' of tax.

The basic settings on a service plan are sectioned into three columns. Further settings are contained in sub-tabs underneath the basic settings. Access to the various sub-tabs for a service plan is determined in two ways:

# From your Emersion Customer Licence Agreement - this defines what features and modules you can access. 
# Which Service type the service plan is for - some sub tabs are only relevant for certain service types. 

Contact the team at Emersion via the [http://support.emersion.com.au Emersion Support Portal] if you need to enquire about access to these tabs.

[[file: New_Service_Plan_Basic_Settings.png]]

---------
'''Left Column Settings'''
; Name : The internal name for the service plan.
; External Name : This is the external (or customer-facing) name for the Service Plan. It is used on the customer's invoices when ledger card lines (e.g. Service Plan Access Fees), related to this service plan, are created. It is also the name of the plan used in the End User Portal.
; Reference Name : A way of providing a link to an external 3rd party system. This could be represented as the name of a prior billing system if one existed. The field is optional.
; Reference Key : A way of providing a link to an External 3rd party. This may be the name of this plan, as it existed in the old system if this were the case. This field is optional.
; Description : An optional description for the service plan. Internal use only.
; Buy or Sell : Indicates whether this is a BUY plan or a SELL plan. Please see the [[PackagePlans/PackagePlans#Buy_and_Sell_Plans|Buy and Sell Plans]] section for further information.

---------
'''Centre Column Settings'''
; Service Type : Will reflect the Service Type that the plan will belong to. Note that this cannot be changed once it is set.
; Period Length : The Period length defines how far in advance (or arrears) the system will generate access fees, as well as how far in arrears the system should bill for usage. It also defines how frequently the access fees are created.
; Period Requires Approval Before Closing : When flagged this will prevent the billing period from automatically closing. [[ServicePlans/Periods/ApprovingPeriods | Learn more about this setting here]].
; Enable service subscription access fee overrides : Checking this flag enables subscribers to the plan to be given a different service plan access fee than the default access fee. This fee override is applied at the service subscription for a customer. A default service plan access fee must be set for any override to be applied. Be aware that any fees set on the package plan will take precedence and void this override.
; Rounding Type : Where usage is rated, the system can round in the following 3 ways:
* Round Up - All figures are rounded up, so a value of '3.1' would become 4.
* Round Down - All figures our rounded down, so 3.1 would be come 3.
* Round Half-Up - The system will round as per accepted mathematical convention. A figure of 3.4 would be rounded down to 3, where as a figure of 3.5 or above would round up to 4.
; Rounding Precision : Defines the number of decimal places to which usage will be rated. The default is 7 - in that usage will be rounded to 7 decimal places. For more information on rounding precision, click [[ServicePlans/Data/RoundingPrecision|here]].
; Setup Fee : The fee charged when a new subscription for this service plan is set up for a customer.
; Churn/Port Service Setup Fee : A fee charged when an existing service is migrated to (or churned from) this service plan.
; Access Fee : A recurring fee generated each billing period for the life of the service subscription.

Please be aware that if this Service Plan is linked to a Package Plan that has Access and/or Setup Fees set, the system will ignore the value set up at the Service Plan Level in favour of the fees set at the Package Plan. For further information on this, please see the [[PackagePlans/PackagePlans#Fee_Setup|Fees section]] on the Package Plans Page.

---------
'''Right Column Settings'''

; Created date : The date the service plan was initially created.
; Created by : Displays the user who created the plan.
; Date modified : Displays the date when the last modification was made to the service plan.
; Modified by : Displays the name of the user who last updated the service plan's.
; Saleable from : The date from which the plan is or was available to order.
; Saleable to : After this date passes, a plan is unavailable to the orders screens.
; Approval status : Status of the plan.
* Draft - Initial state for when the plan is being set up.
* Pending - The plan has been set up but needs review and is not ready for sale.
* Approved - The plan has been approved and is ready for sale.
* Saleable - the plan is able to be sold
* Grandfathered - the plan is no longer used. There maybe customers with active subscriptions on this plan, but it cannot be sold.

== Other Service Plan Settings ==

* [[ServicePlans/ServicePlans/Included Value|Included Value (also known as 'Caps')]]
* [[ServicePlans/ServicePlans/Properties | Properties]]
* [[ServicePlans/ServicePlans/ServiceFeeMultiplier | Service Fee Multiplier]]

=See Also=
* [[Account_Management/Customer_Screen/Service_Subscriptions|Service Subscriptions]]

ServicePlans/ServicePlans/ServiceFeeMultiplier

2019-02-13T07:06:00Z

Dcowan: Replaced content with "Moved to Emersion Knowledge Page --> https://resources.emersion.com/pages/viewpage.action?pageId=32867197"

Moved to Emersion Knowledge Page --> https://resources.emersion.com/pages/viewpage.action?pageId=32867197

Main Page

2019-02-07T06:39:10Z

Dcowan:

{{DISPLAYTITLE:'''Welcome to the Emersion Software Systems Wiki'''}}

This repository is used to provide education on Emersion's billing and provisioning system, Emersion concepts and online help to all Emersion's users regarding all of the features and functions available to you.

The Emersion Wiki is updated regularly to reflect the latest changes to the system. New and updated articles (and videos) are appearing every week. Therefore we encourage you to visit this wiki on a regular basis and subscribe to updates.

If there is a section of the system of which you would specifically like further information about, please contact our [[Support and help from Emersion|support team]].

== NEW RESOURCES SITE ==

Emersion intends to eventually replace the Emersion Wiki where our documentation is presently published and has commenced migrating the content from the wiki to this knowledge base.

===[https://resources.emersion.com https://resources.emersion.com]===

With this knowledge base that seamlessly integrates with the Emersion Service Desk, users of Emersion will be able to gain faster access to a solution and relevant search results helping you solve issues faster than before. Users will generally find articles easiest by searching, and using the topic navigation on the homepage and end of each article, rather than navigating through a tree-like page hierarchy.

Our Release Notes has taken on new life with a new blog format and fortnightly publishing of what's gone live in the last two weeks. Be sure to check them out.

== Announcements ==
Emersion is pleased to advise our customers that we have released a significant set of enhancements to invoice templates in order to give service providers new layout and configuration options. [https://resources.emersion.com/display/EKB/2017/11/21/Announcement+-+Invoice+Templates Check out the details here].

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">

=== Emersion Knowledge Base News ===
====[https://resources.emersion.com https://resources.emersion.com]. ====
* Looking for help for Invoice Templates? [[Main_Page/2017_EKB/invoice_templates| Read more here...]]
* Logging in to the Emersion Knowledge Base [[Main_Page/2017_EKB/Authentication| Read more here...]]
* We have begin shifting to our new Emersion Knowledge Base. [[Main_Page/2017_EKB|Read more here...]]


</td>
<td width="33.33%" align="left" valign="top">


=== SUPPORT ===
* [https://resources.emersion.com/display/EKB/New+Tariffs+Added See the latest updates to our Tariff Lists]


</td>
<td width="33.33%" align="left" valign="top">


=== TRAINING ===
* [https://resources.emersion.com/display/EKB/Training Go here for all your training needs]

</td>
</tr>

<tr colspan=3>
<td>

=== RELEASE NOTES ===

* [[ReleaseNotes|See what's new in the latest update of Emersion]]

</td>
</tr>

</table>

== Core Emersion Modules ==
<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">

* [[Admin|Admin Settings]]
** [https://resources.emersion.com/display/EKB/Permissions Permissions Management]
* [[Account Management | Customer and Account Management]]
** [[Account Management/Customer Screen | The Customer Screen]]

'''Billing Objects'''
* [https://resources.emersion.com/display/EKB/The+Emersion+Billing+Objects An Introduction to all the Emersion Billing Objects]
* [[Service_Types|Service Types]]
* [[PackagePlans/PackagePlans|Package Plans]]
* [[ServicePlans/ServicePlans|Service Plans]]
* [[ServicePlans/RateCard|Rate Cards and Rates]]
** [[ServicePlans/RateCard/Creating_Rate_Cards|Maintaining Rate Cards and Rates]]
* [[Services | Services]]
* [[Products|Products]]


</td>
<td width="33.33%" align="left" valign="top">

* [[Invoicing|Invoicing]]
* [[Billing_Cheat_Sheet|The Billing Cheat Sheet]]
* [[Ledger_Management|Ledger Management]]

</td>
<td width="33.33%" align="left" valign="top">


* [[Services/Orders | Ordering services]]
* [[Account_Management/Customer_Screen/Service_Subscriptions|Service Subscriptions]]
* [[Main_Page/Provisioning|Provisioning]]
* [[Quarantine|Quarantine]]
* [https://resources.emersion.com/display/EKB/Events Events]
* [https://resources.emersion.com/display/EKB/Reports Reports]
* [https://resources.emersion.com/display/EKB/Bulk+Import+and+Processing+Tools Bulk Import]

</td>
</tr>
</table>

== Optional Modules ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">

* [[Account Management/Auto Top-up | Automated Top-up]]
* [[Agent Management |Agents]]
* [[Cost_Centres|Cost Centres]]
* [[Commissions|Commissions]]
* [[EPS|Electronic Payments]]
* [[Inventory and Warehouses | Inventory and Warehouses]]

</td>
<td width="33.33%" align="left" valign="top">

* [[Payments/Manual_Payment_Batch | Manual Payment Batch]]
* [[Payment Plans V2 | Payment Plans]]
* [[Service Desk|Service Desk]]
* [[Early Upgrade|Early Upgrades]]
* [https://resources.emersion.com/display/EKB/Staff+Credit+Levels Credit Levels for Staff Users]
* [[Product_Rate_Cards/Access_Fee_Discount|Access Fee Discounts based on volume]]

</td>
<td width="33.33%" align="left" valign="top">

* [[API | Emersion APIs]]


* External Portals
** [https://resources.emersion.com/display/EKB/The+End+User+Portal End User Portal]
** [https://resources.emersion.com/display/EKB/The+Sign+Up+Portal Sign Up Portal]]
** [[Main_Page/Provisioning/Service_Type_Migrate/Service_Activation_Portal|Service Activation Portal]]

</td>
</tr>
</table>

== Integration ==
* [[Integrations|Integration with Other Applications]] (eg. Xero, ZenDesk)
* [[Integrations/Postal Integration Invoice Delivery|Postal Invoices and Integration for Invoice delivery to mail houses]]

== References ==
* [[Reference|Reference Material]]
* [[Glossary|Glossary of Terms and Abbreviations]]
* [[Media:Emersion_SIR_User_Manual_(CDR,_DDR_Format)_v3.0.pdf|Emersion SIR User Manual (v3.0)]]

== Training and Consulting Services ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">

Training

Main Emersion training page now located on our new knowledge page - https://resources.emersion.com/display/EKB/Training

* [[Emersion User Manuals|Emersion User Manuals]]
* [[Emersion Training Slides|Training Slides]]
* [[Emersion Videos|Training Videos]]


</td>
<td width="33.33%" align="left" valign="top">

Consulting Services
* [[Consulting_Services/Package_Plans | Package Plan Consulting]]

</td>
<td width="33.33%" align="left" valign="top">  
</td>
</tr>

<tr>
<td>   </td>
<td>   </td>
<td>   </td>
</tr>

</table>

== Additional Help ==

* [[Support and help from Emersion|If you need Support from Emersion, start here]]
* [[Emersion Invoice Reconciliation|How to Reconcile Emersion's Invoice to you]]

== Carrier & Service Supplier information ==
This section contains infomation relevant to specific service suppliers and carriers that are popular in Emersion.

=== Emersion IP Addresses ===
* [https://resources.emersion.com/display/EKB/Emersion+IP+Addresses Emersion IP addresses for carrier white lists (inc SPF)]

=== Optus ===
* [[Optus Usage collection | Optus RBT and Optus Multiline]]
[[file:Emersion Optus RBT Service Management System Manual v1.2.pdf]] 
[[file:Emersion Optus RBT Wholesaler Appendix v1.0.pdf]] 

=== Telstra ===
* [[Telstra_NBN|Telstra NBN]]
* [[file:Emersion Telstra eBill Manual V1.0.pdf]] 
* [[file:Emersion Telstra 3G Manual V0.1.pdf]] 
* [[file:Emersion Telstra Mobile Management User Manual v1.0.pdf]] 

=== AAPT ===
[[file:Emersion AAPT DSL Manual V2.0.pdf|Emersion AAPT DSL Manual]] 

* [[AAPT Rebill | AAPT Rebill]]
* [[Broadsoft Softswitch as a Service | AAPT Broadsoft Softswitch as a Service (Voice SSasS) - Semi Manual]]
* [[AAPT_National_Wholesale_Broadband_L3 | AAPT National Wholesale Broadband L3 (Broadband Connect) Layer 3]]
* [[AAPT IP-Line | AAPT IP-Line]]

Main Page/Provisioning

2019-02-07T06:35:39Z

Dcowan: removed IP infom and moved to confluence

{{DISPLAYTITLE:Provisioning}}

This section contains information regarding the provisioning of services. It's important to understand that different service types are provisioned in different ways.

Some types of services can be fully automatically provisioned, meaning Emersion and the Service Supplier/Carrier have system integration for the provisioning and management of services. Other types of services are partially integrated, meaning there is some support for some activities related to services, but not all actions are supported. Others must be manually provisioned in separate systems (Telstra LOLIG, AAPT FrontierWeb, etc) and then updated in Emersion once the provisioning activity is completed.

The following topics contain relevant information to provisioning commonly used service types in Emersion:

* [[Semi Manual Provisioning]]

== IP Addresses for Carrier White lists ==

Moved to https://resources.emersion.com/display/EKB/Emersion+IP+Addresses

== Troubleshooting and other provisioning articles ==

[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/NoPlans_AfterSQ No ADSL Plans Visible After SQ]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/PSTN_Preselect_Provisioning_Workflow PSTN Preselect Provisioning Workflow]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning//Telstra_3G_Provisioning_Errors Telstra 3G Provisioning Errors]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/AAPT_DSL_Provisioning_Errors#Common_AAPT_DSL_Provisioning_Errors_and_how_to_handle_them AAPT DSL Provisioning Errors And How To Handle Them]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/3G_Portin_Process#Telstra_3G_Port_In_Process/3G_Portin_Process Telstra 3G Port In Process]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/3G_Portout_Process Telstra 3G Port Out Process]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/3G_New_Cancel_Process Telstra 3G Processes for New and Cancellations]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/Checking_Daily_Event_Files Checking Daily Event and Status Files for status of PSTN Churns - AAPT]
 
[[Provisioning/AutomaticSuspensionAndRestriction|Automatic Suspension or Restriction of Accounts and Services]]

Main Page/Provisioning

2019-02-04T02:20:20Z

Dcowan: typo

{{DISPLAYTITLE:Provisioning}}

This section contains information regarding the provisioning of services. It's important to understand that different service types are provisioned in different ways.

Some types of services can be fully automatically provisioned, meaning Emersion and the Service Supplier/Carrier have system integration for the provisioning and management of services. Other types of services are partially integrated, meaning there is some support for some activities related to services, but not all actions are supported. Others must be manually provisioned in separate systems (Telstra LOLIG, AAPT FrontierWeb, etc) and then updated in Emersion once the provisioning activity is completed.

The following topics contain relevant information to provisioning commonly used service types in Emersion:

* [[Semi Manual Provisioning]]

== IP Addresses for Carrier White lists ==

Often carriers and service suppliers who need to send Emersion usage files (such as CDRs) will need to white list Emersion's IP address range.

The IP addresses are:

* 122.252.151.52
* 122.252.144.52
* 122.252.146.101 (also use this for SPF records where Emersion send mail on your domain's behalf. Eg. <code>v=spf1 ip4:122.252.146.101 ~all</code>)

Further details on creating and modifying your SPF record can be found at: http://www.openspf.org/SPF_Record_Syntax

== Troubleshooting and other provisioning articles ==

[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/NoPlans_AfterSQ No ADSL Plans Visible After SQ]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/PSTN_Preselect_Provisioning_Workflow PSTN Preselect Provisioning Workflow]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning//Telstra_3G_Provisioning_Errors Telstra 3G Provisioning Errors]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/AAPT_DSL_Provisioning_Errors#Common_AAPT_DSL_Provisioning_Errors_and_how_to_handle_them AAPT DSL Provisioning Errors And How To Handle Them]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/3G_Portin_Process#Telstra_3G_Port_In_Process/3G_Portin_Process Telstra 3G Port In Process]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/3G_Portout_Process Telstra 3G Port Out Process]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/3G_New_Cancel_Process Telstra 3G Processes for New and Cancellations]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/Checking_Daily_Event_Files Checking Daily Event and Status Files for status of PSTN Churns - AAPT]
 
[[Provisioning/AutomaticSuspensionAndRestriction|Automatic Suspension or Restriction of Accounts and Services]]

Main Page/Provisioning

2019-01-17T00:57:20Z

Dcowan: removed confusing notation (guarantee our customer are mostly NOT network engineers)

{{DISPLAYTITLE:Provisioning}}

This section contains information regarding the provisioning of services. It's important to understand that different service types are provisioned in different ways.

Some types of services can be fully automatically provisioned, meaning Emersion and the Service Supplier/Carrier have system integration for the provisioning and management of services. Other types of services are partially integrated, meaning there is some support for some activities related to services, but not all actions are supported. Others must be manually provisioned in separate systems (Telstra LOLIG, AAPT FrontierWeb, etc) and then updated in Emersion once the provisioning activity is completed.

The following topics contain relevant information to provisioning commonly used service types in Emersion:

* [[Semi Manual Provisioning]]

== IP Addresses for Carrier White lists ==

Often carriers and service suppliers who need to send Emersion usage files (such as CDRs) will need to white list Emersion's IP address range.

The IP addresses are:

* 122.252.151.52
* 122.252.144.52
* 122.252.146.101 (also use this for SPF records where Emersion send mail on your domain's behalf. Eg. <code>v=spf1 ip4:122.252.146.101 ~all</code>*)

Further details on creating and modifying your SPF record can be found at: http://www.openspf.org/SPF_Record_Syntax

== Troubleshooting and other provisioning articles ==

[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/NoPlans_AfterSQ No ADSL Plans Visible After SQ]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/PSTN_Preselect_Provisioning_Workflow PSTN Preselect Provisioning Workflow]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning//Telstra_3G_Provisioning_Errors Telstra 3G Provisioning Errors]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/AAPT_DSL_Provisioning_Errors#Common_AAPT_DSL_Provisioning_Errors_and_how_to_handle_them AAPT DSL Provisioning Errors And How To Handle Them]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/3G_Portin_Process#Telstra_3G_Port_In_Process/3G_Portin_Process Telstra 3G Port In Process]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/3G_Portout_Process Telstra 3G Port Out Process]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/3G_New_Cancel_Process Telstra 3G Processes for New and Cancellations]
 
[http://wiki.emersion.com/wiki/index.php/Main_Page/Provisioning/Checking_Daily_Event_Files Checking Daily Event and Status Files for status of PSTN Churns - AAPT]
 
[[Provisioning/AutomaticSuspensionAndRestriction|Automatic Suspension or Restriction of Accounts and Services]]

Products/Create Product

2019-01-15T03:27:39Z

Dcowan: added mandatory text to match the actual UI

= Overview =

This article guides users on how to create a product in Emersion.

== Create a Product ==

To create a product in Cumulus, follow the steps below.

'''Nav: Product > Product Management'''

Click the '''Create New Product''' button. The New Product screen will be displayed.

[[File: Create-product.png|1200px|Creating a new product]]

# Choose a ''Product Type'' from the drop list. ('''Mandatory''')
# Select a ''Product Category'' from the drop down list. ('''Mandatory''')
# Select the ''Product Subcategory'' from the drop down list.
# Enter the ''Product Name''. ('''Mandatory''')
# Enter a ''Description'' for the product. ('''Mandatory''')
# By default, the ''Use Default Ledger Code'' check box will be ticked. This will assign the default product ledger code to this product when it is sold. This ledger code is recorded in the resulting cardline. If you wish to assign a different ledger code, uncheck the box and select the correct ''Custom default ledger code'' to use, or enter a new ledger code in the ''New Ledger Code'' text box.
# If this product will be serialised, or if you wish to use the product inventory to track the sale of product instances, tick the ''Inventory'' checkbox AND the ''Is Serialised'' checkbox.
# If the product being sold allows fractional values (such as hours, square meters or alike) check the ''Allow Fractional Quantity''. Note this is not applicable to serialised products.
# The ''Notify Upon Paid Purchase'' flag, if checked, will send an email notification to a nominated recipient when this item is sold under an instalment plan and the final instalment has been paid. This function relies on the [[Event| '''Notify Upon Paid Purchase''' event]] to be enabled. If a template is set up, but the event is not enabled, no notification will be sent.
# The ''Can Assign Service'' option gives service providers a way to relate a product and a service. For example, a 4G service and a SIM. Or a DSL service and a modem. Service providers can make these relationships mandatory or optional.
##'''Products of type 'Credit' cannot be linked to services - as such this field will be hidden if you select product type Credit. Additionally, this field requires an account feature - please contact Emersion Support if you wish to enable this.'''
# Enter the manufacturer of the product.
# Choose a colour of the product, if applicable.
# Enter the model of the product.
# If you would like to include a product image, press the '''Choose File''' button, find your image and upload it here. Product Images will display as thumbnails in the Products list under '''Product Management''' and also in the Order process where the [[PackagePlans/Advanced/Product_Order_Map|product is mapped to a Package Plan]].
# Enter a ''Stock Keeping Unit (SKU)''. ('''Mandatory''' since Dec 2018)
# Enter a Supplier Name, if applicable.
# Enter a Supplier Product ID, if applicable.
# Choose a barcode type from the list of options, if applicable.
# Enter the number of the barcode, if applicable.

When you are happy with the product information, press '''Create Product'''. To cancel without saving, click the '''Back''' button.

Once the product is saved, the page will refresh to the Product details page.

==Editing a Product==

# From the main Product List page, click the ''Product ID'' of the product you want to change. The main page of the product will be displayed in read mode.
# Click the '''Edit''' button to put the product into Edit mode.
# Change the product information as needed.
# Click the '''Save '''button. An information box showing the product has been saved will be shown to the user.

= See Also =
* [[Credit_Products|Credit Products]]
* [[SystemEvents/Templates | Event templates]]
* [[ProductPricing|Product Pricing]]
* [[ProductCategoriesAndSubCategories|Product Categories and Sub Categories]]
* [[ProductPurchase|Create Purchase]]
* [[OutrightPurchase|Outright Purchase]]
* [[InstallmentPlan|Installment Plan]]
* [[PurchaseManagement|Purchase Management]]
* [http://wiki.emersion.com/wiki/index.php/ProductManagement/Serialized_SIM_Management Serialised SIM Management]

Main Page

2018-11-12T00:02:12Z

Dcowan: added spf for searching

{{DISPLAYTITLE:'''Welcome to the Emersion Software Systems Wiki'''}}

This repository is used to provide education on Emersion's billing and provisioning system, Emersion concepts and online help to all Emersion's users regarding all of the features and functions available to you.

The Emersion Wiki is updated regularly to reflect the latest changes to the system. New and updated articles (and videos) are appearing every week. Therefore we encourage you to visit this wiki on a regular basis and subscribe to updates.

If there is a section of the system of which you would specifically like further information about, please contact our [[Support and help from Emersion|support team]].

== NEW RESOURCES SITE ==

Emersion intends to eventually replace the Emersion Wiki where our documentation is presently published and has commenced migrating the content from the wiki to this knowledge base.

===[https://resources.emersion.com https://resources.emersion.com]===

With this knowledge base that seamlessly integrates with the Emersion Service Desk, users of Emersion will be able to gain faster access to a solution and relevant search results helping you solve issues faster than before. Users will generally find articles easiest by searching, and using the topic navigation on the homepage and end of each article, rather than navigating through a tree-like page hierarchy.

Our Release Notes has taken on new life with a new blog format and fortnightly publishing of what's gone live in the last two weeks. Be sure to check them out.

== Announcements ==
Emersion is pleased to advise our customers that we have released a significant set of enhancements to invoice templates in order to give service providers new layout and configuration options. [https://resources.emersion.com/display/EKB/2017/11/21/Announcement+-+Invoice+Templates Check out the details here].

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">

=== Emersion Knowledge Base News ===
====[https://resources.emersion.com https://resources.emersion.com]. ====
* Looking for help for Invoice Templates? [[Main_Page/2017_EKB/invoice_templates| Read more here...]]
* Logging in to the Emersion Knowledge Base [[Main_Page/2017_EKB/Authentication| Read more here...]]
* We have begin shifting to our new Emersion Knowledge Base. [[Main_Page/2017_EKB|Read more here...]]


</td>
<td width="33.33%" align="left" valign="top">


=== SUPPORT ===
* [https://resources.emersion.com/display/EKB/New+Tariffs+Added See the latest updates to our Tariff Lists]


</td>
<td width="33.33%" align="left" valign="top">


=== TRAINING ===
* [https://resources.emersion.com/display/EKB/Training Go here for all your training needs]

</td>
</tr>

<tr colspan=3>
<td>

=== RELEASE NOTES ===

* [[ReleaseNotes|See what's new in the latest update of Emersion]]

</td>
</tr>

</table>

== Core Emersion Modules ==
<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">

* [[Admin|Admin Settings]]
** [https://resources.emersion.com/display/EKB/Permissions Permissions Management]
* [[Account Management | Customer and Account Management]]
** [[Account Management/Customer Screen | The Customer Screen]]

'''Billing Objects'''
* [https://resources.emersion.com/display/EKB/The+Emersion+Billing+Objects An Introduction to all the Emersion Billing Objects]
* [[Service_Types|Service Types]]
* [[PackagePlans/PackagePlans|Package Plans]]
* [[ServicePlans/ServicePlans|Service Plans]]
* [[ServicePlans/RateCard|Rate Cards and Rates]]
** [[ServicePlans/RateCard/Creating_Rate_Cards|Maintaining Rate Cards and Rates]]
* [[Services | Services]]
* [[Products|Products]]


</td>
<td width="33.33%" align="left" valign="top">

* [[Invoicing|Invoicing]]
* [[Billing_Cheat_Sheet|The Billing Cheat Sheet]]
* [[Ledger_Management|Ledger Management]]

</td>
<td width="33.33%" align="left" valign="top">


* [[Services/Orders | Ordering services]]
* [[Account_Management/Customer_Screen/Service_Subscriptions|Service Subscriptions]]
* [[Main_Page/Provisioning|Provisioning]]
* [[Quarantine|Quarantine]]
* [[:Events|Events]]
* [https://resources.emersion.com/display/EKB/Reports Reports]
* [https://resources.emersion.com/display/EKB/Bulk+Import+and+Processing+Tools Bulk Import]

</td>
</tr>
</table>

== Optional Modules ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">

* [[Account Management/Auto Top-up | Automated Top-up]]
* [[Agent Management |Agents]]
* [[Cost_Centres|Cost Centres]]
* [[Commissions|Commissions]]
* [[EPS|Electronic Payments]]
* [[Inventory and Warehouses | Inventory and Warehouses]]

</td>
<td width="33.33%" align="left" valign="top">

* [[Payments/Manual_Payment_Batch | Manual Payment Batch]]
* [[Payment Plans V2 | Payment Plans]]
* [[Service Desk|Service Desk]]
* [[Early Upgrade|Early Upgrades]]
* [https://resources.emersion.com/display/EKB/Staff+Credit+Levels Credit Levels for Staff Users]
* [[Product_Rate_Cards/Access_Fee_Discount|Access Fee Discounts based on volume]]

</td>
<td width="33.33%" align="left" valign="top">

* [[API | Emersion APIs]]


* External Portals
** [https://resources.emersion.com/display/EKB/The+End+User+Portal End User Portal]
** [https://resources.emersion.com/display/EKB/The+Sign+Up+Portal Sign Up Portal]]
** [[Main_Page/Provisioning/Service_Type_Migrate/Service_Activation_Portal|Service Activation Portal]]

</td>
</tr>
</table>

== Integration ==
* [[Integrations|Integration with Other Applications]] (eg. Xero, ZenDesk)
* [[Integrations/Postal Integration Invoice Delivery|Postal Invoices and Integration for Invoice delivery to mail houses]]

== References ==
* [[Reference|Reference Material]]
* [[Glossary|Glossary of Terms and Abbreviations]]
* [[Media:Emersion_SIR_User_Manual_(CDR,_DDR_Format)_v3.0.pdf|Emersion SIR User Manual (v3.0)]]

== Training and Consulting Services ==

<table class="" style="background-color: transparent; width: 100%">
<tr>
<td width="33.33%" align="left" valign="top">

Training
* [[Emersion User Manuals|Emersion User Manuals]]
* [[Emersion Training Slides|Training Slides]]
* [[Emersion Videos|Training Videos]]


</td>
<td width="33.33%" align="left" valign="top">

Consulting Services
* [[Consulting_Services/Package_Plans | Package Plan Consulting]]

</td>
<td width="33.33%" align="left" valign="top">  
</td>
</tr>

<tr>
<td>   </td>
<td>   </td>
<td>   </td>
</tr>

</table>

== Additional Help ==

* [[Support and help from Emersion|If you need Support from Emersion, start here]]
* [[Emersion Invoice Reconciliation|How to Reconcile Emersion's Invoice to you]]

== Carrier & Service Supplier information ==
This section contains infomation relevant to specific service suppliers and carriers that are popular in Emersion.

=== Emersion IP Addresses ===
* [[Main_Page/Provisioning | Emersion IP addresses for carrier white lists (inc SPF)]]

=== Optus ===
* [[Optus Usage collection | Optus RBT and Optus Multiline]]
[[file:Emersion Optus RBT Service Management System Manual v1.2.pdf]] 
[[file:Emersion Optus RBT Wholesaler Appendix v1.0.pdf]] 

=== Telstra ===
* [[Telstra_NBN|Telstra NBN]]
* [[file:Emersion Telstra eBill Manual V1.0.pdf]] 
* [[file:Emersion Telstra 3G Manual V0.1.pdf]] 
* [[file:Emersion Telstra Mobile Management User Manual v1.0.pdf]] 

=== AAPT ===
[[file:Emersion AAPT DSL Manual V2.0.pdf|Emersion AAPT DSL Manual]] 

* [[AAPT Rebill | AAPT Rebill]]
* [[Broadsoft Softswitch as a Service | AAPT Broadsoft Softswitch as a Service (Voice SSasS) - Semi Manual]]
* [[AAPT_National_Wholesale_Broadband_L3 | AAPT National Wholesale Broadband L3 (Broadband Connect) Layer 3]]
* [[AAPT IP-Line | AAPT IP-Line]]

Reference/IPAddresses

2018-11-12T00:01:41Z

Dcowan: removed invalid character

==Emersion IP Addresses==

To allow Emersion to Access FTP Locations for CDR and other Service Information Records you will need to allow the following IP Addresses access to your systems.

Emersion Production: 
'''122.252.146.101''' (also use this for SPF records where Emersion send mail on your domain's behalf. Eg. <code>v=spf1 ip4:122.252.146.101 ~all</code>) 
'''122.252.151.52'''

Emersion Development: 
'''122.252.144.52'''

﹡ Further details on creating and modifying your SPF record can be found at: http://www.openspf.org/SPF_Record_Syntax

Quarantine/IPND Quarantine

2018-11-08T05:15:53Z

Dcowan: provided link to new error correction document

{{DISPLAYTITLE:IPND Quarantine}}
= Overview =
Subscribers to Emersion's IPND module will have an '''IPND Batch''' quarantine screen. When an address is sent off to the IPND Manager for a particular service, the IP Manager (Currently Australia's IPND Manager is Telstra) may return an address as invalid for a several reasons. This page provides an easy way to identify and correct errors then resubmitting the updated address to the IPND database.

To access this screen:

Nav: '''Billing > Quarantine > IPND Batch'''.

[[File:IPND Navigate.png|1200px|IPND Batch Screen]]

Using the filters, filter on those IPND records that have encountered an error.

[[File:IPND FILTER ERROR.png|1200px|Filtering errors]]

To view the error in more detail, click '''View Error''' on the far-right of the screen. Users can see the errors the IPND Manager is reporting for this address. Be aware that there may be more than one error affecting the record.

[[File:IPND Error.png|1200px|Error for an IPND record]]

Once the error is known, users can navigate to the [[Account_Management/Customer_Screen/Service_Subscriptions|service subscription]] record in question. IPND contacts are stored on the [[Account_Management/Customer_Screen/Service_Subscriptions/Service_Contact|Service Contacts]] tab.

Once the user has updated the service contact, they can mark the IPND Batch record in IPND quarantine. Check the box to the right of the record and select '''Resolve''' and '''submit'''.

[[File:Resolve Resubmit.png|1200px|Resolving an IPND record]]

This will put the the record you just cleansed into the status of ''Pending''. One of two outcomes is possible:
* If the IPND Manger accepts the updated address, a new record will appear in IPND Quarantine with a status of ''IPND Update OK''.
* If the IPND Manager does not accept the updated address, a new record will appear in IPND Quarantine with an error code.

== IPND Error Codes ==
To assist with determining what error has occurred, and how to go about fixing it, Telstra offers an ''IPND Error Correction'' document, as well as other technical documentation and information, at their IPND page - https://www.telstra.com.au/consumer-advice/ipnd

A direct link to IPND Error Correction is available from - https://www.telstra.com.au/content/dam/tcom/personal/consumer-advice/ipnd/data-provider-information-pack/ipnd-error-correction.pdf

= See Also =
* [[Account_Management/Customer_Screen/Service_Subscriptions/Service_Contact|Service Contacts]]

ServicePlans/Telephony/IntraAccountCalling

2018-09-17T04:08:56Z

Dcowan:

Intra Account Calling enables you to create a custom rate for customers with telephony services on the same account.

To activate Intra Account Calling, please contact Emersion for further information.

In summary;

* For a particular usage record, the destination FNN must match;
** An active service identifier under the same end user account (''this generally means the destination service should also be active'')
** An "IntraAccount Discounting Allowed" setting ''Enabled'' on both service plans
** A rate set on the appropriate "Intra Account Calls" tariff on the source subscription's rate card

Example:

{| class="wikitable"
|Service A
|Service B
|-
|FNN: 0399991234
|FNN: 03888884567
|}

{| class="wikitable"
|Service Plan A
|Service Plan B
|-
|Intra Account Discounting is '''Enabled'''
|Intra Account Discounting is '''Enabled'''
|}

{| class="wikitable"
|Rate Card A
|Rate Card B
|-
|Has both a Local Calls rate set (eg. $1), and an Intra Account Calls rate set ($5)
|Has both a Local Calls rate set (eg. $1), and an Intra Account Calls rate set ($5)
|}

* Service A calls Service B
* The system will see this as a local call, however it will also see that the destination matches an active service subscription under the same end user account
* In addition, the system sees that Service Plan B also has the '''Intra Account Discounting Allowed''' setting is ''Enabled'' and as such;
* The system will therefore stamp the final retail rating record with the tariff matching the "Intra Account Calls" tariff setup for the specific tariff as originally identified
* The call will then rate according to the "Intra Account Calls" rate profile ($5 in this example).
** If no rate exists, the system will loop up to the Base Rate (rarely set) and if not found enter rating quarantine with reason ''Invalid Rate''

Note: 
The "Intra Account Calls" tariff maps to 1 or more other normal tariff's within a standard tariff tree for any given carrier / service type category and is initially set by Emersion. 
Please contact Emersion Support if further tariff's are to be included in an Intra Account calling scenario.

ServicePlans/Telephony/IntraAccountCalling

2018-09-17T04:07:54Z

Dcowan:

Intra Account Calling enables you to create a custom rate for customers with telephony services on the same account.

To activate Intra Account Calling, please contact Emersion for further information.

In summary;

* For a particular usage record, the destination FNN must match;
** An active service under the same end user account
** An "IntraAccount Discounting Allowed" setting ''Enabled'' on both service plans
** A rate set on the appropriate "Intra Account Calls" tariff on the source subscription's rate card

Example:

{| class="wikitable"
|Service A
|Service B
|-
|FNN: 0399991234
|FNN: 03888884567
|}

{| class="wikitable"
|Service Plan A
|Service Plan B
|-
|Intra Account Discounting is '''Enabled'''
|Intra Account Discounting is '''Enabled'''
|}

{| class="wikitable"
|Rate Card A
|Rate Card B
|-
|Has both a Local Calls rate set (eg. $1), and an Intra Account Calls rate set ($5)
|Has both a Local Calls rate set (eg. $1), and an Intra Account Calls rate set ($5)
|}

* Service A calls Service B
* The system will see this as a local call, however it will also see that the destination matches an active service subscription under the same end user account
* In addition, the system sees that Service Plan B also has the '''Intra Account Discounting Allowed''' setting is ''Enabled'' and as such;
* The system will therefore stamp the final retail rating record with the tariff matching the "Intra Account Calls" tariff setup for the specific tariff as originally identified
* The call will then rate according to the "Intra Account Calls" rate profile ($5 in this example).
** If no rate exists, the system will loop up to the Base Rate (rarely set) and if not found enter rating quarantine with reason ''Invalid Rate''

Note: 
The "Intra Account Calls" tariff maps to 1 or more other normal tariff's within a standard tariff tree for any given carrier / service type category and is initially set by Emersion. 
Please contact Emersion Support if further tariff's are to be included in an Intra Account calling scenario.

ServicePlans/Telephony/IntraAccountCalling

2018-09-17T03:57:12Z

Dcowan: added a quick summary example - better than the zero we had

Intra Account Calling enables you to create a custom rate for customers with telephony services on the same account.

To activate Intra Account Calling, please contact Emersion for further information.

In summary;

* For a particular usage record, the destination FNN must match;
** An active service under the same end user account
** An "IntraAccount Discounting Allowed" setting ''Enabled'' on both service plans
** A rate set on the appropriate "Intra Account Calls" tariff on the source subscription's rate card

Example:

{| class="wikitable"
|Service A
|Service B
|-
|FNN: 0399991234
|FNN: 03888884567
|}

{| class="wikitable"
|Service Plan A
|Service Plan B
|-
|Intra Account Discounting is '''Enabled'''
|Intra Account Discounting is '''Enabled'''
|}

{| class="wikitable"
|Rate Card A
|Rate Card B
|-
|Has both a Local Calls rate set (eg. $1), and an Intra Account Calls rate set ($5)
|Has both a Local Calls rate set (eg. $1), and an Intra Account Calls rate set ($5)
|}

* Service A calls Service B
* The system will see this as a local call, however it will also see that the destination matches an active service subscription under the same end user account
* In addition, the system sees that Service Plan B also has the '''Intra Account Discounting Allowed''' setting is ''Enabled'' and as such;
* The system will therefore stamp the final retail rating record with the tariff matching "Intra Account Calls" and rate according to it's rate profile ($5 in this example).
** If no rate exists, the system will loop up to the Base Rate (rarely set) and if not found enter rating quarantine with reason ''Invalid Rate''

ReleaseNotes/2012

2018-09-12T06:00:27Z

Dcowan:

The following topics are available:
* [[ReleaseNotes|Back to Release Notes]]
* [[ReleaseNotes/2014|RELEASE NOTES ARCHIVE 2014]]
* [[ReleaseNotes/2013|RELEASE NOTES ARCHIVE 2013]]
* [[ReleaseNotes/2011|RELEASE NOTES ARCHIVE 2011]]
* [[ReleaseNotes/2011|RELEASE NOTES ARCHIVE 2010]]

==3.46.00 – 31 October 2012==

===New Features / Enhancements===
'''''User Interface Optimisations'''''

'''Point of Sale'''

Change Background:
It was reported to us that clients were having challenges processing product purchases within the Emersion system, especially when it came to purchases that were processed over a weekend, but being entered after the fact. In order to make this process easier, the following changes were made;

# We have enhanced the Point of Sale flow to include the ability to better manage invoices (auto-approve, backdate, adjust issue and due dates).
# Added the ability to set Purchase Notes as visible or not visible to the customer (on the invoice)
# You can now set a vanity date on the invoice and it will override the date set on the Product Purchase.
# You can now select whether Multiple Quantity Sales are displayed as a single line on the invoice or multiple.
# When selling physical products, such as hardware to the customer, the product quantity must be in decimal format. Validation added to ensure you can only use decimal quantities on items that are non-serialized.

'''Point of Sale Receipts'''
*[[ReleaseNotes/2012|RELEASE NOTES ARCHIVE 2012]]
Change Background
Clients who were using the point of sale / product purchase system in a retail environment lacked the ability to provide a receipt post invoice / payment to their clients. This feature was inspired by that issue.

# An event has been created to allow a user to print a point of sale receipt, please contact sales to have set up if required.

'''Invoices'''

Change Background:
This primarily was a cleanup of the administrative interfaces that already existed to manage invoices, and bringing them up to date with the functionality of the invoices as they currently stand. Other changes were to compliment changes elsewhere, such as the purchase note.

The tariff silence fix was specifically because there are sometimes calls (such as inbound) that you would not want to send out to your clients, but need them to exist within the system.

# You are now able to create and manage images and custom text messages from the UI.
# Purchase Notes if set to visible will display on the invoice
# Now supports ability to 'silence' a tariff so that calls of that type do not appear on invoices (Not requires Emersion support ticket to set up – global per tariff table)

'''Transactions, POS and Payment UI'''

Change Background:
There was some confusion on which date was relevant to what within the ledger transaction pages. The invoice ‘issue’ date, which is stamped on an invoice, is mostly for vanity, whereas the ledger transaction date references where the invoice sits when it comes to reconciliation of accounts.

# Updated some of the lists of invoices to display the actual invoice issue date and ledger submitted date.

'''Service Based Discounts'''

Change Background:
It was reported by clients that although the package chain discount subsystem was useful, there were some limitations when it came to properly allocating a discount in a package which might be bundled with multiple service types, some of which you would not necessarily want to discount.

For instance, if you were to apply a percentage usage discount across the board, or a $5 discount to access fees across the board, this discount would apply to ALL services within the package. In some situations this might be appropriate, but it seemed more useful to Emersion clients to allow them to specifically isolate a given service, and allocate discounts this way.

The interface also needed to be updated to utilise the new tax management framework which is discussed later in these notes.

# The Discount around Package Chains has been enhanced to also support Service Based Discounts. For Example you can have a discount apply to only one Service in a package, or have the discount apply at the package level.

'''Service Multipliers'''

Change Background:
Previously in Emersion there was no way to have an access fee that would scale based on a given number, which in essence meant that if you were selling for example internet connections which were varied based on how many megabytes the link had, or you were renting floor space at a given square meterage, you were forced to create a service plan per instance, which of course does not scale very well. Emersion has now implemented a ‘service multiplier’ (and ‘service feature multiplier’) concept, which means you can put your per MB or per M2 price in the access fee, turn on service multiplier, and enter the applicable amount at service creation, or modify over time as changed, without creating additional plans, or having to migrate the client.

# Certain service Types can now support Service Multipliers at the subscription level. E.g. You can set up a Plan for Internet where the plan has a price per MBps and then at the sale time define how many Mbps this client is using.

'''New User Wizard'''

Change Background
Clients were concerned that data entry for new users was taking more time than it should.

# Added the ability to copy an address for an Organisation, Contact and User Portal Contact

'''Account Securities'''

Change Background:
The Emersion system was initially built as a strict subscription based system, and at this time, having a generalised securities concept, which would only accept just one type of security was fine. As the system evolves into more of a point of sale and subscription system, and there is a great deal more service types than there used to be, there is reason to support multiple securities per end-user. For instance, a security carpark pass security, a bond for an office, a credit security for a high value client.

# We have significantly reworked the account securities section in Emersion. Previously a 'security' was limited to one amount that was increased or decreased. Users now have the option of managing multiple separate securities with their end-users, and starting and ending them mutually exclusively. The system works by charging a security amount, which creates a debit invoice, and stores the security amount elsewhere, and in reverse when refunding.

'''Reports Engine'''

Change Background:
Clients were forced to export all reports to excel or CSV in order to generate totals for their reports or pull out a calculator.

# Now includes the ability to have totals and subtotals as a new row at the bottom of the report. NB: We will be reviewing existing reports over time to include such features.

'''Invoice Post/Email Events'''

Change Background:
General Invoice Post / Email event missing important variables as reported by clients.

# Now supports same variables as Invoice Overdue event.

'''Bill Status Tab'''

Change Background:
Since Emersion was built, processes which facilitate certain billing outcomes are scheduled at certain times of the day to ensure the system is always available. This has meant to date that clients (even when cancelling a client) – were expected to wait for these processes to run (normally only providing an outcome the next day) – and further manage their clients from that point.

# There is a new tab in the Customer section, which allows you to run all billing processes that might be due for a given account, immediately, versus having to wait for Emersion's daily runs. This can be especially helpful when trying to finalise an account for a user.

'''Plan Statuses'''
Change Background:
Plans could be given an end-date, but this would have no effect, and they would still remain saleable.

# Plans statuses will now automatically be updated to Grandfathered, Active or Saleable depending on its saleable dates. E.g. if the plan is set to approved and the Sailable From Date is now or less then the status will automatically be set to saleable. There is a job running regularly to automatically grandfather plans.

'''Bolt-On Assignment'''

Change Background:
The interface surrounding the linking of Bolt-ons would allow the user to potentially configure them in a way that would break any use of the bolt-on.

# Interface used for linking bolt ons, will not show an add allowance button if there are no sellable bolt ons.

'''Ezidebit BPay Timing Improvement'''

Change Background:
Clients were finding they weren’t receiving a result on BPAY transactions until later in the day, and sometimes would have already called their client to ask for the money, potentially wasting time and annoying their end-user.

# The BPay process now runs at 8am each day based on some transactions being missed when run earlier.

'''Package Cancellation'''

Change Background:
Clients wished to have the ability to cancel subscriptions they had overlooked as much as a few months. Emersion feels a 2 month window, for non-provisioned service types should give this flexibility. Any additional crediting will have to be done via the use of cardlines.

# Packages can now be cancelled up to 2 months in the past (i.e. outside of the current period) for no integrated provisioning service types.

'''Tax Entry and Handling'''

Change Background:
To-date the Emersion system has strictly expected everything to be entered into the system as an ex-tax figure, and the taxable amount would be generated on the fly. Unfortunately this meant when dealing with retail customers, and attempting to give them an accurate figure on what they would be charged, the client would be forced to have a calculator on hand to work out the extax variant of the price. In addition this also made it impossible to manage access fees which may not have a taxable portion at all.

# The UI for price entry has been altered to ensure accurate and easy entry of prices for Products and Plans. This enhancement also ensures you can control taxes more easily per charge type, and see the outcome of your data entry either by entering ex tax or an inc tax amount.

'''Better Support for Non Tax Customers'''

Change Background:
Along with the tax limitations described above, some clients, especially some government sectors are not charged for tax / GST at all due to a tax exempt status. It is now possible to flag a customer as exempt, and all underlying processes will know to manage this accordingly within the Emersion system.

# Customers that are tax Exempt can now be flagged in the Customer Detail tab under ‘Account Tax Rate’ to non-tax. This will prevent the system from generating a taxable portion within a cardline, or if a taxable portion is created by another mechanism, then a corresponding credit will be created.

'''Subtabs for Service Page'''

Change Background:
As we add more and more useful information to the service subscription page, we were noticing that the page speed was slowing very quickly over time.

# The Service Subscription Pages had become very long due to increasing the amount of data. We have now added Sub Tabs to this page to improve performance and usability.

'''IE9 Support'''
* Emersion is now supporting IE9 and above.

'''New Order Wizard Infolink'''
*Added a new infolink to the wiki detailing file sizes and types to the wiki next to the upload button when adding an (optional) file to an order (such as an order form)

'''Profiles'''
* The Profiles Tab has been removed from the Customer UI. The Profiles election is now in the Detail Tab.

'''Default Account Profile'''
* When creating a new customer, the profile selector will now pre select the profile listed as “default” unless no profiles are configured.

'''Performance'''
* Improvements to the time taken to process invoice generation requests.

'''Cost Centres'''
* Changes to default cost centres are now tagged with a modified date.

'''Wholesalers UI'''
* As a Wholesaler you can now in the Detail Tab see the Cumulus user suffix of your clients (enabling easier support).

'''General UI Improvements'''
* Added display of name of package to the Package Subscription detail page.
* Customer List now includes a column with the total of active services for each customer
* You can now see the Invoice Amount when viewing Disputes
* It is now possible to change your password in the Cumulus UI from the Home Menu Item without having permissions under Admin.
* Where Package and Service Plans are displayed both Internal and External Name columns exist.

===Bug Fixes / Minor Changes===
* Fixed bug causing a blank page to appear with no 'back' button on the Service Configuration page.
* Identified a bug where trying to view the details of a Service Subscription in the ‘initialise’ status.
* Fixed bug causing errors when searching for partial Service Identifiers in cumulus.
* Issue identified where no results were being returned when trying to SQ a Block Range for a Ranged Service.
* Corrected error when pressing “Return to List” when editing an Event Template.
* Fixed bug causing usage data in the End User Portal to not appear in IE9 and Firefox.
* Resolved issue where clients using Chrome were unable to ‘auto approve’ invoices.
* Online Sign Up User Portal now correctly displays package plans which have been configured to be sold in the signup portal.

==3.45.00 – 16 August 2012==

===New Features / Enhancements===

'''Audit Log'''

* A new Audit Log page has been made available in the user interface. It allows users to view a list of actions performed by system users, such as creating or editing a customer record, creating cardlines, managing invoices, raising disputes, approving or rejecting an invoice, allocating or modifying cardlines, creating or modifying packages, plans and rate cards, taking payments, creating credits, write offs and refunds. The audit log show the data and time the action took place, with the user ID, the action and what information was modified.
:To enable the audit log, please contact our Sales team.

'''Receipts'''
* The system now allows users to view and print a receipt when a purchase is made or a payment is processed. To enable payment and purchase receipting, please contact our Sales team.

'''BPAY'''
* The system now automatically retrieves BPAY payment details using the EziDebit interface. To enable this feature, please contact our Sales team.

'''Events'''
* New Event types are now available:
** A single phone call with the call length over a particular duration
** A single phone call with the call charge over a particular value
** A particular call type with the call charges in the current billing period over a particular value
**:To enable these new events, please contact our Sales team.

'''Reports – End Customer User Portal'''
* The following new reports are now available in the end customer user portal:
** Top 10 dialled numbers
** Top 10 expensive calls
** Call Trending, showing the customer’s call trending information over past 12 months

'''Other Enhancements and New Features'''

* The system now supports Internet Explorer 9 in addition to Firefox, Chrome and Safari.
* The system now supports the AAPT pre-select product. Contact our Sale team for more information.
* The system now supports the AAPT ADSL product. Contact our Sale team for more information.
* On the Invoice List pages on an account as well as in Finance > Accounts Receivable, the system will now only show a Download link if the invoice has not been archived.
* The Ledger Cardline report exports Cost Centre codes if configured.
* A package chain discount can now be applied at the time the package is ordered.
* Package plans have been modified to now only allow packages that have a status of ‘Approved’ or ‘Saleable’ to be sold to a customer.
*: In addition, when the ‘Saleable To’ date of a package is reached, the system will now automatically ‘grandfather’ the package, and it will no longer be able to be sold.
* The system now allows users to modify customer text and images on invoice templates. A new page in Admin > My Invoice Template > Custom Message allows users to set up the required information.
* During a product purchase, a new Notes field has been implemented to allow the user to enter any required information against the sale. The user can nominate whether the note is visible to the customer or not.
* When viewing reports, the system will not run the report until the user has selected the report criteria and clicks the Search button.
* The report scheduler has been enhanced to allow reports to be scheduled to run hourly.
* A new search filter has been implement to allow a customer to be located by the external reference number.
* The system now allows changes to a service’s cost centre to be tracked.
* For Telstra Mobile services, the system now allows data plan bolt ons to be provisioned through the order interface.
* Issues with displaying very large tariff structures in the Rate Card page have been resolved. The system now shows the tariff structure in a new window.
* The system now allows users to view service and equipment charges on a service, similar to the existing view usage on the Service Subscription page. The end customer usage portal has also been enhanced to allow customers to view the service and equipment charges.
* When creating Contact for a customer account, the system now allows you to copy the address from an existing contract into the new contact.
* The Packages and Plans > Management > Bolt ons > ''View bolt on'' page now displays a list of the Bolton Groups the Bolt on is associated with.
* The external signup page has been enhanced to perform more validation on the customer’s details entered, and some minor usability enhancements have been implemented.
* The external signup page can now perform an SQ to confirm the customer can obtain a service before proceeding with an order.
* The product management have been enhanced to only show products that are sellable to the user.
* Default settings for Account Type and Account Profile are available which are used when new accounts are created. To set up these new defaults, please contact our Sales team.
* Various enhancements have been made to the page navigation to better display options when provisioning a new service and managing an existing service.

===Bug Fixes / Minor Changes===

* An issue that occurred when changing the email address of a primary and/or billing contact of a customer that caused invoices to be sent to the account owner has been resolved.
* The View Contact page now displays more quickly.
* The Check Username function used when provisioning data services has been fixed to correctly identify any duplicate usernames in the system.
* The Permission Group page has been updated to save a permission group with no Permissions.
* When linking a buy bolt on to a buy service plan, the system now correctly displays buy bolts to select, not sell bolt ons.
* When linking a rate card to a service plan, the system now correctly only allows the user to link a rate card that contains rates.
* When linking a buy package plan to a sell package plan, the system now correctly only allows the user to link a package plan that has linked service plans.
* When creating a new user, the system now verifies the new username does not already exist in the system.
* An issue found when updating an invoice’s issue date to a day in the past has been resolved. The system now correctly allows you to set the date up to two days in the past.
* When modifying a rate card name, the system now correctly saves the new name.
* When importing payments, the system now correctly creates charges for the finance charges entered in the import file.
* An issue found when attempting to map ledger codes for services that are provided by a supplier in the system has been resolved.
* A problem discovered when modifying a package plans billing in advance setting has been rectified to insure the correct value is saved.

==3.44.00 – 29 June 2012==

===New Features / Enhancements===

'''Reports'''

* A new suite of reports are now available to provide detailed information including quarantine, cost auditing, margin analysis and batch processing. New report tabs will appear under the Report menu to access the new reports. To enable these new reports, please contact our Sales team.
* All reports now have the additional ability to automatically export.CSV files, which can be placed on the Emersion FTP site for retrieval. To enable this feature, please contact our Sales team.

'''Other Enhancements and New Features'''

* The Services > List All page now allows services to be located by package name.
* The ledger codes displayed on the Ledger Mapping page, as well as in the ledger drop lists for cardlines and products, have been cleaned up to only show ledger codes relevant to the products and service types appropriate to each account.
* The Events Templates page has been enhanced to display more information about each mapped event i.e. account profile and the event mapping type.
* A new Event Type, Credit Limit Exceeded, is now available to alert you when a customer’s balance exceeds their credit limit. To enable this feature, please contact our Sales team.
* The system now supports Bolt Ons to be provisioned with upstream carriers as required by the various service types (e.g. for mobile services with data plans set up as service bolt ons).

===Bug Fixes / Minor Changes===

* Issues found with the Cumulus user interface when using Chrome as the browser have been rectified.
* Issues found when attempting to cleanse records in rating quarantine have been resolved.
* The Billing > Non Existent Service and No Package Available pages now correctly show quarantine records found that have no active services or packages respectively.
* A problem found when attempting to add a custom rate override for a telephony service has been resolved.
* Updates and issues have been resolved surrounding package migrations. Some of the issues addressed include:
** migrating packages with multiple service types with different provisioning workflows now correctly allows the provisioning processes for each service type to successfully complete
** ensuring that if the user clicks the Cancel button while entering a package migration, the system returns to the order page correctly
** migrating to a package with service types that do not require authorisation now correctly allows the order to be submitted without prompting for the authorisation detail to be entered
** migrating to a package with more services than the original package now successfully completes, and new initialised services are created
** the migrate process will not allow a package with any services in a pre-active or pending cancellation status to be migrated
** migrating to a new package with a new service type now allows the user to select the correct order type (i.e. New or Churn)
** the system does not allow packages that have a pending migration (i.e. a migration set to occur on a date in the future) to have services to be allocated
** after aborting a package migration, the system displays the package previously viewed instead of showing the services list page
* An exception detected when a new product is created without selecting a product type has been resolved. The user must select a product type to successfully create a new product.
* The Packages and Plans > Management > Time Tables page has been updated to only show the relevant service types as configured for the account.
* An issue found when displaying rate cards for Telstra Rebill services has been resolved.
* A problem saving the username and password on certain dialup service types has been resolved.
* Churning a Unitel PSTN service with fax duet now provisions the correct service identifier, not the fax duet number.
* The end customer portal has additional validation on the payment screen to ensure the customer cannot enter a comma (“,”) into the payment amount field.
* Further fixes have been made to cancelling Emersion email domains to allow packages to be successfully cancelled when all mailboxes within the package are linked to the email domain.

==3.43.00 – 6 June 2012==

===New Features / Enhancements===

'''Customer Management Enhancements'''

* The create customer wizard now automatically generates a BPay reference number for a new account if a BPay biller code has been configured.
* The system now has additional fields to record the driver’s license expiry date and state. These fields are optional.
* The account details information page contains a new field, “Average Days to Pay Invoice”.

'''Cost Centres'''

* A new Cost Centre feature is now available. It allows users to create cost centres, which are a grouping of financial information for reporting purposes. The following functions have been implemented to support the new cost centre feature:
** The ability to manage cost centre types (e.g. Sites, Departments, Divisions etc). Multiple cost centre types can be set up as required.
** The ability to manage cost centres within each cost centre type (e.g. cost centre type of ‘Department’ with cost centres of ‘Sales’, ‘Support’, ‘Customer Service’, ‘I.T.’ etc)
** Default cost centres can be set against each account, package & plan, service and / or products and cardlines

To enable this feature, please contact our Sales team.

'''Product Enhancements'''

* The system now supports serialised products e.g. modems with individual serial numbers. Users can now manage the serialised product’s inventory, upload serial numbers, and note the product serial number when the product is sold. The serial number of the product will appear on the purchase receipt and the customer’s invoice. A new ‘Serialised Product’ report is also available. To enable this feature, please contact our Sales team.
* When creating a purchase for a product with a quantity greater than one, the system now enables the user the option to create a single consolidated cardline for the total value of the products, or create a separate cardline for each instance of the product.
* During a product purchase the system can now create a transaction receipt immediately. To enable this feature, please contact our Sales team.

'''Other Enhancements and New Features'''

* The Mass Mailout feature has been enhanced to be more usable with improved layout and informational message displays.
* In the Accounts Receivable module, the Disputed, Unallocated and Pending Cardline pages now show totals that sum the amount columns.
* The system now has the ability to cancel packages at the start of the current billing period to enable any pro rata credits to be calculated for the whole period.
* The ‘invoice delivery’ event template has new variables available: invoice issue date, previous balance, payment received and end customer portal username.
* When finalising a new service order, the system now prompts the user to confirm that they wish to submit the order.
* Generic service types that do not have usage (i.e. monthly recurring fees only) can be set to automatically assign a service identifier instead of a user having to add an identifier manually.
* The Quarantine pages have been enhanced to separate BMS quarantine records into 3 tabs to speed up the user interface: Telephony, Data and Miscellaneous.
* The Invoice Management ''Approve'' and ''Approve Do not Send'' functions now prompt for user confirmation before continuing.
* The CVV field in Take Payment has been updated to allow 4 digit CVVs for AMEX payment types.
* When deleting an event template, the system now prompts the user to confirm the deletion.

===Bug Fixes / Minor Changes===

* A problem found when attempting to create a new order when there are not active service types has been corrected. The system now displays an appropriate message.
* An issue discovered when rejecting an invoice from the Accounts Receivable > Invoice List function has been resolved. The system now correctly returns the user to the invoice list page.
* The system now allows products in the service and equipment rate card to be saved with a $0 price.
* The Clear button on the Customer List page now correctly clear any search filters applied and shows all accounts.
* The create customer wizard has been updated to remove the ‘Other’ address field that appeared on the primary contact’s address, and only displays if the user selects a county other than ‘Australia’ for the address.
* The end customer portal has been updated to show the correct service type names.
* The override finance charges fields have been updated to correctly show a single ‘override’ check box.
* Service Types available in the selection criteria of many reports has been cleaned up to only show the service types relevant to each provider.
* An exception found when modifying the permissions on the end customer portal has been resolved.
* The Cancel package at the end of the billing period has been fixed to remove some processing errors that were detected during certain circumstances.
* A problem found when attempting to create new staff users has been resolved to create the user record correctly.
* The ‘receive manual payment’ event type has been updated to correctly show the payment reference information.
* An error found when saving an order’s authorisation data with a reference number was more than 20 characters has been resolved.
* An exception detected when migrating a package that required a new service to be configured has been resolved.
* On eBill services, the ‘Custom Rate Override’ fields on the ‘View Service’ page have been updated to ensure the tariff hierarchy operates correctly.

==3.42.01 - 15 May 2012==

===Bug Fixes / Minor Changes===

* An issue identified with the tax calculation on product purchases has been rectified to ensure the correct price ex tax and tax amount are recorded in the ledger.

==3.42.00 - 4 May 2012==

===New Features / Enhancements===

'''Customer Management Enhancements'''

* Customer Notes now include information about system events that were generated for the account, such when invoices, reminder notices or other automated emails were sent.
* The Customer > Customer List page now allow you to filter the account list by Account Profile.
* In the Customers > Customer List > View account page, the system now displays notes related to the account at the top of the page indicating any overdue invoices and amounts due. These notes may be minimised or expanded.
* For accounts that are set up as an Organisation, the system now stores and displays the organisation’s address fields and details.
* The system now has the ability to show contact details as being verified with additional fields to show the date the details were verified and by whom. To enable this feature, please contact our Sales team.
* The Contact details in an Account now has new fields for the driver’s license state and expiry date,
* The system now has the ability to show whether the current account has an active TIO case, as well as the TIO case level. To enable this feature, please contact our Sales team.
* The Create Account wizard now allows you to set the customer’s user portal login information, including username, the ability to check the username is not already in use, and password.
* The account’s end user portal username can now be modified if required.

'''Other Enhancements and New Features'''

* Invoices shown in Finance > Accounts Receivable > Invoice List now allow actions, such as Approve, Reject, Re-Render, to be performed on many invoices at once. More details are available in the on line help.
* The system now has the ability to create Payment Plans for customers to pay off their account balances over a period of time via installments. More details will be available in the on line help.
* When managing invoices, a confirmation message now appears when the user clicks Approve or Approve – Do Not Send.
* The Pending Payment function’s user interface has been improved to show a ‘Mark as Failed’ button and to display a message to confirm the action.
* The View Usage pages in the end user portal and Cumulus now allows you to select a date range for displaying the service usage.
* When cancelling packages that contain multiple mailboxes, the system will now successfully cancels the entire package if all there are no active mailboxes found that use the same realm i.e. in other packages.
* The Packages and Plans > Management package list page now allows package to be filtered by service type. All packages that contain the service type(s) selected will be displayed.
* The Invoice Delivery template now has the customer’s Username variable available to be added into the email text.
* Support has been added for iSeek TADSL Ull services in the Cyclone provisioning engine.
* A new Event type, Credit Limit Exceeded, has been implemented to trigger when a customer’s account balance exceeds their credit limit. To enable this feature, please our contact our Sales team.
* Data services have been updated to allow the service identifier (i.e. FNN) to be stored ether with a leading “61’ or ‘0’, as required by the each carrier / service provider.
* The semi manual provisioning workflows now have additional support to process service orders that fail provisioning. A semi-manual provisioning request can now be set to ‘rejected’, so the service’s provisioning log is updated accordingly.

'''Report Updates'''

* Many reports now have the ability to provide summary information, such as totals or averages, for data such as invoice amounts, amount due, payment amounts etc. In addition, the reports are able to be sorted by the various columns displayed. To enable this functionality for any of your reports, please our contact our Sales team.
* The Reports module has new options to allow more flexible, automated report scheduling, including the ability to set daily/weekly or monthly frequencies as well options to define what day the report is run.

===Bug Fixes / Minor Changes===

* An exception caused by the external signup portal was resolved, with some minor page layout updates implemented.
* The account ID of the current logged in user now displays in the page footer on every page of the system.
* A bug found in the instalment plan ad hoc payments where the GST was incorrectly calculated has been fixed.
* The payment system (EPS) has been updated to check that payment details are stored correctly before creating and attempting to process an automated payment.
* A problem found when attempting to provision a non-mandatory service on a package with other service types when an order is already in progress has been resolved. The order now correctly processes and provisions all services on the order correctly.
* When aborting a package with multiple services and service identifiers, the system now correctly aborts all services within the package, not just the primary service.
* An exception found when aborting a pre-active service and then attempting to re-allocate it to a new order has been resolve. The user interface will show the Allocate option disabled on services that are aborted.
* Issues found when configuring a new Emersion Email Mailbox have been resolved. The user interface now correctly shows the correct elements and stores the service properties correctly.
* The address fields shown when displaying a Billing Contact on an account now correctly displays all the correct address fields.
* The notification messages display when viewing an account with unallocated services attached to a package have been updated to only show if the package are pre-active or active (i.e. not if they are aborted or cancelled).
* Minor user interface and navigation issues have been resolved in the end user portal and Cumulus discovered when using multiple browser pages.
* When creating or editing a contract, if the ‘no contract’ option is selected as the ‘contract end method’, the information is now correctly saved and processed correctly.
* Rates set to a $0 (zero) value are correctly saved in the database.
* An exception discovered when setting an account’s contract’s date of birth to a date prior to 1956 has been resolved.
* The Edit Rate window has been enhanced with some minor cosmetic changes to improve usability.
* The Receive Payment page has been enhanced with some minor cosmetic changes to improve usability.
* The Take Payment page has been enhanced with some minor cosmetic changes to improve usability.
* When creating a credit on an account, the system now displays the correct confirmation message.
* The amount field labels on the view package page have been updated to indicate inc or ex tax.
* An account’s End User Portal’s Username can now be changed.
* The system now allows user to delete a Product Price point.
* An exception discovered when changing an active service’s static IP address has been fixed.
* The EPS payment processor has been updated to provide more information when payment processing fails.
* A typo in the invoice template when a Bolt On was shown has been fixed.
* An issue found when creating a new data service where the system created an incorrect service identifier containing the user authorisation details has been corrected.
* The invoicing discount calculation has been updated to correct an error discovered where a package chain discount was applied twice.

==3.41.00 - 13 March 2012==

===Bugs Fixes / Minor Changes===

* In Finance > Accounts Receivable, the 'Pending Payments' and 'Failed Payments' pages have been replaced with a single 'Payments' tab. Customers can search for any payments in any status.
* Services that require Automatic Provisioning can no longer be activated in Cumulus.
* Services that are configured for Semi Manual Provisioning can now only be activated by the Provisioning Account ID
* When "Creating Immediate Invoices", the Auto-Approve box will be unticked by default. If the customer ticks it and attempts to proceed, they will be asked to confirm
* During a 'Migration', a user can 'Cancel' and return to their originating Package Subscription
* Emersion Provisioning System can now trigger an Event to be sent to an SP where a new Service Record is received for a service that is not in Cumulus (Automatically Provisioned Service Types only)
* Write Off. Removed 'Auto Allocate' tickbox. Provided better confirmation box on clicking 'Submit'
* Package Chain Discounts will be end dated when Package Subscriptions are cancelled
* Bulk Payment will now validate to make sure that the file is valid and only import payments for accounts I "own"
* Receiving a payment for an account with a pending invoice will force the invoice to be reconciled and re-rendered.
* Paper invoice fees were only being generated for customers that had the Delivery Method of POST set at their level. This meant that if an SP had a default invoice delivery method of post that was not being overidden at the customer level, paper invoice fees were not being generated.
* On creating a NEW BPay reference (through Admin > BPAY Details), there was no validation around the Reference Number Length and Prefix, so customers could create BPAY details with a required Reference Number Length of 1 (and then break the Payment Methods page when it tries to create the BPAY Reference). This has been fixed
* On Ledger Cardlines, Package Chain Discounts were being created but with incomplete descriptions. This has been fixed.
* Cancel Package Subscription function now allows you to:
** Cancel Immediately
** Cancel at End Of Date
** Cancel at End Of Period
** Cancel on Specific day - Note that you cannot cancel on a day prior to the beginning of the current Package Period
* Invoices were being generated showing transactions resulting from 'Credit' Invoices being cleaned up (a debit and an unallocated Payment). This was confusing customers. These transactions will now no longer display
* Various small UI improvements. Including but not limited to;
** Logical List Sort Order Improvements (eg. Services > Orders now sorts by order date DESC so the newest order is at the top)
** Spelling errors fixed
** Logical notifications added to certain events

==3.40.01 – 25 January 2012==

===End User Portal Updates===

* The end user portal has been modified to no longer allow a customer to add, modify or delete their direct debit payment details.
* Extra checking has been implemented to prevent a customer attempting to make a payment through the end user portal when no payment details have been set up.
* The end user portal now correctly displays customer contact details for all address types (i.e. standard, unit/complex, postal address/PO box, and unstructured).
* The end user portal now allows the customer to elect to save their credit card details when making a payment. Their account details will be updated with the credit card details entered.

===Bug Fixes / Minor Changes===

* An exception caused by a user searching for an invoice using the System Search field without entering any data has been resolved.
* An internal error found when viewing the Customer List > Customer > Organisation page has been resolved.
* When migrating a package, the system will now only show destination packages within the same contract pool as the current package subscription being migrated. If you wish to migrate to a plan outside the current contract pool, you will need to break the contract via the View Package Subscription page.
* A permissions issue found when viewing a customer’s transaction has been resolved.
* When searching for a BPay Ref Number using the System Search field it now correctly returns matching payments records.
* An exception caused when saving a note against a customer record in the Customer List > Customer > Notes page has been resolved.
* The Account Balance shown in Customer List now displays tax inclusive, not tax exclusive
* A problem found when approving invoices and un-ticking the “Reset Issue Date to Today and Due Date as per terms when approved” checkbox was fixed.

==3.40.00 – 23 January 2012==

===New Features / Enhancements===

'''Accounts'''

* The Customer List > Customer > Contacts page has been redesigned to show all the account contacts in a list for easy selection. You can now create as many contacts against an account as is required. Previously only three contacts were available.
* Each account contact can now have up to 10 email addresses stored against it. Multiple email address fields can be created on the ''Edit Contact Details'' page.
* A new Transactions tab is now available in the Customer Account page. It lists all the customer’s invoices and payments. This list is also available in the Finance > Accounts Receivable > Transactions tab.
* The Customer List page has a new column, Account Balance, which shows each customer’s balance. Current amounts due are shown highlighted in orange, while overdue amounts (>14 days) are highlighted in red.
* The Receive Payment, Invoice List, and Unallocated functions under Finance > Accounts Receivable now show the Account Balances highlighted in orange for amounts currently due, and in red for overdue amounts (>14 days).
* The Customer details page has a new field, Account Tax Rate, to allow different tax rates to be applied to individual customers. If not set, the system uses the default tax rate.

'''Events'''

* A new Event type, “Package Activated” has been implemented that can be triggered when a new service subscription is activated. Further information about [http://wiki.emersion.com/wiki/index.php/SystemEvents Events] is available in the wiki.
* The Invoice Due event type now has an additional variable available, ‘Amount Due Inc GST’, which can be added to the email template.
* The Event Template function has been modified to now only allow an invoice to be attached to event types that are invoice centric.

'''Cardlines'''

* The Create New Unallocated Cardline function has been enhanced so the cardline amount can now be entered either inclusive or exclusive of. tax. The system automatically calculates the tax amount. In addition, the ‘Covers from’ and ‘Covers to’ date fields have been removed as they were not relevant to pending cardlines.

'''User Portal'''

* A new feature has been implemented on the Customer List > Portal function that shows the number of login attempts a customer has made in the user portal. It also shows whether the customer is locked out and allows you to unlock the customer’s user portal access.
* The Payment Account module in the user portal now allows the customer to set up their payment details i.e. credit card or direct debit information.

'''Reports'''

* The system now supports the scheduling and automatic generation of many system reports. A new ‘Report Schedule’ button is available on the updated reports that allows you to nominate the frequency to automatically run the report.

'''[[ProductManagement|Product Management]]'''

* A new [[ProductManagement|Product Management]] module is now available that allows you to create and manage your products and pricing points. Full details are available in the wiki and the new Products Management User Manual.

'''Cancellations'''

* An error found when a package subscription was cancelled with the ‘Cancel on a specific date’ option has been rectified to ensure credits are calculated correctly.
* When cancelling service types that have a service identifier realm, such as Emersion email domains and DNS hosting, the system will now check for active mailboxes and not allow the service to be cancelled if any exist. All active mailboxes attached to the service must be cancelled before cancelling the service.
* A new option is available (permission controlled) that allows service types that are manually provisioned to be cancelled immediately, without going into ‘Pending Provisioning Cancel’ status.

'''Minor Enhancements'''

* The Customer List > Customer > Package Subscriptions page has been enhanced to show an updated Package Subscription ID column and a new ‘View Customer’ button to easily return to viewing the customer account details.
* The Finance > Accounts Receivable > Receive Payment page now has a new search field that allows you to locate a customer by the customer’s invoice number.
* The Finance > Accounts Receivable > Pending Payments and Failed Payments pages now has a new search field that allows you to locate a payment by the Electronic Payment ID.
* The Electronic Payment System (EPS) has been updated so direct debit payments are not retried after the first failed attempt. The system will update the payment information for the customer as ‘Suspended by the System’. Previously, EPS would re-try the direct debit three times.
* The Finance > Accounts Receivable > Invoice List page will now show the list of invoices sorted in Date Issued order.
* The system now has better page handling when the same system pages is opened in two different browser tabs or windows to reduce errors and produce more consistent results.
* The system has new navigation controls on all functions that show lists with multiple pages of data. Left and Right arrows bedside the page numbers allow easy navigation to next and previous pages.
* If a package subscription is set with a start date in the future, the system now prevents users from migrating or cancelling these packages.
* The Customer List > Customer > Pending Ledger Cardlines function now has a Cancel button to allow you to cancel the creation of an immediate invoice.
* The Service > Migrations function now allows you to set a package migration to be scheduled to occur on the current date, at the end of package period, or at a nominated future date. Scheduled migrations can also be edited or cancelled.
* The finance charges used for processing payment surcharges (e.g. 3% surcharge when paying by Mastercard etc) now correctly allows difference surcharges to be applied against each card type.

===Bug Fixes / Minor Changes===

* An exception found with the data mapping on services that require semi-manual provisioning has been resolved.
* An error that occurred when an email domain or domain registration service type was edited has been fixed.
* Some reports were found to display not starting on page 1. This has now been corrected.
* The contract break out fee calculated when using the break out method of ‘Remaining Value (Initial)’ now calculates the correct fee amount.
* An exception found when trying to view usage data on a service that was cancelled has been resolved.
* The User Portal Access setting on the customer’s account records now correctly controls access to the end user portal.
* When creating a new service and setting the service activation date to a date prior to the current date, the selected date is now correctly saved in the service details.
* A problem found when message temples used in Events contains complex html has been resolved. When an Event template is saved, the system now performs additional checking and clean-up of the content before saving.
* When aborting a package subscription for a customer, though the system processed correctly, a blank screen was displayed. The system now returns to the account’s package subscriptions list.
* An issue found related to checktype identifiers that caused an internal errors was resolved.
* The system has been updated to prevent both a product rate’s markup and a price to be saved as NULL. The system now only allows a price or a markup to be set on rate, not both.
* The Group Cap field in Package Plans has been fixed to only be active when there is an associated telephony service in the package.
* The Customer > Payment Methods now only allows payment details to be set up if the corresponding payment type is set up for the service provider.
* An issue found when viewing initialised service subscriptions now shows more informative error messages.
* Write Offs now correctly create the necessary ledger adjustment transactions.
* Issues discovered during package migrations that resulted in some migrations not working correctly have been resolved.

Main Page/Provisioning/GNAF Address Infrastructure

2018-09-12T06:00:13Z

Dcowan:

== GNAF Instructure Overview ==

* With the introduction of the NBN, Wholesalers are increasingly rolling out their own network infrastructure as opposed to relying on an upstream party.
The Emersion system has now been enhanced to permit the storage of network infrastructure details for a given carrier within an Emersion.
* This permits a given Wholesaler/Carrier to roll out their infrastructure to given addresses and store that information with Emersion. They can also use this same information to place an order and perform a service qualification.
* Cumulus will also assist with the management of network infrastructure. For instance, you can assign a port on a network device to a given address, and keep track of what ports have been assigned to which addresses.

== Fundamental Concepts ==

* With the introduction of the NBN, Wholesalers are increasingly rolling out their own network infrastructure as opposed to relying on an upstream party.
* The Emersion system has now been enhanced to permit the storage of network infrastructure details for a given carrier within an Emersion.
* This permits a given Wholesaler/Carrier to roll out their infrastructure to given addresses and store that information with Emersion. They can also use this same information to place an order and perform a service qualification.
* Cumulus will also assist with the management of network infrastructure. For instance, you can assign a port on a network device to a given address, and keep track of what ports have been assigned to which addresses.

The picture below discusses the initial building blocks to ensure an initial SQ will pass.

* A GNAF address is as the name would suggest, an Australian residential ,business, or government address.
* The carrier location availability indicates whether the carrier is going to service a given address.
* The GNAF Carrier Location Profile tells the system what service types are available for the given address and the given carrier. This is important as when you perform a Service Qualification for a given address, this layer is needed to tell the system what service types are available for the address.
* The service availability indicates how much infrastructure is already in place via the Class Number. Even though all the infrastructure is not in place at a given address, A carrier may elect to allow a Service Qualification to pass. The class number is an indicator as to how "ready" the site is to accomodate a service.
* If a provider has stricter thresholds and requires a mandatory level of service availability to pass SQ, a default level can be set for the account.

[[File:Location_Profile.png]]

* A Site Device is a given piece of network infrastructure that has been installed by the carrier. A site device can have more than one port. A port availability record can be assigned to a GNAF Address. The structure below highlights that more than site device, could service a given GNAF Address.
* Each Port will also have a Port Profile. A Port Profile indicates what service types are associated with a Port. The reason for this is that a port could in principle support many different service types. Instead of making one port per service type, there is a profile which maps multiple service types to a given port. It helps by reducing the number of ports you need to create.

[[File:Port_Profile.png]]

== How Carrier Locations, Devices and Ports work together ==

* If the address has a Location Availability record and;
** The service type of the service plan has a matching service type to that of the GNAF Location profile and;
** The service availability threshold of the address matches the minimum required for the account then;
* The initial SQ will pass for the given address.
**During the activation stage of manual provisioning, you will be permitted to choose a Device and Port for the given address. If the service type of the plan matches the service type of the port, you can assign the port.
* If there is no port available, you may need to choose another device, port, or alternatively, you may need to reconfigure the port availability profile to indicate the desired service type is available for the desired device/port.

== The Building Blocks and how they fit together ==

* To get to the end point of assigning a device/port to GNAF address and service, and an active package subscription for billing you will need in general terms as pictured.

[[File:Checklist.png]]

== Creating basic data about existing infrastructure/availability ==

=== Creating a new Carrier Location Profile ===

* First navigate to Services -> Infrastructure -> GNAF Location Profiles

[[File:Carrierlocation_profile.png]]

* Click Create New

[[File:Location_profile_new.png]]

* Give your Location Profile a name and a description.

[[File:Location_profile_setup.png]]

* After this you will need to indicate what service types are available for this location profile, via the Carrier Location Profile Maps.

* Go to the GNAF Carrier Location Profile Edit Page. Once you create a new profile you will automatically be redirected to this page. Click Create New to begin assigning a service type.

[[File:Carrierlocation_profile.png]]

* Choose your carrier location profile and service type, click save.

[[File:Location_Profile_Map_Edit.png]]

== Adding and Updating GNAF addresses ==

* If you need to add or update a GNAF address users can either:

* add the addresses in Cumulus
* add the addresses via the [[Data_Import/Carrier_Site_Availability|Carrier Location Availability import]] tool.

=== Via Cumulus ===

To add a new address. or to update an existing address in Cumulus:

Nav: '''Services > Address'''
Perform a search before adding a new address to ensure it doesn't already exist.

[[File:Services-Address.png|1200px|Address Tab for GNAF Address]]

# Click '''Add New Address''' or click on the ID of the address you want to modify.
# Complete the required fields.
# When you are finished, press '''Save'''.

[[File:Add Address.png|1200px|Add Address Dialog]]

The presence of an address '''will not''' mean the address will pass a service qualification. Once the address has been added, you will need to supply the carrier location availability data. Refer to the section "Assigning a Location Profile ID to an existing address". The [[/Data_Import/Carrier_Site_Availability|Carrier Location Availability import]] which will permit you to import the address and assign a location availability record at once.

=== How to assign a Location Profile ID to an existing address. ===

* ''This section is for existing addresses only, if you need to add a new address, this is addressed separately. See how to add a new GNAF Address.

* Navigate to Admin -> Bulk Import -> Carrier Location Availability.

[[File:CLA_Import.png]]

* Download a copy of your address data. You can do this by going to Services -> Address - > click on Address Export List button.

[[File:Export address list.png|Export Address List]]

* In the spreadsheet, fill out the Carrier Location Profile ID, and the service availability Description ID. These values MUST be correct or else your import will fail. The Emersion ID to the far left must be populated and correct. If you have exported from your existing address database then you shouldn't have a problem in this respect.

[[File:Sample_data_sheet.png]]

[[File:Service_availability_Desc.png]]

* The '''Carrier Location Profile ID''' can be found in the '''UI as previously described'''. The current '''Service availability descriptions''', and their ID’s are listed here:

[[File:Availability_desc.png]]

* Once you have completed the spreadsheet, save it locally to your Pc or network drive. Select “Choose File”

[[File:CAL_Import.png]]

* Find your file, click open and choose Import. Assuming your event is enabled and a template created, you will be notified via email.

[[File:Find_file.png]]

[[File:Open_import.png]]

=== How to modify availability for a given service address ===

* The import tool will permit you to modify the carrier location profile ID and service availability description ID, however at this time it will not permit a removal of a carrier location availability record.

=== How to create a new device ===

* Go to Services - > Infrastructure -> and click Add new Site Device

[[File:New_device.png]]

* Find your Product in your product list and click select. If it’s not here, then you will need to create it first. Refer to the Emersion user manuals for advice on this.

[[File:Find_Product.png]]

* Fill out the various attributes of the Device. Note that if the device is not active you will be restricted from assigning ports and devices to the address.

* [[File:Device_Details.png]]

* Once you are done click submit.

[[File:Submit.png]]

=== How to create a Port Profile ===

* Go to Services > Infrastructure > Port Profiles tab.

[[File:Infrastructure - Port Profiles.png|Port Profiles]]

* Give your Profile a nam, choose your carrier, and click save to the far right.

[[File:New - Port Profiles.png|New Port Profile Add]]

* Now you are ready to edit the port profile you have created, we do this to assign the relevant service types that will be available against this port.

[[File:Edit List - Port Profiles.png|Edit List Port Profile]]

* From the window below you will see a section below that lists the port profile map. This describes what ports have been mapped to this profile. The idea behind this is that a given port in theory could support multiple service types. Rather than create multiple ports for each service type, this mapping process let's you create one port that supports multiple service types. Go ahead and "Create New".

[[File:Port Profile Show.png|Port Profile Show]]

* In the next window, in the drop down choose the port profile, and the relevant service type and click save. Go ahead and repeat the process for any other service types the port will support.

[[File:Save Profile.png|Save Profile]]

=== How to add a port to a device. ===

* Please note, at this time you cannot set a hard limit on the number of ports on a device. You also cannot create a port unallocated to an address.
* You can add a port to a device through the semi manual provisioning page (more on this later), or device management.
* To add through device management, go to Services > Infrastructure > Management > Configure Link.

[[File:Port_configure.png]]

* Describe the port, assign a type and a port profile.

[[File:New_port.png]]

* Use the existing address against the port if already assigned, or search for a new address.

[[File:Port_address.png]]

* Once you have found a desired address, click add port.

[[File:Add_port.png]]

* Note that this in of itself will not start billing and it will not assign the port to an actual service associated and begin billing. It simply assigns the port to an address. Later on when you place orders you can assign a the port to the actual service.

=== Deleting a Port on a Device ===

* Go to Services -> Infrastructure -> Management -> Then Click Configure next your site device.

[[File:Delete_port.png]]

* to the right you will have a list of ports.
* Click DEL on the desired port. You will additionally see a confirmation dialogue.
* The port will be deleted and deallocated from the GNAF address.

[[File:Delete_port_two.png]]

== Stand Alone SQs ==

* It is possible via cumulus, or an external API call to conduct a standalone SQ.

=== Stand Alone SQs in Cumulus ===

* Before you begin, the user doing the SQ must have the "Stand Alone SQ - Service Infrastructure" module based permission assigned to their role. For more information about permissions see: http://wiki.emersion.com/wiki/index.php/Admin/PermissionManagement.

* In cumulus, navigate to Services -> SQ.

[[File:2015-02-27 11 06 24-Cumulus - Services - SQ.png]]

* Enter your desired address details for searching then click Proceed

[[File:2015-02-27 11 09 38-Cumulus - Services - SQ address list.png]]

* The SQ Result will show the service types available at the site and the nature of availability. If no port has been assigned to the address yet, you will see no reference to a port.

[[File:2015-02-27 11 12 39-Cumulus - Services - SQ Result.png]]
 

* On the other hand, if there is a port assigned to the address, this will be displayed as well. It may be that the port is already used by another service, in which case it will state "Not Available" as pictured below.

[[File:Port Available.png]]

=== SQs via an API call ===

* It is also possible to do an SQ via an API call. Below is a sample web skin and output result. If one of your RSP's plan on doing SQ's via an API call, please request Emersion set this up, and provide the account number of the RSP.

[[File:Api1.png|thumbnail]]

* The sample result set here will show the Service Types available at the site, the number of ports available and the service availability description.

[[File:Api2 result.png]]

== See Also ==
* Watch our short tutorial on [[Services/Orders/Address-based_Service_Qualification | how to create an order using the address-based service qualification]].
* [[Data_Import/Carrier_Site_Availability|Carrier Location Availability import]]

Main Page/Provisioning/AAPT DSL Provisioning Errors

2018-09-12T05:59:19Z

Dcowan:

{{DISPLAYTITLE:AAPT DSL and NBN Provisioning Errors}}
== Common AAPT DSL and NBN Provisioning Errors and how to handle them ==

This page describes common errors that may occur whilst attempting to provision DSL service for Broadband Connect L2, or Broadband Connect L3 service types. In all cases, if a service is still preactive your first reaction should not be to go to manual provisioning straight away. You should not be manually provisioning in FrontierWeb in the first instance. You should navigate to the provisioning logs to investigate what is going on. The provisioning logs can be found against the service subscription as pictured.

We are working on improving error handling for AAPT provisioning. As improvements are made these changes will be reflected in this article.

In all cases when raising a ticket you must provide:

* The Account Number
* The Service ID
* The Service Identifier
* A screenshot of the last provisioning_log.

If you are having issues with manual provisioning, then you must be specific about what those issues are. You must provide steps to reproduce.

 
 

[[File:Cumulus_-_Customers_-_Customer_List_-_Provisioning_Logs.jpg]]

== Common List of errors and actions to take ==

* Succesfully enquired on status of service provisioning for 0738222248, the provisioning is still in a pending state. While a service is provisioning, you'll see this message appear about 4 to 5 times a day. If the last log states this and it has been some time since the polling request, contact Emersion Support. Provide the "Service ID", the "Service Identifier", the Account Number and a screenshot.

* 'FrontierLinkService_enquireService - Request failed, message was: Service Not Found - Service Number = 029629xxxx' .
* FrontierLinkV2Service_enquireService - Request failed, message was: Service Not Found - NBN LocationID = LOC00013430412
** A fairly common error. this means the order was submitted to AAPT, but they have subsequently withdrawn the order. Before taking any action, you need to find out why. Grab the "Service ID" from the subscription and search FrontierWeb in the "Customer Reference" search field. From here you can click into the order and read the withdrawal notice. If appropriate, you may click retry provisioning, which has the effect of resubmitting the DSL component of your original order. If necessary, you may also abort the subscription and reallocate.
[[File:AAPT_Frontier_Screenshot.jpg]]
[[File:Withdrawal_notice.jpg]]
 
** Abort subscription (if necessary).
 
[[File:Abort.jpg]]
** Reallocate subscription. Navigate to the package subscription tab. From here you can go to the unallocated subscription tab, and reallocate subscription. Please note, while these screenshots mention AAPT telephony, they are fairly similar for AAPT L2 and L3.
[[File:Unallocated_Service_Subscription.png]]
[[File:Allocate_Service_Subscription.png]]

* FrontierLinkService_enquireService - Request failed, message was: 0 > File . This is an AAPT generated error. You can click the Retry Provisioning button as pictured in the screenshot above. If this button is not available, navigate to manual provisioning and "halt" provisioning, then click retry provisioning.

* FrontierLinkService_newService - Request failed, message was: Unknown name value for enum class com.aapt.qualification.domain.ParameterKey: TELSTRA_DA_MLL_E_PARAMETER_KEY . If this error is received, contact Emersion.

* FrontierLinkService_newService - Request failed, message was: Error submitting order. - Losing service provider not recognised. . Order was a churn and the losing service provider was not provided, or order became corrupt. Abort and reallocate subscription as described in this article.

* FrontierLinkService_newService - Request failed, message was: Error submitting order. - Specified radius details are already in use. You are already using this username and/or password, you cannot reuse it. I would be checking to see whether someone has provisioned this service manually through frontierweb. If this is the case, you would need to use manual provisioning to finish activation. If not, abort and reallocate subscription as described in this article.

* FrontierLinkService_newService - Request failed, message was: Invalid object state - getTelstraSiteAddress() returns null value. This is a communication error between AAPT and Teltsra. When you provide a service number, AAPT will try and determine the service address by checking the number against a Telstra database. When communication fails between AAPT and Telstra, or there is some other issue between these two entities, this is the error is received. You can click retry provisioning. If this error is repeatedly received, contact Emersion and we will facilitate communication with the frontierlink technical support team. Provide the Service ID, the Service Identifier, the Account ID, and a screenshot.

* FrontierLinkService_newService - Request failed, message was: Error submitting order. - DSL Transfer Date must be in the past, and no more than 30 days in the past. You have set the Churn Authority date in the order to be either in the future, or more than 30 days in the past from when the order was submitted. Check to see if the order is not already active in Frontier. If it is, you will have to manually provision. If it is not, you may abort the subscription and reallocate.

* FrontierLinkService_enquireService - Request failed, message was: Could not connect to host - 0 .. This is a general networking error. It usually means the AAPT went down. You can click retry provisioning which in most cases will move things along. If this error repeatedly reappears Contact Emersion with Service ID, the Service Identifier, the Account ID, and a screenshot.

* FrontierLinkService_newService - Request failed, message was: Error submitting order as the access speed is not available. - Access speed = Up to 20Mbps/1Mbps, did not pass for this orders access method. .

* Frotiner_LinkService_newService - Request failed, message was "Access method=AAPT ADSL2+ is not available".

*Errors similar to the two mentioned above are extremely rare. The plan chosen for the service has an access speed, access method, or some other attribute set which AAPT suggests is not possible for this service number and location. First of all, check the properties tab of the "Buy" Service Plan associated with your preactive subscription. It will list a series of attributes including the service speed.

[[File:Buy_Plan_Properties.png]]

* Against the original subscription, check the results returned from the original Service Qualification by going to the Service Qualifications Tab, then clicking on the magnifying glass. It will return the following properties with either "Pass or Fail".

* Telstra Region/Zone.
* Access Type
* Access Method.
* Service Speed.

[[File:2014-05-21 12 01 42-Cumulus - Customers - Customer List - Service Qualifications.jpg]]

* The attributes from the Service Qualification must match the attributes against the plan chosen. If they do not the order will surely fail. If this is the case you should abort the subscription and reallocate, ensuring that the plan chosen has attributes that match the Service Qualification. If the Plan matches the SQ, and these kinds of errors are still received, contact Emersion and we will help facilitate communications with FrontierLink Support.

* FrontierLinkService_newService - Request failed, message was: Error submitting order. - Access Type 'DSL-L2' can only be specified for Access Method 'Telstra L2IG'. . You have configured your plan incorrectly. Certain access types can only be used together with certain access methods. Current AAPT rules permit the following:

* Access Method AAPT ADSL2+/ Access Type SSS

* Access Method iiNet ADSL2+/ Access Type SSS

* Access Method Telstra L2IG / Access Type DSL-L2

* Access Method NBN/ Access Type NFAS

 These attributes are set on the buy service plan at the top of the plan hierachy as pictured. . If you encounter this error you need to fix your plan, abort the service subscription and reallocate.

[[File:2014-11-19_09_12_06-Cumulus_-_Packages_and_Plans_-_Management_-_Properties.png]]

 
 

* FrontierLinkService_newService - Request failed, message was: In Flight Order validation failed - A pending service order exists . This error typically occurs when there was an issue with provisioning, and provisioning was resubmitted under the assumption that the order was never acknowledged by AAPT. In this case you will likely need to use manual provisioning to activate the order, once the service is marked as active in FrontierWeb.

* FrontierLinkService_newService - Request failed, message was: Error submitting order. - Error submitting order as the qualification has expired for qualification Id = 943155 . When an order is generated, there is an initial SQ. Sometimes provisioning fails and the subscription remains preactive/halted for some time until someone retries provisioning. SQ's are only valid for about 24 hrs before AAPT will ask for a new SQ. The system has been modified in recent times to deal with this error better. If you click retry provisioning the system will now perform a fresh SQ sidestepping this issue.

* Could not Find AAPT response object - was this service ordered via Cumulus? . This error occurs during cancellation. If the service in Emersion has been manually activated during the course of provisioning, or was, for example, imported in an Active state, or was created via any other method other than normal provisioning, then this error will occur. It occurs because when an order is submitted to AAPT, they send back a response with an Integration Reference ID. If AAPT has not responded to us properly, or there was some other error, we don't get this ID. If the service is manually activated, billing begins without the Reference ID in our system. This same reference ID is used to cancel the service when talking to AAPT during cancellation stage. Therefore if the ID is not there, cancellations won't work. If you get this error and you need to cancel, you will have no choice but to finish the cancellation via manual provisioning.

* Request failed, message was: cvc-pattern-valid: Value '0407xxxxxx' is not facet-valid with respect to pattern '((0)[2,3,7,8][0-9]{8})|((13)\d{4})|((1300|1800)\d{6})' for type 'LandLineTelephoneNumber'. For more information regarding this error, click on the following link. [http://wiki.emersion.com/wiki/index.php/Provisioning/AAPT_Error_Landline_Telephone_Number Provisioning Error Landline Telephone Number]

* FrontierLinkV2Service_enquireService - Request failed, message was: java.lang.OutOfMemoryError: Java heap space; nested exception is: java.lang.OutOfMemoryError: Java heap space - java.lang.OutOfMemoryError: Java heap space; nested exception is: java.lang.OutOfMemoryError: This is an error at AAPT's end. If provisioning has halted, you can click retry provisioning which should reinitiate polling. If you cannot retry, or repolling doesn't start again within a few hours, contact Emersion.

* FrontierLinkV2Service_enquireService - Request failed, message was: Service Temporarily Unavailable - 0 > File . This is a temporary AAPT error. If you click retry provisioning it should start polling AAPT again for status updates. Again if you cannot retry, or repolling doesn't start again within a few hours, contact Emersion.

* FrontierLinkV2Service_enquireService - Request failed, message was: Service Not Found - Multiple services found based on specified criteria - Services found: xxxx, xxxxx . There are multiple orders in FrontierWeb for the same service service identifier/location identifier. Even if one is withdrawn and one is complete, AAPT will continue to return two results, preventing auto - activation in Emersion. You will need to manually provision to step around this.

* FrontierLinkV2Service_newService - Request failed, message was: cvc-datatype-valid.1.2.1: is not a valid value for integer. - org.xml.sax.SAXParseException: cvc-datatype-valid.1.2.1 This means that we have tried to send either a phone number, or a LocationID to AAPT to provision a service, however the service identifier against the subscription is not in the correct format, and cannot correctly represent a service identifier or phone number. If this error is received you should abort the subscription and reallocate the subscription with a correctly formatted service identifier (this will be required anyway to get a valid SQ result). If for whatever reason the service is already active in FrontierWeb, you should use manual provisioning to complete provisioning.

* FrontierLinkV2Service_newService - Request failed, message was: cvc-pattern-valid: Value '09111222' is not facet-valid with respect to pattern '((0|[+]61)[2,3,4,7,8]\d{8})|((1300|1800)\d{6})|((13)\d{4})|((\+)\d*)' for type 'AustralianTelephoneNumber'. - org.xml.sax.SAXParseException: cvc-pattern-valid: Value '09111222' is not facet-valid with respect to pattern '((0|[+]61)[2,3,4,7,8]\d{8})|((1300|1800)\d{6})|((13)\d{4})|((\+)\d*)' for type 'AustralianTelephoneNumber'. > File (FrontierLinkV2Service_newService_dd119256e9809239d66fa0fa95312485.log) . Fix the phone number on the primary/billing contact and add the area code and retry provisioning.

Wholesaler/CreatingServiceProviders

2018-09-12T05:58:55Z

Dcowan:

{{DISPLAYTITLE:Setting up a Retail Service Provider in your Emersion Wholesale Account}}
== Introduction ==

This process is the complete wholesaler's process for setting up new Retail Service Provider (RSP) account.

This is a multi-part process involving several steps which we have listed below. Wholesalers should always allow approximately 1 week elapsed time to set up the RSP account and have it operating. Allow additional time if you require Emersion to assist with copying plans to your new RSP account. An estimate can be provided back to you when the work request is submitted.

Steps:

# Gather required information from your RSP
# Create the Emersion Account
# Submit a Work Request ticket to set up File Transfer Protocol (FTP) access
# Provide information back to your RSP
# Submit a Work Request ticket to Emersion to copy plans from your Template SP to the new non-retail billing Service Provider (NRB) ''Optional''

== Gather Required information from RSP ==

You need to gather from your new RSP the following information, most of which is probably in your existing contract process.

# Confirm the RSP is not an existing Emersion customer.
# If the RSP is an existing Emersion customer, please request the RSP to contact Emersion directly to confirm the purchase fo services from yourself.
## '''DO NOT CONTINUE'''. As the customer is already an existing Emersion customer, you will not be required to create the account.
## Primary and Billing Contact Details
##* Ensure you have a landline number for the RSP. This is required by some service types.
# Confirm the ABN.
# Confirm the login realm/domain the RSP wishes to use to login to Cumulus. This will always be in the format of @xxx.xx.xx and forms the suffix to all staff logins used by the RSP to log into Cumulus.
# If you have "Auth" based service types the realm(s) they wish to use for those service types.
# Any IP Addresses they wish to access Service Information Records (SIR) from (normally should include their office IP or billing provider IPs)

== Create the Emersion Account ==

1. Login to Cumulus using your Wholesale Account login 
2. Create the RSP account in Cumulus

Video tutorial: Set up a new service provider under your wholesale account in Cumulus: [[Account/ServiceProviderAccountCreation]]

3. Create a Package Catalogue for the RSP 
Create the Package Catalogue 
Assign Package Groups to the RSP (you may need to create a custom package group)

Video tutorial and further information: [[PackagePlans/LinkingPackageAndServicePlans]]

4. Copy Template Plans into the RSP Account 
If you have access to Plan Copier, use Plan Copier to copy the appropriate plans from your "Template SP" into the New RSP account. 
If you don't have access to plan copier, submit a request to Emersion as per the section below

5. Test access to the RSP account using the automatically generated useradmin@realm credentials.

6. Set up restricted roles and permissions 
If you wish to further restrict the access your RSP has you can modify the permissions on the default roles. You may also offer to create additional logins for the RSP to help them start selling quicker.

Video tutorial: How to create and manage basic permission sets, and apply them to users [[Basic_Permissions]]

== Submit a ticket to Emersion Support to setup FTP access ==

Once the account is set up in Cumulus, the Emersion team will need to configure our systems. Submit a work request ticket by logging into the [https://support.emersion.com Emerson Support Portal] and creating a new ticket in the '''Work Requests queue'''. The cost for activating or adding an RSP is detailed in your Agreement with Emersion. Please allow for a 1 week turn around on these requests once we have '''all''' the required information.

Please include the following required information in your ticket or use the text below as a template for your ticket:

<pre>
Dear Support,
We are currently setting up a new Retail Service Provider account. Please set up SIR generation and FTP access to the SIRs for the RSP below.

Emersion Account Number for RSP:
Emersion Account Name for RSP:
IP Addresses the RSP will connect to our FTP from:

Regards,

</pre>

== Provide Information back to your RSP ==

# Provide the login details to your contact and ask them to change the password and create accounts for their staff.
# Provide the FTP details received from Emersion and ask them to test access from the IPs provided.

Use the template below to provide details to your RSP:

<pre>
Dear NRB,
Welcome to [TestSP Wholesale].

[TestSP Wholesale] uses Emersion Software System's Cumulus platform for ordering, provisioning and service assurance. Please find below information on accessing cumulus.

Cumulus URL: https://cumulus.emersion.com.au
Username: useradmin@[cumulusrealm]
Password: [cumuluspassword]

Please change the useradmin password once you login. You may then create additional users as required.

A Quick Start guide is available from Emersion's wiki (http://wiki.emersion.com/wiki/index.php/QuickStartGuide/NonRetailBiller) along with short videos that show you how to perform common tasks.

Use your cumulus login to access the wiki.

Emersion will produce daily SIR files for you to download and import into your billing system.
Please find below the access details

FTP site: ftp.bms.emersion.com.au
Username: [ftpusername]
Password: [ftppassword]
IP Addresses: [rspipaddresses]
You will only be able to access the ftp site from the IP addresses listed above.

SIR documentation is available on the Emersion wiki.

Should you need any more information, please contact us on the details below.
If needed, we will escalate issues on your behalf to Emersion.

Regards,
[TestSP Wholesale]
Phone [TestSP Phone]
Email: [TestSP Support]

</pre>

== Optional ==

For the new Retail Service Provider to place orders with you, they will need to be given the relevant packages to choose from. There are three ways to do this:

# Manually recreate the plans inside the RSP account 
Use the UserAdmin to create a Support account for your own use - We recommend you to do this anyway in order to provide them support as required. Use your Wholesale Support account to manually build the plans that the RSP will need.
# Use '''Plan Copier''' to copy the plans from your Template SP Account to the new RSP account.
# Submit a Work Request ticket for Emersion to copy plans from your Template SP to the new non-retail billing Service Provider (NRB). 
Please allow a 1 week turnaround time for your request.
Please do not give instructions to move "All Plans". This means we will move EVERYTHING and 99% of the time, the results are undesirable. Most Service Providers have some packages in tiers and will only want 1 Tier offered to the new service provider. To avoid costly re-work, we will only proceed with requests to copy plans from one Service Provider account to other when a list of Package IDs and corresponding package names to be copied are provided to us in an MS Excel file your Work Request.

=== Plan Copier ===

Plan Copier is an administrative tool that copies package plans, service plans, rate cards & product rate cards in bulk from one Emersion account to another. Access to '''Plan Copier''' is only granted after you undergo specific training in its use and limitations. Training will run approximately 30-45 minutes plus question time provided you have completed the training pre-requisites. Training is charged at a per hour rate and is available upon request. Please submit a Work Request ticket if you want to book training in the use of '''Plan Copier''' .

Mistakes when using Plan Copier are very easy to make so please be ''very'' careful when using it. Emersion is not responsible for errors made in the system due to a lack of care or a lack of understanding. Emersion can fix errors made with '''Plan Copier''', but you will be invoiced for the cost in us doing so.

=== Submit a Work Request ticket for Emersion to copy plans from your Template SP to the new non-retail billing Service Provider (NRB)===

Use the template below to create a ticket to have the plans copied from your Wholesale Service Provider account to your new non-retail billing Service Provider.

Please submit one ticket PER SERVICE PROVIDER. Requests for Emersion to copy plans from one account to another are billable on a time & materials basis unless otherwise agreed. Check your Agreement with Emersion for the cost that may apply to you.

Please submit one ticket PER SERVICE PROVIDER.
Note: These are normally billable tasks.

<pre>
Dear Support,
Please copy the packages from our template account into the following RSP.

Emersion Account Number for Template Account (Source):

Emersion Account Number for RSP (Destination):
Emersion Account Name for RSP (Destination):

Packages:
Package ID Package Name
100000 Test Package 1

Regards,

</pre>