PBX Archiving Storage is a feature that can be used to move local files to a remote location (service provided by the user). It can either keep these files on both locations (your PBX server and remote location) or set the files to be removed after a successful offload. The feature can be configured to run automatically at certain times (daily, weekly) or in specified hour intervals.
NOTE: On the configured service files are stored in folders with the following structure:
'/resource/year/month/day/hour/filename'
Where:
- resource: Type of the resource offloaded (E.g. recordings)
- year: Year in which the resource was created in. (E.g. 2019)
- month: Month in which the resource was created, in numeric forme. (E.g. 11 for resources created in November)
- day: Day of the month in which the resource was created in. (E.g. 23)
- hour: Hour of the day in which the resource was created in. (E.g. 11)
- filename: Resource specific file name format, describe below.
Client
In this section the service is configured that will be used as the destination for offloaded files.
- Enable:
Choose to turn Archiving Storage either on or off.
- Client Type:
Select the client to be used. Depending on the selected client there will be different client required fields enabled.
- Test:
Successful test
Pressing this button will run a test for the specified client and display a pop-up showing the result of the test. In case the provided options are valid 'Test finished successfully.' will be displayed in the pop-up.
Amazon S3
- Access Key:
Acquired from amazon account.
- Access Secret:
Acquired from amazon account.
- Bucket:
S3 bucket to be used.
Dropbox
- Code:
Code acquired from the Dropbox authentication window.
- Token:
Automatically generated token.
- Set up:
To set up the Dropbox service the following steps need to be taken:
- Press the Get Code
- In the pop-up windows that appears login to your Dropbox account.
- Press the Allow
- Coppy the code displayed.
- Insert the copied code into the code field.
- Press the Generate Token
NOTE: Dropbox has limitations for standard and advanced accounts (25,000 API calls/month for data transport partners).
More info: https://www.dropbox.com/plans?trigger=nr
FTP
- Server:
Server address/IP.
- User:
Username to be used for registration.
- Password:
Password to be used for registration.
NOTE: For FTP servers with allowed anonymous users only the Server field is required.
Google Drive
- Folder Name:
Folder name on your google drive in which to store the offloaded files. It does not need to exist and will be created by Archiving Storage.
- Code:
Code acquired from Google drive authentication window.
- Token:
Displays if a token exists on the system.
- Set up:
To set up the Dropbox service the following steps need to be taken:
- Press the Get Code
- In the pop-up window that appears log in with your Google account.
- Press the Allow
- Copy the code displayed.
- Insert the copied code into the code field.
- Press the Generate Token
NOTE: Please note that if both folder names (in the Client section and the Files section) Archiving Storage will fail to offload files. In order to avoid this use diferent names for each section.
Files
In this section you can fonfigure which files form the system will be offloaded as well as configure how the files will be displayed on the service used.
- Resources:
List of resources which should be uploaded. Each resource has a specific format for naming files. Available options and their filename formats are:
- Fax: 'date-time-src-ext-uniqueid.format'
- CLIR Reports: 'uniqueid.log.gz'
- Recordings: 'date-time-src-dst-uniqueid.format'
- Voicemail: 'date-time-src-dst-uniqueid.format'
NOTE: In order to enable offload for CLIR Reports the Recordings resource has to be selected as well.
NOTE: Most resources can offload multiple files for the same resource instance. They will have the same name but diferent file extensions. (E.g. voicemails will cause 2 files to be offloaded: one audio file and one txt file)
- Folder Name:
Sets up a subfolder inside the configured services starting folder where all the data for the system will be stored into. This allows users to use the same service credentials on multiple systems while keeping the files separate for each system.
(E.g. If you are using the Google Drive Client with Folder Name inside the Client section set to ArchivingStorage and have Folder Name inside the Files section set to MySystem: all files offloaded for this system will be stored on Google Drive in the ArchivingStorage/MySystem folder)
- Filename Date Format:
Date Format used for the date part of the above describe resource file names.
- Filename Time Format:
Time Format used for the time part of the above describe resource file names.
- Upload Older Than:
How old at least a file has to be for Archiving Storage to offload it.
NOTE: This is checked at the configured Archiving Storage execution time, see Scheduling section. As a side effect of this, there will be files older than this configured time on the system. (E.g. if 2 weeks is set and Archiving Storage is configured to wun weekly there can be up to 3 weeks old files for the configured resources on the system.)
- Convert to MP3:
Convert files to MP3 before upload.
NOTE: This option only applies for the Recordings resource.
Network
In this section, you can configure the amount of system and network resource Archivcing storage will use.
- Max Simultaneous Uploads:
Maximum number of concurrent uploads. The default is 5. May get lower during execution due to client limitations (E.g. FTP server has max connections per user configured)
- Max Retries:
How many times to retry on failed upload in case of a noncritical error. The default is 10.
E-mail Notifications
In this section you can configure e-mail notifications which can be sent after Archiving Storage has finished offload data.
- Enable:
Enable/disable e-mail notifications.
- Send on Error Only:
Only generate e-mail ff execution status if failed or partial.
- E-mail:
Notifications email recipient.
System
Remove Files: If enabled after successful offload the file will be removed from the system.
Remote recording playback
Recordings offloaded to some services with Archiving Storage can be listened to and downloaded from the reports page. This feature is supported for the following services:
- Amazon S3
- FTP
- Google Drive
NOTE: Listen and download must be enabled in the license.
Sound Files
This section administers all sound files used by PBX.
Filter
Sound Files Search Filter
- Directory
Select the directory from the drop-down list to display files located only in that specific system directory.
The directory is sorted alphabetically.
- Search
A search bar to find sound files using a provided search string. The default search string is "A" and the field cannot be empty. It will search all files with name starting with the search string. It is case insensitive.
Type
List of all types for that file that can be shown by hovering the mouse over the 3 dots icon. Please refer to the screenshot provided.
Options
Sound Files options
On the top of the page, the following options are available to be performed on Sound Files.
- Convert:
Convert the selected file to the desired codec.
After selecting a sound file(s) and clicking ‘Convert’, users can choose a codec to which they want to convert file from the drop-down list. The chosen sound file will then be converted.
NOTE: It is possible to convert more than one file at the same time.
- Rename:
Renames the selected sound file (characters a-zA-Z0-9-_ are allowed).
Select a box next to a sound file, and then click on the sound file name and make desired changes. After changing, click on the ‘Rename’ command button and changes will be made.
NOTE: It is possible to rename more than one file at the same time.
- Delete:
Deletes the selected sound file [(this action will delete all types for the selected file(s)].
Select a box next to a sound file(s) and click the ‘Delete’ command button.
NOTE: It is possible to delete more than one file at the same time.
- Download:
Downloads the selected sound file to the user's computer (a drop-down menu is offered and only the available types for that file will be in the drop-down. If "All" is chosen, a ZIP file will be then downloaded containing all available types for that file.)
Select a box next to a sound file(s) and click the ‘Download’ command button. The user can choose whether to download some of the available audio formats or all of them.
(Command button)
- Upload
Sound Files Auto-Conversion Progress
Uploads the selected sound file from the user's desktop.
Click the 'Upload' button and choose a sound file from your desktop to upload it on the system.
NOTE: If you are uploading an .mp3 or a .wav file, these will be auto-converted to other native formats. Other file formats apart from mp3 and wav will just be uploaded without automatic conversion.
A progress bar will be shown when uploading a file.
(Command button)
- Listen
This option allows listening to a sound file. Select a box next to a sound file and click ‘Listen’ to hear it.
TIP
PBX will only play sound file types equal to enabled codecs on the dialing Extension.
For example, Extension 1000 has only the gsm codec enabled. When the same Extension logs in as a Queue Agent by dialing '*202 + $AGENT_NUMBER', all sounds played by PBX (asking for password etc...) will be in the '.gsm' format.
If multiple codecs are enabled for Extension 1000 (ulaw,alaw,gsm), PBX will play the sound files with the better sound quality (ulaw/alaw).
Music on Hold
Music on Hold is music or advertisements played to callers while they are, for example, waiting for an agent or when put on hold.
Content
MOH content window administers all PBX MOH sound files. They are listed here with the following details
- Name:
MOH sound file name.
(E.g. Motorbreath)
- Class:
MOH class sound file belongs to.
(E.g. Default)
- Status:
MOH sound file status. Possible choices are ‘On’ and ‘Off’.
- Edits the MOH file configuration.
- Deletes a MOH file from the system.
Search
- Search:
Possible choices are ‘On’ and ‘Off’.
(E.g. Provide a search phrase here and hit enter to filter the records)
Add/Edit Records
- Clip name:
Audio file name.
(E.g. Für Elise)
- File:
Displays the full path to the music file on local computer. Click 'Upload file' button to select a file.
(E.g. D:\Music\Ludwig van Beethoven\Ludwig van Beethoven - Für Elise.mp3)
- Class:
Select the MOH class the sound file belongs to.
(E.g. default)
- Status:
Set the status of the uploaded file(active/inactive)
(E.g. On/Off)
Classes
MOH classes are something like folders on a computer filled with music files. Once a MOH class is assigned to the queue, for example, all sound files that belong to that class are played back in random order. MOH classes are listed here with the following details
- Name:
MOH class name
(E.g. default)
- Status:
MOH class system status. When disabled, sound files that belong to the class will not be played anywhere on the system
- Edits the the MOH file configuration
- Deletes a MOH file from the system
NOTE: 'default’ MOH Class cannot be deleted. Also, classes who contain recordings cannot be deleted. If deleting classes is needed, users should first move recordings to other classes.
Search
- Search:
Enter a search phrase here to easy finding of MOH Class. Searching can be done by a Class name.
Add/Edit MOH Classes
- Class Name:
Enter the MOH class name.
(E.g. IVR greetings)
- Stream URL:
In latest version of PBX we implemented support for easy MoH streaming. All you have to do is to create new MoH class and enter the link to your stream in Stream URL field.
- Status:
Set the class status
(E.g. On/Off)
- Sort files:
Whether the files assigned to this class be played alphabetically or randomly.