← Action rules SyntaxBase Rules →

finance-related topic Files via Output Selection in Action Rules

General description of how to access files. This is valid for all action rules.

Current process

Several parameters allow to pass files, as input or output. Particularly the case of addressing files retrieved from SAP spool is a typical case, which is described in the section for Rule input below.

The general syntax of file addressing (usually Source files) from the current process as follows:

  1. OS file name of the server, for example /home/redwood/dest/report1.xls.
  2. Document in Redwood Finance Automation, for example doc:/FCA.FCA/report.csv.
  3. Using JobFile:<jobfile Uniqueid>.
  4. Using <Step_name>, Job <x>:<jobfile_name>.
    1. Example Step 1, job 1:stdout.log.
  5. Using job <jobid>:<jobfile_name>.
  6. * to select all files of the current process.
  7. ** to select all files of the current process and its children.
  8. Files which fit to mask (using * or ?), for example *out.log or stdout?.log.
  9. File name.
  10. Parameter, the value of which contains references like above.

Mail Attachments

For mail attachments, a more advanced syntax is available.

Syntax

<name>=<relative_job>:<file_spec>
  • <name> - the name of the file in the email attachment, for example err_log.txt:.
    • inline_ - prefix to use for files to be embedded in emails, for example inline_stderr.log=Step 1, Job 1:stderr.log, you then specify ${inline_stderr.log}` in the email source where you want the file contents to be inserted, see Inline Attachments.
    • @{name} - used when multiple files can match the expression, will be evaluated to the short name of the output.
    • @{index} - used when multiple files can match the expression, a simple counter that gets incremented.
  • <relative_job> - reference to the process that produced the output:.
    • parent - the parent of current process; note that in chain calls, the parent is usually a step and steps have no output.
    • <step_name>, Job <job_order> - a relative process in the chain.
    • Job <job_id> - process with the id job_id; for example Job 12345.
  • <file_spec> - the file reference <name>|?type.
    • <name> - matches a name, * and ? wildcards can be used. A <file_spec> of * matches all files. ** cannot be used, here.
    • ?type - will attach all files matching the type:.
    • log - log files contain the output of standard error, for example Job 6:?type=log.
    • output - output files contain the output of standard out, for example Job 6:?type=output.

You can also extract part of the file using ?search; see Using the Mail Process Definition Type for more information.

Example

<html>
<head/>
<body>
<h1>Report Generated</h1>
<br />
<p>The following is the log of the report generation:</p>
<p>${inline_Sap_Log}</p>
</body>
</html>
[Attachments]
SAP_Log.log=Step 1, job 1:joblog.log
inline_Sap_Log.log=job 12345:joblog.log
report.csv=

Relative Process

There is also an extension that allows the relative selection of output outside of the context of a process. The criteria is then executed from the relative process as a starting point.

To select output in a different process:

[<Criteria>;][{<Rel process>;<Criteria>[;<Criteria>]}]

To select output file names from the parameter content of a relative process:

Step 2, Job 3;{Step 1, job 1:stdout.log}

financeTopic

← Action rules SyntaxBase Rules →