system administrator guide - · pdf filesystem administrator 1 can manage all company user...

System Administrator GuideVersion 7.1

July 2015

RESTRICTED RIGHTSUse, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (C)(1)(ii) of theRights in Technical Data and Computer Software clause at DFARS 252.227 - 7013.

Cleo4203 Galleria DriveRockford, IL 61111 USAPhone: +1.815.654.8110Fax: +1.815.654.8294Email: [email protected]

Support: +1.866.501.2536 (US only), 1.815.282.7894, or [email protected]

Cleo reserves the right to, without notice, modify or revise all or part of this document and/or change product features orspecifications and shall not be responsible for any loss, cost or damage, including consequential damage, caused by relianceon these materials.

This document may not be reproduced, stored in a retrieval system, or transmitted, in whole or in part, in any form or by anymeans (electronic, mechanical, photo-copied or otherwise) without the prior written permission of Cleo.

© 2003-2015 Cleo. All rights reserved.

All marks used herein are the property of their respective owners.

Contents

1. Introducing Cleo Streem®..................................................................................5Technical Support................................................................................................................................................. 5

2. Setting up users...................................................................................................7Add a user.............................................................................................................................................................7

About roles and permissions.................................................................................................................... 7Searching the user list.......................................................................................................................................... 8About LDAP configuration.................................................................................................................................. 8

Synchronizing your Cleo Streem users with your LDAP directory........................................................ 8LDAP Synchronization Administration attributes................................................................................... 8

About cover page templates................................................................................................................................. 9Using a file attachment as a cover page template................................................................................. 10Creating a cover page template..............................................................................................................10Naming and storing custom cover page templates................................................................................ 11

3. About device information.................................................................................13About importing device information..................................................................................................................13

Importing device information.................................................................................................................13Preparing your .csv file for importing................................................................................................... 14

About adding devices manually......................................................................................................................... 15Adding a Xerox MFP.............................................................................................................................15Add a new FTP User..............................................................................................................................15Add a new Save-To-Folder.................................................................................................................... 16Add a new Cleo Streem Printer............................................................................................................. 16

4. About system monitoring................................................................................. 17Installing and running scMonitor....................................................................................................................... 17Configuring scMonitor........................................................................................................................................17About system monitoring tests...........................................................................................................................20About system monitoring reports.......................................................................................................................20

5. Setting up your Cleo Streem server to send faxes......................................... 23Registering the Cleo application on your Xerox device....................................................................................23Configuring an Email Fax Connector................................................................................................................ 25

Configuring a hosted email solution to work with your Cleo Streem server.........................................25Configuring an on-premise email solution to work with your Cleo Streem server............................... 26

6. About error codes and troubleshooting.......................................................... 27Final Call Status Results.................................................................................................................................... 27

Dialogic Brooktrout hang-up codes................................................................................................................... 29Troubleshooting FAQ......................................................................................................................................... 33

7. About Cleo Streem and the Common Alerting Protocol (CAP)................... 39About the Cleo Streem data interface................................................................................................................39

About the Cleo Streem input data file................................................................................................... 39About the Cleo Streem response data file............................................................................................. 46

About the Cleo Streem-CAP-Interface workflow..............................................................................................51Cleo Streem CAP Parser (ScCAP.py)................................................................................................. 52Streem API (ScSubmit.py)............................................................................................................... 52

5

1Introducing Cleo Streem®

Cleo Streem® is a Microsoft Windows-based fax processing platform that provides a complete range of advancedvoice and fax capabilities, including

• Fax/email integration - allows you to send a fax via email using Microsoft Exchange, Lotus Notes, GroupWiseand any SMTP compliant email system.

• Fax messages - allows you to fax the same document to multiple destinations or multiple documents to multipledestinations.

• Fax from print driver - allows you to send a document to a fax destination as if you were sending it to a printer.• Support for faxing from MFPs - allows you to use Cleo Streem to process faxes originating from MFPs (Multi

Function Printers.)

System monitoring and operation are handled centrally, from anywhere on the network, using the Cleo Streemgraphical user interface.

Technical SupportTo request technical support:

• Use the request form at: http://www.cleo.com/support/request.php• Call the automated support line at 1-866-444-CLEO(2536) or 1-815-282-7894.

Cleo Technical Support is available from 7am - 7pm Central Time, Monday through Friday. Requests are handledon a callback basis in the order they are received. The Cleo automated support line or web form will collect yourinformation and your request for support will be placed in our callback queue.

A support subscription is required to work with a Cleo technical support analyst. You can find information on Cleosupport options at: http://www.cleo.com/support/supsub.php .

To ensure your support process goes quickly and smoothly, note where you are in the setup or installation process.Also, note any diagnostic measures taken.

http://www.cleo.com/support/request.php

http://www.cleo.com/support/supsub.php

7

2Setting up users

A user is a person who can send faxes through the Cleo Streem appliance. You use the User Manager page to create,modify, and delete users. An MFP is a device a user might use in conjunction with the Cleo Streem system to send orreceive a fax. In addition, you can synchronize your list of users with your LDAP directory.

Add a userLog in as user with an admin role to add users.

1. If necessary, log in as an user with an Admin role.2. Click the Admin toggle to the admin-only portion of Cleo Streem.3. Click User Manager > Users > Add.4. Select a company and click Continue.

The Add User page displays.5. Enter information about the user and then click Submit.6. Do any of the following:

• Click Update for one of the users listed to display information for that user.• Click Manage for one of the users listed to display lists of recipients and distribution lists owned by that user.

7. Edit user information or list information and then click Submit.Your updates are saved.

8. Close the update window.

About roles and permissionsYou can assign roles to users to your Cleo Streem.

In the Cleo Streem software, you assign permissions through the use of roles. Roles are sets of permissions bundledtogether to make it easier to enable users to do their jobs. The following is a summary of roles you can assign tousers .

Role Role Code Description

System Administrator 1 Can manage all Company User Pages

User 2 Can send broadcasts and see onlytheir own page.

Company Administrator 3 Can manage User Pages for onlytheir own company.

Company Executive 4 Can only view reports from theirown company.

8 | Administrators Guide

Setting up users

Role Role Code Description

System Executive 5 Can only view reports, but from allcompanies.

Denied 0 User has no permission to use thesystem at all.

Searching the user list

1. If necessary, log in as an user with an Admin role.2. Click the Admin toggle to the admin-only portion of the Cleo Streem server.3. Click User Manager > Users > Search.

The Search Users page is displayed.4. Enter values in the fields on which you want to base your search and then click Search.

A list of users matching the criteria you entered is displayed.5. Do any of the following:

• Click Update for one of the users listed to display information for that user.• Click Manage for one of the users listed to display lists of recipients and distribution lists owned by that user.

About LDAP configurationCleo Streem allows you to synchronize your list of Cleo Streem users with one or more LDAP directories, such asMicrosoft Active Directory, Novell eDirectory, or Lotus Domino Directory. The synchronization process is scheduledthrough some Cleo Streem workflow.

Synchronizing your Cleo Streem users with your LDAP directoryCleo Streem uses templates you create to synchronize your Cleo Streem user list with an LDAP source, such asActive Directory or Lotus. For Microsoft environments, you can also use LDAP (domain) authentication.

You use the LDAP Synchronization Administration page to synchronize your user list with LDAP or to create or edita template. To create or edit a template, you need to know about the data Cleo Streem uses to synchronize with anLDAP source. See LDAP Synchronization Administration attributes on page 8

1. Go to the LDAP Synchronization Administration page.2. Search for a "template".

Alternatively, you can add or edit a template.3. Click "synchronize."

LDAP Synchronization Administration attributesThese attributes allow you to specify LDAP synchronization parameters once and use them repeatedly.

LDAP attribute Description

Sync Name The name used to identify this synchronization

Cleo Streem® | 9

Setting up users

LDAP attribute Description

Mail System The mail system used in conjunction with Cleo Streem.Exchange systems add the ability to specify the username and password to connect with Active Directory ifneeded. It also enables you to take advantage of domainauthentication for synchronized users instead of thebuilt-in Cleo Streem authentication

LDAP Server IP Address The IP address of the LDAP server to synchronize with.

LDAP Port The port that the LDAP server uses to field requests - thedefault is 389

LDAP User Class The LDAP class name for Users - default is Person

Load Users This selection filters the users that will be synchronized.Choices are All Users, Users with a Fax number, orUsers with Additional fax numbers.

LDAP Username This is specific to Microsoft systems.. Theusername@domainname (domainname is the fullyqualified domain name) for connecting to ActiveDirectory (Optional)

LDAP Password The password to be used with the LDAP username(required only if LDAP Username is specified)

Admin Email Email address where certain sync errors may be emailed

Fax Format Select the default format for inbound faxes

Default User Role Select the default role for newly synchronized users

Use LDAP Authentication Applicable only to Microsoft environments. Checkingthis box sets all synchronized users to authenticateagainst Active Directory instead of using Cleo Streemauthentication

Internal Domain This is specific to Microsoft systems and is thefully qualified domain name that is appended tothe username when using LDAP authentication(example: internal.streem.net) (required if using LDAPauthentication)

About cover page templatesYou can create and store cover page templates for Cleo Streem users to use when they send faxes.

A cover page template is a rich text format (.rtf) document. Most word processing applications allow you to save.rtf. Because .rtf format preserves document formatting elements, the template can include any features that areavailable with your word processor, such as graphics, a variety of fonts, and formatted text.

You can use specially named file attachments as cover page templates. You can also create your own custom coverpage templates on a per company, per department, and per user basis.


Setting up users

When you use a cover page template as part of a message, Cleo Streem looks for the cover page template in thefollowing order:

