Provisioning¶

Administrators¶

The CSV files to be imported for any administrator account should have the following format:

username

A unique string that is the username for this user. Limit 64 characters.

role_id

The {role_id} defines the type of administrator that is being created. The following can be used as {role_id}:

• platform_owner

• service_provider:<service_provider_name>

first_name (optional)

A string that is the first name of this user. Limit 250 characters.

last_name (optional)

A string that is the last name of this user. Limit 250 characters.

email (optional)

A string that is the email address for this user. Limit 250 characters.

permissions (optional)

An array of permission groups that this user is a member of. Permissions are dependent on the {role_id} of the created administrator.

Service Providers¶

The CSV files to be imported for Service Providers should have the following format:

name

A unique string that is the name of this Service Provider. Limit 64 characters.

display_name (optional)

An unconstrained string used as a display name. Limit 250 characters.

first_name (optional)

A string that is the first name of a contact for this Service Provider. Limit 250 characters.

last_name (optional)

A string that is the last name of a contact for this Service Provider. Limit 250 characters.

email (optional)

A string that is the email address of this Service Provider. Limit 250 characters.

address (optional)

A string that is the physical address of this Service Provider. Use | to represent line breaks. Limit 250 characters.

phone (optional)

A string that is the phone number, excluding hyphens and parentheses, of this Service Provider. Limit 250 characters.

notes (optional)

A string that is a free-form notes field. Limit 2048 characters.

Lots¶

The CSV files to be imported for lots should have the following format:

number

An 8 to 14-digit string of integers that represents the number printed on the card.

PIN

A unique string of integers that indicates the personal identification number used to access this account.

initial balance

A 3 to 8-digit string of integers, with a decimal point before final two digits, indicating the initial balance of funds on this account.

current balance

A 3 to 8-digit string of integers, with a decimal point before final two digits, indicating the current balance of funds on this account.

status

The status of this account. Accepted values are activated, blocked, empty, expired, generated, or uploaded.

activation date

The date and time this account was activated.

default expiration type

The type of expiration for this account. Accepted values are No_Expiration, Fixed_Expiration, or Days_From_First_Use.

expiration date

The date and time this account expires when the expiration type is Fixed_Expiration.

first use expiration duration

Identifys the duration, in days or years, that the account will expire after the specified type of first use.

first use activation type

The type of use that will cause account expiration when the expiration type is Days From First Use. Accepted values are FIRST_USE_IVR or FIRST_BILLED_CALL.

one step numbers

A list of valid phone numbers separated by commas.

phone me numbers

A list of valid phone numbers separated by commas.

speed dial numbers

An array of speed dial numbers followed by valid phone numbers.

constraint override

Set of instructions that block or require the call destination constraint value in regex format.

first_name (optional)

A string that is the first name of a contact for this account. Limit 250 characters.

last_name (optional)

A string that is the last name of a contact for this account. Limit 250 characters.

email (optional)

A string that is the email address of this account. Limit 250 characters.

product offering name

A string indicating the name of the product offering associated with this account.

product offering service provider name

A unique string that is the name of the Service Provider who owns the product offering associated with this account. Must match an existing Service Provider.

service provider name

A unique string that is the name of the Service Provider who uses this account. Must match an existing Service Provider.

Rates¶

The CSV files to be imported for rates should have the following format:

Rate Plans¶

The CSV files to be imported for rate plans should have the following format:

Calling Services¶

The CSV files to be imported for calling services should have the following format:

Product Offerings¶

The CSV files to be imported for product offerings should have the following format:

Import a CSV file¶

Import Using the Web UI

Whether the database operation to import records from a file is available depends on which page is currently displayed.

1. Click Import on the task bar.

2. Click Choose File to browse for a CSV file to import.

3. Click Start Import.

The file is uploaded and the import begins and runs in the background.

The status of an import can be found on the My Account page under Job Logs.

Import Using the API

To import data with the API, the user sends a POST command to the specific object.

The example below shows a Service Provider importing a Subscriber.

curl -X POST \
 -H "Content-Type:cc/json" localhost/cc/api/job/service_provider:cc_service_provider?executable=restworkx-cc \
 -H "Authorization:Basic <secure-access-token>" \
 -d '{"job_type":"import","in_file":"/var/opt/xpressworkx/app-manager/cc/media/upload/subscriber-import.csv","object":"subscriber","service_provider_name":"cc_service_provider"}'

