Deactivate Service Flow

1. Overview

The Deactivate Service Flow removes one or more services from a CPE. The flow deletes the service records from the provision database (provision DB). Then the flow clears the service parameters on the CPE.

These requests start the flow:

  • the Deactivate service tab, see Deactivate Service

  • RemoveServices over SOAP

  • POST /service/deactivate over REST

The request contains the CPE identifier and the services to remove. The identifier is the serial number (SN) or the MAC address. The Business Process Model and Notation (BPMN) process is deactivateServiceFlow in deactivateServiceFlow.bpmn.

2. Flow Diagram

The numbers in the circles are status codes. For their meaning, see Status Codes Reference.

Deactivate Service Flow
Figure 1. Deactivate Service Flow

3. Steps

  1. The flow reads the CPE identifier and the service list from the request.

  2. The flow finds the CPE in the provision DB.

  3. The flow deletes the records of the selected services.

  4. The flow finds the CPE in the ACS.

  5. The flow takes the parameter names of the selected services from Params.xml.

  6. The flow calls FTSetDeviceParameters with these parameters and empty values.

  7. If the CPE is online, the flow waits for the task result.

In step 4, the flow uses FTGetDeviceInfo for an SN. For a MAC address, the flow uses FTFindCPEByWANMAC and then FTGetDeviceInfo. FTGetDeviceInfo also returns the OUI and the Product Class.

In step 6, FTSetDeviceParameters uses reprovision="0", Push=true and Endsession=true. For the task result, see Waiting for Task Results.

The flow ends in one of these ways:

Case Final status Result

The ACS does not have the CPE

513, 514

The flow ends after step 4. The provision DB no longer has the services.

The CPE is online

522

The flow cleared the service parameters on the CPE.

The CPE is offline

523

The task runs when the CPE connects.

4. Status Codes

Code Meaning

501, 502

SN, MAC address in the request XML

5100

No SN and no MAC address in the request XML. The flow ends.

503, 504

Services in the request XML

5103, 5104

No services in the request XML. The flow ends.

505, 506

SN, MAC address in the provision DB

5105, 5106

SN, MAC address not in the provision DB. The flow ends.

507, 510

Service records deleted from the provision DB

5107, 5110

Service records not deleted. The flow ends.

508, 509

CPE in the ACS

511, 512

CPE not in the ACS

513, 514

CPE not in the ACS. Services removed from the provision DB. Final status.

5111, 5112, 5115

FTGetDeviceInfo or FTFindCPEByWANMAC failure

515, 524

OUI and Product Class received

516, 5116

Service parameters from Params.xml: received, failure

517, 5117

FTSetDeviceParameters: success, failure

518, 519

CPE online, CPE offline

520

Task pending. The flow waits.

5119, 5118

Task still pending after the timeout, task status unknown

521, 5121

Parameters cleared, task failed or rejected

522

Deactivation complete. The CPE was online. Final status.

523

Deactivation complete. The CPE was offline. The task waits for the CPE. Final status.