• an attachment with a filename prefix of _SCCP_• a personal cover page• a department cover page• a company cover page• the system default cover page

The default cover page template is \StreemCenter\Documents\defaultcover.rtf.

Using a file attachment as a cover page templateYou can attach an existing file to an email you want to send as a broadcast message and designate that attached file asthe cover page template.

To use a file attachment as a cover page template, you save the file with the special prefix, _SCCP_ and attach it tothe email.

For example, if you attach a file named _SCCP_My_Cover_Page.rtf to an email message, the attachment isused as the cover page template for that message.

Creating a cover page templateUse a word processor or text editor to create an .rtf file to use as a cover page template.

When you create a cover page template, you specify where you want to place variable cover page information, such asthe TO name, the SUBJECT, and the FROM name, by including a code, like a mail merge field name. When you usethe cover page in a broadcast, Cleo Streem replaces the codes with the appropriate information drawn from systemparameters and from broadcast options you have specified. The codes themselves are not shown on the faxed coverpage.

Use the following codes when you create a template document. All of these codes are optional, though typically therecipient's name and the date are always included. Be sure to type the curly braces, { }, around each code.

• {Attention} - Replaced with the recipient’s name, commonly referred to as the TO name.• {Date} - Replaced by the current system date, in the following style associated with the time/date information

associated of the Cleo Streem computer.• {FaxNumber} - Replaced by the destination fax number.• {From} - Replaced by the fax sender’s name. Be aware that this may be expanded to several lines of text.• {Notes} or {Note} - Replaced by notes you want to include on the cover page.• {Subject} - Replaced by the subject of the fax.• {Time} - Replaced by the current system time in 24-hour clock style, for example: 17:35.

Cover page template design tips

Here are some things to keep in mind as you work with your cover page template.

• To replace the default cover page template, replace the file, \StreemCenter\Documents\defaultcover.rtf.

• Some parameters such as {Attention} and {Notes} can be replaced by several lines of text, depending on how youspecified this information when preparing the fax.

• Leave enough room for the amount of information you want to include on the cover page. Any text below theinformation already filled in will be moved down the page.

Cleo Streem® | 11

Setting up users

If the layout of the template is simple and there is plenty of room at the bottom of the page, this might beacceptable. If not, the parameter codes can be placed within text boxes, called constrained text boxes with someword processors. Text boxes are usually available from the word processor’s drawing menu, and they can be madeinvisible with many word processors. By putting a code in a constrained text box, the associated information willbe limited to that amount of text that can fit in the box. Some of the text might be cut off, but the page layout willremain intact.

• Send a test fax to yourself to review your cover page formatting.

Naming and storing custom cover page templatesYou can create cover page templates and associate them with a company, a department within a company or aparticular user.

To distinguish between cover page templates on a per-company, per-department, and per-user basis, you must followsome filename conventions and store the templates in a particular directory.

Type Filename convention Location

Company with multiple emaildomains

company_domain.rtf, wherecompany_domain is the uniqueemail domain for the company.

\Streem\CoverPages

Company with a single email domain company.rtf, where companyis the unique name for the companystored in the Cleo Streem database.

\Streem\CoverPages

Department department_name.rtf,where department_name isthe department name stored in thedatabase. Because departmentsare associated with a company,department names need only beunique within the company theybelong to. The company associatedwith the department is determined

For departments belonging tocompanies with multiple emaildomains: \Streem\CoverPages\<company_domain>

For departments belonging tocompanies with a single emaildomain: \Streem\CoverPages\<company>

User user_email.rtf, whereuser_email is the unique useremail address.

For example, for the [email protected], the filemust be named joe.rtf

\Streem\CoverPages\<company_domain>

13

3About device information

Cleo Streem can enhance your MFP device by allowing users to send documents via fax to recipients without the useof phone line connectivity at the MFP.

You use the Cleo Streem web UI to work with information about devices connected to your Cleo Streem system.You can manually add devices one at a time using the Cleo Streem web UI. Cleo Streem web UI treats the followingentities as devices: users, Xerox devices, Save-to folders, FTP users, and Cleo Streem printers. Alternatively, you canuse a comma-separated value (.csv) file as input to an import process available from the Cleo Streem web UI. If youchoose to import a .csv file, it must be in the correct format.

About importing device informationYou can populate and import a comma-separated value (.csv) file to add a large number of devices to your CleoStreem system at one time.

Importing device informationYou can import device information to Cleo Streem using a .csv file.

1. Prepare the .csv file.You can import users, MFPs, and save-to-folders.

Various devices and users require different data to be entered as follows:

Name Type Required fields

User 1 email addres

Xerox device 2 IP address

fax

confirmations

Save To Folder 3 path

fax

FTP 4 username

path

IP address

User ID PIN

Printer 5 path


About device information

Name Type Required fieldsfax

DocumentManagementUser

6 path

email address

2. Log in as a user with a role of Administrator or Company Administrator.3. Go to Admin > User Manager > Users > Import.4. Click Choose File and then navigate to the .csv file you prepared.

Preparing your .csv file for importingBefore you can import data from your .csv file into Cleo Streem, you must first correctly populate it with the data youwant to import.

You can download either a template .csv file or export a .csv file populated with data from your Cleo Streemdatabase.

The .csv file contains the following fields in this order:

Field Description

firstname User's first name.

lastname User's last name.

username User's user name.

password User's Cleo Streem password.

fax Fax number

email email address

role Numeric value representing the user's role. See Aboutroles and permissions on page 7

otherfax Semi-colon seaprated list of additional fax numbers.

company Name of the company defined for this user.

dept Name of the department within the company defined forthis user.

userid User's numeric user id (1-8 numbers).

userIdPIN User's numeric PIN, used for AC Record, FTP password,and secure PDF password (1-12 numbers).

FaxFormat The user's fax format preference, must be one of: (PDF,TIF, TIF & PDF).

NoCoverPage Numeric value indicating if the person does not want touse a cover page (1=no cover page, 0=use a cover page).

BillingCode

DefaultApp

Cleo Streem® | 15


Field Description

Path

IPAddress

Description

Type

FaxInLength

Confirmations

About adding devices manuallyYou use the Cleo Streem web UI to manually add devices to your Cleo Streem system.

Adding a Xerox MFP

1. Log in as an Admin.2. Go to User Manager > Users > Xerox Devices.3. Enter the information required to define a Xerox device.

• IP Address that was assigned to the Xerox Device• Fax number that is to be assigned to the Xerox Device• Company• Department• A description to help identify the device• A billing code (optional)• A paper color or keep the default (white)• Number of lines per page. Enter 2100 for 7345 Xerox models and 2200 for all other Xerox devices.

4. Click Add Device.

Add a new FTP User

1. Log in to Streem as an Admin.2. Go to User Manager > Users > FTP Users.3. Enter the information required to define an FTP user in Cleo Streem.

• URL for the FTP site• folder path on the FTP site• Fax number that is to be assigned to the FTP User• Username used to log into the FTP site• Password for the FTP site• Re-enter the password for the FTP site for verification• Select a file format. Note: Select SecurePDF to encrypt the document with the FTP site password.• Enter a description to help identify the device• Enter a billing code (optional)



4. Click Add FTP.

Add a new Save-To-Folder

1. Log in to Cleo Streem as an Admin.2. Go to User Manager > Users > Save-To-Folders.3. Enter the information required to define a Save-To-Folder in Cleo Streem. All fields are required except for the

Password if the Format is not Secure PDF.

• Path to the folder where faxes will be saved. The folder must exist before adding it to Cleo Streem. If thefolder is not located on the Cleo Streem server, file permissions might be an issue. Make sure you use the UNCpath, not the local path, to the folder.

• Fax number that is to be assigned to the folder• A format for the saved faxes• Description to help identify the folder• Password if you selected Secure PDF as the file format• Email address. Cleo Streem will send an email with a link to the fax saved in the Save-To-Folder

4. Click Add Folder.

Add a new Cleo Streem Printer

1. Log in to Cleo Streem as an Admin.2. Go to User Manager > Users > Streem Printer.3. Enter the information required to define a Cleo Streem Printer.

• Printer name. The printer must be installed on the Cleo Streem Server before adding it to Cleo Streem.• Fax number that is to be assigned to the printer.• Description to help identify the printer.• Billing code (optional).

4. Click Add Printer.

17

4About system monitoring

Cleo Streem includes functionality that enables you to monitor the entire system.

The Cleo Streem monitoring (scMonitor) service is a script-based utility you use to monitor a Cleo Streem systemon a continuous basis. The Monitoring service proactively detects problems that various parts of the Cleo Streemsystem may be experiencing, and report them back via email.

The Monitoring service performs a series of tests that exercise different parts of the system, and measures the resultsagainst an expected set of outcomes. These tests are repeated at a regular interval. See About system monitoring testson page 20.

Note: As more sub-systems are added for monitoring, this list of tests may get longer.

If a problem is found during any of these tests, all the relevant information is logged to the Windows Event Logand an email message, marked urgent, is immediately sent to a pre-configured list of email recipients. If all tests aresuccessful, an email message is sent to the same recipients indicating that the test was successful. The success email isoptional. See About system monitoring reports on page 20.

Installing and running scMonitor

The monitoring service is a Python script named scMonitor.py.

Note: The service is automatically started when Windows is started. It is not necessary to explicitly start theservice.

• To install the scmonitor service: <streem_install_directory>\scripts\scmonitorscmonitor.py install

• To manually start the service: net start scmonitor• To manually stop the service: net stop scmonitor• To remove the service: <streem_install_directory>\scripts\scmonitorscmonitor.py

remove• To debug the service (run it as a console application with extra debug

output):<streem_install_directory>\scripts\scmonitor directory: scmonitor.py debug

