fauSendFile

The fauSendFile OCE app provides for the automatic sending of a file placed into a monitored directory.

App Downloads

Operational Overview

Highlights for the fauSendFIle functionality are as follows:

Recursive Monitoring

Any file placed anywhere in the top level directory, or it's subdirectories, will be sent to designated recipient(s).

Config Files

Configuration files can be placed in any directory of the monitored tree to define sending instructions specific to that directory.

Global Defaults

Global defaults can be set through the OCE app management screen to define global default behaviours for when no directory specific configuration file is available.

Image Resizing

Images discovered in the fauSendFile monitored directories will be automatically resized as specified by configuration details before being sent.

The fauSendFile application routing can be further tailored through the use of Fautore Instructions. An example workflow would be that of setting up an instruction trigger so that if a USDS message comes in from a specific tribe member using fauSendFile that the message automatically will be directed to one or more locations. This strategy allows for message routing without ever setting up a directory specific configuration file.

CPAN Dependencies

These download dependencies are required only when running the native perl version of this app.

1. sudo cpan install File::Type
2. sudo cpan install Test::JSON
3. sudo cpan install File::HomeDir
4. sudo apt-get install perlmagick (LinuxMint distros way to install ImageMagick for perl)
5. sudo cpan install Net::Address::IP::Local

Environment Dependencies

Installation

The fauSendFile program is designed to work on any computer in the POD. It is not a requirement it be installed on the same server as the OCE. See "Example Installations" below for considerations for different ways to install this application.

1. Download the latest release of fauSendFile
2. Open the archive using method applicable to your OS
3. Run the install program provided with your download

./install -c {Fautore Location}

where:

The "Fautore Location" is the top level directory where your Fautore installation files reside. This is not necessarily a full Fautore OCE installation home. On devices remote from the main OCE this will be home only to installed OSA compliant applications.

The '-c' option forces the creation of missing directories. It is not necessary if all directories are known to exist.

use of the './' in front of the 'install' command is highly recommended to ensure the correct install command is run.

Registration

The fauSendFile app is registered to the OCE via command line.

{OCE home}/apps/fauSendFile/fauSendFile [-i,-p,-s,-vp] -r <membername>:<OCE>:<Port>

where:

{OCE home}

the top level directory for the location Fautore files are installed. This is not necessarily a full OCE installation, but only where the OCE related files, like apps, are located.

<membername>

the login name of a local POD member authorized to register applications.

<OCE>

the IP address of the target OCE intended to manage messages from this app.

<Port>

the port of the target OCE intended to manage messages from this app.

Command Options

All options to the fauSendFile command are for use only at registration time. They have no effect other than when registering the app with the OCE.

Action Commands

Examples

fauSendFile run

Runs through all checks once and quit.

fauSendFile start

Starts the program and monitors continuously. This command does not release the command line and cannot be killed with a "^C" keystroke set. Use "fauSendFile stop" from a second terminal to stop the program.

fauSendFile daemon

Just like "fauSendFile start" above except the command line is released and the program runs in the background. Use this command for start scripts and other automated approaches to program startup.

fauSendFile stop

Use this command to stop a fauSendfile program that is perpetually running using either a "start" or "daemon" command.

faSendFile restart

Equivalent to: "fauSendFile stop" then "fauSendFile daemon" and can be used as a direct equivalent to "fauSendFile daemon" with the added benefit of making sure fauSendFile isn't already running.

OCE Managed Configuration Items

The below table describes the configuration items available in the "App Specs" screen of the OCE for this app. The values defined here act as defaults for all discovered files being sent by the app and can be overridden by configuration files local to the directory where the file was found.

App Specific Features

The features listed here are specific to the operation of the fauSendFile app.

Config Files

fauSendFile can make use of configuration files that can exist in any directory that files to be sent are found. The configuration files are directory specific and have no effect on files outside the directory in which the file is found.

• The config file has different parameters depending on if it is found in the outbound or inbound directory.
• The config file can can be either of two names regardless of whether it is found in an outbound or inbound directory.
  • The name chosen has no affect on functionality.
  • The name chosen does not have to be consistent across directories
  • The configuration name chosen must be either:
    • .fSF
    • .fauSendFile
• Unrecognized parameters are ignored. (This means that a single config file template can be used for both inbound and outbound processing and tailored to directory needs)
• The config file settings do not cascade in their value settings. Lower level directories are not affected by higher level config files.
• Configuration file entry format is a simple: {item}={value}
  • Example: DefSumm=Sarah Wrestlequeen Photo of the Day
• Lines with comments begin with a pound (#) sign.
  • Example: # This is a comment
• Comments line must begin with comments. In-line comments won't work as expected.
  • Example: DefDetail= Some long text # You're in for a surprise with this one.

Image Resizing

The template to follow for specifying image sizes is as follows:
('x' is literally an "ex" character. '#' represents a number - any number)

• ### Maximum size, defines a value to apply as maximum for either height or width
• ###x Maximum width, proportional resizing to specified width.
• x### Maximum height, proportional resizing to specified height
• ###x### definitive height/width