This chapter provides a description of the database schema and instructions for provisioning the PCS databases through both the web UI and the API.
Information that is stored in the database can be divided into the following tables: Administrator, Service Provider, Subscriber, and Number.
The CSV files to be imported for any administrator account should have the following format:
Column |
Value |
|---|---|
1 |
Username |
2 |
Role ID |
3 |
First Name |
4 |
Last Name |
5 |
|
6 |
Permissions |
A unique string that is the user name for this user. Limit 64 characters.
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>
subscriber:<service_provider_name>:<subscriber_name>
A string that is the first name of this user. Limit 250 characters.
A string that is the last name of this user. Limit 250 characters.
A string that is the email address for this user. Limit 250 characters.
An array of permission groups that this user is a member of. Permissions are dependent on the {role_id} of the created administrator.
add_permission_group_entries
alter_permission_group
alter_platform_owner_user
alter_service_provider_user
alter_subscriber_user
create_permission_group
default:platform_owner
default:service_provider
list_permission_group_entries
list_permission_groups
pcs_default:pcs_application_provisioning
pcs_default:pcs_platform_owner_administration
pcs_default:pcs_platform_owner_platform_administration
pcs_default:pcs_platform_owner_provisioning
pcs_default:pcs_platform_owner_user_administration
pcs_default:pcs_platform_owner_views
pcs_default:pcs_service_provider_platform_administration
pcs_default:pcs_service_provider_provisioning
pcs_default:pcs_service_provider_user_administration
pcs_default:pcs_service_provider_views
pcs_default:pcs_subscriber_administration
pcs_default:pcs_subscriber_platform_administration
pcs_default:pcs_subscriber_provisioning
pcs_default:pcs_subscriber_user_administration
pcs_default:pcs_subscriber_views
pcs_view_screening_rule
remove_permission_group
remove_permission_group_entries
screening_engine_view_screening_treatment
view_permission_group
view_service_provider
view_subscriber
view_subscriber_user
default:subscriber
The CSV files to be imported for Service Providers should have the following format:
Column |
Value |
|---|---|
1 |
Name |
2 |
Display Name |
3 |
First Name |
4 |
Last Name |
5 |
|
6 |
Address |
7 |
Phone |
8 |
Whitelist |
9 |
Blacklist |
10 |
Notes |
A unique string that is the name of this Service Provider. Limit 64 characters.
An unconstrained string used as a display name. Limit 250 characters.
A string that is the first name of a contact for this Service Provider. Limit 250 characters.
A string that is the last name of a contact for this Service Provider. Limit 250 characters.
A string that is the email address of this Service Provider. Limit 250 characters.
A string that is the physical address of this Service Provider. Limit 250 characters.
A string that is the phone number of this Service Provider. Limit 250 characters.
An array of strings of telephone digits that are always allowed. This is a global list that is applied to all of this Service Provider’s Subscribers.
An array of strings of telephone digits that are always blocked. This is a global list that is applied to all of this Service Provider’s Subscribers.
A string that is a free-form notes field. Limit 2048 characters.
The CSV files to be imported for Subscribers should have the following format:
Column |
Value |
|---|---|
1 |
Name |
2 |
Display Name |
3 |
Service Provider Name |
4 |
First Name |
5 |
Last Name |
6 |
|
7 |
Address |
8 |
Phone |
9 |
Notes |
10 |
Service Enabled |
11 |
Voicemail (location) |
12 |
Whitelist |
13 |
Blacklist |
14 |
Override |
A unique string that is the name of this Subscriber. Limit 64 characters.
An unconstrained string used as a display name. Limit 250 characters.
A unique string that is the name of this Subscriber’s Service Provider. Must match an existing Service Provider.
A string that is the first name of a contact for this Subscriber. Limit 250 characters.
A string that is the last name of a contact for this Subscriber. Limit 250 characters.
A string that is the email address of this Service Provider. Limit 250 characters.
A string that is the physical address of this Service Provider. Limit 250 characters.
A string that is the phone number of this Subscriber. Limit 250 characters.
A string that is a free-form notes field. Limit 2048 characters.
A string that is the location of the Subscriber’s voice mail service.
A boolean that shows the state of this user’s PCS service. The value “true” means the service is on, and the value “false” means the service is off. The default value is “true”.
A json containing the screening rules that have been disabled by this Subscriber. The format of this json is as follows:
{
"stir_shaken": "false",
"whitelist": "false",
"blacklist": "false",
"call_guardian": "false",
"captcha": "false",
"recorded_greeting": "false"
}
Note
Each screening rule override is a boolean where “true” means the service is disabled and “false” means the service is enabled.
The CSV files to be imported for numbers should have the following format:
Column |
Value |
|---|---|
1 |
Service Provider Name |
2 |
Subscriber Name |
3 |
Number |
4 |
Nickname |
5 |
Whitelist |
6 |
Blacklist |
A unique string that is the name of the Service Provider for the Subscriber who uses this number. Must match an existing Service Provider.
A unique string that is the name of the Subscriber who uses this number. Must match an existing Subscriber.
A unique string that is this number. This should be a valid phone number. Limit 250 characters.
A string that is an optional name for this number. Limit 250 characters.
An array of strings of telephone digits that are always allowed.
An array of strings of telephone digits that are always blocked.
A CSV file can be used to import large amounts of information into a database. Importing data appends the new information to the existing database, and any conflicting records are not overwritten. Each table has at least one unique column that is used to determine if there are conflicting records. Any database entries that are not in the CSV file remain unchanged in the database after the file has been imported.
Note
All columns must be included. If the field is blank, make sure that the column is still included in the CSV file.
Note
When importing CSV files into PCS, do not log off until the import is complete. Logging off before the import is complete will cause the entire import of data to fail.
Import Using the Web UI
Whether the database operation to import records from a file is available depends on which page is currently displayed.
Click Import on the task bar.
Click Choose File to browse for a CSV file to import.
Click Start Import.
The file is uploaded and the import begins and runs in the background.
Note
Click Cancel at any time to close the window and stop the import.
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:pcs/json" localhost/pcs/api/job/service_provider:pcs_service_provider?executable=restworkx-pcs \
-H "Authorization:Basic <secure-access-token>" \
-d '{"job_type":"import","in_file":"/var/opt/xpressworkx/app-manager/pcs/media/upload/subscriber-import.csv","object":"subscriber","service_provider_name":"pcs_service_provider"}'
Which would return a message such as:
"meta": {
"executable": "restworkx-pcs",
"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/pcs/media/download/subscriber-import-2022-04-07-23770cb05d.csv"
},
"uri": "/job"
},
},
"attributes": {
"status": "processing",
"out_file": "/var/opt/xpressworkx/app-manager/pcs/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/pcs/media/upload/subscriber-import.csv",
"kwargs": null,
"progress": null,
"role_id": "service_provider:pcs_service_provider",
"output_hash": null
},
}],
"jsonapi": {
"version": "1.2-2",
"name": "Personalized Call Screening",
"short_name": "pcs",
"author": "IMSWorkX, Inc."
}
Note
The parameter executable=restworkx-pcs is required to import an object.
Information can be exported from the database, saved, and then imported to restore a database.
Export Using the Web UI
Whether the database operation to export records to a file is available depends on which page is currently displayed.
Click Export on the task bar.
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:pcs/json" localhost/pcs/api/job/platform_owner?executable=restworkx-pcs \
-H "Authorization:Basic <secure-access-token>" \
-d '{"job_type": "export","object": "service_provider"}'
Which would return a message such as:
"meta": {
"executable": "restworkx-pcs",
"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/pcs/media/download/service_provider-export-2022-04-07-e996a4f9dc.csv"
},
"uri": "/job"
},
},
"attributes": {
"status": "processing",
"out_file": "/var/opt/xpressworkx/app-manager/pcs/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": "1.2-2",
"name": "Personalized Call Screening",
"short_name": "pcs",
"author": "IMSWorkX, Inc."
}
Note
The parameter executable=restworkx-pcs is required to export an object.
The CSV files to be exported for Call Detail Records (CDRs) will have the following format:
Column |
Value |
|---|---|
1 |
Service Provider Name |
2 |
Subscriber Name |
3 |
CDR ID |
4 |
Start Time |
5 |
End Time |
6 |
Additional Data |
7 |
Events |
A unique string that is the name of the Service Provider for this Subscriber using this service. Must match an existing Service Provider.
A unique string that is the name of the Subscriber using this service. Must match an existing Subscriber.
A unique string that is the identifier of this specific CDR.
The date and time this specific call started.
The date and time this specific call ended.
A string that is not populated in this version of PCS. Currently, events generate an Additional Data field, which is the returned response from screening this specific call.
A string that is all of the events for this specific call.
PCS does not have an explicit delete function for any of its data. Instead, PCS has the ability to archive data that is not in use.
Archived data remains in the PCS application, but this data is not used when screening calls. Archived data can then be returned to the live data by restoring or can be removed completely by purging. When viewing data through the web UI or with an API request, the user can switch between the live and archive database to see all data.
Note
By default, PCS permanently purges archived data after seven days. This can be changed by a Platform Owner in Settings.
Data that is not currently in use by the PCS 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
Navigate to the object that you want to archive.
Right-click on the object to be archived.
Click Archive.
The object will be moved to the archive database.
Archive Multiple Objects Using the Web UI
Navigate to the objects that you want to archive.
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.
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/pcs/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": "1.2-2",
"name": "Personalized Call Screening",
"short_name": "pcs",
"author": "IMSWorkX, Inc."
}
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
Switch to the archive view by toggling Live / Archive Database in the task bar.
Navigate to the object that you want to restore.
Right-click on the object to be restored.
Click Restore.
The object will be moved to the live database.
Restore Multiple Objects Using the Web UI
Switch to the archive view by toggling Live / Archive Database in the task bar.
Navigate to the objects that you want to restore.
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.
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/pcs/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": "1.2-2",
"name": "Personalized Call Screening",
"short_name": "pcs",
"author": "IMSWorkX, Inc."
}
Note
The parameters archive=true&restore=true are required to restore an object.
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.
Warning
Once data has been purged from the database, it cannot be restored.
Purge a Single Object Using the Web UI
Switch to the archive view by toggling Live / Archive Database in the task bar.
Navigate to the object that you want to purge.
Right-click on the object to be purged.
Click Purge.
The object will be permanently removed from the database.
Purge Multiple Objects Using the Web UI
Switch to the archive view by toggling Live / Archive Database in the task bar.
Navigate to the objects that you want to purge.
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.
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
PCS 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 on 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/pcs/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": "1.2-2",
"name": "Personalized Call Screening",
"short_name": "pcs",
"author": "IMSWorkX, Inc."
}
Note
The parameter archive=true is required to purge an object.