Configuring scMonitor

The monitoring service expects a configuration file named scmonitor.cfg. This file must be located in%STREEM_CENTER_PATH%\scmonitor.

The following is a sample scmonitor.cfg file

[options]customer=Customer Name


About system monitoring

testserver=streem_center_servertestport=25notifyserver=email_servernotifyport=25notifyaddr=tech@streem.netnotifyfailureonly=1 droptoaddr=0123456789@[email protected][email protected]=3300.0senddelaytime=120.0 testdropdir=c:\streem\smtpdrop\scmonitorfaxdropdir=c:\streem\temp\ScMonitor attachment=c:\streem\documents\ScMonitor.pdf capxml=c:\streem\scripts\scMonitor\alert-fev.xml ports=24

[monitor]smtp=1fax=1tts=0alert=0xerox=0folder=0prn=0

[folder]folders=c:\streem\temp\folder1, c:\streem\temp\folder2intervals=10,20

Options sectioncustomer

Customer name that appears on the subject line of emails.

testserverServer Cleo Streem SMTP service is running on.

testportThe SMTP port the Cleo Streem SMTP service is listening on.

notifyserverThe SMTP server to use for notification emails.

notifyportThe SMTP port the notification server is listening on.

notifyaddrThe email address to send notifications to.

notifyfailureonlyIf set to 1, only failure emails are sent. Default value is 1.

droptoaddrThe test drop email address. The domain portion of this email address is configured in the CleoStreem Center SMTP server to point to a drop sub-directory (scmonitor) that is not used bycustomer for faxing.

Cleo Streem® | 19


sendtoaddrThe email address used for testing an actual fax delivery. The domain portion of the address shouldbe a domain that is being picked up by the Cleo Streem’s outbound faxing workflow. The accountportion is a test account that is set up in the SystemUserList table. This user is setup to have theirfaxes dropped as a .TIF file to a temp folder located on the Cleo Streem server.

dropdelaytimeThe amount of time to delay (in seconds) between test cycles.

senddelaytimeThe amount of time (in seconds) to wait for a fax to be received into the test account.

testdropdirThe test drop directory location. This is the directory where emails sent to “droptoaddr” will havefiles dropped.

faxdropdirThe directory that will receive the test fax for the test SystemUserList account.

attachmentThe name/path of file to be sent as attachment for fax tests.

capxmlThe name/path of the CAP xml file used for the alert test.

portsNumber of hardware ports installed on this Cleo Streem system

Monitor sectionsmtp

Run the SMTP server test (1) or not (0). Default value is 1.

faxRun the inbound/outbound fax test (1) or not (0). Default value is 1.

ttsRun the Text-to-Speech conversion test (1) or not (0). Default value is 0.

alertRun the fax, voice, email test (1) or not (0). Default value is 0.

xeroxRun the Xerox test (1) or not (0). Default value is 0.

folderRun the folder monitor test (1) or not (0). Default value is 0.

prnRun the PRN monitor test (1) or not (0). Default value is 0.

Folderfolders

Comma separated list of folders to watch.

intervals



Comma-separated list of time intervals associated with the folders listed in the folders value. Ifany file in a watched folder is older than it’s associated interval, then an appropriate error messageis generated. The number of intervals listed must be equal to the number of listed folders.

About system monitoring tests

The Cleo Streem Center Monitoring service tests certain components of the Cleo Streem system on a regular basis. Bydefault, some or all of these tests are performed once every hour. See Configuring scMonitor for information aboutspecifying which tests are run and how often. Selected tests are performed sequentially in the order they are presentedbelow:

Cleo Streem Center SMTP Service

1. Sends an email to the Cleo Streem Center SMTP Service using a test “drop domain” called scmonitor.2. Checks the scmonitor drop directory location for a successful drop by the SMTP server (.dat file).

Faxing – Outbound and Inbound

1. Sends an email to the Cleo Streem Center SMTP Service using a real drop domain and a test account that willcause a fax to be sent back into Cleo Streem Center. The fax is sent (and received) with a PDF attachment.

2. Checks for a received .tif image.

Text-to-Speech

1. Drops a file to the TTS convert folder..2. Checks for a valid .wav file.

Broadcast – Voice, Fax and Email

1. Sends a broadcast using Cleo Streem Center’s Common Alerting Protocol (CAP) interface. The types ofdestinations (voice, fax and email), how many messages are sent to each destination, and other attributes (faxattachment etc.) of this test broadcast is controlled by a CAP-format XML file. The default file creates a testbroadcast with one voice, fax and email destination each.

2. Checks the status of the broadcast job and each destination for successful completion.

Folder

1. Checks the age of files in all the specified folders.

About system monitoring reports

Every time the system monitoring tests are executed, the scMonitor service generates a report that is emailed to apre-configured list of recipients.

If all the tests are successful, scMonitor sends out a test successful email.

Subject: ** SUCCESS – Customer Name - Cleo Streem Center Notification ** All tests were successful.

Company: Customer Name System: Cleo Streem Center

Cleo Streem® | 21


Server: streem_center_server Time: 2008/08/13 11:01:02 Tests: SMTP Server: Successful Fax Outbound: Successful Fax Inbound: Successful Broadcast Fax: Successful Broadcast Voice: Successful Broadcast Email: Successful

Continuing to monitor the system.

In case one of the tests fails, scMonitor sends out a failure email.

Subject: ** FAILURE – Customer Name - Cleo Streem Center Notification ** Error Dropping Message To Cleo Streem SMTP Server. Additional details have been logged to the Windows Event Monitor.

Company: Customer Name System: Cleo Streem Center Server: streem_center_server Time: 2008/08/13 11:01:02

If PRN monitoring is turned activated, scMonitor sends out an email at an interval defined by thedropdelaytime option specified in the scmonitor.cfg file during the voice call window specified injo_alert.ini:

Subject: PRN calling update. - Customer Name

2317 out of 2317 calls completed.

Last 5 jobs completed:

Job Number Status Time Finished 334140 Completed 2011-05-30 16:41:49.097000 334139 Completed 2011-05-30 16:41:36.743000 334138 Completed 2011-05-30 16:41:24.337000 334137 Completed 2011-05-30 16:41:11.960000 334136 Completed 2011-05-30 16:40:59.630000

Company: Customer Name System: Cleo Streem Center Server: streem_center_server Time: 2008/08/13 11:01:02 Tests: SMTP Server: Successful Fax Outbound: Successful Fax Inbound: Successful Broadcast Fax: Successful Broadcast Voice: Successful Broadcast Email: Successful

Continuing to monitor the system.

23

5Setting up your Cleo Streem server to send faxes

Before you can use your Cleo Streem server to send faxes, you must either register it with one or more Xerox MFPdevices or configure an email fax connector between your server and your email system.

Registering the Cleo application on your Xerox deviceBefore you can send a fax using your Cleo Streem server and Xerox MFP, you must install and register somesoftware on your Xerox device.

Note: EIP must be enabled on your Xerox device. Contact your Xerox representative for more information.

Note: If you change your Cleo Streem server IP address, you must also delete the existing Cleo applicationfrom the Xerox device and re-register the Cleo application on your Xerox device using the updated IPaddress.

You Cleo Streem server supports the following devices and firmware combinations.

Product Minimum Firmware Version Needed

WorkCentre

5735/5740/5745/5755/5765/5775/5790

061.132.22

1.29100

WorkCentre

7525/7530/7535/7545/7556

061.121.22

1.20901

ColorQube

9301/9302/9303

071.180.20

3.05402

ColorQube

8700/8900

071.160.10

1.xxx

WorkCentre

7830/7835

Minimum not

required

WorkCentre

7845/7855

Minimum not

required

WorkCentre

58xx

Minimum not

required


Setting up your Cleo Streem server to send faxes

Product Minimum Firmware Version Needed

WorkCentre

7220/7225

Minimum not

required

1. Go to C:\streem\web\webapps\Xerox\reg\Registration.xml and open Registration.xmlusing a text editor, for example, Notepad.

2. In the Registration.xml file, replace all occurrences of $STREEM_SERVER_ADDRESS$ with the IPaddress you specified for your Cleo Streem server when you configured it and then save the file.In the event you have to change your system's IP address, you will need to update the Registration.xml fileaccordingly and re-register your system with the Xerox device.

3. Go to C:\streem\web\registrationApp and run RegClient.exe.The Registration Client dialog box appears.

4. In the Device Connection section, do the following:a) Enter the IP address of the Xerox machine you want to register with EIP.b) Enter the password of Xerox machine you want to register with EIP.

5. Make sure the Use SSL check box is cleared.6. Click Connect to view applications already installed on the Xerox machine you are working with.

Once you are connected, the List and Create New buttons are activated.7. Click List to view the existing applications.8. Click Create New to load the Cleo EIP application on target Xerox machine.

The Registration Detail Form dialog box appears.

Cleo Streem® | 25


9. Click Load from XML button and select the Registration.xml file you updated earlier.This populates the fields in this dialog box with the contents of the Registration.xml.

10. Click Create to deploy the application to the target Xerox MFP you specified earlier.

Configuring an Email Fax ConnectorBefore you can send a fax via email, you need to route email from your email solution to your Cleo Streem server.Configuration procedures are slightly different for on-premise email solutions and hosted email solutions.

Configuring a hosted email solution to work with your Cleo Streem server

The following is a generic procedure to configure your hosted email solution to send email to your Cleo Streem serverfollowed by some more specific steps to configure your Cleo Streem server to listen for incoming emails to be treatedas faxes.

1. In your email solution, create a sub domain to which you want faxes to be routed.2. Indicate to the email host the owner of the sub domain. Create a public DNS A record in a public environment that

