Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Set up file collector to load email messages and/or attachments

...

Emails will be collected from the email account you have set up, and stored on the PhixFlow server. From this store, you can read these in using a file collector.

Full details for this configuration and found in fileCollector, but in this article we will go through a typical set up which should cover most cases.

The file collector will need to have the following settings (see also the screen shot below):

FieldValue
Source TypeManaged File
File TypeThe type of the attached file, or for reading the email message itself (the body), probably CSV
File Location StrategyAll Files in Folder
Tag

If a tag is being set (see below), the tag name surrounded by double quotes. E.g.:

Code Block
"accdataemail"

If a tag is not being set:

Code Block
"default"


Input Directory Expr.


Code Block
"in"


Directory Pattern Expression


Code Block
".*"


File Pattern Expression

A pattern to match attached files, e.g. to find attached files with names like AccData-20170426.xlsx:

Code Block
"AccData.*xlsx"

or if you want to read in the email messages (body) this will be just

Code Block
"body.txt"


Archive Directory Expression


Code Block
"archive"


Setting a tag

You can set a tag for the emails by including

Code Block
#tagValue

in the subject line of incoming emails. Note that the resulting tag you use in the file collector will be all in lower case. For example, if incoming emails have a subject line like

PhixFlow input file accounts 20170426 #accDataEmail

then use the tag

Code Block
"accdataemail"

in your file collector configuration.

Info

You don't need to know this to complete the configuration of the file collector, but sometimes you might find it helpful to be able to find the files delivered by the email polling service.

In system configuration you will have, under the tab System Directories, a setting File Upload Directory. For example:

Code Block
/opt/phixflow/data/upload

If you have not specified a tag in the subject line of your incoming emails, files will appear in directories:

Code Block
/opt/phixflow/data/upload/default/in/[date]/[long ID]

E.g.

Code Block
/opt/phixflow/data/upload/default/in/20170426/ab5dcb71868e47c484d6aa78430393d6

If you have specified a tag in the subject line of the emails, files will appear in directories:

Code Block
/opt/phixflow/data/upload/[tag]/in/[date]/[long ID]

E.g. with the tag "accdataemail"

Code Block
/opt/phixflow/data/upload/accdataemail/in/20170426/eebb98c20ce04246b0cee073a510ccde

Archiving

If you set an archive directory, your files will be moved once they have been read in by the file collector. This will be to:

Code Block
[file upload directory]/[tag]/[archive dir]/[date]/[long ID]

E.g. if you set the archive directory to "archive" (as in the examples above), your files will be moved to directories like:

Code Block
/opt/phixflow/data/upload/default/archive/20170426/6904c5192d5944bd919d4eee99bc0237

or, if you are using the tag "accdataemail":

Code Block
/opt/phixflow/data/upload/accdataemail/archive/20170426/6904c5192d5944bd919d4eee99bc0237


...