Skip to end of banner
Go to start of banner

Create a Provisioning Provider Plugin

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Next »

This section describes how a provisioning provider plugin can be created.

What does this section cover?

Create a provisioning provider plugin

In order to create a provisioning provider plugin, you need to:

  1. Define the provider in provisioning providers metadata file.
  2. Create a process class extending com.crm.process.provisioning.CRMProcessProvisioningProviderBean.
  3. Create a data entry view class and a java class implementing com.crm.process.provisioning.CustomProvisioningAction for each of the provisioning provider related processes.
  4. Set up the provider through the provisioning providers page.

For this example we assume that the provisioning provider is Example.

1. Provisioning Providers Metadata File

The new provider must be defined in provisioningproviders.xml file which is located under <custom_project>/src/main/resources/metadata/ directory. 

The provider definition must consist of the following: 

  • the provproviderprotocol, this is the protocol of the provisioning provider
  • the provprovidername, this is the name of the provider and it will appear on the provider's data entry screen
  • and the provider process name, this must be the same as the custom process class that will be created for the provider.

Also, in this file, you can define the following:

  • generalparameters, these are the provider parameters,
  • hardwaretypes, these are the supported hardware types
  • relatedpages, the data entry or summary pages that are implemented to cover the custom provider's processes
  • regionmapping. a boolean value indicating whether there should be region mapping configured for the provider
  • usedbyusageservicecatalog, a boolean value indicating whether the provider can be used by a usage service catalog
  • testconnectionavailable, a boolean value indicating whether the "Test Connection" button should be available for the provider



2. Provisioning Provider Process Class

Create Process Class and Implement a Method for Each Action

Use @Stateless(mappedName = "ejb/CRMProcessExampleProvider") to define the mapped name of the provisioning provider EJB. The mapped name should match the one defined in provisioningproviders.xml metadata file and the new process class must extend com.crm.process.provisioning.CRMProcessProvisioningProviderBean.


CRMProcessExampleProviderBean.java
@Stateless(mappedName = "ejb/CRMProcessExampleProvider")
@LocalBean
public class CrmProcessExampleProviderBean extends CRMProcessProvisioningProviderBean {
		
    /**
     * Default constructor. 
     */
	public CrmProcessExampleProviderBean() {
        super();
    }
	...
}