points to an externally facing IP. Typically, this is your firewall.3. Create a firewall rule to route mail from that sub domain to your Cleo Streem server.4. Configure Cleo Streem server to listen for incoming messages.

a) Go to C:\Streem\SMTPServer and open SCSMTPMGR.exe. This is the Streem SMTP Service Managerapplication.

b) In the Streem SMTP Service Manager application, click the Domains tabc) Click Add.d) Specify the name of the domain from which you want to route fax emails and specify a Drop directory. The

Drop directory is where Streem workflow listens for emails incoming from the associated domain.e) Click OK.



Configuring an on-premise email solution to work with your Cleo Streem server

The following is a procedure consisting of generic steps to configure your on-premise email solution to send email toyour Cleo Streem server followed by information about configuring your Cleo Streem server to listen for incomingemails.

Note: Some on-premise email solutions have wizard-type tools to help you with this type of configuration.

See Sample email connector for Exchange 2010/2013 on page 26 for a on-premise solution-specific example ofthis configuration.

1. In your email solution, create a sub domain to which faxes will be routed.2. Route email addressed to that sub domain to your Cleo Streem server.3. Configure Cleo Streem server to listen for incoming messages.

a) Go to C:\Streem\SMTPServer and open SCSMTPMGR.exe. This is the Streem SMTP Service Managerapplication.

b) In the Streem SMTP Service Manager application, click the Domains tabc) Click Add.d) Specify the name of the domain from which you want to route fax emails and specify a Drop directory. The

Drop directory is where Streem workflow listens for emails incoming from the associated domain.e) Click OK.

Sample email connector for Exchange 2010/2013

This section provides an example of how to create an SMTP connector on your Exchange 2010/2013 server that willroute messages to Cleo Streem. This connector points any outbound email with a fax number in the To field to theCleo Streem system, which faxes the document to the proper destination.

1. Open the Exchange Management Console. Under Organization Configuration, select Hub Transport. On theright hand side of the console click New Send Connector.The New SMTP Send Connector wizard appears.

2. Name the connector Cleo Streem Fax and then click Next.The Address Space page appears.

3. Click Add and choose SMTP Address Space from the drop down menu.The SMTP Address Space dialog box appears.

4. Enter default to SMTP in the Type field, fax.yourdomain.com (for example, fax.streem.net) inthe Address field , and 1 in the Cost field.

5. Click OK to dismiss the SMTP Address Space dialog box and then click Next.The Network settings page appears.

6. Select Route mail through the following smart host and click Add.The Add smart host dialog box appears.

7. Select the IP Address check box and enter the IP address for your Cleo Streem Server, click OK to dismiss theAdd smart host dialog box, and then click Next.

8. Click Next until the install is finished.

27

6About error codes and troubleshooting

Cleo Streem provides error codes to help you understand and diagnose issues with your system

Final Call Status Results

Code Description Comments

301 Normal busy; remote end busy (off-hook). Busy signal received after the maximumnumber of retries. Resend the fax at a latertime.

302 Normal busy; remote end busy (off-hook). Used instead of301 in certain countries.

Busy signal received after the maximumnumber of retries. Resend the fax at a latertime.

303 Reorder or fast busy; indicates that telephone companytrunk lines are busy; on PBXs, indicates no availableoutside lines.

No available outside lines. Try dialing thenumber from another phone. If this works,contact your support team to assist helpcheck for problems with the line.

304 Recall dial tone detected; signal generated when callinganother party while already connected to one or moreparties (for example, conference calling, call waiting).

Number dialed is not a fax number. Trydialing the number from another phone toverify the number is a fax number.

305 Confirmation tone; automated equipment acknowledgessuccessful completion of caller requested feature (forexample, call forwarding). This is not G2 confirmationtone (CFR2).

This indicates there is a problem withthe line, switch, or card. Try dialing thenumber from another phone to verify thenumber. Contact your support team.

306 This result is reserved and should never occur. Contact your support team.

316 Answer (probable human) detected; does not match anyother expected call progress signal patterns.

317 Remote end answered call; can occur immediately aftera break in the ring-back cycle; like HUMAN, does notmatch any other call progress signal patterns, but ismarked by silence.

Number dialed is not a fax number. Trydialing the number from another phone toverify the number is a fax number.

318 Dial tone detected; usually indicates the dialing sequencedid not break dial tone.

This occurs when you did not access anoutside line. Could be an invalid numberor dialing configuration in Cleo Streem.Verify the number is correct. Contact yoursupport team.


About error codes and troubleshooting

Code Description Comments

324 In VOICE mode, after dialing, no signal detected duringthe silence timeout. In ANSWER mode, no fax CNG tonedetected after answering a call.

Try dialing the number from another phoneto verify the number is a fax number. Couldbe a problem with the line, switch, or card.Contact your support team.

325 Indicates the remote end was ringing but did not answer. Infax mode, this result occurs after the ced_timeout (default:40 secs) has expired and the line continues to ring (Youcan adjust the value of these time-out parameters in thebtcall.cfg configuration file).

No answer. Try dialing the number fromanother phone to verify the number is a faxnumber.

326 Group 2 fax machine detected; remote machine is capableof sending and receiving G2 facsimiles only.

This is a problem with the line, switch, orcard. Contact your support team.

327 Intercept tone detected; remote end originating failure;invalid telephone number or class of service restriction.With the ISDN TR1034, this can also indicate a datalinkmis-match (ptp or pmp).

Possible bad number or phone service isdown. Try dialing the number from anotherphone to verify the number is a fax number.If number is a valid fax number then itcould be a problem with the line, switch, orcard. Contact your support team.

328 After dialing the number, no energy detected on the linefor the wait_for_ced time-out period; possible dead line.

The line is down. Try dialing the numberfrom another phone to verify the number isa fax number. Contact your support teamfor additional assistance.

329 Vacant tone detected; remote originating failure; invalidtelephone number.

Possible bad number. Try dialing thenumber from another phone to verify thenumber is a fax number.

330 Reorder tone detected; end office (PBX) or carrieroriginating failure.

Possible problem with the line coming intothe Server. This will normally be a fastbusy signal. Try dialing the number fromanother phone to verify the number.

331 No circuit detected; end office or carrier originatingfailure, possible dead line.

No line is detected which could be aproblem with the line, switch, or card.Contact your support team for additionalassistance.

339 Fax machine detected; usually a fax CED tone, but alsofax V.21 signals when the remote machine does not send aCED tone before it sends the fax protocol information.

Called a fax machine but it did not send theproper protocol. Could be a problem withthe fax machine that is receiving the fax.Resend the fax.

340 An error occurred due to an unknown cause Error is unknown. Resend the fax. If it failsagain contact your support team.

348 By enabling call progress on an ISDN D channel, one ofthe following values is in the second byte of the FIFObuffer:

• 4: CALL_PROCEEDING: Call is proceedingnormally.

Problem with the line or switch. Contactyour support team.

Cleo Streem® | 29


Code Description Comments• 5: CALL_ALERTING: Ringback detected; remote end

is ringing.• 6: CALL_CONNECTED: Call is connected.• 7: CALL_DISCONNECTED: Call was disconnected.

349 Indicates that a call collision occurred on the ISDN line. Indicates there is a call going out on thesame line as a call coming in. Problem withthe line or switch. Contact your supportteam.

Dialogic Brooktrout hang-up codesHang-up codes identify and provide a description of disconnections that have occurred

The hang-up codes are grouped according to classification (usually by T.30 protocol phase) and provide code valuesin decimal format. Code types described below include:

• Call Placement Codes• Transmit Phase A Codes• Transmit Phase B Codes• Transmit Phase D Codes• Receive Phase B Codes• Receive Phase D Codes• Phase C Codes• Miscellaneous Codes• API-Created Codes

Call placement codes

Value Hang-up Code Description

0 HNG_NORMAL_XMIT Normal and proper end of connection. While thisis considered by the firmware to be a successfulfax transmit result if it occurs in conjunction withBT_STATUS_ERROR_HANGUP it still indicates thatan error has occurred.

1 HNG_RNG_DET Ring detected without a successful handshake.

2 HNG_ABORT Call Aborted.

3 HNG_NO_LOOP_CURRENT No loop current or A/B signaling bits.

4 HNG_ISDN_DISCONNECT ISDN disconnection.

Transmit Phase A Codes


11 HNG_T1_TIMEOUT No answer T.30 T1 timeout.



Transmit Phase B Codes


20 HNG_XMITB_TIMEOUT Unspecified transmit Phase B error.

21 HNG_XMITB_NORM Remote cannot receive or send.

22 HNG_XMITB_MISC COMREC error Phase B transmit.

23 HNG_XMITB_COMREC_VCNR COMREC invalid command received.

24 HNG_XMITB_SE RSPREC error.

25 HNG_XMITB_DCS_FTC DCS sent three times without response.

26 HNG_XMITB_DIS_FTC DIS/DTC received three times; DCS not recognized.

27 HNG_XMITB_TRAINFAIL Failure to train.

28 HNG_XMITB_RSPREC_VCNR RSPREC invalid response received.

29 HNG_XMITB_COMREC_DCN DCN received in COMREC.

30 HNG_XMITB_RSPREC_DCN DCN received in RSPREC.

33 HNG_PHASEB_INCOMPAT_FMT Incompatible fax formats, for example, a page widthmismatch.

34 HNG_XMITB_INVAL_DMACNT Invalid DMA count specified for transmitter.

35 HNG_XMITB_FTM_NOECM Binary File Transfer specified but ECM not enabled ontransmitter.

36 HNG_XMITB_INCMP_FTM Binary File Transfer mode specified but not supported byreceiver.

37 HNG_XMITB_INCMP_EFF Remote does not support EFF page options required byhost.

