A KFI manifest file determines the processing sequence of unattended KFIs and the state under which they should be run.
The KFI log records an entry each time a manifest, unattended or user-executed KFI file runs. The log records information such as whether the file processed successfully or not.
Each command within the manifest file must sit on a new line. Additionally, both manifest and unattended KFI files now allow you to set processing timeframes. By configuring parameters in the manifest file, Attaché Alex is able to send status notifications based on KFI status notifications. Notifications sent via Attaché Alex are charged at current document delivery rates.
Important points to note:
The KFI Manifest file needs to be saved with the extension .kfm.
A line must contain only one command.
The Manifest file must contain a version tag.
The Manifest file must contain a KFI source folder setting
all KFI files listed in the Manifest must be in that source folder
the source folder must be separate/different to the Inbox folder
List of KFI Manifest Tags
KFI tag name | KFI tag format | Description |
object_id | object_id='nnn' | Program number for the task the data in being imported into. |
Version | <KFI_Manifest_Version = 1.0> | Indicates the manifest file version. Manifests with invalid versions are not processed. |
Process file | <ProcessFile = xxxx> | Indicates which files to process |
User defined tags | Set Tag xxx=yyy | Creates a use defined tag. Whenever <xxx> is found in a KFI, or in the manifest file, it is replaced with yyy |
Attaché Date | Set Date DD/MM/YYYY | Sets the Attache Date. The Attache date will be set to this date for the duration of any following KFIs. On completion the date will revert to its previous setting. |
System Date | Set System Date DD/MM/YYYY | Sets the system date. The system date will be set to this date for the duration of any following KFIs. On completion the date will revert to its previous setting. |
Auto close | Set CloseOnSuccess=TRUE/FALSE | Sets the default KFI setting of <CloseOnSuccess> |
Carriage Returns | Set IgnoreCR=TRUE/FALSE | Sets the default KFI setting of <IgnoreCR> |
Processing Speed | Set Speed=XXX | Sets the KFI speed. This may be overridden by a setting in the KFI itself. |
Source Folder | Set SourceFolder = xxxx | Determines the name of the folder in which the target KFI files can be found. |
Success Folder | Set SuccessFolder = xxxx | Determines the name of the folder in which the processed KFI manifest file is placed when all KFIs have been processed. |
Failure Folder | Set FailureFolder = xxxx | Determines the name of the folder in which the KFI manifest file is output if it fails to complete. |
Not Processed Folder | Set NotProcessedFolder = xxxx | Determines the name of the folder in which the KFI manifest file is output when rejected. |
StopOnError | Set StopOnError = TRUE/FALE | Stops processing the manifest file and moves it to the failure file when there is a non-fatal problem with any of the target KFI files. |
Add a remark or comment indicator | semi colon (;) | Allows users to enter comments in the manifest file which will be ignored by the command interpreter. |
Send notification | <NotifySuccess> | Indicates that the unattended KFI has been processed successfully. |
Send notification | <NotifyFailure> | Indicates that the unattended KFI has not been processed successfully. |
Notification method | <MailTo=[Recipient] email address> <FaxTo=[Recipient] fax number> | Insert in the header of KFI file. When a KFI file has been successful or failed to process, action any notification requests and send the notification via Attaché Alex. |
Processing Timeframe | <Active=dd/mm/yyyy hh:mm:ss> <Expire=dd/mm/yyyy hh:mm:ss> | Insert in the header of KFI file. This will instruct the program on when to process a KFI. |
Steps for a successful KFI manifest implementation
To ensure that your KFI manifest file works successfully, the following steps will need to be taken:
Have your current KFIs (Standard KFIs and Unattended KFIs) setup and working correctly.
Create a KFI manifest file using the above KFI tags.
Test the KFI manifest file in a sample or play company. Ensure the KFI files are placed in the Source folder, whereas the Manifest file is placed in the Inbox folder.
Choose Accept (F9).