Configuring MailOut in StreamServe 5.6.2 & 5.6.1

Streamserve is a knowledge management software package, dedicated to providing users with several different document management options (such as presentation, management, creation, etc.), as well as the ability to connect with other applications as well. It also provides options for distributing content as well, through sending it out via several different options (such as email and fax).

This document details out the walkthrough of settings that is needed to configure a mail to be sent on completion of a job for StreamServe version 5.6.1 & 5.6.2.

Email output connector

There are three types of configurations for sending emails:

• A standard Process and an email connector.

• A MailOUT Process and an email connector.

• A MailOUT Process, a PageOUT Process and a Topcall connector.

This document will walkthrough for a MailOUT process and an email Connector method.

MailOUT Process and email connector

This type of configuration includes a MailOUT Process, an email connector and

optionally a standard Process. The output from the MailOUT Process is an email.

To this email you can attach files from disk and output from other Processes. The

email is sent via an email connector to a mail server. Which connector to use

depends on the type of mail server. This is the most effortless method if you only

want to attach files on disk to an email, or send plain information in the email

body.

Lets get started:

Platform

For configuring the platform for engaging e-mail we need to add a new output connector for mail.

  

Here are the steps:

1. Double click on the platform on your project browser for it open in the editor.
2. Rightclick on the platform,hover to “New Output Connector” and click on “MailOUT-dependant”.

     3. Rename the Output connector ,in this example its “MailOut”

      

   4. Right Click on the MailOut Connector and Click on settings.

   5. Click on the Selected Layer dropdown and working Platform, “Dev(Physical)” in this

example.

   6. Select “SMTP(MIME) for Mail Out” from the connector dropdown.

   7. Enter the mail server to be used and the domain name.

Message

The example already consists of an XMLIN event and a StoryTeller process. In addition to

that for configuring mail we need to another process(MailOut) to the message.

Below are the steps for it:

1. Double click on the message on your project browser for it open in the editor.

2. Rightclick on the Message,hover to “Add Process” and click on “MailOUT”.

 3. Rename the Process,in this example its “MailOut”.

 4.    Double Click on the “MailOut” Process to open the Mail editor.

MailOUT Process reference

            From

            Standard email attribute.

            Display name

            The display name. Only applicable to SMTP (MIME). The From address is replaced by this name when   the email is delivered to the recipient. This functionality must be supported in the email client.

            Reply to

            The address to reply to. Only applicable to SMTP (MIME). Used by the email recipient instead of the From address when responding to an email.

            To

            Standard email attribute.

            Cc

            Standard email attribute.

            Bcc

            Standard email attribute.

            Subject

            Standard email attribute.

            Request receipt

            Request a delivery receipt. A notification is received when the email is delivered.This functionality must     be supported by the email servers and clients.

            Attachments

            Files to add as attachment to the email. Use the Add/Edit buttons to configure the settings. See Mail attachment settings below.

            Mail attachment settings

            Attachment

            The path to the file to attach.

            Attachment name

            The name of the attachment. Leave this empty if you want the attachment name to be the same as the name   of the source file.

            MIME type

            The MIME type (content-type) of the attachment. Only applicable to SMTP (MIME).

            • Predefined – Select the MIME type from the Value drop-down list.

            • Custom – Enter a custom MIME type in the Value field..

            Convert attachment from PCL to PDF

Select to convert a PCL attachment to PDF.

            Compress attachment

            Select to compress the attachment

Runtime

In the runtime the process and the message as we added them already would appear and

needs to be connected.

Note that the processes are executed in sequence in the order from top to bottom in the

runtime view. It is important that you place the story teller process on top of the mail as the

output pdf has to be generated and would trigger the email connector to fetch the attachment

from the first process or send the mail.

Here the steps for the above:

1. Double click on the Runtime on your project browser for it open in the editor.

2. Connect the “MailOut” Process to the “MailOut” output Connector by dragging and

dropping.

Output/Email Example:

  To test the project, simply drop a copy of the sample file into the “in” directory in the wd of your application. If you have configured the mail server settings and address correctly, you should receive a mail like this:

Conclusion:

           

One can create unpaginated output from a StoryTeller Document, for use in an email body. This output stream has all data (Substitutions, Repeaters etc) and scripts evaluated.
To enable this, you must connect the StoryTeller Process to the HTML unpaginated driver. When this driver is connected, the Story defined at the top of the Stories panel is used. As any Story, this can contain e.g.:

·   Story references that link to other Stories. This way you can include all your Stories in the Document by referencing them from the first Story.

·   Substitutions that link to external content, e.g. Composition Center Sections. 

Basics of Project Creation- StreamServe 5.6.1 & 5.6.2

All technologies start from ‘Hello World!’; our journey will start from creating a project using xmlIn & creating simple PDF. The below steps are for StreamServe version 5.6.2 & 5.6.1.

Create a new project in StreamServe

1. In Design Center, select “Create new project”