38 HNG_XMITB_NOEFF Remote does not support EFF page coding.

Transmit Phase D Codes


40 HNG_XMITD_RR_NORES No response to RR after three tries.

41 HNG_XMITD_CTC_NORES No response to CTC or response was not CTR.

42 HNG_XMITD_T5TO_RR T5 time out since receiving first RNR.

43 HNG_XMITD_NOCONT_NSTMSG Do not continue with next message after receiving ERR.

44 HNG_XMITD_ERRRES_EOREOP ERR response to EOR-EOP or EOR-PRI-EOP.

45 HNG_XMITD_RTN_DCN Transmitted DCN after receiving RTN.

46 HNG_XMITD_PPR_EOR EOR-MPS, EOR-EOM, EOR-NULL, EOR-PRI-MPS, orEOR-PRI-EOM sent after fourth PPR received.

51 HNG_XMITD_SE RSPREC error.

Cleo Streem® | 31



52 HNG_XMITD_MPS_FTC No response to MPS repeated three times.

53 HNG_XMITD_MPS_VCNR Invalid response to MPS.

54 HNG_XMITD_EOP_FTC No response to EOP repeated three times.

55 HNG_XMITD_EOP_VCNR Invalid response to EOP.

56 HNG_XMITD_EOM_FTC No response to EOM repeated three times.

57 HNG_XMITD_EOM_VCNR Invalid response to EOM.

60 HNG_XMITD_RSPREC_DCN DCN received in RSPREC.

61 HNG_XMITD_PPSNULL_NORES No response received after third try for PPS-NULL.

62 HNG_XMITD_PPSMPS_NORES No response received after third try for PPS-MPS.

63 HNG_XMITD_PPSEOP_NORES No response received after third try for PPS-EOP.

64 HNG_XMITD_PPSEOM_NORES No response received after third try for PPS-EOM.

65 HNG_XMITD_EORNULL_NORES No response received after third try for EOR-NULL.

66 HNG_XMITD_EORMPS_NORES No response received after third try for EOR-MPS.

67 HNG_XMITD_EOREOP_NORES No response received after third try for EOR-EOP.

68 HNG_XMITD_EOREOM_NORES No response received after third try for EOR-EOM.

Receive Phase B Codes


70 HNG_RCVB_TIMEOUT Unspecified receive Phase B error.

71 HNG_RCVB_SE RSPREC error.

72 HNG_RCVB_MISC COMREC error.

73 HNG_T2_PNOTREC T.30 T2 timeout expected page not received.

74 HNG_RCVB_T1_TIMEOUT T.30 T1 timeout after EOM received.

75 HNG_NORMAL_RCV DCN received in COMREC. While this isconsidered by the firmware to be a successfulfax receive result if it occurs in conjunction withBT_STATUS_ERROR_HANGUP it still indicates thatan error has occurred.

76 HNG_RCVB_RSPREC_DCN DCN received in RSPREC.

77 HNG_T2_TIMEOUT T.30 T2 timeout expected page received.

78 HNG_RCVB_INVAL_DMACNT Invalid DMA count specified for receiver.

79 HNG_RCVB_FTM_NOECM Binary File Transfer specified but ECM not supported byreceiver.



Receive Phase D Codes


101 HNG_RCVD_SE_VCNR RSPREC invalid response received.

102 HNG_RCVD_COMREC_VCNR COMREC invalid response received.

103 HNG_RCVD_T3TO_NORES T3 timeout; no local response for remote voice interrupt.

104 HNG_RCVD_T2TO T2 timeout; no command received after respondingRNR.

105 HNG_RCVD_DCN_COMREC DCN received for command received.

106 HNG_RCVD_COMREC_ERR Command receive error.

107 HNG_RCVD_BLKCT_ERR Receive block count error in ECM mode.

108 HNG_RCVD_PGCT_ERR Receive page count error in ECM mode.

109 HNG_RCVD_EOR EOR received in phase D.

110 HNG_RCVD_RNRTO Timeout while repeating RNR.

Phase C Codes


150 HNG_RCVC_EOL_TIMEOUT No EOL received in a 5-second period.

151 HNG_RCVC_BAD_MMR Bad MMR data received from remote.

Miscellaneous Code


240 HNG_INTERRUPT_ACK No interrupt acknowledgetimeout.

241 HNG_COMM_FAULT Loop current still present while playing recorder toneafter timeout.

242 HNG_T30_HOLDUP T.30 holdup timeout.

243 HNG_HOLDUP_DCN DCN received from host in receive holdup section forFAX PAD mode.

244 HNG_HOLDUP_DCN_NON_FPAD DCN received from host in receive holdup section fornon-FAX PAD mode.

API-Created Codes


500 HNG_ERROR_INTERRUPT An error interrupt occurred indicating a problem with thechannel too severe to continue.

Cleo Streem® | 33



501 HNG_INTERRUPT_OVERRUN The application was unable to process incominginterrupts/commands fast enough and information waslost. See LINE_INTR_OVERRUN in Macros section ofVolume 1, Chapter 6.

502 HNG_UNEXPECTED_IRSDONE The channel generated an unexpected 03 (reset done)or 7F interrupt indicating the existence of a firmware orhardware problem.

503 HNG_IOCTL_ERROR An API command to the driver returned an errorindicating that the driver or the operating systemdetected an error.

504 HNG_OVERLAY_DLOAD_ERR Error reported at termination of fax overlay download.

505 HNG_MAX_TIMEOUT Maximum timeout exceeded. This code occurs when theuser configuration file parameter max_timeout has beenenabled and the specified timeout has expired

Troubleshooting FAQ

Problem: I didn’t receive my confirmation. Did my fax go through?

Solution: Cleo Streem has two separate processes for handling faxes and confirmations. It is possible that the faxhas been sent, and that only the process that sends the confirmation failed. Under normal circumstances, you shouldalways receive a confirmation. To verify that your fax was successful, go to the Cleo Streem Reporting web pages athttp://<STREEM_SERVER_NAME>/streemalert/status.php. Contact your Cleo Streem Administratorif you need the name of the Cleo Streem server.

Problem: Where can I find copies of my faxes in case I need to reprint one?

Solution: Copies of all inbound faxes are kept in <STREEM_FOLDER>\Documents\Inbound where<STREEM_FOLDER> is the path to the Cleo Streem installation. Note the following:

• You will have to work with your Cleo Streem Administrator, Cleo Support, or both to gain access to this folder.• The date and time on the fax will match the date and time of the corresponding file in this folder.• Files are retained in this folder only for a fixed number of days. The default is three days, however, it may be

different at your location. To inquire about or change this default, contact your Cleo Streem Administrator.

Problem: I see an error that says, “get optout” in the Event Monitor. Is my server still working?

Solution: Yes, your server is still working. Cleo Streem is required, by Federal Law, to put an “opt-out” numberon every fax. This number must be set-up by the customer and configured within Cleo Streem. If this setting isblank, Cleo Streem prints out a warning message in the Event Monitor for every outgoing fax. However, faxing willcontinue as normal.

Problem: Outbound faxes aren’t going out, what should I do?

Solution: There are several possible causes:

• All outbound faxing is down:



• Make sure Cleo Streem is running.• Make sure all Cleo Streem “job” processes are running, including the following:

• job_alert.exe• job_prepare.exe

• Make sure ports are enabled in Cleo Streem.• Make sure the Cleo Streem Fax printer exists and is set as the default.• Check to see if there is an actual job corresponding to the fax in the Cleo Streem system. If not, then the fax is

not making it to Cleo Streem.• If there is a job in the system, look at its current status. Here are the possible values for status:

Code Status Comments

10 Adding

12 Submitted Job was successfully submitted and should beprocessed by Cleo Streem Center

20 Preparing Job is being prepared by Cleo Streem Center

25 Prepared

40 Ready Destinations are ready to be sent for this job

60 Holding

65 Routed

70 Sending Primary Fax transmission is in progress

75 Sending Secondary

90 Telex

95 Purged (Marked for Deletion)

100 Completed Jobs with status > 100 are considered complete andshould generate a confirmation

110 Error

120 Canceled

130 Failed

140 Aborted

200 Completed-VM

• Outbound email faxing is down:

• Check if the Cleo Streem Fax-Outbound workflow is enabled.• Check if the Cleo Streem SMTP Server is running.

1. Use Windows Control Panel to view a list of services2. Check the list of services for Cleo Streem SMTP Server, and make sure its status is Started.

• Check if the Cleo Streem “Connector” is setup properly on your mail server.• Outbound Xerox faxing is down:

Cleo Streem® | 35


• Check if the Cleo Streem Xerox Parser is running. If it is running, it displays an icon in the Windows systemtray.

• Make sure that the Xerox device(s) are able to deliver scanned files to Cleo Streem. These files are delivered inthe folder <STREEM_FOLDER>\ftp\in. If no files are getting there:

• Make sure that the IP address and/or hostname for the Cleo Streem server has not changed.• Make sure that the FTP username and/or password for the Cleo Streem server has not changed.• Make sure that other settings for FTP/repository locations are setup correctly for Network Scanning or Server

Fax on the Xerox device.• Make sure that the Xerox device is connected to the network and working properly in other ways.

Problem: Inbound faxes aren’t coming in, what should I do?

Solution: Let’s look at different cases again:

• All inbound faxing is down:

• Check if Cleo Streem is running.• Check if ports are enabled in Cleo Streem.• Check if the Cleo Streem Fax-Inbound workflow is enabled.• Check if there are error messages in the Event Monitor.

• Inbound email faxing is down:

• Make sure that the IP address and/or hostname of your email server – which Cleo Streem uses to deliver faxesvia email – has not changed and responds to a ping command from the Cleo Streem server.