Which would return a message such as:

"meta": {
        "executable": "restworkx-cc",
        "code": 200,
        "encoding": "ascii",
        "scope": "success",
        "records_shown": 1,
        "message": "",
        "authorization": "Basic <secure-access-token>"
},
"data": [{
        "scope": "job",
        "meta": {
                "modified_by": "system",
                "txnid": null,
                "modified": "2022-04-07 11:39:44.724128",
                "created_by": "system",
                "created": "2022-04-07 11:39:44.724102"
        },
        "links": {
                "self": {
                        "scope": "job",
                        "identifier": {
                                "job_id": 104,
                                "out_file": "/var/opt/xpressworkx/app-manager/cc/media/download/subscriber-import-2022-04-07-23770cb05d.csv"
                        },
                        "uri": "/job"
                },
        },
        "attributes": {
                "status": "processing",
                "out_file": "/var/opt/xpressworkx/app-manager/cc/media/download/subscriber-import-2022-04-07-23770cb05d.csv",
                "pid": null,
                "object": "subscriber",
                "job_type": "import",
                "job_id": 104,
                "elapsed": "0",
                "in_file": "/var/opt/xpressworkx/app-manager/cc/media/upload/subscriber-import.csv",
                "kwargs": null,
                "progress": null,
                "role_id": "service_provider:cc_service_provider",
                "output_hash": null
        },
}],
"jsonapi": {
        "version": "2.2-17",
        "name": "Calling Card",
        "short_name": "cc",
        "author": "IMSWorkX, Inc."
}

Export a CSV file¶

Export Using the Web UI

Whether the database operation to export records to a file is available depends on which page is currently displayed.

1. Click Export on the task bar.

2. Click Start Export.

The output CSV file can be found on the My Account page under Job Logs.

Export Using the API

To export data with the API, the user sends a POST command to the specific object.

The example below shows a Platform Owner exporting Service Providers.

curl -X POST \
 -H "Content-Type:cc/json" localhost/cc/api/job/platform_owner?executable=restworkx-cc \
 -H "Authorization:Basic <secure-access-token>" \
 -d '{"job_type": "export","object": "service_provider"}'

Which would return a message such as:

"meta": {
        "executable": "restworkx-cc",
        "code": 200,
        "encoding": "ascii",
        "scope": "success",
        "records_shown": 1,
        "message": "",
        "authorization": "Basic <secure-access-token>"
},
"data": [{
        "scope": "job",
        "meta": {
                "modified_by": "system",
                "txnid": null,
                "modified": "2022-04-07 13:50:20.834266",
                "created_by": "system",
                "created": "2022-04-07 13:50:20.834246"
        },
        "links": {
                "self": {
                        "scope": "job",
                        "identifier": {
                                "job_id": 109,
                                "out_file": "/var/opt/xpressworkx/app-manager/cc/media/download/service_provider-export-2022-04-07-e996a4f9dc.csv"
                        },
                        "uri": "/job"
                },
        },
        "attributes": {
                "status": "processing",
                "out_file": "/var/opt/xpressworkx/app-manager/cc/media/download/service_provider-export-2022-04-07-e996a4f9dc.csv",
                "pid": null,
                "object": "service_provider",
                "job_type": "export",
                "job_id": 109,
                "elapsed": "0",
                "in_file": null,
                "kwargs": null,
                "progress": null,
                "role_id": "platform_owner",
                "output_hash": null
        },
}],
"jsonapi": {
        "version": "2.2-17",
        "name": "Calling Card",
        "short_name": "cc",
        "author": "IMSWorkX, Inc."
}

Archiving¶

Data that is not currently in use by the CC application can be removed from the live database by archiving the data. Provisioned data can be archived in the web UI or through the API.

Archive a Single Object Using the Web UI

1. Navigate to the object that you want to archive.

2. Right-click on the object to be archived.

3. Click Archive.

The object will be moved to the archive database.

Archive Multiple Objects Using the Web UI

1. Navigate to the objects that you want to archive.

