Go to full article

Service type ID: 5389

Service Type name: Vocus NBN

Carrier:  Vocus

Overview

Vocus provides Layer 2 and Layer 3 services under various product names. 

The Vocus NBN service type in Emersion supports both Layer 2 and layer 3 services.  

Layer 3

Layer 2

Key Characteristics

Key characteristics of a Vocus NBN service include the network type, technology, line speed and profile. 

Vocus NBN Key Characteristics Support

Not all technologies or other characteristics are supported in all possible cases. This table contains specific information for each characteristic and the support that is provided.

NBN Technology and Features Support

This table contains each technology type and the support that is provided for the relevant features.

Automated Provisioning

Vocus NBN is fully automated service type for the purposes of SQs, orders and managing services on the Vocus network. 

Onboarding?

To enable this service type,  Emersion require the following items to be supplied:

1. Your provisioning certificate
2. Certificate Password
3. API Access Key
4. Plan Codes File - This is a document that contains the technology, speed and network type and profile, then give you a plan code to match each.

You may need to ask your Vocus account manager for this information.  When received Please send this to our onboarding team.

Plan Building

This section gives advice as to how to structure plans for Vocus NBN services.

Reseller Connect (RC) and Reseller Connect Customer Experience (RC:CX)

One service plan for each line speed is required for plans that are month-to-month (no contract). At the time of writing, RC plans have no option for a contract.

If your plans can or will, utilise a contract the plan set above is supported with additional packge plans for each contract variant. 

The table below contains plans that are needed when services can be sold under a 12 or 24 month contract, or no contract (paying month to month). 

BUY Service Plan Properties

There are the following properties defined at the buy service plan level. 

• Vocus Network Profile
• Technologies
  • A single plan can support multiple technologies.
• NBN Experience
• Service Speed
• Network Type

SELL Service Plan Properties

The system will show the BUY service plan properties within the SELL service plan so the sellers know what they are selling.  These are displayed as read-only. 

A copy function enables users to choose an approved BUY plan to copy properties from.  

Additional properties are defined within the SELL plan.

Ordering and Service Management

This section contains specific information regarding ordering and managing Vocus NBN services in Emersion.  It does not apply to other service types. 

Order Routes

Orders cab be placed via the following routes

• Cumulus
• Sign Up Portal
• API

Order Variations

A number of variations to the standard ordering processes and interfaces have been made to accommodate Vocus NBN services. 

• The ordering options (see below) are not shown at initial SQ screen, but are displayed after the SQ has returned a result.  
• The Phone Number/Vocus Carrier ID optionally appears on the second SQ screen if there is a PSTN line existing at the premise and user is permitted to continue it. An on-screen message is provided to the user. If the provided phone number does not match the PSTN line at the premise, an error will be shown,
• Service Configuration Items will collect certain ordering parameters required by various NBN technology types, in conjunction with the transfer types.  These are required by the Vocus platform. 

Modem / NCD Ordering from Vocus

If there is NCD Shortfall for an FTTC order (i.e. Service Class 33) or the service plan has the Requires Delivery Address for Modem flag enabled, the order will require a delivery address to be provided.

At the time of generating the provisioning request for Vocus

• The delivery address will be created in Vocus and passed as "CPEDirectoryID" parameter to Vocus
• If there is NCD Shortfall for an FTTC order (i.e. Service Class 33), the "NBNCPEPlanID" parameter would be passed to Vocus - this ensures an NCD will be shipped by Vocus
• If the Service Plan says "Modem to be provided by Vocus", only then the "CPEPlanID" parameter would be passed to Vocus - this ensures a Modem will be shipped by Vocus

Ordering Options

Below is a list of all possible ordering option values.

Service-Level Properties

Service level properties is the data that is service-specific and stored against the service / service subscription in Emersion.   It is entered during an order at the service configuration step and can be viewed later under Service Subscription > (Service) > Properties.

Aggregated CVC Management for NC Layer 2

An aggregated CVC represents a shared pool of data that is owned by a service provider. Their customers share this data pool.  A service provider may own multiple CVCs across the country. A CVC ID can be mapped to one or many states and territories in Australia or declared as "National" to apply in all states.

Emersion has a specific optional feature that enables CVC management for service providers selling Network Connect Layer 2 services.  Emersion permits authorised providers to import their CVC information from Vocus and allow for selection of a Default CVC.  The default CVC becomes part of the SQ and the order requests sent to Vocus for an NCL2 service.

It will be only granted to providers using NCL2 integration with Vocus upon receipt of a written request.  Please contact us if this feature interests you. 

Plan Changes

Plan changes are permitted where compatibility requirements are met between plans. The following rules apply.

1. An active service with an associated technology cannot be migrated to a plan which does not support the same technology. 
2. If the source active service has traffic classes associated, it cannot be migrated to a destination plan which does not support the same traffic classes.
3. The system checks that the following properties match in both the source and the destination plans.
   1. NBN Technologies
   2. Vocus Network Type
   3. Vocus Network Connect Tag Type
   4. Vocus Reseller Connect Tag Type

Service Management Functions

For each type of service management function, we have listed what is presently supported. 

Usage Collection

It explains what Emersion needs from you in order to collect and mediate usage.

FTP Details

Please provide Emersion with your Vocus FTP credentials so we can collect usage from Vocus.  You may need to ask your Vocus account manager for this information.

Events

The following events are included with the service type.  These event types will be provided to you as part of enabling the service type for your account.

Click on any event to learn more about it.

• Event: Vocus NBN Appointment Change

• Event: Vocus NBN Credentials Assigned

• Event: Vocus NBN Order Submitted

• Event: Vocus NBN Service Activated

You will need to set up a message template, then enable the event type for it to be triggered.

Related Pages

• Page:
  Vocus NBN
• Page:
  Vocus Usage Collection
• Page:
  AAPT Usage Collection
• Page:
  Event: Vocus NBN Order Submitted
• Page:
  Event: Vocus NBN Appointment Change
• Page:
  Event: Vocus NBN Service Activated
• Page:
  AAPT National Wholesale Broadband (Broadband Connect L3)
• Page:
  AAPT National Wholesale Broadband (Broadband Connect L2)
• Page:
  Requesting New Service Types
• Page:
  Telstra WME Bounty Management Module
• Page:
  Rhipe Microsoft CSP
• Page:
  Onboarding Service Types
• Page:
  Time zones
• Page:
  Packages and Plans for Rhipe Microsoft CSP
• Page:
  Orders and Subscriptions for Microsoft CSP Rhipe