查看“传真 - UCP”的源代码

'''Fax - UCP'''


'''User Control Panel Fax Options'''

User Control Panel (UCP) is a web-based user interface for the PBX. Fax Pro lets, users can send, receive, and view faxes in UCP depending on the permissions you've set in the User Management module.

Users would typically access UCP at&nbsp;''[http://yourpbxdomain/ucp http://yourpbxdomain/ucp'']&nbsp;or&nbsp;''[http://yourpbxip/ucp http://yourpbxIP/ucp'']&nbsp;(using actual PBX domain or IP).

After logged into UCP, click&nbsp;'''Fax'''&nbsp;in the menu to access the fax section.

http://wiki.freepbx.org/download/attachments/23036371/fax-menu.png

From here, a user can view all locally stored inbound and outbound faxes (if local storage is enabled for the user), and send outbound faxes to anyone.

http://wiki.freepbx.org/download/attachments/23036371/fax-ucp.png

'''Folders'''

Faxes can be filed under the following folders:

'''Inbox'''

Faxes that have not yet been viewed.

http://wiki.freepbx.org/download/thumbnails/23036371/inbox.png

'''Archived'''

Faxes that have been viewed but not yet deleted.

http://wiki.freepbx.org/download/attachments/23036371/new-fax.png

'''Outgoing'''

Faxes in the process of being sent.&nbsp;The page will show the current status of the fax. Information updates automatically in near real-time with no need to reload the page.

http://wiki.freepbx.org/download/thumbnails/23036371/outgoing.png
* 
** You'll see "In Progress" if the system is still in the process of sending (or trying to send) the fax:
http://wiki.freepbx.org/download/attachments/23036371/fax-in-progress.png
** You'll see "OK" if the fax was sent successfully:

http://wiki.freepbx.org/download/attachments/23036371/sent.png
** The system will also display messages related to any errors that are encountered, such as "Retrying" when it's trying to send a fax again after a failure.

'''''''''Sent'''

Faxes that have been sent successfully.

http://wiki.freepbx.org/download/thumbnails/23036371/sent-menu-item.png
http://wiki.freepbx.org/download/attachments/23036371/sent-fax-list.png

'''Failed'''

Faxes that have not been sent successfully.

http://wiki.freepbx.org/download/thumbnails/23036371/failed-menu-item.png
http://wiki.freepbx.org/download/attachments/23036371/originate-failed.png

'''Fax Data'''

UCP displays the following information for each fax:

* '''''''''Date:&nbsp;'''The date and time the fax was received or sent, in YYYY-MM-DD format.
* '''From:&nbsp;'''The user number or caller ID (CID) of the sender.
* '''To:&nbsp;'''The user number or fax number of the recipient.
* '''Status:''' The status for the fax as reported by Asterisk.
* '''Pages:&nbsp;'''The number of pages for the fax as reported by Asterisk.
* '''Controls:''' Buttons to view, download, forward, or delete the fax, as described below.

'''Controls (Buttons)'''

Throughout UCP, buttons allow you to view and manage saved faxes. In the&nbsp;'''Inbox''',&nbsp;'''Archived''',&nbsp;'''Outgoing''',&nbsp;'''Sent''', and&nbsp;'''Failed'''&nbsp;folders, you'll find some or all of these buttons:&nbsp;

* http://wiki.freepbx.org/download/attachments/23036371/pdf-symbol.png'''View PDF in Browser:&nbsp;'''Displays the PDF file of the fax document in your browser, if your browser is configured to view PDFs.
* http://wiki.freepbx.org/download/attachments/23036371/download.png;'''Download:&nbsp;'''Downloads the PDF file of the fax to your computer.
* http://wiki.freepbx.org/download/attachments/23036371/download.png'''Forward:&nbsp;'''Lets you send the fax to another recipient - either an outside number or an internal extension.
http://wiki.freepbx.org/download/thumbnails/23036371/forward-fax.png
* http://wiki.freepbx.org/download/attachments/23036371/trash-symbol.png'''Delete:'''&nbsp;Delete the saved fax from the system.

'''How To Send a Fax in UCP'''

Create one or more PDF or TIFF files on your computer. Multiple pages and/or multiple documents are acceptable.

After you've clicked&nbsp;'''Fax'''&nbsp;in the main menu in UCP, click the&nbsp;'''Send New Fax'''&nbsp;button.

http://wiki.freepbx.org/download/thumbnails/23036371/send-fax-fm-ucp.png

Basic options include&nbsp;'''Destination''', whether to use a&nbsp;'''Coversheet''', and the&nbsp;'''Document(s)'''. (If you enable the coversheet, additional options will appear.)

http://wiki.freepbx.org/download/attachments/23036371/send-fax-form.png

'''Destination'''

Enter the fax number of the recipient.

'''Coversheet'''

This is&nbsp;'''Off'''&nbsp;by default. Click the switch to toggle the&nbsp;'''on/off'''&nbsp;setting.

If the switch is set to&nbsp;'''On''', additional fields appear:

http://wiki.freepbx.org/download/attachments/23036371/coversheet-on.png

The information you enter will appear on the cover sheet.

* '''Recipient Name:&nbsp;'''The name of the person you are sending the fax to.
* '''Message:&nbsp;'''A short message to include in the cover sheet.
* '''My Name:&nbsp;'''The sender's name is pulled from User Management settings, but you can override it here.
* '''My Telephone:&nbsp;'''The sender's phone number is pulled from the User Management settings, but you can override it here.
* '''My Email:&nbsp;'''The sender's e-mail address is pulled from the User Management settings, but you can override it here.

'''Document(s)'''

Documents must be in PDF or TIFF format. 

A single fax can contain one or more documents. There are two ways to upload documents to be included in your fax:

* Click the&nbsp;'''Upload Document'''&nbsp;button to select a file from your computer,
* ''OR''&nbsp;drag and drop files from your computer to the&nbsp;'''Drag New Documents Here'''&nbsp;area.

The uploaded file(s) will appear in a list:

http://wiki.freepbx.org/download/attachments/23036371/filelist.png

* To view a file, click thehttp://wiki.freepbx.org/download/attachments/23036371/pdf-symbol.png &nbsp;button.
* To remove a file from the list, click the&nbsp;http://wiki.freepbx.org/download/attachments/23036371/trash-symbol.png &nbsp;button.

'''Send'''

When ready to send the fax, click the&nbsp;'''Send'''&nbsp;button.

http://wiki.freepbx.org/download/attachments/23036371/send-button.png

You'll be reminded that you can check the Outgoing section if you would like to see status updates in UCP.

http://wiki.freepbx.org/download/attachments/23036371/instructions-to-check-outgoing.png

When a fax has been sent successfully, it will be moved to the&nbsp;'''Sent''' folder. If it fails to send and all retry attempts have been exhausted, it will be moved to the&nbsp;'''Failed''' folder.

'''How to Receive a Fax in UCP'''

'''Inbox Folder'''

Receiving a fax in UCP is easy - just check your Inbox! You don't need to be logged into UCP at the time a fax is received.&nbsp;In UCP, after clicking&nbsp;'''Fax''' in the main menu, click the&nbsp;'''Inbox'''&nbsp;menu item to view the inbox.

Remember, the [http://wiki.freepbx.org/ user's fax settings] in the User Management module must be set to '''Store Locally: Yes''' in order to receive faxes in UCP. Otherwise, the fax will only be sent to e-mail.

If you're logged into UCP and have allowed your web browser to display notifications, you'll see a pop-up notification when a new fax arrives.

http://wiki.freepbx.org/download/thumbnails/23036371/fax-notify-chrome.png

For instructions on enabling/disabling notifications in your web browser, please see your specific browser's instructions. Typically, your web browser will ask you about whether to enable notifications the first time you log into the User Control Panel.

'''Fax Settings in UCP'''

Users can manage their fax settings directly from UCP.

To do this, log into UCP, click&nbsp;'''Fax''' in the primary navigation menu, and then click&nbsp;'''Settings''' in the secondary menu.

http://wiki.freepbx.org/download/attachments/23036371/settings-fax-ucp.png

Fax Settings update automatically as new information is entered. There is no "Save" button.

http://wiki.freepbx.org/download/attachments/23036371/fax-settings-list-in-ucp.png

'''''''''Fax Email'''

The e-mail address to send inbound faxes to when this user receives a fax

'''Attachment Format'''

'''PDF/TIFF/both:''' Which file format(s) to use when e-mailing an inbound fax to this user.

'''Store Locally'''

* '''Yes:&nbsp;'''Store the fax locally after e-mailing it to the user, so that the fax can be viewed in UCP.
* '''No:''' Delete the fax after e-mailing it to the user. The fax will not be accessible in UCP.

'''Outgoing Station ID'''

The fax number that will be displayed at the top of each outbound fax.

'''Outgoing Header'''

Text, such as a company name, that will be displayed at the top of each outbound fax page.

'''Coversheet Name'''

The name of the person who is sending the fax. This will be displayed in the "From" section of the cover sheet.

'''Coversheet Telephone'''

The voice telephone number of the person who is sending the fax.&nbsp;This will be displayed in the "From" section of the cover sheet.

'''Coversheet Email'''

The e-mail address of the person who is sending the fax.&nbsp;This will be displayed in the "From" section of the cover sheet.

'''Email Results'''

This setting controls whether to e-mail the results of an outbound fax to a sender, so that the sender can be alerted of the status.

* '''Never:''' Never e-mail the results.
* '''Always''': Always e-mail the results.
* '''On Success''': Only e-mail the results when the outbound fax is successful.
* '''On Failure''': Only e-mail the results when the outbound fax fails.
* '''Use Global''': Use the setting that is defined globally in the Fax Configuration module of the PBX administration GUI.

'''Retries'''

'''''''''0/1/2/3/Use Global Setting:''' How many times to try and resend a failed fax (none, 1, 2, or 3). Select&nbsp;'''Use Global''' to use the global setting from the Fax Configuration module of the PBX administration GUI.