2. Select the objects by clicking on the first object then:

   • Hold the Shift key and click another object to select everything between and including the two selected objects.

   • Hold the Ctrl key and click the other objects you want.

3. Click Archive Selected on the bottom of the page.

The objects will be moved to the archive database.

Archive Using the API

To archive an object with the API, the user sends a DELETE command to the specific object.

The example below shows a user archiving a Subscriber object called new_subscriber.

curl -X DELETE \
 -H "Authorization:Basic <secure-access-token>" \
 -d 'localhost/cc/api/subscriber/service_test/new_subscriber'

Which would return a message such as:

"meta": {
        "encoding": "ascii",
        "records_shown": 0,
        "message": "Record successfully archived or restored.",
        "code": "205",
        "scope": "success"
},
"data": [],
"jsonapi": {
        "version": "2.2-17",
        "name": "Calling Card",
        "short_name": "cc",
        "author": "IMSWorkX, Inc."
}

Restoring¶

Restoring data will move data from the archive database to the live database. Restoring data can be done through the web UI or the API.

Restore a Single Object Using the Web UI

1. Switch to the archive view by toggling Live / Archive Database in the task bar.

2. Navigate to the object that you want to restore.

3. Right-click on the object to be restored.

4. Click Restore.

The object will be moved to the live database.

Restore Multiple Objects Using the Web UI

1. Switch to the archive view by toggling Live / Archive Database in the task bar.

2. Navigate to the objects that you want to restore.

3. Select the objects by clicking on the first object then:

   • Hold the Shift key and click another object to select everything between and including the two selected objects.

   • Hold the Ctrl key and click the other objects you want.

4. Click Restore Selected on the bottom of the page.

The objects will be moved to the live database.

Restore Using the API

To restore an object with the API, the user sends a DELETE command to the specific object.

The example below shows a user restoring a Subscriber object called new_subscriber.

curl -X DELETE \
         -H "Authorization:Basic <secure-access-token>" \
         -d 'localhost/cc/api/subscriber/service_test/new_subscriber?archive=true&restore=true'

Which would return a message such as:

"meta": {
        "encoding": "ascii",
        "records_shown": 0,
        "message": "Record successfully archived or restored.",
        "code": "205",
        "scope": "success"
},
"data": [],
"jsonapi": {
        "version": "2.2-14",
        "name": "Calling Card",
        "short_name": "cc",
        "author": "IMSWorkX, Inc."
}

Purging¶

Purging data permanently removes the data from the archived database. Purging data can be done through the API, web UI, or the Maximum Inactive Days for Records setting in the web UI.

Purge a Single Object Using the Web UI

1. Switch to the archive view by toggling Live / Archive Database in the task bar.

2. Navigate to the object that you want to purge.

3. Right-click on the object to be purged.

4. Click Purge.

The object will be permanently removed from the database.

Purge Multiple Objects Using the Web UI

1. Switch to the archive view by toggling Live / Archive Database in the task bar.

2. Navigate to the objects that you want to purge.

3. Select the objects by clicking on the first object then:

   • Hold the Shift key and click another object to select everything between and including the two selected objects.

   • Hold the Ctrl key and click the other objects you want.

4. Click Purge Selected on the bottom of the page.

The objects will be permanently removed from the database.

Purge Using the Maximum Inactive Days Setting

CC will remove records that have been archived longer than the value specified by this setting every night at midnight, which is determined by the time on the active NIU. A value of zero will always keep archived records in the database.

This setting can be found in the Settings page when the user is logged in as a Platform Owner.

Purge Using the API

To purge an object with the API, the user sends a DELETE command to the specific object.

The example below shows a user purging a Subscriber object called new_subscriber.

curl -X DELETE \
 -H "Authorization:Basic <secure-access-token>" \
 -d 'localhost/cc/api/subscriber/service_test/new_subscriber?archive=true'

Which would return a message such as:

"meta": {
        "encoding": "ascii",
        "records_shown": 0,
        "message": "Record successfully archived or restored.",
        "code": "205",
        "scope": "success"
},
"data": [],
"jsonapi": {
        "version": "2.2-14",
        "name": "Calling Card",
        "short_name": "cc",
        "author": "IMSWorkX, Inc."
}