Emersion - User contributions [en]

Plan Definition Overview and Creation Walk Through

2021-07-16T06:23:13Z

Scarpenter:

=This Content Has Moved House=

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/Plan+Building+and+Plan+Management Take me to the Emersion Knowledge Base article]

InvoiceManagementSetup

2021-03-15T00:30:37Z

Scarpenter:

=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 our new home.

[https://resources.emersion.com/display/EKB/Invoicing Take me to the Emersion Knowledge Base article]

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

Services/Service Identifier Management

2021-02-24T01:27:40Z

Scarpenter: /* Interfaces */

{{DISPLAYTITLE: Service Identifiers}}
= Overview =
Service identifiers identifies an end-user's service (or a component of a service) against all other services of the same type.

All services in Emersion must at least one identifier to distinguish it from others. This is called the core, or primary identifier and is printed on the invoice.

Examples of primary identifiers are:

* A home telephone line will adopt the resident's phone number as the primary service identifier.
* A mobile service will will adopt the mobile number.
* A VoIP/SIP service type will adopt single number as the core identifier and a range of numbers as secondary identifiers.

Service types can use multiple service identifiers to identify an entire service, with each identifier representing a distinguishable part of a service.

The format of a service identifier will vary across different types of services. However, they all contain one or more of the following characteristics:

# They are all unique to a service type.
# They may be used to identify and rate usage.
# One service identifier must be nominated as the 'core' service identifier.
# Service identifiers may be used for provisioning.
# Service identifiers may be used for authentication purposes.

== Interfaces ==
Service Identifiers can be managed via the following interfaces

=== Cumulus ===
Service Identifiers can be added in Cumulus, within two separate areas.

* The '''Services > Manual Provisioning''' area, when activating a service or processing a service change.
* The '''Customer > Service Subscriptions > Configuration''' tab, when a core identifier of an active service needs to be updated. A message will be displayed to the user when additions and changes to identifiers will not go through a service qualification process.
* The '''Customer > Service Subscription > Service Identifiers''' tab, for entering secondary identifiers at any time and for the setting of different attributes, e.g. vanity name.

There is also a service identifier import tool and another to set service identifier vanity names.

Should you require access to manage multiple service identifiers for a single service, and do not have access to the '''Service Identifiers''' sub tab of a service subscription, please raise a request with Emersion to have it enabled for your Cumulus Retail instance.

=== API ===
The Services APIs contain the ability to manage service identifiers.

=== Service Activation Portal ===
Support is provided to enter core/primary identifiers within the Service Activation Portal when activating the service.

= Types of Service Identifiers =

===Core/Primary Identifiers===
The core service identifier, sometimes referred to as the 'primary' identifier is printed on the customer's invoice. It is also used to identify usage, if the service type includes a usage feed.

There cannot be more than 1 core service identifier covering the same date range.

Parent accounts of ends users (the retail service provider) has full control over adding and editing core identifiers against ''preactive'' and ''active'' services.

Wholesalers can enter core service identifiers against services in the '''Manual Provisioning''' interface when they are wholly responsible for the provisioning of those services to their downstream retail providers, or the service type belongs to them.

===Authentication ('Auth') Identifiers===
These are identifiers that are used in the provisioning of data services. They comprise a username, password and a realm. The are also flagged as Auth identifiers.

Parent accounts of ends users (the retail service provider) has full control over adding and editing core identifiers against ''preactive'' and ''active'' services.

When the service type belongs to the wholesaler, the wholesaler will see the realms associated with service.

Anybody else with permission to access will be unable to add or edit these identifiers, or convert an existing identifier to an Auth identifier.

=== Secondary Identifiers===
These are not Core/Primary and not Auth identifiers. Parent accounts of ends users (the retail service provider) has full control over adding and editing core identifiers against ''preactive'' and ''active'' services.

== Business Rules ==
The following rules apply to entering service identifiers.

* Service identifiers cannot be added against cancelled services.
* There cannot be more than 1 core service identifier covering the same date range as another core identifier.
* If a replacement core identifier is entered, the core identifier it is replacing will be automatically end dated to prevent overlap.
* Usage received for any service identifier received that is outside the active date range will fall into quarantine.
* Service identifiers cannot be backdated to a date prior to the service subscription start date.
* Service identifiers are validated by the system. Different service types have different requirements the service identifier needs to use. E.g. an FNN, a username@realm, etc.
* Text-based identifiers are not case sensitive. For example, ''identify'' and ''IDENTIFY'' are considered by the system as the same identifier.
* In the cases of full national phone numbers, different variants of the same number (i.e. 04xxxxxxxxx and 614xxxxxxxxx) are considered different identifiers.
* Passwords are invalid for identifiers not flagged as Auth.

'''IMPORTANT!''' Service identifiers are tied to the service itself, not the service subscription. Users can add identifiers to a service from any of its subscriptions, including subscriptions that are inactive. This is the case as long as the service itself remains active. As identifiers belong to the service, identifiers added on one subscription are present when looking at other subscriptions for the same service.

== Service ID vs Service Identifier ==
It is important to know that the service ID and the service identifier are not the same.

The '''Service ID''' is the Emersion-generated unique number that identifies this service from all others in the system. The number is unique to the system. It is not known by, or displayed to, an end-user. You may give this number to our support team to identify the service if you ever need help with it.

The '''Service Identifier''' is the identifier known by the end-user of the service. It is unique to a service type, and displayed on the customer's invoice. Your customer may give this identifier to you when making a query regarding the service.

= Adding Service Identifiers =

Navigate to the customer's service subscription. Find the service subscription and open it.
Click on the Service Identifiers sub tab.

Nav: '''Customer > Service Subscription > Service Identifiers'''

The tab will open with existing service identifiers listed in the table.

To add a new identifier, click the '''Add New Identifier''' button and complete the fields as shown below.

[[file: Add-new-si.png]]

The field definitions are as follows:

;Service Identifier
Enter the service identifier.

;Realm
Enter an optional realm if needed.

;Password
Enter the password provided to the end user for authentication. This is used when the ''IsAuth'' flag is enabled.

;Vanity Identifier
Use this field to override the service identifier with a client-friendly name that will display on the invoice and end user portal. e.g: Jack's Mobile, Collins Street Office, etc. Users can also apply vanity names to service identifiers using this [[Data Import/Service Identifier Vanity|handy bulk tool]]. Vanity names on service identifiers can be up to 100 characters.

;Identifier start date
Give the start date of the service identifier commences. This date will be used by the system to collect and rate usage. Be aware that usage prior to the start date will not be rated and will fall into [[quarantine]]. While a service identifier may not be unique across different service types, it is unique within the service type. While the system will allow 'duplicate' service identifiers, they cannot overlap in terms of start/end dates.

;Identifier end date:
Give an optional end date to the service identifier

;Core Identifier flag
Tick this box if the service identifier you are entering is the ''core'' identifier. It is mandatory for all services to have a single service identifier marked as ''core''.

;Provisioning Identifier flag
Tick this box if the service identifier you are entering is used to provision. This is only required for service types with fully automated provisioning.

;Authentication Identifier flag
Tick this box if the service identifier is used to authenticate the service. This is used in RADIUS based service types. If this is ticked, the password field will be displayed under the ''realm'' field, and prompt the user to enter a password.

== Access Control ==
The following powers can be used to secure users' access to service identifiers.

;Service Identifier
Provides access to the service identifier management section under the service subscription and within the '''Manual Provisioning''' section.

;View service identifier list
Grants access to view the service identifier list.

;View service identifier
Ability to view service identifiers.

;Edit service identifier
Grants access to modify a non-core service identifier. If the user requires the ability to update a core identifier, enable the "Update core identifier" power.

;Delete service identifier
Access to delete service identifier.

;Update core identifier
Access to edit/update the core identifier.

= See Also =
* [[Data Import/Service Identifier Vanity|Update Service Identifiers with Vanity Names]]

Services/Service Identifier Management

2021-02-24T01:26:27Z

Scarpenter:

{{DISPLAYTITLE: Service Identifiers}}
= Overview =
Service identifiers identifies an end-user's service (or a component of a service) against all other services of the same type.

All services in Emersion must at least one identifier to distinguish it from others. This is called the core, or primary identifier and is printed on the invoice.

Examples of primary identifiers are:

* A home telephone line will adopt the resident's phone number as the primary service identifier.
* A mobile service will will adopt the mobile number.
* A VoIP/SIP service type will adopt single number as the core identifier and a range of numbers as secondary identifiers.

Service types can use multiple service identifiers to identify an entire service, with each identifier representing a distinguishable part of a service.

The format of a service identifier will vary across different types of services. However, they all contain one or more of the following characteristics:

# They are all unique to a service type.
# They may be used to identify and rate usage.
# One service identifier must be nominated as the 'core' service identifier.
# Service identifiers may be used for provisioning.
# Service identifiers may be used for authentication purposes.

== Interfaces ==
Service Identifiers can be managed via the following interfaces

=== Cumulus ===
Service Identifiers can be added in Cumulus, within two separate areas.

The '''Services > Manual Provisioning''' area, when activating a service or processing a service change.
The '''Customer > Service Subscriptions > Configuration''' tab, when a core identifier of an active service needs to be updated. A message will be displayed to the user when additions and changes to identifiers will not go through a service qualification process.
The '''Customer > Service Subscription > Service Identifiers''' tab, for entering secondary identifiers at any time and for the setting of different attributes, e.g. vanity name.

There is also a service identifier import tool.

Should you require access to manage multiple service identifiers for a single service, and do not have access to the '''Service Identifiers''' sub tab of a service subscription, please raise a request with Emersion to have it enabled for your Cumulus Retail instance.

=== API ===
The Services APIs contain the ability to manage service identifiers.

=== Service Activation Portal ===
Support is provided to enter core/primary identifiers within the Service Activation Portal when activating the service.

= Types of Service Identifiers =

===Core/Primary Identifiers===
The core service identifier, sometimes referred to as the 'primary' identifier is printed on the customer's invoice. It is also used to identify usage, if the service type includes a usage feed.

There cannot be more than 1 core service identifier covering the same date range.

Parent accounts of ends users (the retail service provider) has full control over adding and editing core identifiers against ''preactive'' and ''active'' services.

Wholesalers can enter core service identifiers against services in the '''Manual Provisioning''' interface when they are wholly responsible for the provisioning of those services to their downstream retail providers, or the service type belongs to them.

===Authentication ('Auth') Identifiers===
These are identifiers that are used in the provisioning of data services. They comprise a username, password and a realm. The are also flagged as Auth identifiers.

Parent accounts of ends users (the retail service provider) has full control over adding and editing core identifiers against ''preactive'' and ''active'' services.

When the service type belongs to the wholesaler, the wholesaler will see the realms associated with service.

Anybody else with permission to access will be unable to add or edit these identifiers, or convert an existing identifier to an Auth identifier.

=== Secondary Identifiers===
These are not Core/Primary and not Auth identifiers. Parent accounts of ends users (the retail service provider) has full control over adding and editing core identifiers against ''preactive'' and ''active'' services.

== Business Rules ==
The following rules apply to entering service identifiers.

* Service identifiers cannot be added against cancelled services.
* There cannot be more than 1 core service identifier covering the same date range as another core identifier.
* If a replacement core identifier is entered, the core identifier it is replacing will be automatically end dated to prevent overlap.
* Usage received for any service identifier received that is outside the active date range will fall into quarantine.
* Service identifiers cannot be backdated to a date prior to the service subscription start date.
* Service identifiers are validated by the system. Different service types have different requirements the service identifier needs to use. E.g. an FNN, a username@realm, etc.
* Text-based identifiers are not case sensitive. For example, ''identify'' and ''IDENTIFY'' are considered by the system as the same identifier.
* In the cases of full national phone numbers, different variants of the same number (i.e. 04xxxxxxxxx and 614xxxxxxxxx) are considered different identifiers.
* Passwords are invalid for identifiers not flagged as Auth.

'''IMPORTANT!''' Service identifiers are tied to the service itself, not the service subscription. Users can add identifiers to a service from any of its subscriptions, including subscriptions that are inactive. This is the case as long as the service itself remains active. As identifiers belong to the service, identifiers added on one subscription are present when looking at other subscriptions for the same service.

== Service ID vs Service Identifier ==
It is important to know that the service ID and the service identifier are not the same.

The '''Service ID''' is the Emersion-generated unique number that identifies this service from all others in the system. The number is unique to the system. It is not known by, or displayed to, an end-user. You may give this number to our support team to identify the service if you ever need help with it.

The '''Service Identifier''' is the identifier known by the end-user of the service. It is unique to a service type, and displayed on the customer's invoice. Your customer may give this identifier to you when making a query regarding the service.

= Adding Service Identifiers =

Navigate to the customer's service subscription. Find the service subscription and open it.
Click on the Service Identifiers sub tab.

Nav: '''Customer > Service Subscription > Service Identifiers'''

The tab will open with existing service identifiers listed in the table.

To add a new identifier, click the '''Add New Identifier''' button and complete the fields as shown below.

[[file: Add-new-si.png]]

The field definitions are as follows:

;Service Identifier
Enter the service identifier.

;Realm
Enter an optional realm if needed.

;Password
Enter the password provided to the end user for authentication. This is used when the ''IsAuth'' flag is enabled.

;Vanity Identifier
Use this field to override the service identifier with a client-friendly name that will display on the invoice and end user portal. e.g: Jack's Mobile, Collins Street Office, etc. Users can also apply vanity names to service identifiers using this [[Data Import/Service Identifier Vanity|handy bulk tool]]. Vanity names on service identifiers can be up to 100 characters.

;Identifier start date
Give the start date of the service identifier commences. This date will be used by the system to collect and rate usage. Be aware that usage prior to the start date will not be rated and will fall into [[quarantine]]. While a service identifier may not be unique across different service types, it is unique within the service type. While the system will allow 'duplicate' service identifiers, they cannot overlap in terms of start/end dates.

;Identifier end date:
Give an optional end date to the service identifier

;Core Identifier flag
Tick this box if the service identifier you are entering is the ''core'' identifier. It is mandatory for all services to have a single service identifier marked as ''core''.

;Provisioning Identifier flag
Tick this box if the service identifier you are entering is used to provision. This is only required for service types with fully automated provisioning.

;Authentication Identifier flag
Tick this box if the service identifier is used to authenticate the service. This is used in RADIUS based service types. If this is ticked, the password field will be displayed under the ''realm'' field, and prompt the user to enter a password.

== Access Control ==
The following powers can be used to secure users' access to service identifiers.

;Service Identifier
Provides access to the service identifier management section under the service subscription and within the '''Manual Provisioning''' section.

;View service identifier list
Grants access to view the service identifier list.

;View service identifier
Ability to view service identifiers.

;Edit service identifier
Grants access to modify a non-core service identifier. If the user requires the ability to update a core identifier, enable the "Update core identifier" power.

;Delete service identifier
Access to delete service identifier.

;Update core identifier
Access to edit/update the core identifier.

= See Also =
* [[Data Import/Service Identifier Vanity|Update Service Identifiers with Vanity Names]]

Services/Service Identifier Management

2021-02-24T01:23:15Z

Scarpenter:

{{DISPLAYTITLE: Service Identifiers}}
= Overview =
Service identifiers identifies an end-user's service (or a component of a service) against all other services of the same type.

All services in Emersion must at least one identifier to distinguish it from others. This is called the core, or primary identifier and is printed on the invoice.

Examples of primary identifiers are:

* A home telephone line will adopt the resident's phone number as the primary service identifier.
* A mobile service will will adopt the mobile number.
* A VoIP/SIP service type will adopt single number as the core identifier and a range of numbers as secondary identifiers.

Service types can use multiple service identifiers to identify an entire service, with each identifier representing a distinguishable part of a service.

The format of a service identifier will vary across different types of services. However, they all contain one or more of the following characteristics:

# They are all unique to a service type.
# They may be used to identify and rate usage.
# One service identifier must be nominated as the 'core' service identifier.
# Service identifiers may be used for provisioning.
# Service identifiers may be used for authentication purposes.

== Interfaces ==
Service Identifiers can be managed via the following interfaces

=== Cumulus ===
Service Identifiers can be added in Cumulus, within two separate areas.

The Services > Manual Provisioning, when activating a service or processing a service change.
The ''Customer > Service Subscriptions > Configuration'' tab, when a core identifier of an active service needs to be updated. A message will be displayed to the user when additions and changes to identifiers will not go through a service qualification process.
The ''Customer > Service Subscription > Service Identifiers'' tab, for entering secondary identifiers at any time and for the setting of different attributes, e.g. vanity name.

There is also a service identifier import tool.

Should you require access to manage multiple service identifiers for a single service, and do not have access to the ''Service Identifiers'' sub tab of a service subscription, please raise a request with Emersion to have it enabled for your Cumulus Retail instance.

=== API ===
The Services APIs contain the ability to manage service identifiers.

=== Service Activation Portal ===
Support is provided to enter core/primary identifiers within the Service Activation Portal when activating the service.

= Types of Service Identifiers =

===Core/Primary Identifiers===
The core service identifier, sometimes referred to as the 'primary' identifier is printed on the customer's invoice. It is also used to identify usage, if the service type includes a usage feed.

There cannot be more than 1 core service identifier covering the same date range.

Parent accounts of ends users (the retail service provider) has full control over adding and editing core identifiers against '''preactive''' and '''active''' services.

Wholesalers can enter core service identifiers against services in the ''Manual Provisioning'' interface when they are wholly responsible for the provisioning of those services to their downstream retail providers, or the service type belongs to them.

===Authentication ('Auth') Identifiers===
These are identifiers that are used in the provisioning of data services. They comprise a username, password and a realm. The are also flagged as Auth identifiers.

Parent accounts of ends users (the retail service provider) has full control over adding and editing core identifiers against '''preactive''' and '''active''' services.

When the service type belongs to the wholesaler, the wholesaler will see the realms associated with service.

Anybody else with permission to access will be unable to add or edit these identifiers, or convert an existing identifier to an Auth identifier.

=== Secondary Identifiers===
These are not Core/Primary and not Auth identifiers. Parent accounts of ends users (the retail service provider) has full control over adding and editing core identifiers against '''preactive''' and '''active''' services.

== Business Rules ==
The following rules apply to entering service identifiers.

* Service identifiers cannot be added against cancelled services.
* There cannot be more than 1 core service identifier covering the same date range as another core identifier.
* If a replacement core identifier is entered, the core identifier it is replacing will be automatically end dated to prevent overlap.
* Usage received for any service identifier received that is outside the active date range will fall into quarantine.
* Service identifiers cannot be backdated to a date prior to the service subscription start date.
* Service identifiers are validated by the system. Different service types have different requirements the service identifier needs to use. E.g. an FNN, a username@realm, etc.
* Any number of additional identifiers may be needed to entered and managed in Cumulus. This can be done via the '''Service Subscription > Service Identifiers''' tab.
* Text-based identifiers are case insensitive. For example, ''identify'' and ''IDENTIFY'' are considered by the system as the same identifier.
* In the cases of full national phone numbers, different variants of the same number (i.e. 04xxxxxxxxx and 614xxxxxxxxx) are considered different identifiers.
* Passwords are invalid for identifiers not flagged as IsAuth.

'''IMPORTANT!''' Service identifiers are tied to the service itself, not the service subscription. Users can add identifiers to a service from any of its subscriptions, including subscriptions that are inactive. This is the case as long as the service itself remains active. As identifiers belong to the service, identifiers added on one subscription are present when looking at other subscriptions for the same service.

== Service ID vs Service Identifier ==
It is important to know that the service ID and the service identifier are not the same.

The '''Service ID''' is the Emersion-generated unique number that identifies this service from all others in the system. The number is unique to the system. It is not known by, or displayed to, an end-user. You may give this number to our support team to identify the service if you ever need help with it.

The '''Service Identifier''' is the identifier known by the end-user of the service. It is unique to a service type, and displayed on the customer's invoice. Your customer may give this identifier to you when making a query regarding the service.

= Adding Service Identifiers =

Navigate to the customer's service subscription. Find the service subscription and open it.
Click on the Service Identifiers sub tab.

Nav: Customer > Service Subscription > Service Identifiers

The tab will open with existing service identifiers listed in the table.

To add a new identifier, click the '''Add New Identifier''' button and complete the fields as shown below.

[[file: Add-new-si.png]]

The field definitions are as follows:

;Service Identifier
Enter the service identifier.

;Realm
Enter an optional realm if needed.

;Password
Enter the password provided to the end user for authentication. This is used when the ''Authentication Identifier'' flag is enabled.

;Vanity Identifier
Use this field to override the service identifier with a client-friendly name that will display on the invoice and end user portal. e.g: Jack's Mobile, Collins Street Office, etc. Users can also apply vanity names to service identifiers using this [[Data Import/Service Identifier Vanity|handy bulk tool]]. Vanity names on service identifiers can be up to 100 characters.

;Identifier start date
Give the start date of the service identifier commences. This date will be used by the system to collect and rate usage. Be aware that usage prior to the start date will not be rated and will fall into [[quarantine]]. While a service identifier may not be unique across different service types, it is unique within the service type. While the system will allow 'duplicate' service identifiers, they cannot overlap in terms of start/end dates.

;Identifier end date:
Give an optional end date to the service identifier

;Core Identifier flag
Tick this box if the service identifier you are entering is the ''core'' identifier. It is mandatory for all services to have a single service identifier marked as ''core''.

;Provisioning Identifier flag
Tick this box if the service identifier you are entering is used to provision. This is only required for service types with fully automated provisioning.

;Authentication Identifier flag
Tick this box if the service identifier is used to authenticate the service. This is used in RADIUS based service types. If this is ticked, the password field will be displayed under the ''realm'' field, and prompt the user to enter a password.

== Access Control ==
The following powers can be used to secure users' access to service identifiers.

;Service Identifier
Provides access to the service identifier management section under the service subscription and within the '''Manual Provisioning''' section.

;View service identifier list
Grants access to view the service identifier list.

;View service identifier
Ability to view service identifiers.

;Edit service identifier
Grants access to modify a non-core service identifier. If the user requires the ability to update a core identifier, enable the "Update core identifier" power.

;Delete service identifier
Access to delete service identifier.

;Update core identifier
Access to edit/update the core identifier.

= See Also =
* [[Data Import/Service Identifier Vanity|Update Service Identifiers with Vanity Names]]

Services/Service Identifier Management

2021-02-23T23:54:18Z

Scarpenter:

{{DISPLAYTITLE: Service Identifiers}}
= Overview =
Service identifiers identifies an end-user's service (or a component of a service) against all other services of the same type.

All services in Emersion must at least one identifier to distinguish it from others. This is called the core, or primary identifier and is printed on the invoice.

Examples of primary identifiers are:

* A home telephone line will adopt the resident's phone number as the primary service identifier.
* A mobile service will will adopt the mobile number.
* A VoIP/SIP service type will adopt single number as the core identifier and a range of numbers as secondary identifiers.

Service types can use multiple service identifiers to identify an entire service, with each identifier representing a distinguishable part of a service.

The format of a service identifier will vary across different types of services. However, they all contain one or more of the following characteristics:

# They are all unique to a service type.
# They may be used to identify and rate usage.
# One service identifier must be nominated as the 'core' service identifier.
# Service identifiers may be used for provisioning.
# Service identifiers may be used for authentication purposes.

Should you require access to manage multiple service identifiers for a single service, and do not have access to the ''Service Identifiers'' sub tab of a service subscription, please raise a request with Emersion to have it enabled for your Cumulus Retail instance.

== Use Of Service Identifiers ==
By default, retail providers can enter service identifiers against an account holder's service. The end user of the service is their customer. Parent accounts of ends users (the retailer) has full control over adding and editing identifiers against services.

Wholesalers can only enter service identifiers against services when they are wholly responsible for the provisioning of those services to downstream retail providers.

== Service Identifier Business Rules ==
The following rules apply to entering service identifiers.

* Service identifiers cannot be added against cancelled services.
* There cannot be more than 1 core service identifier covering the same date range as another core identifier.
* If a replacement core identifier is entered, the core identifier it is replacing will be automatically end dated to prevent overlap.
* Usage received for any service identifier received that is outside the active date range will fall into quarantine.
* Service identifiers cannot be backdated to a date prior to the service subscription start date.
* Service identifiers are validated by the system. Different service types have different requirements the service identifier needs to use. E.g. an FNN, a username@realm, etc.
* Any number of additional identifiers may be needed to entered and managed in Cumulus. This can be done via the '''Service Subscription > Service Identifiers''' tab.
* Text-based identifiers are case insensitive. For example, ''identify'' and ''IDENTIFY'' are considered by the system as the same identifier.
* In the cases of full national phone numbers, different variants of the same number (i.e. 04xxxxxxxxx and 614xxxxxxxxx) are considered different identifiers.
* Passwords are invalid for identifiers not flagged as IsAuth.

'''IMPORTANT!''' Service identifiers are tied to the service itself, not the service subscription. Users can add identifiers to a service from any of its subscriptions, including subscriptions that are inactive. This is the case as long as the service itself remains active. As identifiers belong to the service, identifiers added on one subscription are present when looking at other subscriptions for the same service.

=== Authentication Identifiers ===
Auth identifiers require a username, a password and a realm.

== Service ID vs Service Identifier ==
It is important to know that the service ID and the service identifier are not the same.

The '''Service ID''' is the Emersion-generated unique number that identifies this service from all others in the system. The number is unique to the system. It is not known by, or displayed to, an end-user. You may give this number to our support team to identify the service if you ever need help with it.

The '''Service Identifier''' is the identifier known by the end-user of the service. It is unique to a service type, and displayed on the customer's invoice. Your customer may give this identifier to you when making a query regarding the service.

== Core Service Identifier ==
The core service identifier may also referred to as the 'primary' identifier. This identifier is displayed on the customer's invoice in the service subscription section. It is also used to identify usage for rating where the service type includes a usage feed.

'''There cannot be more than 1 core service identifier covering the same date range.''' If a user enters a new core identifier, the system will prompt the user for a date from when this identifier will be used. The system will then end-date the existing core identifier automatically.

The core service identifier can be seen in several places in Cumulus. Here are the two obvious ones:

* On the '''Services > List''' screen.

[[file: Service-list-core-identifier.png|1100px|Service List, Service Identifier]]

* On the '''Customer > Service Subscriptions''' section.

[[file: Service-subscription-core-identifier.png|1100px|Service Subscription, Service Identifier]]

* On the '''Customer > Service Subscription > Configuration''' users can edit the core identifier, subject to the business rules at the top of this article. Users can add additional service identifiers in the Service Identifier management screen.

= Service Identifier Management =
This section is for service types where additional service identifiers are required. If the service type does not support multiple identifiers, or the module is not enabled for your service provider, you will not see these screens. If you believe this to be incorrect, please raise a service desk ticket to our Customer Service tea

To access the service identifier management section:

'''Nav: Customer > Service Subscription > ''<service id>'' > Service Identifiers'''

The tab will open with any existing service identifiers listed in the table.

To add a new identifier, click the '''Add New Identifier''' button and complete the fields as shown below.

[[file: Add-new-si.png]]

The field definitions are as follows:

;Service Identifier
Enter the service identifier.

;Realm
Enter an optional realm if needed.

;Password
Enter the password provided to the end user for authentication. This is used when the ''Authentication Identifier'' flag is enabled.

;Vanity Identifier
Use this field to override the service identifier with a client-friendly name that will display on the invoice and end user portal. e.g: Jack's Mobile, Collins Street Office, etc. Users can also apply vanity names to service identifiers using this [[Data Import/Service Identifier Vanity|handy bulk tool]]. Vanity names on service identifiers can be up to 100 characters.

;Identifier start date
Give the start date of the service identifier commences. This date will be used by the system to collect and rate usage. Be aware that usage prior to the start date will not be rated and will fall into [[quarantine]]. While a service identifier may not be unique across different service types, it is unique within the service type. While the system will allow 'duplicate' service identifiers, they cannot overlap in terms of start/end dates.

;Identifier end date:
Give an optional end date to the service identifier

;Core Identifier flag
Tick this box if the service identifier you are entering is the ''core'' identifier. It is mandatory for all services to have a single service identifier marked as ''core''.

;Provisioning Identifier flag
Tick this box if the service identifier you are entering is used to provision. This is only required for service types with fully automated provisioning.

;Authentication Identifier flag
Tick this box if the service identifier is used to authenticate the service. This is used in RADIUS based service types. If this is ticked, the password field will be displayed under the ''realm'' field, and prompt the user to enter a password.

== Access Control ==
The following powers can be used to secure users' access to service identifiers.

;Service Identifier
Provides access to the service identifier management section under the service subscription and within the '''Manual Provisioning''' section.

;View service identifier list
Grants access to view the service identifier list.

;View service identifier
Ability to view service identifiers.

;Edit service identifier
Grants access to modify a non-core service identifier. If the user requires the ability to update a core identifier, enable the "Update core identifier" power.

;Delete service identifier
Access to delete service identifier.

;Update core identifier
Access to edit/update the core identifier.

= See Also =
* [[Data Import/Service Identifier Vanity|Update Service Identifiers with Vanity Names]]

Services/Service Identifier Management

2021-02-23T23:11:56Z

Scarpenter: /* Service Identifier Business Rules */

{{DISPLAYTITLE: Service Identifier Management}}
= Overview =
Service identifiers are, as the name suggests, used to identify a service or a component of a service. Many [[Service_Types|service types]] contain a single identifier to identify the service, known as the core service identifier. A home telephone line for example, will adopt the resident's phone number as the service identifier. A mobile service will use the mobile number. Other service types are more complex using multiple service identifiers to identify an entire service, or parts of a service. A number ranged service type will use one single number as the core identifier and a range of numbers as secondary identifiers.

The format of a service identifier will vary across different types of services. However, they all contain one or more of the following characteristics:

# They are all unique to a service type.
# They may be used to identify and rate usage.
# One service identifier must be nominated as the 'core' service identifier.
# Service identifiers may be used for provisioning.
# Service identifiers may be used for authentication purposes.

Cumulus contains a Service Identifier Management module enabling users to manage multiple identifiers for a service. Since not all service types require identifier management the module is enabled on an as-needed basis. Should you require access to manage multiple service identifiers for a service, please raise a ticket to the Customer Service team.

== Service Identifier Business Rules ==
The following rules apply to entering service identifiers.

* Service identifiers cannot be added against cancelled services.
* There cannot be more than 1 core service identifier covering the same date range as another core identifier.
* If a replacement core identifier is entered, the core identifier it is replacing will be automatically end dated to prevent overlap.
* Usage received for any service identifier received that is outside the active date range will fall into quarantine.
* Service identifiers cannot be backdated to a date prior to the service subscription start date.
* Service identifiers are validated by the system. Different service types have different requirements the service identifier needs to use. E.g. an FNN, a username@realm, etc.
* Any number of additional identifiers may be needed to entered and managed in Cumulus. This can be done via the '''Service Subscription > Service Identifiers''' tab.
* Text-based identifiers are case insensitive. For example, ''identify'' and ''IDENTIFY'' are considered by the system as the same identifier.
* In the cases of full national phone numbers, different variants of the same number (i.e. 04xxxxxxxxx and 614xxxxxxxxx) are considered different identifiers.
* Passwords are invalid for identifiers not flagged as IsAuth.

'''IMPORTANT!''' Service identifiers are tied to the service itself, not the service subscription. Users can add identifiers to a service from any of its subscriptions, including subscriptions that are inactive. This is the case as long as the service itself remains active. As identifiers belong to the service, identifiers added on one subscription are present when looking at other subscriptions for the same service.

=== Authentication Identifiers ===
Auth identifiers require a username, a password and a realm.

== Service ID vs Service Identifier ==
It is important to know that the service ID and the service identifier are not the same.

The '''Service ID''' is the Emersion-generated unique number that identifies this service from all others in the system. The number is unique to the system. It is not known by, or displayed to, an end-user. You may give this number to our support team to identify the service if you ever need help with it.

The '''Service Identifier''' is the identifier known by the end-user of the service. It is unique to a service type, and displayed on the customer's invoice. Your customer may give this identifier to you when making a query regarding the service.

== Core Service Identifier ==
The core service identifier may also referred to as the 'primary' identifier. This identifier is displayed on the customer's invoice in the service subscription section. It is also used to identify usage for rating where the service type includes a usage feed.

'''There cannot be more than 1 core service identifier covering the same date range.''' If a user enters a new core identifier, the system will prompt the user for a date from when this identifier will be used. The system will then end-date the existing core identifier automatically.

The core service identifier can be seen in several places in Cumulus. Here are the two obvious ones:

* On the '''Services > List''' screen.

[[file: Service-list-core-identifier.png|1100px|Service List, Service Identifier]]

* On the '''Customer > Service Subscriptions''' section.

[[file: Service-subscription-core-identifier.png|1100px|Service Subscription, Service Identifier]]

* On the '''Customer > Service Subscription > Configuration''' users can edit the core identifier, subject to the business rules at the top of this article. Users can add additional service identifiers in the Service Identifier management screen.

= Service Identifier Management =
This section is for service types where additional service identifiers are required. If the service type does not support multiple identifiers, or the module is not enabled for your service provider, you will not see these screens. If you believe this to be incorrect, please raise a service desk ticket to our Customer Service tea

To access the service identifier management section:

'''Nav: Customer > Service Subscription > ''<service id>'' > Service Identifiers'''

The tab will open with any existing service identifiers listed in the table.

To add a new identifier, click the '''Add New Identifier''' button and complete the fields as shown below.

[[file: Add-new-si.png]]

The field definitions are as follows:

;Service Identifier
Enter the service identifier.

;Realm
Enter an optional realm if needed.

;Password
Enter the password provided to the end user for authentication. This is used when the ''Authentication Identifier'' flag is enabled.

;Vanity Identifier
Use this field to override the service identifier with a client-friendly name that will display on the invoice and end user portal. e.g: Jack's Mobile, Collins Street Office, etc. Users can also apply vanity names to service identifiers using this [[Data Import/Service Identifier Vanity|handy bulk tool]]. Vanity names on service identifiers can be up to 100 characters.

;Identifier start date
Give the start date of the service identifier commences. This date will be used by the system to collect and rate usage. Be aware that usage prior to the start date will not be rated and will fall into [[quarantine]]. While a service identifier may not be unique across different service types, it is unique within the service type. While the system will allow 'duplicate' service identifiers, they cannot overlap in terms of start/end dates.

;Identifier end date:
Give an optional end date to the service identifier

;Core Identifier flag
Tick this box if the service identifier you are entering is the ''core'' identifier. It is mandatory for all services to have a single service identifier marked as ''core''.

;Provisioning Identifier flag
Tick this box if the service identifier you are entering is used to provision. This is only required for service types with fully automated provisioning.

;Authentication Identifier flag
Tick this box if the service identifier is used to authenticate the service. This is used in RADIUS based service types. If this is ticked, the password field will be displayed under the ''realm'' field, and prompt the user to enter a password.

== Access Control ==
The following powers can be used to secure users' access to service identifiers.

;Service Identifier
Provides access to the service identifier management section under the service subscription and within the '''Manual Provisioning''' section.

;View service identifier list
Grants access to view the service identifier list.

;View service identifier
Ability to view service identifiers.

;Edit service identifier
Grants access to modify a non-core service identifier. If the user requires the ability to update a core identifier, enable the "Update core identifier" power.

;Delete service identifier
Access to delete service identifier.

;Update core identifier
Access to edit/update the core identifier.

= See Also =
* [[Data Import/Service Identifier Vanity|Update Service Identifiers with Vanity Names]]

Quarantine

2020-06-11T03:49:29Z

Scarpenter:

= Quarantine =

The Quarantine section of Cumulus is used to review and resolve any billing issues that are encountered in the Billing and Rating engine of Emersion.

The Billing & Rating engine (Batch Mediation System or 'BMS') functions include, but are not limited to

* receiving & processing usage from your suppliers
* rating the usage in accordance with your rate cards
* appending rated usage to your customer accounts
* producing CDRs for your customers (for Wholesale Service Providers)

Issues may arise for many reasons, such as missing service information, incorrect rating data, missing tariffs, or issues with the service usage file received from your upstream service provider. The Billing and Rating engine places these records into Quarantine for manual intervention. Once the issue is resolved, the records can be re-processed through the billing and rating engine to place the associated charges on to the required account’s invoice.

Throughout the billing cycle, and particularly around the bill run, you should regularly review Quarantine to resolve billing issues placed into Quarantine to ensure your account’s invoices contain all the appropriate charges. Records in quarantine may result in missing or incorrect charges on your invoices, and lead to missing revenue.

Quarantine issues are categorised into broad two categories: [[Quarantine/BMS_Quarantine|BMS Quarantine]], which is separated into three types: Telephony BMS, Data BMS, and Misc BMS; and [[Quarantine/Rating_Quarantine|Rating Quarantine]].

This handy manual defines the reasons why usage may be quarantined and tells you how to resolve the issue.

[[media:Emersion Quarantine Manual Excerpt v0.1.pdf]]

'''Note:''' This section outlines the system actions performed to resolve billing issues identified by the Billing and Rating engine. It does not describe hjow to investigate issues and determine what action is required action to resolve each issue.

* [[Quarantine/BMS_Quarantine|BMS Quarantine]]
* [[Quarantine/Non Existent Service|Non Existent Services]]
* [[Quarantine/Rating_Quarantine|Rating Quarantine]]
* [[Quarantine/BMS Quarantine/Preactive Package| Preactive Package]]
* [https://resources.emersion.com/display/EKB/IPND+Module IPND_Quarantine]
* [[Quarantine/Service Feature Quarantine | Service Feature Quarantine]]

= See Also =
* [https://resources.emersion.com/display/EKB/Cleanse+and+Write+Off+Quarantine Cleansing Quarantine records in bulk]

Account Management/Customer Screen/Service Subscriptions/Service Contact

2020-06-11T03:48:56Z

Scarpenter:

{{DISPLAYTITLE:Service Contacts}}
= Overview =
Some service types require a service contact to be entered. This represents the user of the service when the user is not the account owner. A service contact may also be required for subscribers to the [https://resources.emersion.com/display/EKB/IPND+Module IPND module]. If a service contact is needed, it will be collected as part of the order process. After the service has been created, it can be modified on this tab.

[[file: Service-contact-tab.png|1200px|The Service Contact sub tab]]

== The Contact Index ==
The contact index places gives users the ability to sort the service contacts into a specific order. If multiple contacts are entered, users can change the number ordering and press '''Update Contact Index'''

== Viewing and Editing a Service Contact==

The example above contains a single service contact. To view the contact's details, click the ID.

Click the '''Edit''' button to put the page into EDIT mode should you want to update the information stored for the contact.

Press '''Save''' when you are done.

[[file: View-service-contact.png|1200px|Viewing a Service Contact]]

=See Also=
* [[Account_Management/Customer_Screen/Service_Subscriptions|The Service Subscription tab]]

Quarantine/IPND Quarantine

2020-06-11T03:47:37Z

Scarpenter:

=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 our new home.

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

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

Main Page

2020-04-22T02:45:43Z

Scarpenter: /* Optional Modules */

{{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">

* [https://resources.emersion.com/display/EKB/The+Cumulus+Admin+Menu 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]
* [https://resources.emersion.com/display/EKB/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]]
* [https://resources.emersion.com/display/EKB/The+Billing+Cheat+Sheet The Billing Cheat Sheet]
* [https://resources.emersion.com/display/EKB/The+Ledger+Journal 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]]
* [https://resources.emersion.com/display/EKB/Agents Agents]
* [https://resources.emersion.com/display/EKB/Cost+Centres Cost Centres]
* [[Commissions|Commissions]]
* [https://resources.emersion.com/display/EKB/Automated+Payments Electronic Payments]
* [[Inventory and Warehouses | Inventory and Warehouses]]

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

* [https://resources.emersion.com/display/EKB/Manual+Payment+Batch Manual Payment Batch]
* [https://resources.emersion.com/display/EKB/Payment+Plans Payment Plans]
* [https://resources.emersion.com/display/EKB/Service+Desk Service Desk]
* [https://resources.emersion.com/display/EKB/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]
** [https://resources.emersion.com/display/EKB/The+Activation+Portal 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

2020-04-22T02:45:04Z

Scarpenter: /* Optional Modules */

{{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">

* [https://resources.emersion.com/display/EKB/The+Cumulus+Admin+Menu 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]
* [https://resources.emersion.com/display/EKB/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]]
* [https://resources.emersion.com/display/EKB/The+Billing+Cheat+Sheet The Billing Cheat Sheet]
* [https://resources.emersion.com/display/EKB/The+Ledger+Journal 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]]
* [https://resources.emersion.com/display/EKB/Agents | Agents]
* [https://resources.emersion.com/display/EKB/Cost+Centres | Cost Centres]
* [[Commissions|Commissions]]
* [https://resources.emersion.com/display/EKB/Automated+Payments | Electronic Payments]
* [[Inventory and Warehouses | Inventory and Warehouses]]

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

* [https://resources.emersion.com/display/EKB/Manual+Payment+Batch | Manual Payment Batch]
* [https://resources.emersion.com/display/EKB/Payment+Plans | Payment Plans]
* [https://resources.emersion.com/display/EKB/Service+Desk | Service Desk]
* [https://resources.emersion.com/display/EKB/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]
** [https://resources.emersion.com/display/EKB/The+Activation+Portal | 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

2020-04-22T02:42:49Z

Scarpenter: /* Optional Modules */

{{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">

* [https://resources.emersion.com/display/EKB/The+Cumulus+Admin+Menu 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]
* [https://resources.emersion.com/display/EKB/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]]
* [https://resources.emersion.com/display/EKB/The+Billing+Cheat+Sheet The Billing Cheat Sheet]
* [https://resources.emersion.com/display/EKB/The+Ledger+Journal 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]]
* [https://resources.emersion.com/display/EKB/Agents|Agents]
* [https://resources.emersion.com/display/EKB/Cost+Centres|Cost Centres]
* [[Commissions|Commissions]]
* [https://resources.emersion.com/display/EKB/Automated+Payments|Electronic Payments]
* [[Inventory and Warehouses | Inventory and Warehouses]]

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

* [https://resources.emersion.com/display/EKB/Manual+Payment+Batch | Manual Payment Batch]
* [https://resources.emersion.com/display/EKB/Payment+Plans | Payment Plans]
* [https://resources.emersion.com/display/EKB/Service+Desk|Service Desk]
* [https://resources.emersion.com/display/EKB/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]]

Early Upgrade

2020-04-22T02:41:34Z

Scarpenter:

=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 our new home.

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

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

Service Desk

2020-04-22T02:39:43Z

Scarpenter:

=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 our new home.

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

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

EPS

2020-04-22T02:37:34Z

Scarpenter:

=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 our new home.

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

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

Account Management/Customer Screen/Payment Methods

2020-04-22T02:37:13Z

Scarpenter:

=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 our new home.

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

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

Automated Payment Status

2020-04-22T02:36:08Z

Scarpenter:

=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 our new home.

[https://resources.emersion.com/display/EKB/Auomated+Payment+Status Take me to the Emersion Knowledge Base article]

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

PaymentInfo/AutomatedPayment

2020-04-22T02:17:36Z

Scarpenter: Replaced content with "=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 unti..."

=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 our new home.

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

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

BPAY

2020-04-22T02:09:22Z

=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 our new home.

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

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

Account/AccountCreation

2020-04-22T02:04:54Z

Scarpenter: /* Wizard Screen 1: Data Definition */

= Create Customer Wizard - End User Accounts =

Creating end user customers in Emersion is able to be achieved in a number of ways, including via the

* [https://resources.emersion.com/display/EKB/The+Sign+Up+Portal Sign Up Portal]
* [[API]]
* Cumulus

This article is limited to the Create Customer wizard in Cumulus and focuses on creating ''End User'' customers. While the process is similar for other types of accounts, the fields and steps may vary. If you want to know how to create retail service providers, non-retail billing service provider, Agents or other types of accounts, start at the [[Account_Management | Account Management page]] and choose from the relevant list of account types.

To create a new customer:

Nav: '''Customer > Create Customer''' to start the wizard.

The wizard will follow a series of steps to assist you with creating an account, entering both required and optional information. The information collected via the wizard will vary based on the type of account you are creating; ''Organisation'' or ''Individual''.

The progress bar will tell users how many steps they have completed, and are yet to complete.

[[file: Account-create-wizard-01-progressbar.png || Create Customer Wizard Progress Bar]]

== Wizard Screen 1: Create Account ==
This first screen has the initial settings that determine the account's behavior in terms of billing. '''Therefore for billing to be accurate, it is important these settings are correct before proceeding.'''

[[file: Account-create-wizard-01.png]]

=== Wizard Screen 1: Data Definition ===
{|class="wikitable" style="text-align: left; width: 70%;" align="center"
|+Create Customer Wizard Step 1 - Field Definition
!Data field ||Description
|-
|style="width: 20%; |Account Enterprise || style="width: 80%;"| An account can be an individual or organisation. Data collection on the following screens changes depending on your selection here.
|-
|Account Type || Select between Agent and End User if Agent module is enabled. Otherwise leave as End User. Note: If a person or company is both an Agent ''and'' a customer of yours, they will need two accounts, one for each type.
|-
|Start Date || This date is very important. Usage cannot be processed for services before this date. Services and accounts CAN be backdated for back-billing purposes. If you do not know the actual start date of the customer, or the start date is greater than 6 months in the past, provide the earliest date from when usage will be collected. This date will be the very first opening date of the account's first account invoice period. Usage received by Emersion before this date cannot be processed onto an invoice.
|-
|Account Profile || If you have multiple [[Accounts/AccountProfiles|account profiles]] for the customer.
|-
|Account Invoice Method || Defined how the invoice will be sent to the customer.
|-
|Account Invoice Template || All accounts must be allocated an invoice template from which their invoice will be created. If you have multiple invoice template layouts, choose the one for this customer or leave it as the default. The default template can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] invoice setting or overridden for a given customer.
|-
|Account Billing Day || The actual day, within the month, that the customer [[AccountInvoicePeriod|Account Invoice Period]] will begin. This can be a default set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer. As is standard in the Emersion platform, invoices are generated 2 days after the close of the invoice period. For example: If you set this value to 7, the customer's invoice will be generated on the 10th of every month (''being 2 days after the close of the account invoice period'') and providing you have opted for the standard 1 month period length as defined by the ''Period Length Months'' field below).
|-
|Invoice Itemisation || Defines if the invoice will include itemised usage records, or a summary only.
|-
|Automatically Allocate Payments To Invoices: || Define if payments received fgrom the customer are allocated to invoices automatically. By default, payments will be allocated to the oldest invoice that has an outstanding amount owing first.
|-
|Credit Limit || This is a credit limit for the account. It is used by the system in a number of ways, for example:

* sending notifications (via [[Events]]) to either the service provider or customer when the credit limit is exceeded.
* The [[Account_Management/Auto_Top-up|auto top-up]] feature.
* The [[Provisioning/AutomaticSuspensionAndRestriction | automated suspension]] feature. This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer.
|-
|Unbilled Credit Limit || This is the unbilled credit limit for the account. This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer. If this is set, the [[SystemEvents/EventTypes#Credit_Limit_Exceeded|'''Credit Limit Exceeded''' event notification]] can be leveraged to send the customer an alert.
|-
|Trading Due Days || This setting controls how many days after an invoice has been generated it will fall due. E.g. If the customer's invoice is due 7 days after it is generated, enter "7". If the customer's invoice is due 14 days after the issue date, enter "14". This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer.
|-
|Period Length Months || The amount of time that passes between invoice periods. E.g. If you set the '''Account Billing Day''' to 1 & the '''Period Length Months''' to 1, the customer will receive an invoice on the 3rd of every month (invoices are generated 2 days after the close of the invoice period)
|-
|Align Pkgs to Acct || This flag will align any newly created package subscriptions to the underlying account invoice period for 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 some package configurations can conflict with this setting, producing undesirable billing results. For instance, 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.
|-
|Export Reference || An optional field that, if used, can be used in a customer search to locate the account. E.g. Former account number from a previous system.
|-
|CRM Export Ref || An optional field for an identifier from a legacy CRM.
|-
|Xero Account Name || Link the customer with their Xero Account. Requires the [https://resources.emersion.com/display/EKB/Xero | Xero integration] to be enabled.
|-
| Auto Generate Cost Centre || [https://resources.emersion.com/display/EKB/Auto+Generate+Cost+Centres+for+an+Account | Click here for the instructions on this setting].
|}

== Wizard Screen 2: Primary Contact ==

When the user arrives at step 2 of the wizard, a new account record is saved in the system in a status of '''Preactive''' and is given a unique ID. This ID is the customer's account number. This activity can be seen by users in a blue notification below the main Cumulus menu.

New accounts transition from '''Preactive''' to '''Active''' once all steps of the Create Customer Wizard has been completed. Should a user need to leave the wizard, or the user is thrown from the wizard for any reason at all, the account data up to the last save point is retained by the system. This means that users can exit the wizard and return at a later time without having to start the wizard from the beginning. If users know the account, they can pick up their place in the wizard where they left off.

Step two of the Create Customer Wizard captures the information of the primary contact for the account. The fields on the screen can change based on your choices. The most obvious place where this happens is in the address section. A complex address will capture more information than a simple or standard address, enabling Emersion to support address data from any other sources systems, such as legacy systems or Customer Relationship Management (CRM) systems.

''''Emersion Tip:'''' Emersion recommends breaking down the account and contact addresses into each individual field element where it is possible to do so. This data breakdown process is called 'data normalisation'. Normalising data makes reporting and searching far easier. It is very time consuming and difficult to search for customers in the suburb of "Cheltenham" if your data is entered into line number fields as "1/123 Main St" and "Cheltenham VIC 3123". Use ''Standard'' and ''Complex'' addresses where ever possible and break down the data into field elements to make this searching feasible.

<gallery>
File:Account-create-wizard-02-person.png|Personal details
File:Account-create-wizard-02-comms.png|Communication information
File:Account-create-wizard-02-addr-std.png|Address information for a Standard address
File:Account-create-wizard-02-addr-complex.png|Address information for a Complex address
File:Account-create-wizard-02-privacy.png|Privacy & verification information
File:Account-create-wizard-02-userportal.png|End User Portal login information
</gallery>

=== Wizard Screen 2: Contact Form Data Definition ===
{|class="wikitable" style="text-align: left; width: 70%;" align="center"
|+Create Customer Wizard Step 2 - Contact Form Field Definition
!Data field ||Description
|-
!colspan="2"|Personal Information
|-
|style="width: 20%; |Contact Sub-Type || style="width: 80%;"| Select from the list of options if you wish to flag this contact with any of the sub-types.
|-
|Title || Select from the list of options the correct title of the primary contact. This is also known as a 'Salutation'.
|-
|First name || The first name of the contact.
|-
|Middle Name || The middle name of the contact, if known.
|-
|Last name || The surname of the contact.
|-
|Preferred name || If the contact prefers to be known by an alternative name, enter that here.
|-
|Suffix || Give the contact an optional suffix if known.
|-
|Job title || Enter the job title if know. If you specify a job title, the Job Code is then mandatory. Otherwise, Job Code is optional.
|-
!colspan="2"|Address Information - ''''Note: Only Complex Address fields are documented here''''
|-
| Address Layout || Your selection here will determine what fields are shown to enter address information. Emersion recommends users enter addresses using the Standard or Complex layout.
|-
| Address type || Select from the list of address types, if known.
|-
|Lot number || Enter a lot number if it is part of the address.
|-
|Nearest Cross Street || A text field used to capture the nearest cross street, if desired.
|-
|Building name || A text field used to capture the name of the building if it is relevant.
|-
|Site location || A text field used to capture the site location if it is relevant.
|-
|Site name || A text field used to capture the site name if it is relevant.
|-
|Unit type || Select from a list of unit types if it is relevant. If you choose a unit type, the unit number becomes mandatory.
|-
|Unit number || Enter the number of the unit. If you enter a value here, you must choose a unit type.
|-
|Level type || Select from a list of level types if it is relevant. If you choose a level type, the level number becomes mandatory.
|-
|Level number || Enter the number of the level. If you enter a value here, you must choose a level type.
|-
|Street number || Enter the street number. If the address spans multiple numbers (e.g. 6-8) use both fields to separate the start and end street numbers.
|-
|Street name || Enter the street name. Do not enter the type after the name of the street. E.g. "Smith Street" should be entered as "Smith" and "Michigan Avenue" would be be entered as "Michigan"
|-
|Street type|| Choose the street type that matches the street name.
|-
|Street suffix|| If it is applicable, choose the street suffix.
|-
|Suburb || Enter the street name. Do not enter the type after the name of the street. E.g. "Smith Street" should be entered as "Smith" and "Michigan Avenue" would be be entered as "Michigan"
|-
|Postcode|| Enter the postcode. There is no postcode validation or postcode/suburb matching in Emersion, so be sure to enter the postcode correctly.
|-
|State|| Choose the state.
|-
|Country|| Choose from the list of countries.
|-
|Date from|| A field to store the date from when the contact commenced living/operating from at this address, if desired.
|-
!colspan="2"|Communication Information
|-
|Preferred number|| Select from the list of options. The user's choice determines which of the following phone number fields are mandatory. For example, choosing '''Mobile''' will mean at least one mobile number must be provided. Choosing landline means at least one landline number must be provided. Users can enter as many phone numbers as required by clicking the 'green plus' icon exposing further number fields.
|-
|Ext|| If you know the extension to the phone number, you can enter it.
|-
|Email|| Enter the contact's email address. Additional email addresses can be entered by clicking the 'green plus' icon exposing alt email address fields.
|-
|Internet Messaging|| Enter the IM of the contact, if desired.
|-
|Provider|| Provider of the IM service in the IM field.
|-
|Website|| Enter the website of the contact if desired without the 'http://'
|-
|Language|| Select the user's primary language.
|-
|Timezone|| Choose from the list of timezones where the user is based from.
|-
|Marketing source|| Select from the list of options how the customer was sourced.
|-
!colspan="2"|Privacy and Verification Information
|-
|Marketing Notification || Flag the customer as not interested in receiving cross-promo marketing notifications by phone or via email. Using this flag '''does not''' affect the distribution of any notifications from Emersion's system. The customer will still receive unpaid invoice reminders, usage notification alerts and all other notifications that come from the Emersion system provided they are enabled by the service provider. This flag is used in reporting only.
|-
|Account Password|| This is a clear text password that was designed to help your phone support staff validate the identity of a caller requesting support or sensitive information pertaining to the account. Service providers without a policy similar to this can enter '123456' or any 6 characters. The minimum number of characters for this field is 6.
|-
|Secret Questions and Answers || Up to 2 secret questions and answers can be nominated to help your phone support staff validate the identity of a caller requesting support or sensitive information pertaining to the account.
|-
|Gender|| Select the contact's gender.
|-
|Marital Status|| Select the contact's marital status.
|-
|Residential Status|| Select the contact's residential status.
|-
|Date of Birth|| Enter the contact's date of birth.
|-
|Birth Country|| Enter the contact's country of birth.
|-
|Drivers Licence|| Enter the number of the contact's drivers licence.
|-
|State licence|| Select the state from which the contact's drivers licence was issued.
|-
|Licence Expiry Date|| Use the date picker to select the expiry date of the contact's drivers licence.
|-
|Residency Status|| Select the contact's residency status.
|-
|Passport no| Enter the contact's passport number.
|-
|Passport Expiry Date|| Use the date picker to select the passport expiry date.
|-
|Passport Country of Issue|| Select the country from which the contact's passport was issued.
|-
|Medicare Number|| Enter the contact's medicare number.
|-
|No of Dependants|| Enter the number of dependants the contact is responsible for.
|-
|Pension Card Type|| Enter the contact's pension type.
|-
!colspan="2"|End User portal Information - This is to give the account holder access to the [[End_User_Portal_and_Customer_Sign_Up_Portal#End_User_Portal | End User Portal.]]
|-
|User portal login|| Uncheck this box if you do not want to set up End user portal access for this account or you want to set it up later. This can be done at any time under the '''Customer > Userportal''' tab. If you select this option, you will not be required to complete the mandatory fields for this section.
|-
|Username|| Enter a username for the account. The full username when the customer logs into the End User Portal is as follows:
 username + cumulus user suffix . E.g. emesupport@emersiontest.com.au or user@yourdomain.com.au. The cumulus user suffix is displayed to the right of the username field and always begins with an '@' symbol. Usernames can use A-Za-z0-9_.@ and must be a minimum of 2 characters. Usernames are not case sensitive.
|-
|Password|| Enter a password for the end user portal. Minimum number of characters is 6 and the password is case sensitive.
|-
|Retype password|| Confirm the password for the end user portal.
|}

== Wizard Screen 3: Billing Contact ==

When the user arrives at step 3 of the wizard, they are prompted to enter a billing contact. Primary and billing contacts are mandatory for all accounts.

If the primary and billing contact are the same people as often happens in an individual accounts, leave the checkbox ''''Same as primary contact?''' checked, and proceed to the next step in the wizard. The system will flag the primary contact as the billing contact.

If the primary and billing contact are different people, uncheck the ''''Same as primary contact?''' checkbox and complete the contact form for the billing contact. This form is the same as the previous form for the primary contact.

== Wizard Screen 4: Secondary Contact ==

Emersion supports any number of additional contacts for an account, however this was not always the case. Prior to that enhancement, users could provide one additional contact, known as the '''Secondary Contact'''. This screen is a legacy option left over from that time.

Users can optionally enter a single additional contact here if they choose. If the user has several additional contacts to enter, we suggest doing this after the account is created and active. Additional contacts are entered and maintained under the '''Customer > Contacts tab'''.

If the user wants to enter a single additional contact as part of account creation, select '''New''' from the list of options, complete the contact form and proceed.

To skip entering another contact now, select '''Skip Secondary Contact''' from the list of options and proceed.

== Finishing the Create Customer Wizard ==

Once users save and complete step 4, the account will be changed from a '''Preactive''' to an '''Active''' status, indicating it is ready to use. The user will be shown the main customer screen where they can inspect the sub tabs and enter additional information if needed.

[[file: Account-create-wizard-finished.png |1300px| The Customer Screen after completing the Create Customer wizard]]

= See Also =
* [[Account Management/Customer Screen | The Customer Screen]]
* [[Account/Account Status | Account Statuses]]

Account/AccountCreation

2020-04-22T02:03:43Z

Scarpenter: /* Wizard Screen 1: Create Account */

= Create Customer Wizard - End User Accounts =

Creating end user customers in Emersion is able to be achieved in a number of ways, including via the

* [https://resources.emersion.com/display/EKB/The+Sign+Up+Portal Sign Up Portal]
* [[API]]
* Cumulus

This article is limited to the Create Customer wizard in Cumulus and focuses on creating ''End User'' customers. While the process is similar for other types of accounts, the fields and steps may vary. If you want to know how to create retail service providers, non-retail billing service provider, Agents or other types of accounts, start at the [[Account_Management | Account Management page]] and choose from the relevant list of account types.

To create a new customer:

Nav: '''Customer > Create Customer''' to start the wizard.

The wizard will follow a series of steps to assist you with creating an account, entering both required and optional information. The information collected via the wizard will vary based on the type of account you are creating; ''Organisation'' or ''Individual''.

The progress bar will tell users how many steps they have completed, and are yet to complete.

[[file: Account-create-wizard-01-progressbar.png || Create Customer Wizard Progress Bar]]

== Wizard Screen 1: Create Account ==
This first screen has the initial settings that determine the account's behavior in terms of billing. '''Therefore for billing to be accurate, it is important these settings are correct before proceeding.'''

[[file: Account-create-wizard-01.png]]

=== Wizard Screen 1: Data Definition ===
{|class="wikitable" style="text-align: left; width: 70%;" align="center"
|+Create Customer Wizard Step 1 - Field Definition
!Data field ||Description
|-
|style="width: 20%; |Account Enterprise || style="width: 80%;"| An account can be an individual or organisation. Data collection on the following screens changes depending on your selection here.
|-
|Account Type || Select between Agent and End User if Agent module is enabled. Otherwise leave as End User. Note: If a person or company is both an Agent ''and'' a customer of yours, they will need two accounts, one for each type.
|-
|Start Date || This date is very important. Usage cannot be processed for services before this date. Services and accounts CAN be backdated for back-billing purposes. If you do not know the actual start date of the customer, or the start date is greater than 6 months in the past, provide the earliest date from when usage will be collected. This date will be the very first opening date of the account's first account invoice period. Usage received by Emersion before this date cannot be processed onto an invoice.
|-
|Account Profile || If you have multiple [[Accounts/AccountProfiles|account profiles]] for the customer.
|-
|Account Invoice Method || Defined how the invoice will be sent to the customer.
|-
|Account Invoice Template || All accounts must be allocated an invoice template from which their invoice will be created. If you have multiple invoice template layouts, choose the one for this customer or leave it as the default. The default template can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] invoice setting or overridden for a given customer.
|-
|Account Billing Day || The actual day, within the month, that the customer [[AccountInvoicePeriod|Account Invoice Period]] will begin. This can be a default set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer. As is standard in the Emersion platform, invoices are generated 2 days after the close of the invoice period. For example: If you set this value to 7, the customer's invoice will be generated on the 10th of every month (''being 2 days after the close of the account invoice period'') and providing you have opted for the standard 1 month period length as defined by the ''Period Length Months'' field below).
|-
|Invoice Itemisation || Defines if the invoice will include itemised usage records, or a summary only.
|-
|Automatically Allocate Payments To Invoices: || Define if payments received fgrom the customer are allocated to invoices automatically. By default, payments will be allocated to the oldest invoice that has an outstanding amount owing first.
|-
|Credit Limit || This is a credit limit for the account. It is used by the system in a number of ways, for example:

* sending notifications (via [[Events]]) to either the service provider or customer when the credit limit is exceeded.
* The [[Account_Management/Auto_Top-up|auto top-up]] feature.
* The [[Provisioning/AutomaticSuspensionAndRestriction | automated suspension]] feature. This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer.
|-
|Unbilled Credit Limit || This is the unbilled credit limit for the account. This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer. If this is set, the [[SystemEvents/EventTypes#Credit_Limit_Exceeded|'''Credit Limit Exceeded''' event notification]] can be leveraged to send the customer an alert.
|-
|Trading Due Days || This setting controls how many days after an invoice has been generated it will fall due. E.g. If the customer's invoice is due 7 days after it is generated, enter "7". If the customer's invoice is due 14 days after the issue date, enter "14". This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer.
|-
|Period Length Months || The amount of time that passes between invoice periods. E.g. If you set the '''Account Billing Day''' to 1 & the '''Period Length Months''' to 1, the customer will receive an invoice on the 3rd of every month (invoices are generated 2 days after the close of the invoice period)
|-
|Align Pkgs to Acct || This flag will align any newly created package subscriptions to the underlying account invoice period for 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 some package configurations can conflict with this setting, producing undesirable billing results. For instance, 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.
|-
|Export Reference || An optional field that, if used, can be used in a customer search to locate the account. E.g. Former account number from a previous system.
|-
|CRM Export Ref || An optional field for an identifier from a legacy CRM.
|-
|Xero Account Name || Associate the customer with a Xero Account. Requires the [https://resources.emersion.com/display/EKB/Xero | Xero integration] to be enabled.
|-
| Auto Generate Cost Centre || Requires subscription to the [https://resources.emersion.com/display/EKB/Cost+Centres | Cost Centre] module. [https://resources.emersion.com/display/EKB/Auto+Generate+Cost+Centres+for+an+Account | Click here for the instructions on this setting].
|}

== Wizard Screen 2: Primary Contact ==

When the user arrives at step 2 of the wizard, a new account record is saved in the system in a status of '''Preactive''' and is given a unique ID. This ID is the customer's account number. This activity can be seen by users in a blue notification below the main Cumulus menu.

New accounts transition from '''Preactive''' to '''Active''' once all steps of the Create Customer Wizard has been completed. Should a user need to leave the wizard, or the user is thrown from the wizard for any reason at all, the account data up to the last save point is retained by the system. This means that users can exit the wizard and return at a later time without having to start the wizard from the beginning. If users know the account, they can pick up their place in the wizard where they left off.

Step two of the Create Customer Wizard captures the information of the primary contact for the account. The fields on the screen can change based on your choices. The most obvious place where this happens is in the address section. A complex address will capture more information than a simple or standard address, enabling Emersion to support address data from any other sources systems, such as legacy systems or Customer Relationship Management (CRM) systems.

''''Emersion Tip:'''' Emersion recommends breaking down the account and contact addresses into each individual field element where it is possible to do so. This data breakdown process is called 'data normalisation'. Normalising data makes reporting and searching far easier. It is very time consuming and difficult to search for customers in the suburb of "Cheltenham" if your data is entered into line number fields as "1/123 Main St" and "Cheltenham VIC 3123". Use ''Standard'' and ''Complex'' addresses where ever possible and break down the data into field elements to make this searching feasible.

<gallery>
File:Account-create-wizard-02-person.png|Personal details
File:Account-create-wizard-02-comms.png|Communication information
File:Account-create-wizard-02-addr-std.png|Address information for a Standard address
File:Account-create-wizard-02-addr-complex.png|Address information for a Complex address
File:Account-create-wizard-02-privacy.png|Privacy & verification information
File:Account-create-wizard-02-userportal.png|End User Portal login information
</gallery>

=== Wizard Screen 2: Contact Form Data Definition ===
{|class="wikitable" style="text-align: left; width: 70%;" align="center"
|+Create Customer Wizard Step 2 - Contact Form Field Definition
!Data field ||Description
|-
!colspan="2"|Personal Information
|-
|style="width: 20%; |Contact Sub-Type || style="width: 80%;"| Select from the list of options if you wish to flag this contact with any of the sub-types.
|-
|Title || Select from the list of options the correct title of the primary contact. This is also known as a 'Salutation'.
|-
|First name || The first name of the contact.
|-
|Middle Name || The middle name of the contact, if known.
|-
|Last name || The surname of the contact.
|-
|Preferred name || If the contact prefers to be known by an alternative name, enter that here.
|-
|Suffix || Give the contact an optional suffix if known.
|-
|Job title || Enter the job title if know. If you specify a job title, the Job Code is then mandatory. Otherwise, Job Code is optional.
|-
!colspan="2"|Address Information - ''''Note: Only Complex Address fields are documented here''''
|-
| Address Layout || Your selection here will determine what fields are shown to enter address information. Emersion recommends users enter addresses using the Standard or Complex layout.
|-
| Address type || Select from the list of address types, if known.
|-
|Lot number || Enter a lot number if it is part of the address.
|-
|Nearest Cross Street || A text field used to capture the nearest cross street, if desired.
|-
|Building name || A text field used to capture the name of the building if it is relevant.
|-
|Site location || A text field used to capture the site location if it is relevant.
|-
|Site name || A text field used to capture the site name if it is relevant.
|-
|Unit type || Select from a list of unit types if it is relevant. If you choose a unit type, the unit number becomes mandatory.
|-
|Unit number || Enter the number of the unit. If you enter a value here, you must choose a unit type.
|-
|Level type || Select from a list of level types if it is relevant. If you choose a level type, the level number becomes mandatory.
|-
|Level number || Enter the number of the level. If you enter a value here, you must choose a level type.
|-
|Street number || Enter the street number. If the address spans multiple numbers (e.g. 6-8) use both fields to separate the start and end street numbers.
|-
|Street name || Enter the street name. Do not enter the type after the name of the street. E.g. "Smith Street" should be entered as "Smith" and "Michigan Avenue" would be be entered as "Michigan"
|-
|Street type|| Choose the street type that matches the street name.
|-
|Street suffix|| If it is applicable, choose the street suffix.
|-
|Suburb || Enter the street name. Do not enter the type after the name of the street. E.g. "Smith Street" should be entered as "Smith" and "Michigan Avenue" would be be entered as "Michigan"
|-
|Postcode|| Enter the postcode. There is no postcode validation or postcode/suburb matching in Emersion, so be sure to enter the postcode correctly.
|-
|State|| Choose the state.
|-
|Country|| Choose from the list of countries.
|-
|Date from|| A field to store the date from when the contact commenced living/operating from at this address, if desired.
|-
!colspan="2"|Communication Information
|-
|Preferred number|| Select from the list of options. The user's choice determines which of the following phone number fields are mandatory. For example, choosing '''Mobile''' will mean at least one mobile number must be provided. Choosing landline means at least one landline number must be provided. Users can enter as many phone numbers as required by clicking the 'green plus' icon exposing further number fields.
|-
|Ext|| If you know the extension to the phone number, you can enter it.
|-
|Email|| Enter the contact's email address. Additional email addresses can be entered by clicking the 'green plus' icon exposing alt email address fields.
|-
|Internet Messaging|| Enter the IM of the contact, if desired.
|-
|Provider|| Provider of the IM service in the IM field.
|-
|Website|| Enter the website of the contact if desired without the 'http://'
|-
|Language|| Select the user's primary language.
|-
|Timezone|| Choose from the list of timezones where the user is based from.
|-
|Marketing source|| Select from the list of options how the customer was sourced.
|-
!colspan="2"|Privacy and Verification Information
|-
|Marketing Notification || Flag the customer as not interested in receiving cross-promo marketing notifications by phone or via email. Using this flag '''does not''' affect the distribution of any notifications from Emersion's system. The customer will still receive unpaid invoice reminders, usage notification alerts and all other notifications that come from the Emersion system provided they are enabled by the service provider. This flag is used in reporting only.
|-
|Account Password|| This is a clear text password that was designed to help your phone support staff validate the identity of a caller requesting support or sensitive information pertaining to the account. Service providers without a policy similar to this can enter '123456' or any 6 characters. The minimum number of characters for this field is 6.
|-
|Secret Questions and Answers || Up to 2 secret questions and answers can be nominated to help your phone support staff validate the identity of a caller requesting support or sensitive information pertaining to the account.
|-
|Gender|| Select the contact's gender.
|-
|Marital Status|| Select the contact's marital status.
|-
|Residential Status|| Select the contact's residential status.
|-
|Date of Birth|| Enter the contact's date of birth.
|-
|Birth Country|| Enter the contact's country of birth.
|-
|Drivers Licence|| Enter the number of the contact's drivers licence.
|-
|State licence|| Select the state from which the contact's drivers licence was issued.
|-
|Licence Expiry Date|| Use the date picker to select the expiry date of the contact's drivers licence.
|-
|Residency Status|| Select the contact's residency status.
|-
|Passport no| Enter the contact's passport number.
|-
|Passport Expiry Date|| Use the date picker to select the passport expiry date.
|-
|Passport Country of Issue|| Select the country from which the contact's passport was issued.
|-
|Medicare Number|| Enter the contact's medicare number.
|-
|No of Dependants|| Enter the number of dependants the contact is responsible for.
|-
|Pension Card Type|| Enter the contact's pension type.
|-
!colspan="2"|End User portal Information - This is to give the account holder access to the [[End_User_Portal_and_Customer_Sign_Up_Portal#End_User_Portal | End User Portal.]]
|-
|User portal login|| Uncheck this box if you do not want to set up End user portal access for this account or you want to set it up later. This can be done at any time under the '''Customer > Userportal''' tab. If you select this option, you will not be required to complete the mandatory fields for this section.
|-
|Username|| Enter a username for the account. The full username when the customer logs into the End User Portal is as follows:
 username + cumulus user suffix . E.g. emesupport@emersiontest.com.au or user@yourdomain.com.au. The cumulus user suffix is displayed to the right of the username field and always begins with an '@' symbol. Usernames can use A-Za-z0-9_.@ and must be a minimum of 2 characters. Usernames are not case sensitive.
|-
|Password|| Enter a password for the end user portal. Minimum number of characters is 6 and the password is case sensitive.
|-
|Retype password|| Confirm the password for the end user portal.
|}

== Wizard Screen 3: Billing Contact ==

When the user arrives at step 3 of the wizard, they are prompted to enter a billing contact. Primary and billing contacts are mandatory for all accounts.

If the primary and billing contact are the same people as often happens in an individual accounts, leave the checkbox ''''Same as primary contact?''' checked, and proceed to the next step in the wizard. The system will flag the primary contact as the billing contact.

If the primary and billing contact are different people, uncheck the ''''Same as primary contact?''' checkbox and complete the contact form for the billing contact. This form is the same as the previous form for the primary contact.

== Wizard Screen 4: Secondary Contact ==

Emersion supports any number of additional contacts for an account, however this was not always the case. Prior to that enhancement, users could provide one additional contact, known as the '''Secondary Contact'''. This screen is a legacy option left over from that time.

Users can optionally enter a single additional contact here if they choose. If the user has several additional contacts to enter, we suggest doing this after the account is created and active. Additional contacts are entered and maintained under the '''Customer > Contacts tab'''.

If the user wants to enter a single additional contact as part of account creation, select '''New''' from the list of options, complete the contact form and proceed.

To skip entering another contact now, select '''Skip Secondary Contact''' from the list of options and proceed.

== Finishing the Create Customer Wizard ==

Once users save and complete step 4, the account will be changed from a '''Preactive''' to an '''Active''' status, indicating it is ready to use. The user will be shown the main customer screen where they can inspect the sub tabs and enter additional information if needed.

[[file: Account-create-wizard-finished.png |1300px| The Customer Screen after completing the Create Customer wizard]]

= See Also =
* [[Account Management/Customer Screen | The Customer Screen]]
* [[Account/Account Status | Account Statuses]]

Account/AccountCreation

2020-04-22T02:02:36Z

Scarpenter: /* Wizard Screen 1: Create Account */

= Create Customer Wizard - End User Accounts =

Creating end user customers in Emersion is able to be achieved in a number of ways, including via the

* [https://resources.emersion.com/display/EKB/The+Sign+Up+Portal Sign Up Portal]
* [[API]]
* Cumulus

This article is limited to the Create Customer wizard in Cumulus and focuses on creating ''End User'' customers. While the process is similar for other types of accounts, the fields and steps may vary. If you want to know how to create retail service providers, non-retail billing service provider, Agents or other types of accounts, start at the [[Account_Management | Account Management page]] and choose from the relevant list of account types.

To create a new customer:

Nav: '''Customer > Create Customer''' to start the wizard.

The wizard will follow a series of steps to assist you with creating an account, entering both required and optional information. The information collected via the wizard will vary based on the type of account you are creating; ''Organisation'' or ''Individual''.

The progress bar will tell users how many steps they have completed, and are yet to complete.

[[file: Account-create-wizard-01-progressbar.png || Create Customer Wizard Progress Bar]]

== Wizard Screen 1: Create Account ==
This first screen has the initial settings that determine the account's behavior in terms of billing. '''Therefore for billing to be accurate, it is important these settings are correct before proceeding.'''

[[file: Account-create-wizard-01.png]]

=== Wizard Screen 1: Data Definition ===
{|class="wikitable" style="text-align: left; width: 70%;" align="center"
|+Create Customer Wizard Step 1 - Field Definition
!Data field ||Description
|-
|style="width: 20%; |Account Enterprise || style="width: 80%;"| An account can be an individual or organisation. Data collection on the following screens changes depending on your selection here.
|-
|Account Type || Select between Agent and End User if Agent module is enabled. Otherwise leave as End User. Note: If a person or company is both an Agent ''and'' a customer of yours, they will need two accounts, one for each type.
|-
|Start Date || This date is very important. Usage cannot be processed for services before this date. Services and accounts CAN be backdated for back-billing purposes. If you do not know the actual start date of the customer, or the start date is greater than 6 months in the past, provide the earliest date from when usage will be collected. This date will be the very first opening date of the account's first account invoice period. Usage received by Emersion before this date cannot be processed onto an invoice.
|-
|Account Profile || If you have multiple [[Accounts/AccountProfiles|account profiles]] for the customer.
|-
|Account Invoice Method || Defined how the invoice will be sent to the customer.
|-
|Account Invoice Template || All accounts must be allocated an invoice template from which their invoice will be created. If you have multiple invoice template layouts, choose the one for this customer or leave it as the default. The default template can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] invoice setting or overridden for a given customer.
|-
|Account Billing Day || The actual day, within the month, that the customer [[AccountInvoicePeriod|Account Invoice Period]] will begin. This can be a default set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer. As is standard in the Emersion platform, invoices are generated 2 days after the close of the invoice period. For example: If you set this value to 7, the customer's invoice will be generated on the 10th of every month (''being 2 days after the close of the account invoice period'') and providing you have opted for the standard 1 month period length as defined by the ''Period Length Months'' field below).
|-
|Invoice Itemisation || Defines if the invoice will include itemised usage records, or a summary only.
|-
|Automatically Allocate Payments To Invoices: || Define if payments received fgrom the customer are allocated to invoices automatically. By default, payments will be allocated to the oldest invoice that has an outstanding amount owing first.
|-
|Credit Limit || This is a credit limit for the account. It is used by the system in a number of ways, for example:

* sending notifications (via [[Events]]) to either the service provider or customer when the credit limit is exceeded.
* The [[Account_Management/Auto_Top-up|auto top-up]] feature.
* The [[Provisioning/AutomaticSuspensionAndRestriction | automated suspension]] feature. This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer.
|-
|Unbilled Credit Limit || This is the unbilled credit limit for the account. This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer. If this is set, the [[SystemEvents/EventTypes#Credit_Limit_Exceeded|'''Credit Limit Exceeded''' event notification]] can be leveraged to send the customer an alert.
|-
|Trading Due Days || This setting controls how many days after an invoice has been generated it will fall due. E.g. If the customer's invoice is due 7 days after it is generated, enter "7". If the customer's invoice is due 14 days after the issue date, enter "14". This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer.
|-
|Period Length Months || The amount of time that passes between invoice periods. E.g. If you set the '''Account Billing Day''' to 1 & the '''Period Length Months''' to 1, the customer will receive an invoice on the 3rd of every month (invoices are generated 2 days after the close of the invoice period)
|-
|Align Pkgs to Acct || This flag will align any newly created package subscriptions to the underlying account invoice period for 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 some package configurations can conflict with this setting, producing undesirable billing results. For instance, 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.
|-
|Export Reference || An optional field that, if used, can be used in a customer search to locate the account. E.g. Former account number from a previous system.
|-
|CRM Export Ref || An optional field for an identifier from a legacy CRM.
|-
|Xero Account Name || Associate the customer with a Xero Account. Requires subscription to the Xero integration module.
|-
| Auto Generate Cost Centre || Requires subscription to the [https://resources.emersion.com/display/EKB/Cost+Centres | Cost Centre] module. [https://resources.emersion.com/display/EKB/Auto+Generate+Cost+Centres+for+an+Account | Click here for the instructions on this setting].
|}

== Wizard Screen 2: Primary Contact ==

When the user arrives at step 2 of the wizard, a new account record is saved in the system in a status of '''Preactive''' and is given a unique ID. This ID is the customer's account number. This activity can be seen by users in a blue notification below the main Cumulus menu.

New accounts transition from '''Preactive''' to '''Active''' once all steps of the Create Customer Wizard has been completed. Should a user need to leave the wizard, or the user is thrown from the wizard for any reason at all, the account data up to the last save point is retained by the system. This means that users can exit the wizard and return at a later time without having to start the wizard from the beginning. If users know the account, they can pick up their place in the wizard where they left off.

Step two of the Create Customer Wizard captures the information of the primary contact for the account. The fields on the screen can change based on your choices. The most obvious place where this happens is in the address section. A complex address will capture more information than a simple or standard address, enabling Emersion to support address data from any other sources systems, such as legacy systems or Customer Relationship Management (CRM) systems.

''''Emersion Tip:'''' Emersion recommends breaking down the account and contact addresses into each individual field element where it is possible to do so. This data breakdown process is called 'data normalisation'. Normalising data makes reporting and searching far easier. It is very time consuming and difficult to search for customers in the suburb of "Cheltenham" if your data is entered into line number fields as "1/123 Main St" and "Cheltenham VIC 3123". Use ''Standard'' and ''Complex'' addresses where ever possible and break down the data into field elements to make this searching feasible.

<gallery>
File:Account-create-wizard-02-person.png|Personal details
File:Account-create-wizard-02-comms.png|Communication information
File:Account-create-wizard-02-addr-std.png|Address information for a Standard address
File:Account-create-wizard-02-addr-complex.png|Address information for a Complex address
File:Account-create-wizard-02-privacy.png|Privacy & verification information
File:Account-create-wizard-02-userportal.png|End User Portal login information
</gallery>

=== Wizard Screen 2: Contact Form Data Definition ===
{|class="wikitable" style="text-align: left; width: 70%;" align="center"
|+Create Customer Wizard Step 2 - Contact Form Field Definition
!Data field ||Description
|-
!colspan="2"|Personal Information
|-
|style="width: 20%; |Contact Sub-Type || style="width: 80%;"| Select from the list of options if you wish to flag this contact with any of the sub-types.
|-
|Title || Select from the list of options the correct title of the primary contact. This is also known as a 'Salutation'.
|-
|First name || The first name of the contact.
|-
|Middle Name || The middle name of the contact, if known.
|-
|Last name || The surname of the contact.
|-
|Preferred name || If the contact prefers to be known by an alternative name, enter that here.
|-
|Suffix || Give the contact an optional suffix if known.
|-
|Job title || Enter the job title if know. If you specify a job title, the Job Code is then mandatory. Otherwise, Job Code is optional.
|-
!colspan="2"|Address Information - ''''Note: Only Complex Address fields are documented here''''
|-
| Address Layout || Your selection here will determine what fields are shown to enter address information. Emersion recommends users enter addresses using the Standard or Complex layout.
|-
| Address type || Select from the list of address types, if known.
|-
|Lot number || Enter a lot number if it is part of the address.
|-
|Nearest Cross Street || A text field used to capture the nearest cross street, if desired.
|-
|Building name || A text field used to capture the name of the building if it is relevant.
|-
|Site location || A text field used to capture the site location if it is relevant.
|-
|Site name || A text field used to capture the site name if it is relevant.
|-
|Unit type || Select from a list of unit types if it is relevant. If you choose a unit type, the unit number becomes mandatory.
|-
|Unit number || Enter the number of the unit. If you enter a value here, you must choose a unit type.
|-
|Level type || Select from a list of level types if it is relevant. If you choose a level type, the level number becomes mandatory.
|-
|Level number || Enter the number of the level. If you enter a value here, you must choose a level type.
|-
|Street number || Enter the street number. If the address spans multiple numbers (e.g. 6-8) use both fields to separate the start and end street numbers.
|-
|Street name || Enter the street name. Do not enter the type after the name of the street. E.g. "Smith Street" should be entered as "Smith" and "Michigan Avenue" would be be entered as "Michigan"
|-
|Street type|| Choose the street type that matches the street name.
|-
|Street suffix|| If it is applicable, choose the street suffix.
|-
|Suburb || Enter the street name. Do not enter the type after the name of the street. E.g. "Smith Street" should be entered as "Smith" and "Michigan Avenue" would be be entered as "Michigan"
|-
|Postcode|| Enter the postcode. There is no postcode validation or postcode/suburb matching in Emersion, so be sure to enter the postcode correctly.
|-
|State|| Choose the state.
|-
|Country|| Choose from the list of countries.
|-
|Date from|| A field to store the date from when the contact commenced living/operating from at this address, if desired.
|-
!colspan="2"|Communication Information
|-
|Preferred number|| Select from the list of options. The user's choice determines which of the following phone number fields are mandatory. For example, choosing '''Mobile''' will mean at least one mobile number must be provided. Choosing landline means at least one landline number must be provided. Users can enter as many phone numbers as required by clicking the 'green plus' icon exposing further number fields.
|-
|Ext|| If you know the extension to the phone number, you can enter it.
|-
|Email|| Enter the contact's email address. Additional email addresses can be entered by clicking the 'green plus' icon exposing alt email address fields.
|-
|Internet Messaging|| Enter the IM of the contact, if desired.
|-
|Provider|| Provider of the IM service in the IM field.
|-
|Website|| Enter the website of the contact if desired without the 'http://'
|-
|Language|| Select the user's primary language.
|-
|Timezone|| Choose from the list of timezones where the user is based from.
|-
|Marketing source|| Select from the list of options how the customer was sourced.
|-
!colspan="2"|Privacy and Verification Information
|-
|Marketing Notification || Flag the customer as not interested in receiving cross-promo marketing notifications by phone or via email. Using this flag '''does not''' affect the distribution of any notifications from Emersion's system. The customer will still receive unpaid invoice reminders, usage notification alerts and all other notifications that come from the Emersion system provided they are enabled by the service provider. This flag is used in reporting only.
|-
|Account Password|| This is a clear text password that was designed to help your phone support staff validate the identity of a caller requesting support or sensitive information pertaining to the account. Service providers without a policy similar to this can enter '123456' or any 6 characters. The minimum number of characters for this field is 6.
|-
|Secret Questions and Answers || Up to 2 secret questions and answers can be nominated to help your phone support staff validate the identity of a caller requesting support or sensitive information pertaining to the account.
|-
|Gender|| Select the contact's gender.
|-
|Marital Status|| Select the contact's marital status.
|-
|Residential Status|| Select the contact's residential status.
|-
|Date of Birth|| Enter the contact's date of birth.
|-
|Birth Country|| Enter the contact's country of birth.
|-
|Drivers Licence|| Enter the number of the contact's drivers licence.
|-
|State licence|| Select the state from which the contact's drivers licence was issued.
|-
|Licence Expiry Date|| Use the date picker to select the expiry date of the contact's drivers licence.
|-
|Residency Status|| Select the contact's residency status.
|-
|Passport no| Enter the contact's passport number.
|-
|Passport Expiry Date|| Use the date picker to select the passport expiry date.
|-
|Passport Country of Issue|| Select the country from which the contact's passport was issued.
|-
|Medicare Number|| Enter the contact's medicare number.
|-
|No of Dependants|| Enter the number of dependants the contact is responsible for.
|-
|Pension Card Type|| Enter the contact's pension type.
|-
!colspan="2"|End User portal Information - This is to give the account holder access to the [[End_User_Portal_and_Customer_Sign_Up_Portal#End_User_Portal | End User Portal.]]
|-
|User portal login|| Uncheck this box if you do not want to set up End user portal access for this account or you want to set it up later. This can be done at any time under the '''Customer > Userportal''' tab. If you select this option, you will not be required to complete the mandatory fields for this section.
|-
|Username|| Enter a username for the account. The full username when the customer logs into the End User Portal is as follows:
 username + cumulus user suffix . E.g. emesupport@emersiontest.com.au or user@yourdomain.com.au. The cumulus user suffix is displayed to the right of the username field and always begins with an '@' symbol. Usernames can use A-Za-z0-9_.@ and must be a minimum of 2 characters. Usernames are not case sensitive.
|-
|Password|| Enter a password for the end user portal. Minimum number of characters is 6 and the password is case sensitive.
|-
|Retype password|| Confirm the password for the end user portal.
|}

== Wizard Screen 3: Billing Contact ==

When the user arrives at step 3 of the wizard, they are prompted to enter a billing contact. Primary and billing contacts are mandatory for all accounts.

If the primary and billing contact are the same people as often happens in an individual accounts, leave the checkbox ''''Same as primary contact?''' checked, and proceed to the next step in the wizard. The system will flag the primary contact as the billing contact.

If the primary and billing contact are different people, uncheck the ''''Same as primary contact?''' checkbox and complete the contact form for the billing contact. This form is the same as the previous form for the primary contact.

== Wizard Screen 4: Secondary Contact ==

Emersion supports any number of additional contacts for an account, however this was not always the case. Prior to that enhancement, users could provide one additional contact, known as the '''Secondary Contact'''. This screen is a legacy option left over from that time.

Users can optionally enter a single additional contact here if they choose. If the user has several additional contacts to enter, we suggest doing this after the account is created and active. Additional contacts are entered and maintained under the '''Customer > Contacts tab'''.

If the user wants to enter a single additional contact as part of account creation, select '''New''' from the list of options, complete the contact form and proceed.

To skip entering another contact now, select '''Skip Secondary Contact''' from the list of options and proceed.

== Finishing the Create Customer Wizard ==

Once users save and complete step 4, the account will be changed from a '''Preactive''' to an '''Active''' status, indicating it is ready to use. The user will be shown the main customer screen where they can inspect the sub tabs and enter additional information if needed.

[[file: Account-create-wizard-finished.png |1300px| The Customer Screen after completing the Create Customer wizard]]

= See Also =
* [[Account Management/Customer Screen | The Customer Screen]]
* [[Account/Account Status | Account Statuses]]

Account/AccountCreation

2020-04-22T02:01:48Z

Scarpenter: /* Wizard Screen 1: Create Account */

= Create Customer Wizard - End User Accounts =

Creating end user customers in Emersion is able to be achieved in a number of ways, including via the

* [https://resources.emersion.com/display/EKB/The+Sign+Up+Portal Sign Up Portal]
* [[API]]
* Cumulus

This article is limited to the Create Customer wizard in Cumulus and focuses on creating ''End User'' customers. While the process is similar for other types of accounts, the fields and steps may vary. If you want to know how to create retail service providers, non-retail billing service provider, Agents or other types of accounts, start at the [[Account_Management | Account Management page]] and choose from the relevant list of account types.

To create a new customer:

Nav: '''Customer > Create Customer''' to start the wizard.

The wizard will follow a series of steps to assist you with creating an account, entering both required and optional information. The information collected via the wizard will vary based on the type of account you are creating; ''Organisation'' or ''Individual''.

The progress bar will tell users how many steps they have completed, and are yet to complete.

[[file: Account-create-wizard-01-progressbar.png || Create Customer Wizard Progress Bar]]

== Wizard Screen 1: Create Account ==
This first screen has the initial settings that determine the account's behavior in terms of billing. '''Therefore for billing to be accurate, it is important these settings are correct before proceeding.'''

[[file: Account-create-wizard-01.png]]

=== Wizard Screen 1: Data Definition ===
{|class="wikitable" style="text-align: left; width: 70%;" align="center"
|+Create Customer Wizard Step 1 - Field Definition
!Data field ||Description
|-
|style="width: 20%; |Account Enterprise || style="width: 80%;"| An account can be an individual or organisation. Data collection on the following screens changes depending on your selection here.
|-
|Account Type || Select between Agent and End User if Agent module is enabled. Otherwise leave as End User. Note: If a person or company is both an Agent ''and'' a customer of yours, they will need two accounts, one for each type.
|-
|Start Date || This date is very important. Usage cannot be processed for services before this date. Services and accounts CAN be backdated for back-billing purposes. If you do not know the actual start date of the customer, or the start date is greater than 6 months in the past, provide the earliest date from when usage will be collected. This date will be the very first opening date of the account's first account invoice period. Usage received by Emersion before this date cannot be processed onto an invoice.
|-
|Account Profile || If you have multiple [[Accounts/AccountProfiles|account profiles]] for the customer.
|-
|Account Invoice Method || Defined how the invoice will be sent to the customer.
|-
|Account Invoice Template || All accounts must be allocated an invoice template from which their invoice will be created. If you have multiple invoice template layouts, choose the one for this customer or leave it as the default. The default template can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] invoice setting or overridden for a given customer.
|-
|Account Billing Day || The actual day, within the month, that the customer [[AccountInvoicePeriod|Account Invoice Period]] will begin. This can be a default set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer. As is standard in the Emersion platform, invoices are generated 2 days after the close of the invoice period. For example: If you set this value to 7, the customer's invoice will be generated on the 10th of every month (''being 2 days after the close of the account invoice period'') and providing you have opted for the standard 1 month period length as defined by the ''Period Length Months'' field below).
|-
|Invoice Itemisation || Defines if the invoice will include itemised usage records, or a summary only.
|-
|Automatically Allocate Payments To Invoices: || Define if payments received fgrom the customer are allocated to invoices automatically. By default, payments will be allocated to the oldest invoice that has an outstanding amount owing first.
|-
|Credit Limit || This is a credit limit for the account. It is used by the system in a number of ways, for example:

* sending notifications (via [[Events]]) to either the service provider or customer when the credit limit is exceeded.
* The [[Account_Management/Auto_Top-up|auto top-up]] feature.
* The [[Provisioning/AutomaticSuspensionAndRestriction | automated suspension]] feature. This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer.
|-
|Unbilled Credit Limit || This is the unbilled credit limit for the account. This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer. If this is set, the [[SystemEvents/EventTypes#Credit_Limit_Exceeded|'''Credit Limit Exceeded''' event notification]] can be leveraged to send the customer an alert.
|-
|Trading Due Days || This setting controls how many days after an invoice has been generated it will fall due. E.g. If the customer's invoice is due 7 days after it is generated, enter "7". If the customer's invoice is due 14 days after the issue date, enter "14". This can be set globally by the service provider, overridden by the [[Accounts/AccountProfiles|account profile]] or overridden for a given customer.
|-
|Period Length Months || The amount of time that passes between invoice periods. E.g. If you set the '''Account Billing Day''' to 1 & the '''Period Length Months''' to 1, the customer will receive an invoice on the 3rd of every month (invoices are generated 2 days after the close of the invoice period)
|-
|Align Pkgs to Acct || This flag will align any newly created package subscriptions to the underlying account invoice period for 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 some package configurations can conflict with this setting, producing undesirable billing results. For instance, 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.
|-
|Export Reference || An optional field that, if used, can be used in a customer search to locate the account. E.g. Former account number from a previous system.
|-
|CRM Export Ref || An optional field for an identifier from a legacy CRM.
|-
|Xero Account Name || Associate the customer with a Xero Account. Requires subscription to the Xero integration module.
|-
| Auto Generate Cost Centre || Requires subscription to the [https://resources.emersion.com/display/EKB/Cost+Centres | Cost Centre] module. [https://resources.emersion.com/display/EKB/Auto+Generate+Cost+Centres+for+an+Account | Click here for the instructions on this setting].
|}

== Wizard Screen 2: Primary Contact ==

When the user arrives at step 2 of the wizard, a new account record is saved in the system in a status of '''Preactive''' and is given a unique ID. This ID is the customer's account number. This activity can be seen by users in a blue notification below the main Cumulus menu.

New accounts transition from '''Preactive''' to '''Active''' once all steps of the Create Customer Wizard has been completed. Should a user need to leave the wizard, or the user is thrown from the wizard for any reason at all, the account data up to the last save point is retained by the system. This means that users can exit the wizard and return at a later time without having to start the wizard from the beginning. If users know the account, they can pick up their place in the wizard where they left off.

Step two of the Create Customer Wizard captures the information of the primary contact for the account. The fields on the screen can change based on your choices. The most obvious place where this happens is in the address section. A complex address will capture more information than a simple or standard address, enabling Emersion to support address data from any other sources systems, such as legacy systems or Customer Relationship Management (CRM) systems.

''''Emersion Tip:'''' Emersion recommends breaking down the account and contact addresses into each individual field element where it is possible to do so. This data breakdown process is called 'data normalisation'. Normalising data makes reporting and searching far easier. It is very time consuming and difficult to search for customers in the suburb of "Cheltenham" if your data is entered into line number fields as "1/123 Main St" and "Cheltenham VIC 3123". Use ''Standard'' and ''Complex'' addresses where ever possible and break down the data into field elements to make this searching feasible.

<gallery>
File:Account-create-wizard-02-person.png|Personal details
File:Account-create-wizard-02-comms.png|Communication information
File:Account-create-wizard-02-addr-std.png|Address information for a Standard address
File:Account-create-wizard-02-addr-complex.png|Address information for a Complex address
File:Account-create-wizard-02-privacy.png|Privacy & verification information
File:Account-create-wizard-02-userportal.png|End User Portal login information
</gallery>

=== Wizard Screen 2: Contact Form Data Definition ===
{|class="wikitable" style="text-align: left; width: 70%;" align="center"
|+Create Customer Wizard Step 2 - Contact Form Field Definition
!Data field ||Description
|-
!colspan="2"|Personal Information
|-
|style="width: 20%; |Contact Sub-Type || style="width: 80%;"| Select from the list of options if you wish to flag this contact with any of the sub-types.
|-
|Title || Select from the list of options the correct title of the primary contact. This is also known as a 'Salutation'.
|-
|First name || The first name of the contact.
|-
|Middle Name || The middle name of the contact, if known.
|-
|Last name || The surname of the contact.
|-
|Preferred name || If the contact prefers to be known by an alternative name, enter that here.
|-
|Suffix || Give the contact an optional suffix if known.
|-
|Job title || Enter the job title if know. If you specify a job title, the Job Code is then mandatory. Otherwise, Job Code is optional.
|-
!colspan="2"|Address Information - ''''Note: Only Complex Address fields are documented here''''
|-
| Address Layout || Your selection here will determine what fields are shown to enter address information. Emersion recommends users enter addresses using the Standard or Complex layout.
|-
| Address type || Select from the list of address types, if known.
|-
|Lot number || Enter a lot number if it is part of the address.
|-
|Nearest Cross Street || A text field used to capture the nearest cross street, if desired.
|-
|Building name || A text field used to capture the name of the building if it is relevant.
|-
|Site location || A text field used to capture the site location if it is relevant.
|-
|Site name || A text field used to capture the site name if it is relevant.
|-
|Unit type || Select from a list of unit types if it is relevant. If you choose a unit type, the unit number becomes mandatory.
|-
|Unit number || Enter the number of the unit. If you enter a value here, you must choose a unit type.
|-
|Level type || Select from a list of level types if it is relevant. If you choose a level type, the level number becomes mandatory.
|-
|Level number || Enter the number of the level. If you enter a value here, you must choose a level type.
|-
|Street number || Enter the street number. If the address spans multiple numbers (e.g. 6-8) use both fields to separate the start and end street numbers.
|-
|Street name || Enter the street name. Do not enter the type after the name of the street. E.g. "Smith Street" should be entered as "Smith" and "Michigan Avenue" would be be entered as "Michigan"
|-
|Street type|| Choose the street type that matches the street name.
|-
|Street suffix|| If it is applicable, choose the street suffix.
|-
|Suburb || Enter the street name. Do not enter the type after the name of the street. E.g. "Smith Street" should be entered as "Smith" and "Michigan Avenue" would be be entered as "Michigan"
|-
|Postcode|| Enter the postcode. There is no postcode validation or postcode/suburb matching in Emersion, so be sure to enter the postcode correctly.
|-
|State|| Choose the state.
|-
|Country|| Choose from the list of countries.
|-
|Date from|| A field to store the date from when the contact commenced living/operating from at this address, if desired.
|-
!colspan="2"|Communication Information
|-
|Preferred number|| Select from the list of options. The user's choice determines which of the following phone number fields are mandatory. For example, choosing '''Mobile''' will mean at least one mobile number must be provided. Choosing landline means at least one landline number must be provided. Users can enter as many phone numbers as required by clicking the 'green plus' icon exposing further number fields.
|-
|Ext|| If you know the extension to the phone number, you can enter it.
|-
|Email|| Enter the contact's email address. Additional email addresses can be entered by clicking the 'green plus' icon exposing alt email address fields.
|-
|Internet Messaging|| Enter the IM of the contact, if desired.
|-
|Provider|| Provider of the IM service in the IM field.
|-
|Website|| Enter the website of the contact if desired without the 'http://'
|-
|Language|| Select the user's primary language.
|-
|Timezone|| Choose from the list of timezones where the user is based from.
|-
|Marketing source|| Select from the list of options how the customer was sourced.
|-
!colspan="2"|Privacy and Verification Information
|-
|Marketing Notification || Flag the customer as not interested in receiving cross-promo marketing notifications by phone or via email. Using this flag '''does not''' affect the distribution of any notifications from Emersion's system. The customer will still receive unpaid invoice reminders, usage notification alerts and all other notifications that come from the Emersion system provided they are enabled by the service provider. This flag is used in reporting only.
|-
|Account Password|| This is a clear text password that was designed to help your phone support staff validate the identity of a caller requesting support or sensitive information pertaining to the account. Service providers without a policy similar to this can enter '123456' or any 6 characters. The minimum number of characters for this field is 6.
|-
|Secret Questions and Answers || Up to 2 secret questions and answers can be nominated to help your phone support staff validate the identity of a caller requesting support or sensitive information pertaining to the account.
|-
|Gender|| Select the contact's gender.
|-
|Marital Status|| Select the contact's marital status.
|-
|Residential Status|| Select the contact's residential status.
|-
|Date of Birth|| Enter the contact's date of birth.
|-
|Birth Country|| Enter the contact's country of birth.
|-
|Drivers Licence|| Enter the number of the contact's drivers licence.
|-
|State licence|| Select the state from which the contact's drivers licence was issued.
|-
|Licence Expiry Date|| Use the date picker to select the expiry date of the contact's drivers licence.
|-
|Residency Status|| Select the contact's residency status.
|-
|Passport no| Enter the contact's passport number.
|-
|Passport Expiry Date|| Use the date picker to select the passport expiry date.
|-
|Passport Country of Issue|| Select the country from which the contact's passport was issued.
|-
|Medicare Number|| Enter the contact's medicare number.
|-
|No of Dependants|| Enter the number of dependants the contact is responsible for.
|-
|Pension Card Type|| Enter the contact's pension type.
|-
!colspan="2"|End User portal Information - This is to give the account holder access to the [[End_User_Portal_and_Customer_Sign_Up_Portal#End_User_Portal | End User Portal.]]
|-
|User portal login|| Uncheck this box if you do not want to set up End user portal access for this account or you want to set it up later. This can be done at any time under the '''Customer > Userportal''' tab. If you select this option, you will not be required to complete the mandatory fields for this section.
|-
|Username|| Enter a username for the account. The full username when the customer logs into the End User Portal is as follows:
 username + cumulus user suffix . E.g. emesupport@emersiontest.com.au or user@yourdomain.com.au. The cumulus user suffix is displayed to the right of the username field and always begins with an '@' symbol. Usernames can use A-Za-z0-9_.@ and must be a minimum of 2 characters. Usernames are not case sensitive.
|-
|Password|| Enter a password for the end user portal. Minimum number of characters is 6 and the password is case sensitive.
|-
|Retype password|| Confirm the password for the end user portal.
|}

== Wizard Screen 3: Billing Contact ==

When the user arrives at step 3 of the wizard, they are prompted to enter a billing contact. Primary and billing contacts are mandatory for all accounts.

If the primary and billing contact are the same people as often happens in an individual accounts, leave the checkbox ''''Same as primary contact?''' checked, and proceed to the next step in the wizard. The system will flag the primary contact as the billing contact.

If the primary and billing contact are different people, uncheck the ''''Same as primary contact?''' checkbox and complete the contact form for the billing contact. This form is the same as the previous form for the primary contact.

== Wizard Screen 4: Secondary Contact ==

Emersion supports any number of additional contacts for an account, however this was not always the case. Prior to that enhancement, users could provide one additional contact, known as the '''Secondary Contact'''. This screen is a legacy option left over from that time.

Users can optionally enter a single additional contact here if they choose. If the user has several additional contacts to enter, we suggest doing this after the account is created and active. Additional contacts are entered and maintained under the '''Customer > Contacts tab'''.

If the user wants to enter a single additional contact as part of account creation, select '''New''' from the list of options, complete the contact form and proceed.

To skip entering another contact now, select '''Skip Secondary Contact''' from the list of options and proceed.

== Finishing the Create Customer Wizard ==

Once users save and complete step 4, the account will be changed from a '''Preactive''' to an '''Active''' status, indicating it is ready to use. The user will be shown the main customer screen where they can inspect the sub tabs and enter additional information if needed.

[[file: Account-create-wizard-finished.png |1300px| The Customer Screen after completing the Create Customer wizard]]

= See Also =
* [[Account Management/Customer Screen | The Customer Screen]]
* [[Account/Account Status | Account Statuses]]

Account Management/Customer Screen/Pending Ledger Cardlines

2020-04-22T01:59:37Z

Scarpenter: /* Edit A Pending Cardline */

{{DISPLAYTITLE: Pending Ledger Cardlines}}

==Pending Ledger Cardlines==

This page will display cardlines that have been generated by the system that are NOT allocated to an invoice yet.

'''For a brief video on pending cardlines and the manage invoice section, please see the bottom of this article!'''

==Unallocated Ledger Cardlines==

As discussed in [[InvoiceCardlineManagement|''Invoice cardline management'']], you can add a cardline to an existing pending invoice. However, you can also manually create an unallocated cardline, or pending cardline, against an account when there is no existing pending invoice, or for other charges and credits you do not wish to allocate to an existing pending invoice. Unallocated, pending ledger cardlines can be created at any time during the billing period independently to the regular billing cycle.

The pending cardline amount will not be reflected in the account’s balance until it is allocated to an invoice, and the invoice then approved. The manually created cardline will appear in the ''Miscellaneous Charges'' section of the invoice. If the cardline is a credit (i.e. a negative cardline amount) the amount will appear in the ''Adjustments'' section of the invoice, and the amount will be deducted from the invoice total.

----
'''Note:''' Cardlines entered for a negative amount will appear as a credit against the account.
----

Once an unallocated, pending ledger cardline has been created against an account, you can perform a number of actions:

* add the pending cardline to an existing pending invoice, via the [[InvoiceManageInvoice|''Manage Invoice'']] function
* if there is no current pending invoice for the account, you can create an [[InvoiceImmeditateInvoice|''immediate'' invoice]] that will automatically allocate the pending cardline created, as well as any other pending cardlines stored against the account, to the new invoice created (see ''Immediate Invoices'' below)
* leave the pending cardline to be processed with all other charges and cardlines during the next bill run. It will then be automatically picked up by the billing process, and appear on the account’s next invoice.

===To Create an Unallocated Pending Ledger Cardline===

# Select '''Customers''' > '''Customer List '''>''' '''from the '''Menu.''' The ''Customer List'' page will appear.
# Select the required customer account. The Account ''Summary'' tab page will display.
# Click the '''Pending Ledger Cardlines''' tab. The ''Pending Ledger Cardlines'' page will appear showing any unallocated pending ledger cardlines held against the account.
# Click the '''Create New Unallocated Cardline''' button near the top of the list. The ''New Unallocated Cardline'' page will appear.
# Enter the date for the cardline in the ''Transaction Date'' field. A calendar tool will appear to allow you to select the required date. This date will appear on the Invoice as the date the cardline charge was incurred.
# Enter the amount including tax in the ''Total (inc. Tax) ''field. The system will automatically calculate the ''Actual Value (ex Tax)'' and the ''Tax Amount'' and display in the corresponding fields.
#:Alternately, enter the cardline amount in the ''Actual Value (ex. Tax)'' field. The system will automatically calculate the ''Total (inc Tax) ''and the ''Tax Amount''.
# Select the ''Tax Type'' applicable to the cardline in the drop list. By default, this is set to ‘Australian GST’.
# If you need to enter a manual tax amount, tick the ''Manually enter tax'' check box. The ''Tax Amount'' field will re-display enabled for editing. Enter the tax amount required.
# Enter the description to show on the invoice for the cardline in the ''Description'' field.
# Select the ''Ledger Code'' in the drop list. The cardline will be recorded against the selected ledger in the system for accounting purposes.
# Enter the Vanity Cover From, Vanity Cover To dates as desired. The underlying start and end dates won't change, these fields are simply for presentation purposes on the invoice.
# Click the '''Save''' button. A message will display at the top of the screen informing that the cardline was saved successfully.
# Click the '''Cancel''' button to cancel the cardline creation.

For a brief video on pending cardlines and the manage invoice section, please see below;

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">http://wiki.emersion.com/wiki/media/PendingCardlinesManageInvoice.mp4</mediaplayer>
 

== Delete a Pending Cardline ==
''Only non-usage cardlines can be deleted. The system will check the cardline's ledger code name and if it contains "USAGE' you will not be able to delete it''

# Navigate to Customer > Pending Ledger Cardlines
# Use either the list pagination links at the bottom or filter on either Pending Cardline ID, Description, Created Date From or Created Date To to target the cardline you wish to delete
# Click Delete in the '''Action''' column on the right
# A pop-up box will allow you to NOT proceed in case you make a mistake. If you click Yes, the cardline will be delete forever. You cannot undo this action.

== Edit A Pending Cardline ==

''Some cardlines are able to be edited. You will see a magnifying glass icon in the '''Edit''' column on the left if this is the case.''

# Navigate to Customer > Pending Ledger Cardlines
# Use either the list pagination links at the bottom or filter on either Pending Cardline ID, Description, Created Date From or Created Date To to target the cardline you wish to delete
# Click the magnifying glass icon in the '''Edit''' column on the left.
# You may edit the following fields: Transaction Date, Description, Actual Value (ex GST), Tax Amount, Covers From, Covers To, Vanity Covers From, Vanity Covers To, Note
#* (''Only some cardlines can have their Ledger Code modified from this page'')
# Change whichever fields you are able to and the click '''Save'''. Click '''Cancel''' to undo any field changes prior to saving.
 
* For customers with the [https://resources.emersion.com/display/EKB/Cost+Centres| Cost Centre] module, you will see an additional section called ''Edit Cost Centres''
# Following the instructions above to edit the appropriate cardline
# Choose the cost centre value to apply to the cardline
# Click the '''Update Cost Centres''' button.
 

'''Note''': Editing a cardline will not automatically allocate it to an invoice. You can do this from [[InvoiceCardlineManagement|Invoice Manage]] page of a pending invoice.

== Bulk Import & Manage Pending Cardlines ==

A bulk import tool is also available to import ledger cardlines in bulk against 1 or more accounts. See [[Data Import/Cardlines]]

In addition, a bulk update tool exists to enable you to manage pending cardlines. See [[Data Import/Cardline Management]]
----

===See also===
* [[InvoiceCardlineManagement|Invoice Cardline Management]]
* [[InvoiceImmeditateInvoice|Immeditate Invoices]]
* [[Data Import/Cardlines| Bulk Cardline Import]]
* [[Data Import/Cardline Management|Bulk Cardline Management (Update/Allocate/Delete/De-allocate)]]

Account Management/Customer Screen/Pending Ledger Cardlines

2020-04-22T01:59:10Z

Scarpenter: /* Edit A Pending Cardline */

{{DISPLAYTITLE: Pending Ledger Cardlines}}

==Pending Ledger Cardlines==

This page will display cardlines that have been generated by the system that are NOT allocated to an invoice yet.

'''For a brief video on pending cardlines and the manage invoice section, please see the bottom of this article!'''

==Unallocated Ledger Cardlines==

As discussed in [[InvoiceCardlineManagement|''Invoice cardline management'']], you can add a cardline to an existing pending invoice. However, you can also manually create an unallocated cardline, or pending cardline, against an account when there is no existing pending invoice, or for other charges and credits you do not wish to allocate to an existing pending invoice. Unallocated, pending ledger cardlines can be created at any time during the billing period independently to the regular billing cycle.

The pending cardline amount will not be reflected in the account’s balance until it is allocated to an invoice, and the invoice then approved. The manually created cardline will appear in the ''Miscellaneous Charges'' section of the invoice. If the cardline is a credit (i.e. a negative cardline amount) the amount will appear in the ''Adjustments'' section of the invoice, and the amount will be deducted from the invoice total.

----
'''Note:''' Cardlines entered for a negative amount will appear as a credit against the account.
----

Once an unallocated, pending ledger cardline has been created against an account, you can perform a number of actions:

* add the pending cardline to an existing pending invoice, via the [[InvoiceManageInvoice|''Manage Invoice'']] function
* if there is no current pending invoice for the account, you can create an [[InvoiceImmeditateInvoice|''immediate'' invoice]] that will automatically allocate the pending cardline created, as well as any other pending cardlines stored against the account, to the new invoice created (see ''Immediate Invoices'' below)
* leave the pending cardline to be processed with all other charges and cardlines during the next bill run. It will then be automatically picked up by the billing process, and appear on the account’s next invoice.

===To Create an Unallocated Pending Ledger Cardline===

# Select '''Customers''' > '''Customer List '''>''' '''from the '''Menu.''' The ''Customer List'' page will appear.
# Select the required customer account. The Account ''Summary'' tab page will display.
# Click the '''Pending Ledger Cardlines''' tab. The ''Pending Ledger Cardlines'' page will appear showing any unallocated pending ledger cardlines held against the account.
# Click the '''Create New Unallocated Cardline''' button near the top of the list. The ''New Unallocated Cardline'' page will appear.
# Enter the date for the cardline in the ''Transaction Date'' field. A calendar tool will appear to allow you to select the required date. This date will appear on the Invoice as the date the cardline charge was incurred.
# Enter the amount including tax in the ''Total (inc. Tax) ''field. The system will automatically calculate the ''Actual Value (ex Tax)'' and the ''Tax Amount'' and display in the corresponding fields.
#:Alternately, enter the cardline amount in the ''Actual Value (ex. Tax)'' field. The system will automatically calculate the ''Total (inc Tax) ''and the ''Tax Amount''.
# Select the ''Tax Type'' applicable to the cardline in the drop list. By default, this is set to ‘Australian GST’.
# If you need to enter a manual tax amount, tick the ''Manually enter tax'' check box. The ''Tax Amount'' field will re-display enabled for editing. Enter the tax amount required.
# Enter the description to show on the invoice for the cardline in the ''Description'' field.
# Select the ''Ledger Code'' in the drop list. The cardline will be recorded against the selected ledger in the system for accounting purposes.
# Enter the Vanity Cover From, Vanity Cover To dates as desired. The underlying start and end dates won't change, these fields are simply for presentation purposes on the invoice.
# Click the '''Save''' button. A message will display at the top of the screen informing that the cardline was saved successfully.
# Click the '''Cancel''' button to cancel the cardline creation.

For a brief video on pending cardlines and the manage invoice section, please see below;

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">http://wiki.emersion.com/wiki/media/PendingCardlinesManageInvoice.mp4</mediaplayer>
 

== Delete a Pending Cardline ==
''Only non-usage cardlines can be deleted. The system will check the cardline's ledger code name and if it contains "USAGE' you will not be able to delete it''

# Navigate to Customer > Pending Ledger Cardlines
# Use either the list pagination links at the bottom or filter on either Pending Cardline ID, Description, Created Date From or Created Date To to target the cardline you wish to delete
# Click Delete in the '''Action''' column on the right
# A pop-up box will allow you to NOT proceed in case you make a mistake. If you click Yes, the cardline will be delete forever. You cannot undo this action.

== Edit A Pending Cardline ==

''Some cardlines are able to be edited. You will see a magnifying glass icon in the '''Edit''' column on the left if this is the case.''

# Navigate to Customer > Pending Ledger Cardlines
# Use either the list pagination links at the bottom or filter on either Pending Cardline ID, Description, Created Date From or Created Date To to target the cardline you wish to delete
# Click the magnifying glass icon in the '''Edit''' column on the left.
# You may edit the following fields: Transaction Date, Description, Actual Value (ex GST), Tax Amount, Covers From, Covers To, Vanity Covers From, Vanity Covers To, Note
#* (''Only some cardlines can have their Ledger Code modified from this page'')
# Change whichever fields you are able to and the click '''Save'''. Click '''Cancel''' to undo any field changes prior to saving.
 
* For customers with the [https://resources.emersion.com/display/EKB/Cost+Centres| Cost Centre] module, you will see an additional section called ''Edit Cost Centres''
# Following the instructions above to edit the appropriate cardline
# Choose the cost centre value to apply to the cardline
# Click the '''Update Cost Centres''' button.
 

'''Note''': Editing a cardline will not automatically allocate it to an invoice. You can do this from [[InvoiceCardlineManagement|Invoice Manage]] page of a pending invoice.
 

[[File:Pending ledger cardlines 001.png]]

== Bulk Import & Manage Pending Cardlines ==

A bulk import tool is also available to import ledger cardlines in bulk against 1 or more accounts. See [[Data Import/Cardlines]]

In addition, a bulk update tool exists to enable you to manage pending cardlines. See [[Data Import/Cardline Management]]
----

===See also===
* [[InvoiceCardlineManagement|Invoice Cardline Management]]
* [[InvoiceImmeditateInvoice|Immeditate Invoices]]
* [[Data Import/Cardlines| Bulk Cardline Import]]
* [[Data Import/Cardline Management|Bulk Cardline Management (Update/Allocate/Delete/De-allocate)]]

Account Management/Customer Screen/Pending Ledger Cardlines

2020-04-22T01:58:51Z

Scarpenter: /* Edit A Pending Cardline */

{{DISPLAYTITLE: Pending Ledger Cardlines}}

==Pending Ledger Cardlines==

This page will display cardlines that have been generated by the system that are NOT allocated to an invoice yet.

'''For a brief video on pending cardlines and the manage invoice section, please see the bottom of this article!'''

==Unallocated Ledger Cardlines==

As discussed in [[InvoiceCardlineManagement|''Invoice cardline management'']], you can add a cardline to an existing pending invoice. However, you can also manually create an unallocated cardline, or pending cardline, against an account when there is no existing pending invoice, or for other charges and credits you do not wish to allocate to an existing pending invoice. Unallocated, pending ledger cardlines can be created at any time during the billing period independently to the regular billing cycle.

The pending cardline amount will not be reflected in the account’s balance until it is allocated to an invoice, and the invoice then approved. The manually created cardline will appear in the ''Miscellaneous Charges'' section of the invoice. If the cardline is a credit (i.e. a negative cardline amount) the amount will appear in the ''Adjustments'' section of the invoice, and the amount will be deducted from the invoice total.

----
'''Note:''' Cardlines entered for a negative amount will appear as a credit against the account.
----

Once an unallocated, pending ledger cardline has been created against an account, you can perform a number of actions:

* add the pending cardline to an existing pending invoice, via the [[InvoiceManageInvoice|''Manage Invoice'']] function
* if there is no current pending invoice for the account, you can create an [[InvoiceImmeditateInvoice|''immediate'' invoice]] that will automatically allocate the pending cardline created, as well as any other pending cardlines stored against the account, to the new invoice created (see ''Immediate Invoices'' below)
* leave the pending cardline to be processed with all other charges and cardlines during the next bill run. It will then be automatically picked up by the billing process, and appear on the account’s next invoice.

===To Create an Unallocated Pending Ledger Cardline===

# Select '''Customers''' > '''Customer List '''>''' '''from the '''Menu.''' The ''Customer List'' page will appear.
# Select the required customer account. The Account ''Summary'' tab page will display.
# Click the '''Pending Ledger Cardlines''' tab. The ''Pending Ledger Cardlines'' page will appear showing any unallocated pending ledger cardlines held against the account.
# Click the '''Create New Unallocated Cardline''' button near the top of the list. The ''New Unallocated Cardline'' page will appear.
# Enter the date for the cardline in the ''Transaction Date'' field. A calendar tool will appear to allow you to select the required date. This date will appear on the Invoice as the date the cardline charge was incurred.
# Enter the amount including tax in the ''Total (inc. Tax) ''field. The system will automatically calculate the ''Actual Value (ex Tax)'' and the ''Tax Amount'' and display in the corresponding fields.
#:Alternately, enter the cardline amount in the ''Actual Value (ex. Tax)'' field. The system will automatically calculate the ''Total (inc Tax) ''and the ''Tax Amount''.
# Select the ''Tax Type'' applicable to the cardline in the drop list. By default, this is set to ‘Australian GST’.
# If you need to enter a manual tax amount, tick the ''Manually enter tax'' check box. The ''Tax Amount'' field will re-display enabled for editing. Enter the tax amount required.
# Enter the description to show on the invoice for the cardline in the ''Description'' field.
# Select the ''Ledger Code'' in the drop list. The cardline will be recorded against the selected ledger in the system for accounting purposes.
# Enter the Vanity Cover From, Vanity Cover To dates as desired. The underlying start and end dates won't change, these fields are simply for presentation purposes on the invoice.
# Click the '''Save''' button. A message will display at the top of the screen informing that the cardline was saved successfully.
# Click the '''Cancel''' button to cancel the cardline creation.

For a brief video on pending cardlines and the manage invoice section, please see below;

<mediaplayer MWPlayerConfig="MyCustomConfig" height="400" width="600">http://wiki.emersion.com/wiki/media/PendingCardlinesManageInvoice.mp4</mediaplayer>
 

== Delete a Pending Cardline ==
''Only non-usage cardlines can be deleted. The system will check the cardline's ledger code name and if it contains "USAGE' you will not be able to delete it''

# Navigate to Customer > Pending Ledger Cardlines
# Use either the list pagination links at the bottom or filter on either Pending Cardline ID, Description, Created Date From or Created Date To to target the cardline you wish to delete
# Click Delete in the '''Action''' column on the right
# A pop-up box will allow you to NOT proceed in case you make a mistake. If you click Yes, the cardline will be delete forever. You cannot undo this action.

== Edit A Pending Cardline ==

''Some cardlines are able to be edited. You will see a magnifying glass icon in the '''Edit''' column on the left if this is the case.''

# Navigate to Customer > Pending Ledger Cardlines
# Use either the list pagination links at the bottom or filter on either Pending Cardline ID, Description, Created Date From or Created Date To to target the cardline you wish to delete
# Click the magnifying glass icon in the '''Edit''' column on the left.
# You may edit the following fields: Transaction Date, Description, Actual Value (ex GST), Tax Amount, Covers From, Covers To, Vanity Covers From, Vanity Covers To, Note
#* (''Only some cardlines can have their Ledger Code modified from this page'')
# Change whichever fields you are able to and the click '''Save'''. Click '''Cancel''' to undo any field changes prior to saving.
 
* For customers subscribed to the [https://resources.emersion.com/display/EKB/Cost+Centres|Cost Centre] module, you will see an additional section called ''Edit Cost Centres''
# Following the instructions above to edit the appropriate cardline
# Choose the cost centre value to apply to the cardline
# Click the '''Update Cost Centres''' button.
 

'''Note''': Editing a cardline will not automatically allocate it to an invoice. You can do this from [[InvoiceCardlineManagement|Invoice Manage]] page of a pending invoice.
 

[[File:Pending ledger cardlines 001.png]]

== Bulk Import & Manage Pending Cardlines ==

A bulk import tool is also available to import ledger cardlines in bulk against 1 or more accounts. See [[Data Import/Cardlines]]

In addition, a bulk update tool exists to enable you to manage pending cardlines. See [[Data Import/Cardline Management]]
----

===See also===
* [[InvoiceCardlineManagement|Invoice Cardline Management]]
* [[InvoiceImmeditateInvoice|Immeditate Invoices]]
* [[Data Import/Cardlines| Bulk Cardline Import]]
* [[Data Import/Cardline Management|Bulk Cardline Management (Update/Allocate/Delete/De-allocate)]]

Cost Centres

2020-04-22T01:55:56Z

=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 our new home.

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

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

Cost Centres/Standard Invoice Presentation

2020-04-22T01:55:43Z

Scarpenter:

=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 our new home.

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

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

Cost Centres/Standard Invoice Presentation/Cardlines

2020-04-22T01:55:30Z

Scarpenter:

=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 our new home.

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

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

Cost Centres/Package Cost Centres

2020-04-22T01:54:55Z

Scarpenter:

=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 our new home.

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

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

Cost Centres/Service Cost Centres

2020-04-22T01:54:12Z

Scarpenter:

=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 our new home.

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

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

Cost Centres/Service Cost Centres

2020-04-22T01:53:28Z

Scarpenter: /* Setting Service Cost Centres */

{{DISPLAYTITLE: Service-based Cost Centres}}
= Overview =
Emersion's support for cost centres include a list of cost centre types with values that can be set at different levels, including:
* an account
* a package
* a service
* a cardline.

This article covers service-level cost centres.

= Setting Service Cost Centres =

Please refer to the [https://resources.emersion.com/display/EKB/Cost+Centres|Cost Centre help] on the Emersion Knowledge Base

Account Management/Customer Screen/Details

2020-04-22T01:52:04Z

Scarpenter:

=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 our new home.

[https://resources.emersion.com/display/EKB/Cost+Centre+Default+Key Take me to the Emersion Knowledge Base article]

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

Account Management/Customer Screen/Details

2020-04-22T01:51:41Z

Scarpenter: /* Cost Centre Default */

{{DISPLAYTITLE: Customer Details}}
= Overview =
To access this screen:

Nav: '''Customer > List'''

Click on the ID of a customer. Click the '''Details''' tab. The '''Customer > Details''' tab provides a way for users to view and edit the main billing and account information for an end user.

There are the followimg customer detail sub tabs that may also be displayed. The appearance of these tabs will vary based on your company's subscription agreement with Emersion. Some tabs belong to optional modules.

* Profile (Account Profile)
* Delivery address
* Trading terms
* Early discount
* Late fee
* Late fee Invoice Ages
* Network Account Attributes
* Auto-Top Up Settings
* Cost Centre Default
* Xero Integration
* Jasper Configuration
* Access Fee Bulk Override Pricing

== Editing Customer Details ==

To edit any of the account details in the main Customer > Details tab, click the '''Edit Account Summary''' button. When you are finished, press the '''Save Account Summary''' button.

You can find the field definitions for this page in the [[Account/AccountCreation|article on how to create a customer]].

== Profile ==
The profile sub tab displays the customer's account profile.

Please refer to the [https://resources.emersion.com/display/EKB/Account+Profiles Account Profile help articles] on the EKB for more on account profiles

== Delivery Address ==
The Delivery Address sub tab is opened in EDIT mode where users can nominate a delivery address.

If the delivery address is the same as the address of the primary contact, tick the '''Same as Primary Contact''' box.

Otherwise, complete the address fields and when you are done, press '''Submit'''.

== Trading Terms ==
The Trading Terms tab displays the customer's trading terms.

Refer to our help on [https://resources.emersion.com/display/EKB/Trading+Terms trading terms] on the EKB for more on Trading Terms

== Early Discount ==
This sub tab shows the customer's configuration for an Early Payment Discount.

Refer to our help on [https://resources.emersion.com/display/EKB/Early+Payment+Discount the early discount feature] on the EKB for more.

== Late Fee ==
This sub tab shows any late payment fee the customer may incur.

Refer to our help on [https://resources.emersion.com/display/EKB/Late+Payment+Fee+on+Paid+Invoice the late payment fee for paid invoices] on the EKB.

== Late Fee - Invoice Ages ==
This sub tab shows any late payment fee the customer may incur.

Refer to our help on [https://resources.emersion.com/display/EKB/Late+Payment+Fee+On+Overdue+Invoice the late payment fee for overdue invoices] on the EKB.

=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 our new home.

[https://resources.emersion.com/display/EKB/Cost+Centre+Default+Key Take me to the Emersion Knowledge Base article]

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

== Xero Integration ==
This tab relates to Xero Integration and appears for service providers who are subscribed to the [https://resources.emersion.com/display/EKB/Xero Xero Integration]. This page enables users to assign a cost center to the customer. If there is no cost centre assigned, the name will be blank.

Please [https://resources.emersion.com/display/EKB/Associate+an+Emersion+Account+with+a+Xero+Contact refer to this article] to learn how to associate an Emersion account with a Xero contact.

== Access Fee Bulk Price Override ==
This tab relates to the application of the [[Product_Rate_Cards/Access_Fee_Discount/Access_Fee_Bulk_Pricing_Override|'''Access Fee Bulk Price Override''' feature]]. Please see the two articles below for detailed information on this feature.

* [[Product_Rate_Cards/Access_Fee_Discount|Access Fee Discounts (Tiered Pricing)]]
* [[Product_Rate_Cards/Access_Fee_Discount/Access_Fee_Bulk_Pricing_Override|Access Fee Bulk (Tiered) Pricing Override]]

Account Management/Customer Screen/Package Subscriptions/Cost Centres

2020-04-22T01:49:51Z

Scarpenter:

=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 our new home.

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

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

Cost Centres/Standard Invoice Presentation/Package Cost Centres

2020-04-22T01:49:40Z

Scarpenter:

=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 our new home.

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

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

Admin/Cost Centres

2020-04-22T01:49:04Z

=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 our new home.

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

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

Cost Centres/Cardline Cost Centres

2020-04-22T01:48:53Z

Scarpenter:

=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 our new home.

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

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

Account Management/Customer Screen/Service Subscriptions/Cost Centre

2020-04-22T01:47:58Z

Scarpenter:

=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 our new home.

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

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

Account Management/Customer Screen/Cost Centre

2020-04-22T01:47:34Z

Scarpenter:

=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 our new home.

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

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

Payment Plans V2/Create Payment Plan

2020-04-21T23:23:45Z

=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 our new home.

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

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

Payment Plans V2

2020-04-21T23:23:19Z

=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 our new home.

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

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

InvoiceReRate

2020-04-20T01:43:51Z

Scarpenter:

=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 our new home.

[https://resources.emersion.com/display/EKB/Re-Rate+Invoice Take me to the Emersion Knowledge Base article]

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

PackagePlans/Advanced

2019-11-20T07:14:43Z

Scarpenter: /* Tutorials */

= 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.

PackagePlans/Advanced/Package Subscription Groups

2019-11-20T07:14:05Z

Scarpenter:

=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 our new home.

[https://resources.emersion.com/display/EKB/Package+Subscription+Groups Take me to the Emersion Knowledge Base article]

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

PackagePlans/Advanced

2019-11-19T07:00:36Z

Scarpenter: /* Tutorials */

= 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.

* [[PackagePlans/Advanced/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.

PackagePlans/Advanced/First Period End Date

2019-11-19T07:00:09Z

=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 our new home.

[https://resources.emersion.com/display/EKB/First+Subscription+Period+End+Date Take me to the Emersion Knowledge Base article]

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

Commissions

2019-10-20T23:31:09Z

Scarpenter: /* See Also */

== Commissions ==

The commissions module is an additional optional module for Service Providers who are subscribed to the [[Agent Management|Agents module]]. Features of the Commissions module include:

* Create commissions plan(s) for Agents.
* Bind a commissions plan to an Agent.
* Set rules governing how & when a Commission can be processed.
* Set bounties and trails as a % and/or $ for both access fees and for usage.
* Set different commission plans Agents who are selling the same services and products as other Agents.
* View, process and manage the individual commissions across all Agents.
* My Commissions page for Agents allowing them to view the commissions they have earned.
* Ability for the Agent to invoice the Service Provider for Commissions earned.

For further information and pricing, please [[Support_and_help_from_Emersion|create a sales ticket]] and we will be pleased to assist you.
Subscription to this module requires a separate subscription to the Agents module.

== The Commissions Lifecycle ==

This section contains a high-level look at the commissions life cycle, including when Commissions are gathered, processed, and how Agents can ascertain how much they are due in commissions revenue.

=== Placing an Order – Gathering the Commissions ===

Each time an Agent places an order for a service or product that is included in the commission plan that has been set up by a Service Provider, Agents can then create and submit orders for their customers and the system will generate a record of the commissions.

There is nothing specific that an Agent needs to do in order to ensure commissions for their sales are calculated.

If an Agent or representative of a service provider will not be placing the orders themselves in Cumulus (e.g. Orders are placed by the upstream service provider on behalf of the Agent), the system supports linking the Agent to the order to ensure that commission for that order is appropriately attributed. This also applies to service migrations.

=== Commissions Rules - Determine how and when commissions are applied and processed ===

When an order is submitted by the Agent, the order is sent to the upstream service provider to be filled. At the same time, one or more commission record(s) are generated and held in a pending state until such time where they can be processed.

Whether a commission can be processed yet or not, is determined by the business rules for your commission plan as set up by the upstream service provider.
When the pending commission meets the business rules of your commission plan, the upstream service provider can then process the commission entries.

=== Collecting Commissions – Viewing the Invoice ===

When commission entries are processed, they will move from a pending status to processed status and a pending credit cardline will be generated. This will remain as a pending cardline until it is processed onto an invoice. The system will do this automatically.

Like all Emersion invoices, Agents can use this invoice to bill their upstream service provider for their commissions that they are owed. An Agent can also access commissions attributed to their service subscriptions and product orders using the '''My Commissions''' section.

== Definitions ==
{| class="wikitable"
|+Commissions definitions
|Term ||Meaning
|-
|Commission Tier ||A commission plan for an Agent or Agency who sells the products & services of the Service Provider. Once created and linked to an agent, the Commission tier is then linked to products, package plans, service plans, service features or bolt-ons. Commissions Tiers can also be used to provide different 'levels' of Commission for different staff or groups within the same Agency.
|-
|Bounty ||A bounty is a type of commission that applies once only when the service, package or otherwise is created
|-
|Trail ||A trail is an ongoing commission that applies in a recurring nature each time an access fee is billed. The trail can be a fixed amount and it can also be defined as a percentage of an access fee or usage charge. If both commission types are set, both apply.
|-
|Commission Status ||The status of the commission record 
* Created – A commission has been created but cannot be processed as it does not meet the business rule to be paid. It will not show on the agent’s invoice
* Processed – The commission meets business rules and has either been automatically or manually processed. The cardline will appear on the Agent’s invoice.
* Withdrawn – A commission that has been clawed back. Will not show on the Agent’s invoice. 
|}

== Training your Agents ==

Emersion provides the following document you can use that will assist you to train your Agents. You can hand them this document as is, or use it as a base for your own training guide.

Download: [[file:Commissions - For Agents of Service Providers v1.0.pdf]]

== Data Import and Further Help ==

If you would like Emersion to assist with:

* importing data
* configuration of commission tiers, Agents, subscription-based plans or products
* training you or your agents

Please submit a work request detailing the type of assistance you request so we can provide a quote.

If you are seeking help with importing data, import templates can be provided upon request.

== See Also ==

* [[Commissions/Commission_Management|Configuration and Management of the Commissions module]]
* [https://resources.emersion.com/display/EKB/Agents The Agents module]

Commissions

2019-10-20T23:29:38Z

Scarpenter: /* See Also */