Rule reference

A routing has two parts: General, with the scan and log options, and FileMatching, with the list of rules. In the database mode, the routing is maintained in the Riversoft® Console Portal and can be exported with -export. In the local file mode, it is a JSON file created from the example-config_rules.json template.

{
  "General": { "Name": "INBOUND", "ScanDir": "/mailbox/IN", "LogLevelOnSuccess": 6, "LogLevelOnError": 1 },
  "FileMatching": [
    {
      "Index": 0,
      "Name": "NOTES",
      "FileRegEx": "^NOTES.*\\.TXT$",
      "General": { "SourceUser": "PARTNER", "WeekDayInterval": 127, "EndDateHour": 23, "EndDateMinute": 59, "EndDateSecond": 59 },
      "Filename": { "RenameFileTo": "" },
      "Copy": { "CopyToDir": "/mailbox/OUT", "CopyFileOption": 13 },
      "Backup": { "BkpToDir": "/backup/notes", "BkpFileOption": 4 }
    }
  ]
}

Text fields accept regular expressions in RE2 syntax. Numeric fields marked as options are sums of values: to combine options, add the values, for example 1 + 4 + 8 = 13.

Routing General

File selection

Each FileMatching item is a rule. Rules are evaluated in Index order, and the first one that matches the file applies.

An empty field accepts any value.

Rule General

When the file is outside the allowed time, day, age or size, processing ends with a warning.

New name (Filename)

The new name is built in this order:

1. Starts from RenameFileTo. Empty: the new name starts empty and, if nothing is added, the original name is kept.
2. Applies ReplacesFromFile, when enabled in ReplaceFromFileOption.
3. Applies Replaces, in order.
4. Adds the date and time, according to InsertTimestamp.
5. Applies ReplacesByRegEx, in order.

Replaces

Each item copies a piece from a source into the new name. Positions start at 1.

• ...PosFrom: start position of the piece in the source. 0: start.
• ...PosTo: position in the new name where the piece is written, overwriting what is there. 0 or -1: appends to the end.
• ...Len: number of characters. 0 disables the item.

The last sequence number used is kept in the applLockDir directory. InsertSeqNumberSeq is kept for compatibility.

Example: for the file NF20261110.TXT, the item below produces 20261110, copying 8 characters from position 3:

{ "ReplaceFileNamePosFrom": 3, "ReplaceFileNamePosTo": -1, "ReplaceFileNameLen": 8 }

ReplacesFromFile

Copies into the new name a piece of the first line of the file that matches the expression.

ReplacesByRegEx

Replaces in the new name each occurrence of RegExReplaceFrom with RegExReplaceTo. Use ${1}, ${2} for the groups and ${0} for the matched text. Example: "RegExReplaceFrom": "(?i)\\.txt$", "RegExReplaceTo": ".csv". RegExReplaceOcorr is kept for compatibility.

Copy (Copy)

Backup (Backup)

Control files

Control files signal to other processes that a file is being processed or is ready. The names accept variables, for example $PATHOLDNAME/$OLDNAME.lck.

External commands

ExecProgBefore, ExecProg and ExecProgError receive a command with arguments, for example:

/usr/local/bin/notify.sh "$FILENEWNAME" $SRCUSER $DSTUSER

• Variables are replaced before the run. See Variable reference.
• The command runs directly, without a shell: use the full path and, for redirections or pipes, call a script.
• Arguments in double or single quotes are passed without the quotes.
• Riversoft STCP Gemini Rename waits for the command to finish. An exit code other than 0 is treated as a failure.