Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Code Block
drudr pccGetData ( string typename, string key) 

Parameters

ParameterDescription

typename

The fully qualified typename of the requested UDR.

key

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.

...

Info
titleExample


Code Block
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.

Code Block
list<drudr> pccListData ( string typename ) 

Parameters

ParameterDescription

typename

The fully qualified typename of the requested UDRs.

Returns:

A list containing all the UDRs of the requested type.

...

Info
titleExample


Code Block
list<drudr> pccRulesList = pccListData
("PCRF.Rules.Provisioning.PCC_Rule");

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.

Code Block
drudr pccCreateData ( drudr udr )

Parameters

ParameterDescription

udr

The new UDR that is going to be inserted.

Returns:

The created UDR or null if there was an error.

...

Info
titleExample


Code Block
drudr created = pccCreateData(input);

will insert a new UDR named created through the provisioning interface.

pccUpdateData

This function updates a UDR through the provisioning interface.

Code Block
drudr pccUpdateData ( drudr udr ) 

Parameters

ParameterDescription

udr

The UDR that is going to be updated.

Returns:

The updated UDR or null if there was an error.

...

Info
titleExample


Code Block
drudr pccUpdateData(created);

will update the UDR named created through the provisioning interface.

pccDeleteData

This function deletes a UDR in the provisioning interface.

Code Block
drudr pccDeleteData ( drudr udr ) 

Parameters

ParameterDescription

udr

The UDR that is going to be deleted.

Returns:

The deleted UDR or null if there was an error.

...

Info
titleExample


Code Block
drudr pccDeleteData(created);

will delete the UDR named created through the provisioning interface.

pccLastErrorCode

If any of the create, delete or update operations should fail, the error code can be retrieved with this method.

...

Info
titleExample

If the last error code was 500.

Code Block
int pccLastErrorCode();

will return 500.

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.

...

Info
titleExample

If the last error code was 500.

Code Block
string pccLastErrorMessage();

will return a description of error code 500.

pccSetProvisioningArea

Sets a provisioning working area for the workflow. There are two areas available, TEST and PROD.

Code Block
void pccSetProvisioningArea ( string area ) 

Parameters

ParameterDescription

area

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.

...

Info
titleExample


Code Block
pccSetProvisioningArea("TEST");

will set area TEST as working area for the workflow.

pccGetProvisioningArea

Retrieves information about the currently active area for the workflow.

Code Block
string pccGetProvisioningArea()

Parameters

ParameterDescription

Returns:

The name of the currently active provisioning area.

...

Info
titleExample

If the currently active area for the workflow is TEST,

Code Block
string pccGetProvisioningArea();

will return "TEST".

pccCopyAreaData

Copies the specified configurations in one area to another.

...

Code Block
void pccCopyAreaData ( string source, string  destination, string product ) 

Parameters

ParameterDescription

source

The name of the source area.

destination

The name of the destination area.

product

The name of the product to copy.

...

Note
titleNote!

When working with PCC Rules, the product parameter should be set to PCRF.Rules.

pccClearArea

Deletes the specified product in the stated area.

Code Block
void pccClearArea ( string area, string  product ) 

Parameters

ParameterDescription

area

The name of the area to clear.

product

The name of the product you want to delete.

...