• Inbound Xerox faxing is down:

• Make sure that the IP address and hostname of your email Xerox devices have not changed and respond to aping command from the Cleo Streem server..

• Make sure that the Xerox device(s) effected are turned on and not having other problems.

Problem: My Xerox device isn’t printing faxes, what should I do?

Solution: Make sure that:

• The Xerox device has paper, and is not having other problems.• The IP address for the device is defined correctly within Cleo Streem. You can check this by going to the

appropriate web page under Cleo Streem Alert administration.• Make sure you are looking for the fax on the correct Xerox device i.e. the inbound number is assigned to this

Xerox device.

Problem: A person called me and said they sent me a fax, but I did not receive it. How can Idetermine whether it was delivered or not?

Solution: You can use the Cleo Streem reporting web pages to verify whether a fax was received by Cleo Streemor not, and if so, for which number. In addition, your Email Administrator can help determine whether an email,containing the fax, was delivered to you.

Problem: Why do I get failures on numbers that I send to?

Solution: Make sure that the numbers that are failing are valid fax numbers. Look carefully at the error code/description you are getting in the confirmation email. Are you getting the same error code for all your failures? Ifthis doesn’t help, report the error codes to your Cleo Streem Administrator or Cleo Support. If you have attachments,open the attachment and print the attachment before submitting the fax to make sure the document doesn’t generate



a dialog box (i.e. document is larger than the printable margins, which opens a dialog box that needs to be clickedon before it finishes processing, document is able to be opened and not corrupt). If you see an error related to thedocument, fix it before submitting it. This will help make sure your broadcasts are successful and trouble-free

Problem: Why are my faxes not printing correctly, for example the print out shows the fax cut inhalf?

Solution: Look at the TIFF file received by Cleo Streem. If that file looks the same as what is being printed, have thesender re-transmit the fax. In case the received file looks fine, please check the size (height x width) and the papersize it is being printed on. Do these sizes match?

Problem: Why am I not receiving a job completion email?

Solution: You will not get the confirmation email until the job is complete. If you think the job is taking an unusuallylong time, see problem and solution for outbound faxes not going out.

Problem: Why am I receiving duplicate faxes?

Solution: Verify that the information was not faxed to you multiple times. Report duplicate fax problems to CleoSupport.

Problem: I always reply to the email when I get a fax and I don’t get an email back?

Solution: You cannot and should not reply to the fax-email sent from Cleo Streem, as we use an “auto” e-mailaddress as the sender for these emails. Instead, you can forward these emails.

Problem: Why is my fax double-sided?

Solution: Some Xerox devices, such as WorkCentre 7665, have a firmware problem where they default to printingfaxes in double-sided mode. There is a patch that resolves this issue. Please contact your Xerox Analyst and havethem check their SPAR database for the firmware upgrade for the device.

Problem: My job is stuck in Job Status. Why is it not going out?

Solution: Please refer to the above problem and solution for outbound faxes not going out.

Problem: Why can't I dial an international number?

Solution: Please check with your long-distance phone company to see if they are blocking international numbers.Cleo Streem does not treat international numbers in a special way. Also, your Cleo Streem Administrator or CleoSupport can make sure that number normalization is set-up properly for international dialing.

Problem: How do I determine if Cleo Streem is running?

Solution: Make sure your T1 connection is functional and that all of the Cleo Streem processes shown below arerunning.

Cleo Streem® | 37


Problem: I receive a conversion timeout (.pdf) when sending a fax from my desktop. How can I fixthis?

Solution: Verify the PDF attachment is not password protected or corrupted. Also, verify that Adobe Reader(installed on Cleo Streem Server) is not set to automatically update as this will cause conversion errors. Additionally,you can end any Adobe processes in the Task Manager under processes.

Problem: I am receiving a conversion time out (.tiff) when sending a fax from my desktop. How canI fix this?

Solution: Open Windows Explorer on the fax server and go to Streem\Documents. Look at the tiff files – right clickthe tiff file and click print. It should be sent to the Cleo Streem Fax printer. Open Streem\Converted and open theconverted .tif there. If the tiff file associations are working, this should be the same document you just right-clicked and printed. If it isn’t and there isn’t an icon associated with the tiff file, open Microsoft Office DocumentImaging and go to Tools > Options > Other and click the Reset button to set tiff file associations back to thisprogram. You can right-click print to check that other document types such as pdf, bmp, jpg, doc, etc. are printingproperly as well.

Problem: I am getting a conversion error when sending an Office document as a fax attachment.The error says conversion timeout (.docx). How can I fix this?

Solution: This error generally indicates that users are sending newer Office 2007 documents and the Cleo Streemserver is running an older version of Office such as 2003 and there is no file association for this document type on theserver. You can open Windows Explorer and go to file associations and look for docx or xlsx file types to confirm



this. To remedy this you can either use Microsoft Update to install the Office 2007 compatibility pack on the faxserver. The best way to resolve this is to upgrade to the latest version of Office on the fax server.

Problem: Our Exchange server has changed to Exchange 2007 and our faxes are not working. Whatdo we do?

Solution: First, a new connector needs to be set up on the new Exchange Server – follow pages 1 through 3 on thisdocument: http://www.cleo.com/documents/exchange%202007%20fax%20connector.pdf. Then, contact Cleo Supportto have the settings on the server changed to reflect the new IP address or name of the new SMTP server.

Problem: I am trying to use Cleo Streem Print but the cover page never shows up. What do I do?

Solution: Check “Printers and Faxes” and confirm that Cleo Streem Print is listed as a printer there. If it isn’t, yourCleo Streem Print needs to be reinstalled following the uninstall/install guide supplied to your System Administrator.

Problem: I am receiving a socket error when using Cleo Streem Print. How can I fix this?

Solution: A socket error is received when the wrong port is configured. Open Cleo Streem Print, go to File >Preferences, and click the SMTP server tab. Verify you have the correct port configured with your SystemAdministrator. Also be sure your antivirus software or firewall is not blocking that port.

Problem: I see LOS listed in the Cleo Streem Event Monitor and incoming and outgoing faxes donot appear to be working. What should I do?

Solution: LOS means the T1 has Loss of Signal and you should contact your telecom provider to have them check theT1. After your telecom provider has fixed the T1, you can contact Cleo Support and they will help you verify the T1is functioning properly.

Problem: I added a fax number to Active Directory for a new user and sent a test but he/she hasn’treceived my test. How do I fix this?

Solution: When adding a fax number to AD, a workflow on the Cleo Streem server is set to run every 30 minutesor every hour. This means you either need to wait for the workflow to pull this information from AD or you can goto Streem\databases\Sync and double-click the getfaxusers.cmd to run the synchronization immediately. Trytesting after the sync has run. The user should now receive the document in their inbox.

Problem: I need to add new users in Cleo Streem Notify but I don’t remember how to get there orthe login to do this. How can I get to Cleo Streem Notify?

Solution: The URL to get to Cleo Streem Notify is generally http://servername/streemalert/ . You need to replace‘servername' with either the fax server name or IP address. The default administrator login and password can beobtained by contacting [email protected] or by calling the support number at 888-724-1030.

http://www.cleo.com/documents/exchange%202007%20fax%20connector.pdf

http://servername/streemalert/

concepts/mailto:[email protected]

39

7About Cleo Streem and the Common Alerting Protocol(CAP)

Data interchange with Cleo Streem is based on the Common Alerting Protocol (CAP) Standard.

The CAP standard is an XML-based data structure created as a means to standardize data for critical communications.CAP is approved by the Organization for the Advancement of Structured Information Standards (OASIS) a non-profit, international consortium that oversees the development, convergence, and adoption of e-business standards.The CAP standard is used by organizations such as National Oceanic And Atmospheric Administration (NOAA) andDisaster Management Interoperability Services (DMIS) to disseminate emergency/critical information. The full CAPspecification is available at http://www.oasis-open.org/specs/index.php#capv1.1.

Cleo Streem input data files consist of four components: Alert, Info, Resource, and Area. The Cleo Streem output datauses the Cleo Streem Reporting XML scheme embedded in an EDXL Distribution Element.

Cleo Streem uses a workflow called Cleo Streem-CAP-Interface to handle XML files in the CAP format. On seeing anew CAP file, the workflow calls the Cleo Streem CAP Parser. The Parser extracts information contained in the CAPfile and, if the information is complete and valid, reformats it into a file suitable for input to the Cleo Streem API. TheCleo Streem API then uses this information to submit a job to the Cleo Streem system.

About the Cleo Streem data interface

Data interchange with Cleo Streem is based on the Common Alerting Protocol (CAP) standard. There are two datafiles Cleo Streem handles: the input data file and the response data file. Each of the data files has a unique structure.

About the Cleo Streem input data fileThere are four main components to the data file passed as input to Cleo Streem: Alert, Info, Resource, and Area.

The Alert component is the parent component of the data file and is required. The Info component, though notrequired by CAP, is required for interfacing with Cleo Streem and is the main information component. The Resourcecomponent is optional and is used by Cleo Streem for message attachments. The Area component is optional and isplanned for future Cleo Streem handling of geographic contact information. Following is a high-level view of thestructure of the components:

<alert> <info> <eventCode> <valueName></valueName> <value></value> </eventCode> <resource> </resource> <area> </area> </info>

http://www.oasis-open.org/specs/index.php#capv1.1


About Cleo Streem and the Common Alerting Protocol (CAP)

</alert>

Alert component

The Alert component comprises the following elements:

Element Name Required Notes

Identifier Yes Unique identifier for this message(cannot contain “<”or “&”)

Cleo Streem format:username_dateTime

Sender Yes Globally unique identifier of theinitiating user.

