APL - PCC Rules Provisioning Plugin
- Yeok Hong Ng
The provisioning functions include:
These functions can be used to interact with the PCC provisioning interface.
pccGetData
Retrieves a specific UDR from the provisioning interface based on the stated UDR type and key.
drudr pccGetData ( string typename, string key)Â Parameters
Parameter | Description |
|---|---|
| The fully qualified typename of the requested UDR. |
| The primary key value of the requested UDR, which is unique |
Returns: | The matching UDR or null if no matching UDR was found, or if an error occurred during lookup. |
Example
drudr rule = pccGetData("PCRF.Rules.Provisioning.PCC_Rule",555);will retrieve a UDR of the type PCRF.Rules.Provisioning.PCC_Rule with the key 555 .
pccListData
Retrieves a list with all the UDRs from the provisioning interface with the stated UDR type.
list<drudr> pccListData ( string typename )Â Parameters
Parameter | Description |
|---|---|
| The fully qualified typename of the requested UDRs. |
Returns: | A list containing all the UDRs of the requested type. |
Example
will return a list named pccRulesList with all the UDRs that have the type PCRF.Rules.Provisioning.PCC_Rule .
pccCreateData
This function inserts a new UDR through the provisioning interface.
Parameters
Parameter | Description |
|---|---|
| The new UDR that is going to be inserted. |
Returns: | The created UDR or null if there was an error. |
Example
will insert a new UDR named created through the provisioning interface.
pccUpdateData
This function updates a UDR through the provisioning interface.
Parameters
Parameter | Description |
|---|---|
| The UDR that is going to be updated. |
Returns: | The updated UDR or null if there was an error. |
pccDeleteData
This function deletes a UDR in the provisioning interface.
Parameters
Parameter | Description |
|---|---|
| The UDR that is going to be deleted. |
Returns: | The deleted UDR or null if there was an error. |
pccLastErrorCode
If any of the create, delete or update operations should fail, the error code can be retrieved with this method.
Error code | Explanation |
|---|---|
200 | Will be returned if the last operation was successful. |
400 | Will be returned if you are trying to create or update an object that is missing required references. The object will not be created or updated. |
401 | Will be returned if the delete operation failed because the object contains references from other objects. |
402 | This error code is only applicable for the pccCreateData function, and will be returned if the object already exists. |
403 | Will be returned if any of the functions pccGetData, pccUpdateData, or pccDeleteData are referring to a missing object. |
500 | Will be returned if there was an error trying to read/write to storage. |
pccLastErrorMessage
If any of the create, delete or update operations should fail, a more detailed description of the error can be retrieved with this method.
Parameter | Description |
|---|---|
Returns: | A description of the last error. |
pccSetProvisioningArea
Sets a provisioning working area for the workflow. There are two areas available, TEST and PROD.
Parameters
Parameter | Description |
|---|---|
| The name of the area to work against. All delete, update, get and create operations will use this area. Must be either TEST or PROD. |
pccGetProvisioningArea
Retrieves information about the currently active area for the workflow.
Parameters
Parameter | Description |
|---|---|
Returns: | The name of the currently active provisioning area. |
pccCopyAreaData
Copies the specified configurations in one area to another.
Parameters
Parameter | Description |
|---|---|
| The name of the source area. |
| The name of the destination area. |
| The name of the product to copy. |
pccClearArea
Deletes the specified product in the stated area.
Parameters
Parameter | Description |
|---|---|
| The name of the area to clear. |
| The name of the product you want to delete. |