APL - PCC Provisioning Plugins - Buckets
- Yeok Hong Ng
The provisioning functions include:
Note!
These functions can be used to interact with the PCC provisioning interface from APL.
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. |
Example
drudr notification = pccGetData
("PCC.Products.Provisioning.Notification", "70");will retrieve a UDR of the type PCC.Products.Provisioning.Notification with the key 70 .
pccListData
Retrieves a list with all the UDRs from the provisioning interface with the stated UDR type.
list<drudr> pccListData( string typenameParameters
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 notificationsList with all the UDRs that have the type PCC.Products.Provisioning.Notification .
pccCreateData
This function inserts a new UDR through the provisioning interface.
Parameters
Parameter | Description |
|---|---|
| The new UDR to insert. |
Returns: | The created UDR or null if there was an error. |
pccUpdateData
This function updates a UDR through the provisioning interface.
Parameters
Parameter | Description |
|---|---|
| The UDR to update. |
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 to delete. |
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.
Parameters
Return code | Explanation |
|---|---|
200 | Will be returned if the last operation was successful. |
400 | Will be returned if the object just created/updated is referring to one or more objects that are missing. |
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.
Parameters
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 one of the either TEST or PROD. |
Returns: | Nothing |
pccGetProvisioningArea
Retrieves the currently active area for the workflow.
Parameters
Parameter | Description |
|---|---|
Returns: | The name of the currently active provisioning area. |
pccCopyAreaData
Copies configurations from one area to another.
Parameters
Parameter | Description |
|---|---|
| The name of the source area. |
| The name of the destination area. |
| The configurations that you want to copy, e g PCC (for all PCC configurations), PCC.Products (for only Product configurations), PCC.Periods (for only Periods configurations), etc. |
Returns: | Null if the command succeeded or the error message if there was an error. |
pccClearArea
Clears an area. All content in the area will be deleted.
Parameters
Parameter | Description |
|---|---|
| The name of the area to clear. |
Returns: | Null if the command succeeded or the error message if there was an error. |