Cleo Streem format: user'semail address

Sent Yes Date and time message was createdin dateTime format (20060130T16:3006: 00). Timezones followthe time and are in the format,+/-00:00

Status Yes Cleo Streem acts on the data fileidentically regardless of the value ofthe Status element. CAP Standardcode values are:

Actual - Actionable by alltargeted recipientsExercise - Actionable only bydesignated exercise participatns;exercise identifier should appearin <note>.System - For messages thatsupport alert network internalfunctions.Test - Technical testing only. allrecipients disregard.Draft - A preliminary tempalte ordraft, not actionable in draft form.

msgType Yes Cleo Streem supports only "Alert".CAP standard code values are:

Alert - Initial informationrequiring attention by targetedrecipients.

Cleo Streem® | 41



Update - Updates and supersedesany earlier messages identified inthe <references> element.Cancel - Cancels any earliermessages in the <references>element.Ack - Acknowledges receipt andacceptance of the messages inidentified in the <references>element.Error - Indicates rejectionof the messages in identifiedin the <references> element;explanation should appear in<note> element.

Scope Yes Cleo Streem supports only "Public".CAP standard code values are:

Public - For generaldissemination to unrestrictedaudiences.Restricted - For disseminationonly to users with a knownoperation requirement. See<restriction>.Private - For disseminationonly to specified addresses. See<address>.

Info component

The Info component comprises the following elements:


Language No Language identifier per RFC3066. If not present, the implicit defaultvalue is en-US. Null value is also considered the default value ofen-US.

Cleo Streem supports only the default.

Category Yes Cleo Streem acts on the data file in the same way regardless of thevalue present here.

• Geo - Geophysical (inc. landslide)• Met - Meteorological (inc. flood)• Safety - General emergency and public safety• Security - Law enforcement, military, homeland and local/

private security




• Rescue - Rescue and recovery• Fire - Fire suppression and rescue• Health - Medical and public health• Env - Pollution and other environmental• Transport - Public and private transportation• Infra - Utility, telecommunication, other nontransport

infrastructure• CBRNE – Chemical, Biological, Radiological, Nuclear or

HighYield Explosive threat or attack• Other - Other events

Event Yes The text denoting the type of the subject event of the alert message.

Cleo Streem usage: Title of Broadcast

Urgency Yes Cleo Streem acts on the data file in the same way regardless of thevalue present here.

This element uses the following CAP Standard codes:

• Immediate - Responsive action SHOULD be taken immediately• Expected - Responsive action SHOULD be taken soon (within

next hour)• Future - Responsive action SHOULD be taken in the near future• Past - Responsive action is no longer required• Unknown - Urgency not known

Severity Yes Cleo Streem acts on the data file in the same way regardless of thevalue present here.


• Extreme - Extraordinary threat to life or property• Severe - Significant threat to life or property• Moderate - Possible threat to life or property• Minor - Minimal threat to life or property• Unknown - Severity unknown

Certainty Yes Cleo Streem acts on the data file in the same way regardless of thevalue present here.


• Observed – Determined to have occurred or to be ongoing.• Likely - Likely (p > ~50%)• Possible - Possible but not likely (p <= ~50%)• Unlikely - Not expected to occur (p ~ 0)• Unknown - Certainty unknown

Cleo Streem® | 43



eventCode Yes (Cleo Streem) Name-Value pairs used by Cleo Streem to denote distributionmethod and recipient addresses. See eventCode detail on page43

Effective Yes (Cleo Streem) Date and time in dateTime format (20060130T16: 3006: 00).Timezones follow the time and are in the format, +/-00:00

Cleo Streem usage: Scheduled date/time

senderName Yes (Cleo Streem) Cleo Streem usage: user’s full name

Headline Yes (Cleo Streem) Cleo Streem usage: subject line for nonvoice messages

Instructions Yes (Cleo Streem) Cleo Streem usage: message body or message id in theformat MessageID=xxx where xxx is the message ID

Parameter Yes (Cleo Streem) ValueName/Value pairs used by Cleo Streem to denote distributionmethod and recipient addresses. See parameter detail on page 44

eventCode detailThe eventCode elements define the distribution method and recipient addresses for the given distribution method.

This is handled in the data file by means of the eventCode tag and child tag pairs, valueName and value.There must be at least one valueName/value pair and a valueName/value pair for each distribution methodrequired for the message. The valid valueName codes are listed below. The value data is a semicolon delimited list ofrecipient addresses in the form dictated by the distribution method set in the valueName element.

valueName codes Value format

Fax Semicolon-delimited list of fax numbers (numeric only.)

Example: 1234567890;8113456732

Email Semicolon-delimited list of email addresses.

Example: [email protected];[email protected]

Phone Semicolon-delimited list of phone numbers (numeric only.)

Example: 1234567890;8113456732

Cell Semicolon-delimited list of cell phone numbers (numeric only.)

Example: 1234567890;8113456732

SMS Semicolon-delimited list of messaging addresses.

Example: [email protected]

Pager Semicolon-delimited list of pager numbers (numeric only.)



valueName codes Value format

Distribution Distribution list ID

UserName Semicolon-delimited list of user names.

Example: johnDoe;JDoe

EDXLResponse File name for EDXL Response file. Use unique identifier tag and .xml.

parameter detailThe parameter elements define the remaining information for a Cleo Streem broadcast.

The parameter valueName/value pairs are dependent on the eventCode elements in the data file. The followingtable details the valid valueName/value pairs for each eventCode valueName. Note that all of theseelements are optional.

eventCodevalueName

ParametervalueName code

Description

Fax Resolution Possible values:

1 - normal resolution2 - high resolution

If no value is present, Resolution defaults to 1.

Fax CoverPage Possible values:

null or blank - company defaultCompany - company-specified cover pageDept - department-specified cover pagenone - no cover page

If no value is present, CoverPage defaults to Company.

All eventCodes ConfirmationTo The name of the person that will receive the confirmation.

All eventCodes ConfirmationEmail The email address of the person to receive the broadcastconfirmation.

If no value is present, then no confirmation is sent.

All eventCodes Priority Possible values:

1 - high priority5 - normal priority9 - low priority

If no value is present, Priority defaults to 5.

All eventCodes BillingCode Alphanumeric value for billing purposes.

Cleo Streem® | 45


eventCodevalueName

ParametervalueName code

Description

EDXLResponse EDXLFileName File name for creation of EDXL response data.

All eventCodes BatchID Alphanumeric value.

Distribution Can be any of the above parameter valueName/value pairs,depending on the distribution methods within the distribution list.

Resource componentThe Resource component is typically used for related information, such as remote documentation. In the case ofStreem, it is used for attachments for non-voice (for example, fax and email) messages.

If a broadcast job does not require attachments, then this component can be left out entirely. The following chartdetails the elements that make up the Resource Component when the broadcast requires one or more attachments.


resourceDesc Yes Text describing the content and typeof file.

Uri Yes (Cleo Streem) File name of the attachment.Attachment must be in the samedirectory as the data file.

Sample XML file

<?xml version="1.1" encoding="UTF-8" standalone="yes"?> <alert xmlns="http://www.incident.com/cap/1.1"> <identifier>mach_c8beda0f-a196-11dd-8304-b9be87d0703ci</identifier> <sender>[email protected]</sender> <sent>2006-03-14T16:50:15-08:00</sent> <status>Actual</status> <msgType>Alert</msgType> <scope>Public</scope> <info> <language>en-US</language> <category>Other</category> <event>Streem Center Fax</event> <urgency>Immediate</urgency> <severity>Minor</severity> <certainty>Possible</certainty> <eventCode> <valueName>FirstName</valueName> <value>Joe</value> <valueName>LastName</valueName> <value>Recipient</value> <valueName>Fax</valueName> <value>0114545821644</value> </eventCode>



<effective>2006-03-14T16:50:15-08:00vi</effective> <senderName>John Sender</senderName> <headline>Streem Center Fax</headline> <instructions>You have received a fax from Streem Center </instructions> <parameter> <valueName>ConfirmationEmail</valueName> <value>[email protected]</value> </parameter> <parameter> <valueName>Priority</valueName> <value>5</value> </parameter> <parameter> <valueName>BillingCode</valueName> <value>ABS12345</value> </parameter> <resource> <resourceDesc>Fax Document</resourceDesc> <uri>c8beda0f-a196-11dd-8304-b9be87d0703c.pdf</uri> </resource> </info> </alert>

About the Cleo Streem response data fileThe Cleo Streem system supplies output data using the Cleo Streem Reporting XML scheme embedded in an EDXLDistribution Element.

Cleo Streem utilizes the main EDXL Distribution Element and the optional contentObject Container Element. TheCleo Streem XML data is contained within the contentObject Container.

For complete information about the EDXL Distribution Element, refer to http://docs.oasis-open.org/emergency/EDXL-DE/V1.0.

EDXLDistribution element


EDXLDistribution Yes This is the container for all of the elements related to the distributionof content messages.

distributionID Yes Unique Identifier of this distribution message.

Cleo Streem usage: JobNumber_dateTime .

senderID Yes Globally unique identifier of the initiating user.

Cleo Streem usage: original broadcast initiator’s email address

dateTimeSent Yes Date/Timeof message creation in dateTime format (20060130T16:3006: 00).

http://docs.oasis-open.org/emergency/EDXL-DE/V1.0

http://docs.oasis-open.org/emergency/EDXL-DE/V1.0

Cleo Streem® | 47



Time zones follow the time and are in the format, +/00: 00.

distributionStatus Yes Actionability of the message. Must be one of the following:

Actual – Real world information for actionExercise – Simulated information for exercise participantsSystem – Message regarding or supporting network functionsTest – Discardable message for technical testing