The new process class must implement the following methods, which are defined as abstract in CRMProcessProvisioningProviderBean parent class:

  1. public void testConnection(CRMDOProvProvider provProvider)


    This method is called to test whether the connection with the provisioning provider is valid.

    testConnection
    	@Override
    	public void testConnection(CRMDOProvProvider provProvider) throws Exception {
    		...
    	}
    	...
    }
  2. public ProvisioningProviderResult processAddService(AddServiceParameters addServiceParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'Add Service' subscription action is executed.

    processAddService
    	@Override
    	public ProvisioningProviderResult processAddService(AddServiceParameters addServiceParameters,
    			ArrayList<ProvisioningProviderService> providerServices,
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		
    		...
    	}
    	...
    }
  3. public ProvisioningProviderResult processAmendBundleService(AmendBundleServiceParameters amendBundleServiceParameters,
    ArrayList<ProvisioningProviderService> removedProviderServices,
    ArrayList<ProvisioningProviderService> addedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems)

    This method is called whenever an 'Amend Bundled' subscription action is executed.

    processAmendBundleService
    	@Override
    	public ProvisioningProviderResult processAmendBundleService(
    			AmendBundleServiceParameters amendBundleServiceParameters,
    			ArrayList<ProvisioningProviderService> removedProviderServices,
    			ArrayList<ProvisioningProviderService> addedProviderServices, 
    			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, 
    			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception {
    		
    		...
    	}
    	...
    }
  4. public ProvisioningProviderResult processRemoveService(RemoveServiceParameters removeServiceParameters,
    ArrayList<ProvisioningProviderService> removedProviderServices,
    ArrayList<ProvisioningProviderService> addedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems)

    This method is called whenever a 'Remove Service' subscription action is executed.

    processRemoveService
    	@Override
    	public ProvisioningProviderResult processRemoveService(RemoveServiceParameters removeServiceParameters,
    			ArrayList<ProvisioningProviderService> removedProviderServices,
    			ArrayList<ProvisioningProviderService> addedProviderServices, 
    			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, 
    			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception {
    
    		...
    	}
    	...
    }
  5. public ProvisioningProviderResult processSwapService(SwapServiceParameters swapServiceParameters,
    ArrayList<ProvisioningProviderService> removedProviderServices,
    ArrayList<ProvisioningProviderService> addedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems)

    This method is called whenever a 'Swap Service' subscription action is executed.

    processSwapService
    	@Override
    	public ProvisioningProviderResult processSwapService(SwapServiceParameters swapServiceParameters,
    			ArrayList<ProvisioningProviderService> removedProviderServices,
    			ArrayList<ProvisioningProviderService> addedProviderServices, 
    			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, 
    			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  6. public ProvisioningProviderResult processStartService(StartServiceParameters startServiceParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Start Service' subscription action is executed.

    processStartService
    	@Override
    	public ProvisioningProviderResult processStartService(StartServiceParameters startServiceParameters,
    			ArrayList<ProvisioningProviderService> providerServices,
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  7. public ProvisioningProviderResult processStopService(StopServiceParameters stopServiceParameters,
    ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Stop Service' subscription action is executed.

    processStopService
    	@Override
    	public ProvisioningProviderResult processStopService(StopServiceParameters stopServiceParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  8. public ProvisioningProviderResult processAddInstalledItem(AddInstalledItemParameters addInstalledItemParameters,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems, ArrayList<ProvisioningProviderService> providerServices)

    This method is called whenever an 'Add Installed Item' subscription action is executed.

    processAddInstalledItem
    	@Override
    	public ProvisioningProviderResult processAddInstalledItem(AddInstalledItemParameters addInstalledItemParameters,
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems, 
    			ArrayList<ProvisioningProviderService> providerServices) throws Exception {
    		...
    	}
    	...
    }
  9. public ProvisioningProviderResult processRemoveInstalledItem(RemoveInstalledItemParameters removeInstalledItemParameters,

    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Remove Installed Item' subscription action is executed.

    processRemoveInstalledItem
    	@Override
    	public ProvisioningProviderResult processRemoveInstalledItem(
    			RemoveInstalledItemParameters removeInstalledItemParameters,
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  10. public ProvisioningProviderResult processMoveInstalledItem(MoveInstalledItemParameters moveInstalledItemParameters,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems)

    This method is called whenever a 'Move Installed Item' subscription action is executed.

    processMoveInstalledItem
    	@Override
    	public ProvisioningProviderResult processMoveInstalledItem(MoveInstalledItemParameters moveInstalledItemParameters,
    			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  11. public ProvisioningProviderResult processSwapInstalledItem(SwapInstalledItemParameters swapInstalledItemParameters,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems,
    ArrayList<ProvisioningProviderService> providerServices)

    This method is called whenever a 'Swap Installed Item' subscription action is executed.

    processSwapInstalledItem
    	@Override
    	public ProvisioningProviderResult processSwapInstalledItem(SwapInstalledItemParameters swapInstalledItemParameters,
    			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems, 
    			ArrayList<ProvisioningProviderService> providerServices) throws Exception {
    		...
    	}
    	...
    }
  12. public ProvisioningProviderResult processChangeSubscriptionDistribution(ChangeSubscriptionDistributionParameters changeSubscriptionDistributionParameters,
    ArrayList<ProvisioningProviderService> removedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderService> addedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems,
    ArrayList<ProvisioningProviderService> authorisedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems)

    This method is called whenever a 'Change Subscription Distribution' subscription action is executed.

    processChangeSubscriptionDistribution
    	@Override
    	public ProvisioningProviderResult processChangeSubscriptionDistribution(
    			ChangeSubscriptionDistributionParameters changeSubscriptionDistributionParameters,
    			ArrayList<ProvisioningProviderService> removedProviderServices,
    			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    			ArrayList<ProvisioningProviderService> addedProviderServices,
    			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems, 
    			ArrayList<ProvisioningProviderService> authorisedProviderServices, 
    			ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  13. public ProvisioningProviderResult processBecomeSubscriber(BecomeSubscriberParameters becomeSubscriberParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Become Subscriber' subscription action is executed.

    processBecomeSubscriber
    	@Override
    	public ProvisioningProviderResult processBecomeSubscriber(
    			BecomeSubscriberParameters becomeSubscriberParameters,
    			ArrayList<ProvisioningProviderService> providerServices,
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  14. public ProvisioningProviderResult processActivateSubscription(ActivateSubscriptionParameters activateSubscriptionParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'Activate Subscription' subscription action is executed.

    processActivateSubscription
    	@Override
    	public ProvisioningProviderResult processActivateSubscription(
    			ActivateSubscriptionParameters activateSubscriptionParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  15. public ProvisioningProviderResult processDeactivateSubscription(DeactivateSubscriptionParameters deactivateSubscriptionParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Deactivate Subscription' subscription action is executed.

    processDeactivateSubscription
    	@Override
    	public ProvisioningProviderResult processDeactivateSubscription(
    			DeactivateSubscriptionParameters deactivateSubscriptionParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  16. public ProvisioningProviderResult processTerminateSubscription(TerminateSubscriptionParameters teminateSubscriptionParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Terminate Subscription' subscription action is executed.

    processTerminateSubscription
    	@Override
    	public ProvisioningProviderResult processTerminateSubscription(
    			TerminateSubscriptionParameters teminateSubscriptionParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  17. public ProvisioningProviderResult processRestSubscription(RestSubscriptionParameters restSubscriptionParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Rest Subscription' subscription action is executed.

    processRestSubscription
    	@Override
    	public ProvisioningProviderResult processRestSubscription(RestSubscriptionParameters restSubscriptionParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  18. public ProvisioningProviderResult processEndSubscriptionResting(EndSubscriptionRestingParameters endSubscriptionRestingParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'End Subscription Resting' subscription action is executed.

    processEndSubscriptionResting
    	@Override
    	public ProvisioningProviderResult processEndSubscriptionResting(
    			EndSubscriptionRestingParameters endSubscriptionRestingParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  19. public ProvisioningProviderResult processShortTermSubscriptionActivation(ShortTermSubscriptionActivationParameters shortTermActivationParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Short Term Activation' subscription action is executed.

    processShortTermSubscriptionActivation
    	@Override
    	public ProvisioningProviderResult processShortTermSubscriptionActivation(
    			ShortTermSubscriptionActivationParameters shortTermActivationParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  20. public ProvisioningProviderResult processEndShortTermSubscriptionActivation(EndShortTermSubscriptionActivationParameters endShortTermSubscriptionActivationParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'End Short Term Activation' subscription action is executed.

    processEndShortTermSubscriptionActivation
    	@Override
    	public ProvisioningProviderResult processEndShortTermSubscriptionActivation(
    			EndShortTermSubscriptionActivationParameters endShortTermSubscriptionActivationParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  21. public ProvisioningProviderResult processShortTermSubscriptionDeactivation(ShortTermSubscriptionDeactivationParameters shortTermSubscriptionDeactivationParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Short Term Deactivation' subscription action is executed.

    processShortTermSubscriptionDeactivation
    	@Override
    	public ProvisioningProviderResult processShortTermSubscriptionDeactivation(
    			ShortTermSubscriptionDeactivationParameters shortTermSubscriptionDeactivationParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  22. public ProvisioningProviderResult processEndShortTermSubscriptionDeactivation(EndShortTermSubscriptionDeactivationParameters endShortTermSubscriptionDeactivationParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'End Short Term Deactivation' subscription action is executed.

    processEndShortTermSubscriptionDeactivation
    	@Override
    	public ProvisioningProviderResult processEndShortTermSubscriptionDeactivation(
    			EndShortTermSubscriptionDeactivationParameters endShortTermSubscriptionDeactivationParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  23.  public ProvisioningProviderResult processAddServiceUsage(AddServiceUsageParameters addServiceUsageParameters,
    ArrayList<ProvisioningProviderUsageDataRecord> protocolProviderUdrs,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'Add Service Usage' subscription action is executed.

    processAddServiceUsage
    	@Override
    	public ProvisioningProviderResult processAddServiceUsage(AddServiceUsageParameters addServiceUsageParameters,
    			ArrayList<ProvisioningProviderUsageDataRecord> protocolProviderUdrs, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  24. public ProvisioningProviderResult processCancelledUDRs(CancelServiceUsageParameters cancelServiceUsageParameters, ArrayList<ProvisioningProviderUsageDataRecord> providerUsageDataRecords)

    This method is called whenever a 'Cancel UDR' action is executed.

    processCancelledUDRs
    	@Override
    	public ProvisioningProviderResult processCancelledUDRs(CancelServiceUsageParameters cancelServiceUsageParameters,
    			ArrayList<ProvisioningProviderUsageDataRecord> providerUsageDataRecords) throws Exception {
    		...
    	}
    	...
    }
  25. public ProvisioningProviderResult processResetSubscription(ResetSubscriptionParameters resetSubscriptionParameters,
    ArrayList<ProvisioningProviderService> providerServicesForDeactivation,
    ArrayList<ProvisioningProviderService> providerServicesForActivation,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItemsForActivation,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItemsForDeactivation,
    ArrayList<ProvisioningProviderUsageDataRecord> providerUdrsForActivation,
    ArrayList<ProvisioningProviderUsageDataRecord> providerUdrsForDeactivation,
    ArrayList<ProvisioningProviderService> authorisedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems)

    This method is called whenever a 'Reset Subscription' subscription action is executed.

    processResetSubscription
    	@Override
    	public ProvisioningProviderResult processResetSubscription(ResetSubscriptionParameters resetSubscriptionParameters,
    			ArrayList<ProvisioningProviderService> providerServicesForDeactivation,
    			ArrayList<ProvisioningProviderService> providerServicesForActivation,
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItemsForActivation,
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItemsForDeactivation,
    			ArrayList<ProvisioningProviderUsageDataRecord> providerUdrsForActivation,
    			ArrayList<ProvisioningProviderUsageDataRecord> providerUdrsForDeactivation, 
    			ArrayList<ProvisioningProviderService> authorisedProviderServices, 
    			ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  26. public ProvisioningProviderResult processChangeSubscriberAccount(ChangeSubscriberAccountParameters changeSubscriberAccountParameters)

    This method is called whenever a 'Change Subscriber Account' action is executed.

    processChangeSubscriberAccount
    	@Override
    	public ProvisioningProviderResult processChangeSubscriberAccount(
    			ChangeSubscriberAccountParameters changeSubscriberAccountParameters) throws Exception {
    		...
    	}
    	...
    }
  27. public ProvisioningProviderResult processChangeSubscriptionLocation(ChangeSubscriptionLocationParameters changeSubscriptionLocationParameters)

    This method is called whenever a 'Change Subscription Address' action is executed.

    processChangeSubscriptionLocation
    	@Override
    	public ProvisioningProviderResult processChangeSubscriptionLocation(
    			ChangeSubscriptionLocationParameters changeSubscriptionLocationParameters) throws Exception {
    		...
    	}
    	...
    }
  28. public ProvisioningProviderResult processExtendSubscriptionGracePeriod(ExtendSubscriptionGracePeriodParameters extendSubscriptionGracePeriodParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'Extend Grace Period' action is executed.

    processExtendSubscriptionGracePeriod
    	@Override
    	public ProvisioningProviderResult processExtendSubscriptionGracePeriod(
    			ExtendSubscriptionGracePeriodParameters extendSubscriptionGracePeriodParameters,
    			ArrayList<ProvisioningProviderService> providerServices, 
    			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  29. public ProvisioningProviderResult processAmendServicesAndInstalledItems(AmendServicesAndInstalledItemsParameters amendServicesAndInstalledItemsParameters,
    ArrayList<ProvisioningProviderService> removedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderService> addedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems,
    ArrayList<ProvisioningProviderService> authorisedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems)

    This method is called whenever an 'Amend Services and Installed Items' action is executed.

    processAmendServicesAndInstalledItems
    	@Override
    	public ProvisioningProviderResult processAmendServicesAndInstalledItems(
    			AmendServicesAndInstalledItemsParameters amendServicesAndInstalledItemsParameters,
    			ArrayList<ProvisioningProviderService> removedProviderServices,
    			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    			ArrayList<ProvisioningProviderService> addedProviderServices,
    			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems, 
    			ArrayList<ProvisioningProviderService> authorisedProviderServices, 
    			ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems) throws Exception {
    		...
    	}
    	...
    }
  30. public ProvisioningProviderResult processCustomProvisioningAction(CustomProvisioningActionParameters customProvisioningActionParameters)

    This method is called whenever a Custom action is executed.

    processCustomProvisioningAction
    	@Override
    	public ProvisioningProviderResult processCustomProvisioningAction(
    			CustomProvisioningActionParameters customProvisioningActionParameters) throws Exception {
    		...
    	}
    	...
    }
  31. public Boolean authenticate(AuthenticateParameters authenticateParameters)

    This method is called to authenticate the subscriber.

    authenticate
    	@Override
    	public Boolean authenticate(AuthenticateParameters authenticateParameters) throws Exception {
    		...
    	}
    	...
    }

3. Data Entry View Pages and Java classes 

You will need to create a data entry view page for each of the provisioning provider's individual processes. These pages must be defined in the relatedpages section of the provisioningproviders.xml file, to appear as links in the provisioning providers screen.

These processes are considered Custom Provisioning Provider Actions. Thus, for each of these processes a new Java Class implementing com.crm.process.provisioning.CustomProvisioningAction should be created. In the example below, a java class is created for the "Set pin code" process.

SetPinCodeAction.java
public class SetPinCodeAction implements CustomProvisioningAction {
	...
}


Then, an object of this java class is used in the data entry view page to send the custom provisioning requests for the "Set pin code" process.

SetPinCodeView.java
@ManagedBean(name = "setPinCodeView", eager = true)
@ViewScoped
public class SetPinCodeView extends DataEntryView {

@EJB private CRMProcessExampleProviderBean processExampleProvider;

...

public void submitButton() throws Exception {
		
		...

		SetPinCodeAction setPinCodeAction = new SetPinCodeAction();		
		setPinCodeAction.setProvProvider(provider);
		setPinCodeAction.setPINCode(getPINCode());
		
		processExampleProvider.sendCustomProvisioningCommandsToHandler(setPinCodeAction, provider.getProtocol());		
		...
	}


On clicking the submit button, the submitButton() method of the SetPinCodeView class will be called and the custom provisioning request will be sent to the provisioning provider handler.

4. Set up the plugin provider through CRM.COM

The plugin provider can be set up through CRM.COM from the Provisioning Providers data entry view page, which can be found under Settings & Admin > Billing Application > Subscription & Billing Settings > Set up Provisioning Providers. 

Once the provider is defined in the provisioning providers metadata file, it can be added as a plugin through the Provisioning Providers data entry view page. By selecting "Set Up a Provisioning Provider", you can add the plugin provider to the list of provisioning providers. After adding it, you will be able to set it up, manage the provider's provisioning requests, perform reset subscription runs, reset a single subscription of the provider and execute the processes defined in the related pages of the provisioning provider's definition (in the provisioningproviders.xml file). 




  • No labels