help_documentation
Σύνολο εγγραφών στον πίνακα: 1581
| help_id | help_title | help_text |
|---|---|---|
| screen_colors-frame_background | Frame Background | <QXZ>This is where you set the hex color value for the frame main background. It must be a light color since black text will be displayed on top of it. Default is D9E6FE.</QXZ> |
| screen_colors-std_row_background | Standard Row Backgrounds | <QXZ>This is where you set the hex color values for the several standard row backgrounds. They should be lighter colors since black text will be displayed on top of them. These are often used to make different sections stand apart or as alternating colors for rows. Defaults are 9BB9FB, B9CBFD, 8EBCFD, B6D3FC, A3C3D6. The Standard Row 5 Background is used in the Agent screen for the background color behind the logo after the agent has logged in.</QXZ> |
| screen_colors-alt_row_background | Alternate Row Backgrounds | <QXZ>This is where you set the hex color values for the several alternate row backgrounds. They should be lighter colors since black text will be displayed on top of them. These are used to differentiate sections from the Standard backgrounds defined above. Defaults are BDFFBD, 99FF99, CCFFCC.</QXZ> |
| screen_colors-web_logo | Web Logo | <QXZ>This is where you can select a custom image file for your logo. The standard size for a logo image is 170 pixels wide and 45 pixels high. We suggest using the PNG format, but GIF and JPG will work as well. To have a custom logo image show up in this list, it needs to be uploaded to your webserver in the images directory, and the filename needs to begin with vicidial_admin_web_logo. For example, if you upload the image file vicidial_admin_web_logoSAMPLE.png, it will show up in the select list as SAMPLE.png. Default is default_new for the new PNG logo image file.</QXZ> |
| screen_colors-active | Active | <QXZ>Set whether the screen color set is active or not.</QXZ> |
| settings_containers | Settings Containers allow for an easy way to add, modify and delete large configurations of settings, or for elements like email templates to be used by PHP and Perl scripts within the codebase. | <B><QXZ>Settings Containers allow for an easy way to add, modify and delete large configurations of settings, or for elements like email templates to be used by PHP and Perl scripts within the codebase.</QXZ></B> |
| settings_containers-container_id | Container ID | <QXZ>This field needs to be at least 2 characters in length and no more than 40 characters in length, no spaces or special characters. This is the ID that will be used to identify the Settings Container throughout the system.</QXZ> |
| settings_containers-container_notes | Container Notes | <QXZ>This is the descriptive name of the Settings Container entry.</QXZ> |
| settings_containers-container_type | Container Type | <QXZ>This is the type of Container entry. This is used primarily for categorization and to show only certain containers in certain places. There is also a special container type -READ_ONLY- that is used and updated by external processes that cannot have the container entry modified within the admin screens. Default is OTHER.</QXZ> |
| settings_containers-user_group | Admin User Group | <QXZ>This is the administrative user group for this record, this allows admin viewing of this record restricted by user group. Default is --ALL-- which allows any admin user to view this record.</QXZ> |
| settings_containers-container_entry | Container Entry | <QXZ>This is where you put the contents of the settings that you want in this container.</QXZ> |
| auto_reports | Automated Reports allow for a simplified way of configuring reports to be run on a scheduled and recurring basis, and to have the results sent by email or uploaded to an FTP server. | <B><QXZ>Automated Reports allow for a simplified way of configuring reports to be run on a scheduled and recurring basis, and to have the results sent by email or uploaded to an FTP server.</QXZ></B> |
| auto_reports-report_id | Report ID | <QXZ>This field needs to be at least 2 characters in length and no more than 30 characters in length, no spaces or special characters. This is the ID that will be used to identify the Automated Report throughout the system.</QXZ> |
| auto_reports-report_name | Report Name | <QXZ>This is the descriptive name of the Automated Report entry.</QXZ> |
| auto_reports-user_group | Admin User Group | <QXZ>This is the administrative user group for this record, this allows admin viewing of this record restricted by user group. Default is --ALL-- which allows any admin user with Modify Automated Reports permissions to view this record.</QXZ> |
| auto_reports-report_last_run | Last Run Time | <QXZ>This is the date and time of the last run of this automated report process. Also included is the number of seconds it took for this process to run the last time.</QXZ> |
| auto_reports-report_server | Report Server | <QXZ>This is the machine that you want to use to run this automated report. You must choose a server that runs the keepalive process every minute in the crontab. The default is to use the active voicemail server as defined in System Settings.</QXZ> |
| auto_reports-report_times | Report Times | <QXZ>This is the list of times in HHMM format when you want the automated report to run. You can specify multiple times by separating them with a dash, like how the List Reset Times feature works.</QXZ> |
| auto_reports-report_weekdays | Report Weekdays | <QXZ>This is the list of days of the week when you want the automated report to run. Either this option or the Month Days field below must be set for the report to run automatically.</QXZ> |
| auto_reports-report_monthdays | Report Month Days | <QXZ>This is the list of days of the month in DD format when you want the automated report to run. You can specify multiple month days by separating them with a dash. Either this option or the Weekdays field above must be set for the report to run automatically.</QXZ> |
| auto_reports-report_destination | Report Destination | <QXZ>This option will determine how you want the automated report to be delivered, by EMAIL or FTP. Depending on the destination you choose, you must fill in the configuration fields below for it to work properly. Default is EMAIL.</QXZ> |
| auto_reports-email_from | Email From | <QXZ>If the EMAIL destination is chosen above, then this field must be filled in with the email address that you want the automated report email to come from. Note: some email servers may require certain registered email address to be used for delivery to be accepted by them. You may also have to set up a reverse domain name lookup with your network provider for the server you have chosen to send emails from.</QXZ> |
| auto_reports-email_to | Email To | <QXZ>If the EMAIL destination is chosen above, then this field must be filled in with the email address that you want to receive the automated report email. You can define more than one email address by separating them with a colon.</QXZ> |
| auto_reports-email_subject | Email Subject | <QXZ>If the EMAIL destination is chosen above, then this field must be filled in with the subject of the email. As an option, you can use the --A--date--B-- or --A--datetime--B-- flag in this field to populate the current date or date-time.</QXZ> |
| auto_reports-ftp_server | FTP Server | <QXZ>If the FTP destination is chosen above, then this field must be filled in with the FTP server address. If you would like to use an SFTP or FTP over SSL server, then you will need to have your administrator confirm that your system has the proper modules installed to connect to them. If you want to connect to an SFTP server, you will need to create a Settings Container with the connection options for it, and put that Container ID in this field with SFTPCNTR before it, so if you have an SFTP Settings Container with an ID of test_send, then you would put SFTPCNTRtest_send in this field. For FTP over SSL you would follow very similar instructions except you need to use FTPSCNTR as your prefix. A basic settings container entry for an SFTP server might look like this</QXZ>-<BR>--ftp-server=192.168.1.3<BR>--ftp-login=reports<BR>--ftp-pass=reportpass<BR>--ftp-port=22<BR>--ftp-dir=/home/reports<BR><QXZ>For an FTP over SSL server you may also need to define Explicit or Implicit encryption</QXZ>-<BR>--ftp-encrypt=E |
| auto_reports-ftp_user | FTP User | <QXZ>If the FTP destination is chosen above, then this field must be filled in with the FTP login user.</QXZ> |
| auto_reports-ftp_pass | FTP Pass | <QXZ>If the FTP destination is chosen above, then this field must be filled in with the FTP login password.</QXZ> |
| auto_reports-ftp_directory | FTP Directory | <QXZ>If the FTP destination is chosen above, then this field can be filled in with the FTP folder directory that you want the automated reports to be uploaded into. Note: the folder must already exist, this process will not try to create the folder.</QXZ> |
| auto_reports-filename_override | Filename Override | <QXZ>By default, the reports will be saved as files and either emailed or sent by FTP to the selected destination, and the filenames used for those files are automatically generated with unique generic names based upon the report ID. If you would like to override those unique generic names, you can do so by using this field. You can also use the variables shown below in the Report URL field so that you can put dates into the filename. You can also use --A--filedatetime--B-- as a variable to note the date and time the report was generated, which is useful if you will be running a report more than once a day. Only letters, numbers dashes and underscore characters are allowed in this field. Also, you should not include a file extension as part of the filename override, since the type of report will dictate the file extension that is used. Default is empty for disabled.</QXZ> |
| auto_reports-active | Active | <QXZ>The automated report will only run on the set schedule above if active is set to Y. Default is N.</QXZ> |
| auto_reports-run_now_trigger | Run Now Trigger | <QXZ>This option offers a way to test this automated report process before setting it to active. It can take up to one minute for the process to start running after submitting this page with this field set to Y. Default is N.</QXZ> |
| auto_reports-report_url | Report URL | <QXZ>This is the field where you will put the full web address, or URL, for the report that you want to run. The easiest way to figure out what address to use is to run the report normally, then go to the Reports, Admin Utilities, Admin Report Log Viewer to see the full URL that was used to run that report. Once you have copied that URL, you can replace the dates that you see with one of these variables in the standard format that is used within this system, for example, --A--today--B--. You can use: today, yesterday, 6days, 7days, 8days, 13days, 14days, 15days, 30days. Note: some networks may require that you use a local server address in this URL if that is the only way that a server on your network can access the webserver used for reporting. Related to this, you may also have to use a local IP address if a full domain name is not accessible from within your system network. Also, it is recommended that you run reports in TEXT format for best display results.</QXZ> |
| ip_lists | IP Lists | <QXZ>The purpose of this feature is to allow an administrator the ability to restrict who can use the system web resources on an IP Address basis. This is designed to allow you to create IP Lists and then assign those IP Lists on a per-User-Group basis separated as Admin, Agent and API permissions. For example, you can set the IP List for Agent web access to DISABLED to allow anyone in the User Group to log in as an agent from any location, this is the default behavior. You can then set an IP List with one IP Address in it so within that same User Group, managers will only be able to log in to the admin web screens from that one location. You can also set an IP List with no entries in it for the API access IP List to not allow any user in that User Group to use the APIs.</QXZ><BR><BR><QXZ>This IP whitelisting authentication is designed to happen after user authentication in order to allow a specific user to be set to ignore the IP List blocking feature, as well as to be able to have the IP List feature work on a per-User-Group basis.</QXZ><BR><BR><QXZ>There is also a System-wide Blacklist option that allows you to specify an IP List to use to block all web service access to all users coming from the IP Addresses listed in the system settings blacklist IP List.</QXZ><BR><BR><QXZ>In order to use any of these features, the System Settings option Allow IP Lists must be enabled on your system. Then you will see the IP Lists Admin section appear in the Admin menu.</QXZ> |
| ip_lists-ip_list_id | IP List ID | <QXZ>This field needs to be at least 2 characters in length and no more than 30 characters in length, no spaces or special characters. This is the ID that will be used to identify the IP List throughout the system.</QXZ> |
| ip_lists-ip_list_name | IP List Name | <QXZ>This is the descriptive name of the IP List entry.</QXZ> |
| ip_lists-user_group | Admin User Group | <QXZ>This is the administrative user group for this record, this allows admin viewing of this record restricted by user group. Default is --ALL-- which allows any admin user with Modify IP Lists permissions to view this record.</QXZ> |
| ip_lists-active | Active | <QXZ>The IP List will only be able to be enabled for a user group if active is set to Y. Default is N.</QXZ> |
| ip_lists-ip_address | IP Addresses | <QXZ>This is the list of IP Addresses within this IP List. Only one IP Address per line is allowed. If you want to use IP whitelisting for agent access and you are using Dispo Call URL features like the dispo_move_list.php script, you will need to remember to include the IP Addresses of the web server in your IP List, because Dispo Call URL actions are run from the webserver.</QXZ> |
| users-pause_code_approval | Manager Pause Code Approval | <QXZ>If a campaign pause code is set to require manager approval, the manager that approves the agent pause code selection must have this setting set to 1. Default is 0.</QXZ> |
| users-modify_ip_lists | Modify IP Lists | <QXZ>If IP Lists are enabled on your system, this setting will allow this administrative user the ability to modify the IP Lists. Default is 0.</QXZ> |
| users-ignore_ip_lists | Ignore IP Lists | <QXZ>If IP Lists are enabled on your system, this setting will allow this user to ignore the IP Lists settings when accessing the system. Default is 0.</QXZ> |
| users-two_factor_override | Two Factor Auth Override | <QXZ>If Two-Factor-Authorization is enabled on your system, this setting can override it. Default is NOT_ACTIVE which will not override the System Settings for 2FA.</QXZ> |
| status_categories | System Status Categories | <QXZ>Through the use of system status categories, you can group together statuses to allow for statistical analysis on a group of statuses. The Category ID must be 2-20 characters in length with no spaces, the name must be 2-50 characters in length, the description is optional and TimeonVDAD Display defines whether that status will be one of the upto 4 statuses that can be calculated and displayed on the Time On VDAD Real-Time report. The Sale Category and Dead Lead Category are both used by the List Suggestion system when analyzing list statistics.</QXZ> |
| admin_phones_bulk_insert-registration_password | Registration Password | <QXZ>This is the registration password that will be used for all of the phones that are created. For SIP and IAX2 protocol you should use a complex password for secutiry reasons.</QXZ> |
| email_accounts | Email Accounts | <QXZ>The Email Accounts management section allows you to create, copy, and delete email account settings that will allow you to have email messages come into your system and be treated as if they were phone calls to agents. EMAIL ACCOUNTS MUST BE SET UP BY YOU AND AN EMAIL SERVICE PROVIDER - THAT IS NOT COVERED BY THIS MODULE.</QXZ> |
| email_accounts-email_account_id | Email Account ID | <QXZ>This is the short name of the email account, it is not editable after initial submission, must not contain any spaces and must be between 2 and 20 characters in length.</QXZ> |
| email_accounts-email_account_name | Email Account Name | <QXZ>This is the full name of the email account, it must be between 2 and 30 characters in length. </QXZ> |
| email_accounts-email_account_active | Active | <QXZ>This determines whether this account will be checked for new email messages to be loaded into the dialer. </QXZ> |
| email_accounts-email_account_description | Email Account Description | <QXZ>This allows for a lengthy description, if needed, of the email account. 255 characters max. </QXZ> |
| email_accounts-email_account_type | Email Account Type | <QXZ>Specifies whether the account is used for inbound or outbound email messages. Should be set to INBOUND. </QXZ> |