2. In Project Settings dialog box,specify the following:
a) Project name- Demo_xmltopdf_billgeneration
b) Default code page:(None)
c) Default Resource set: Demo_xmltopdf_billgenerationRset
d) Project folder: Anywhere on your harddisk.
e) Click OK

3. Right-Click the project and select New–> Folder to create a folder named Resources.

4. Drag and Drop the Rset into Resources folder

5. Add folders to the the resource-set
a) In the project browser,click the project. The Resource-set view opens.
b) In the resource-set view,right click an empty space and select New–> Folder
c) Rename the folder to Samplefiles.
d) Similarly create two more folders named, Images and overlay

6. Add the resources to the Resource-set
a) In the resource-set view,right click on the samplefiles folder and select Import.The select file to import dialog box opens.Browse to the sample file and click OK.
b) Add the images and the overlays as resources to the respective folders.

7. Platform Configuration:
The platform is where you configure the environment settings for the project.
a) Add a new folder to the project and name it Platform
b) Right click on folder and select New-> Platform. A new generic layer for a platform
is added.
c) Expand the platform generic layer to view the New Physical Layer Object.
d) Rename the platform and the New PhysicalLayer Object.

7.1 Create a new Input connector

7.1.1 In platform view, right click and select New Input Connector.
7.1.2 Rename the new input connector.
7.1.3 Right click the Input connector and select Settings. The Input connector settings dialog box opens.
7.1.4 From the selected layer drop-down list, select Physical(DEV)
7.1.5 Specify the following:
a. Connector type: Directory
b. Folder: C:\Demo_xmltopdf\DEV\IN
c. File name pattern: *.xml
d. Click OK.

7.2 Add output connector to platform
7.2.1 In platform view,right click and select New Output Connector → Generic
7.2.2 Rename the output connector.
7.2.3 Right-click OutputFolder and select Settings.
7.2.4 Make sure the generic platform layer is selected.
7.2.5 From the device drop-down list select PDF
7.2.6 From the selected layer drop-down list,select DEV(physical)
7.2.7 In the dialog box that opens,click yes.
7.2.8 From the connector type drop-down list select File.

7.2.9 Specify the following:
a. Connector type: File
b. File:
c. Append:
d. Create Directories: Yes
e. Click OK

8. Configuring a message
The main function of a Message is to transform input documents into output documents.
8.1 Create a new message
a) Create a new folder in the project directory and name the folder Message.
b) Right Click the message folder and select New–> Message
c) Rename the message

8.2 Add the event
a) In the message view, right click and select Add Event → XMLIN.
b) Rename the new Event

8.3 Add the process:
a) In the message view,right click and select Add process → storyteller
b) Rename the new process.

9. Configure Event :
9.1 Open a Sample File
a) In Message view, right-click LetterEvent and select Open. The XMLIN
window Opens.
b) From the File Menu,select Open Sample. The select resource dialog box opens.
c) Browse to the Rset > SampleFiles
d) Browse to the Letter directory and select the sample xml.

9.2 Define a Pattern
a) In the XMLIN tool bar, select the Pattern Tool.
b) In the sample view click on the unique identifier of the document, here

A new pattern object names Patten_DocumentType is added to the Message view.
c) In the properties panel, make sure the following Match Value is as follows:
/DOC/document[@title=’BILL’]

9.3 Define a message tree structure
a) In the XMLIN tool bar, click the Extract Message toolbar button
Fields are automatically created and displayed in both the Message view and in the
sample view.
b) Click Field tool
c) In the XMLIN view, click the XML attributes.The attribute fields appears in the Message panel.
d) Save and exit XMLIN.

10. Configure the process
10.1 Open the new process.
10.1.1 In the message view, right-click LetterProcess and select Open.
10.1.2 A blank page opens where you can design accordingly or use overlays for the design part. You
can add texts, images, tables etc and also drag the fields mapped from input xml onto the pdf.

11. Create new Runtime
11.1 Create a new folder in the project browser and rename it Runtime.
11.2 Right click Runtime and select New–> Runtime. The select platform dialog box opens ,displaying a
list of available platforms, in this demo only one.
11.3 Select Platform and click OK.
11.4 The Add Resource Sets dialog box opens. Click Yes.
11.5 Add message to Runtime.
a) Rename the default Runtime job.
b) Right-click Job and select Add Message. The Select Message dialog box opens, displaying a list
of available Message, in this example one.
c) Select and click OK.
d) The letter message is added to the Job runtime job.
11.6 Connect Message to Platform
a) Connect the InputDirectory input connector to the LetterEvent by dragging and droping.
b) Connect the LetterProcess to the OutputFile connector in a similar way.

The Project configuration is done. Now you have to export the project & deploy the export on the control centre. Please make sure to correctly select the pattern from your xml file & not copy from the example!!

Incase you point any mistake,i’ll be happy to hear!! Drop a HI!! Happy Stream-Serving!!