Cleo Streem Usage: Actual

distributionType Yes The type of message. Must be one of the following:

• Report – New information regarding an incident or activity.• Update – Updated information superseding a previous message.• Cancel –A revocation of a previous message.• Request – A request fo rresources, information, or action.• Response – A response to a previous request.• Dispatch – A commitment of resources or assistance.• Ack –Acknowledgment of receipt for earlier message.• Error – Rejection of an earlier message (technical issue).

Cleo Streem Usage: Report

distributionReference Yes (Cleo Streem) A reference to a previous distribution message.

Cleo Streem Usage: Unique identifier

This comes from the identifier tag in the XML input file used toinitiate the broadcast.

contentObjectThe EDXL contentObject element is mandatory for Streem.


contentObject Yes This is the container for all of the elements related to the messagecontent.

xmlContent Yes (Cleo Streem) The container for XML data.

embeddedXMLContent

Yes (Cleo Streem) Open container for XML content.

Streem Reporting XML dataThe Streem Reporting XML schema is used to report the status details for a submitted broadcast.

The Streem schema contains three main sections.



1. Broadcast job summary data - provides the summary data for the broadcast as a whole and occurs only once in themessage.

2. Recipient data - provides details for each recipient. The Recipient Section is repeated for each recipient in thebroadcast.

3. Acknowledgements data - a subsection of the Recipient data comprising the question, the digit chosen, and itscorresponding text. Since there can be multiple acknowledgements, there could be multiple Acknowledgementssections.

Broadcast Job summary section


Summary Yes This is the container for all of the elements related to the summarydata.

JobNumber Yes This is the internal job number assigned to the broadcast uponinitiation.

Title Yes (Cleo Streem) The title of the original broadcast.

Subject Yes The subject used in email or fax recipients

NumberRecipients Yes The total number of recipients of the broadcast.

NumberPages No The total number of Fax pages.

Successful Yes The number of messages successfully delivered in the broadcast.

StatusId Yes The final status ID of the broadcast. See StatusId and ResultIdcodes and related status or result values on page 51 for possiblevalues.

StatusText Yes The final status text associated with the StatusID. See StatusId andResultId codes and related status or result values on page 51 forpossible values.

Acknowledgements Yes Boolean value indicating whether or not acknowledgements wererequired.

ConfCall Yes Boolean value indicating whether or not a conference call wasincluded in the broadcast.

Cleo Streem Recipient section


Recipient Yes The container for all of the elements related to each of the individualrecipients.

Cleo Streem® | 49



DestinationId Yes The destination ID that uniquely identifies the destination in thebroadcast.

Name Yes The recipient’s name.

Address Yes The destination address for the recipient. Can be a phone number,fax number, email address, or text message address.

Type Yes Indicates what type of destination this recipient has (cell, phone, fax,email, text message, pager).

ResultId No Result Code. See StatusId and ResultId codes and related status orresult values on page 51 for possible values.

Result Yes The success or failure of delivery to the recipient. See StatusId andResultId codes and related status or result values on page 51 forpossible values.

Acknowledgment Conditional If acknowledgments were required in the original broadcast, this isthe container for the acknowledgments.

ConfCallResponseDigitConditional If a conference call was included in the original broadcast, this is thedigit selected.

ConfCallResponseText Conditional If a conference call was included in the original broadcast, this is thetext association with the digit selected.

Attempts Yes A numberindicating how many attempts were used to contact therecipient.

Attempted Yes Date and time of the last attempt.

Acknowledgment section


Acknowledgement Yes The container for all of the elements related to acknowledgments.

Question Yes The original question posed.

Digit Yes The digit selected in response to the question.

Text Yes The text of the answer associated with the digit selected.

Sample response file

<EDXLDistribution xmlns="urn:oasis:names:tc:emergency:EDXL:DE:1.0">



<distributionID>18301_20060101010000</distributionID> <senderID>[email protected]</senderID> <dateTimeSent>20060101T01:00:0005:00</dateTimeSent> <distributionStatus>Actual</distributionStatus> <distributionType>Report</distributionType> <contentObject> <xmlContent> <embeddedXMLContent> <Summary xmlns = "urn:Streem:names:Report:1.0"> <JobNumber>18301</JobNumber> <Title>Demo Broadcast</Title> <Subject>Demonstration</Subject> <Submitted>20060531T022:10:3405:00</Submitted> <NumberRecipients>2</NumberRecipients> <NumberPages>5</NumberPages> <Successful>2</Successful> <StatusId>100</StatusId> <StatusText>Complete</StatusText> <Acknowledgements>True</Acknowledgements> <ConfCall>True</ConfCall> <Recipient> <DestinationId>1</DestinationId> <Name>John Doe</Name> <Address>5551230987</Address> <Type>Cell</Type> <ResultId>100</ResultId> <Result>Success</Result> <Acknowledgement> <Question>Are you available for a meeting on Monday?</Question> <Digit>1</Digit> <Text>Yes</Text> </Acknowledgement> <ConfCallResponseDigit>1</ConfCallResponseDigit> <ConfCallResponseText>Will Attend</ConfCallResponseText> <Attempts>2</Attempts> <Attempted>20060531T022:11:1705:00</Attempted> </Recipient> <Recipient> <DestinationId>2</DestinationId> <Name>Jane Doe</Name> <Address>[email protected]</Address> <Type>Email</Type> <Result>Success</Result> <Attempts>1</Attempts> <Attempted>20060531T022:10:4005:00</Attempted> </Recipient> </Summary> </embeddedXMLContent> </xmlContent> </contentObject></EDXLDistribution

Cleo Streem® | 51


StatusId and ResultId codes and related status or result valuesThe value contained by some result or status elements correspond to certain statuses or results.

StatusId or ResultId StatusText or Result

10 Adding

12 Submitted

20 Preparing

25 Prepared

40 Ready

60 Holding

65 Routed

70 Sending Primary

75 Sending Secondary

90 Telex

95 Purged (Marked for Deletion)

100 Completed

110 Error

12 Canceled

130 Failed

140 Aborted

200 Completed-VM

About the Cleo Streem-CAP-Interface workflow

This workflow must be enabled for the entire process to work. Once enabled, it waits for a file to be dropped in the{watch} folder; {watch} is a workflow parameter and defaults to <Streem_folder>\ftp\in. Once a CAP fileis detected in the watched folder, the workflow processes the file as follows:

• Copies the CAP file to <Streem_folder>\temp\ScCAP• Invokes the Cleo Streem CAP Parser by calling <Streem_folder>\scripts\ScCAP\ScCAP.py• Runs a command file that copies attachments, if any, referenced in the CAP file to <Streem_folder>\temp

\ScSubmit• Invokes the Cleo Streem API to submit a job that is then picked up and handled by Cleo Streem Center. In case an

error is encountered during any of the above steps, the workflow sends an appropriate message to the SCleo treemEvent Monitor and quits.



Cleo Streem CAP Parser (ScCAP.py)The Cleo Streem CAP Parser is the application that actually processes the CAP file, extracting Cleo Streem job datafrom it.

The parser takes CAP file as input and creates the following artifacts:

• A control (.ctl) file in the format accepted by the Cleo Streem API.• A command (.cmd) file that contains commands to copy attachment files, if any, specified in the CAP file.• A recipient (.csv) file that contains a list of recipients specified in the CAP file.• A message (.out) file that contains the exit status number and message.

UsageScCAP.py -o output_ctl_file -i input_cap_file -d recipient_csv_file -c cmd_file -m msg_file-o output_ctl_file

Required. Specifies the path to the output .ctl file.

-i input_cap_fileRequired. Specifies the path to the input .xml file

-d recipient_csv_fileRequired. Specifies the path to the .csv file containing recipients

-c cmd_fileRequired. Specifies the path to the .cmd file, which copies attachments.

-m msg_fileOptional. Specifies the path to the .out status message file. Default value is %TEMP%\ScCAP.out.

Status (.out) messages

The output file will always be two lines:

1. Result code2. Message

Result code Message

0 Success

1 Error - General

51 Error - No input XML file specified

52 Error - No output CTL file specified

53 Error - No output CMD file specified

54 Error - No output CSV file specified

99 Debug - Early exit for testing

Streem API (ScSubmit.py)The Cleo Streem API processes the control and recipient files generated by the CAP Parser.

The data specified in these files is packaged as Cleo Streem job data and written to the Cleo Streem database.

Cleo Streem® | 53


UsageScSubmit.py -o output_msg_file [-i input_ctrl_file ] [-m msg_id | -l list_id] [-u user_id]-o output_msg_file

Required. Specifies the path to the .OUT status message file

-i input_ctrl_fileUsed for normal processing/submission of a job. When you specify -i, the only other flag consideredis -o.

-m msg_idUsed to check if the specified user has access to specified message. Cannot be used with -l option.

-l list_idUsed to check if the specified user has access to specified distribution list. Cannot be used with -moption.

-u user_idOnly required if –m or –l is specified.

Status (.out) messages

The output file will be two or three lines:

1. Result code2. Message3. Job number for the newly added job if the job was submitted successfully; that is, the job number must only be

used if the message number (first line) is 0.

Result code Message

0 Success

1 Error - General

2 Error - Text destination(s) selected but the messagespecified is voice only

3 Error - Voice destination(s) selected but the messagespecified is text only

4 Error – Specified user does not have access to thespecified message

5 Error - Specified user does not have access to thespecified distribution list

6 Error - Specified message not found

7 Error - Specified distribution list not found

51 Error - Specified User not found

52 Error - flags '-m' and '-l' are exclusive, only one can bespecified at a time

53 Error - No output CMD file specified

54 Error - invalid combination of flags specified



Result code Message

99 Debug - Early exit for testing