Using an Audit Trail | Proficy iFIX 2024 Documentation

The Recipe Package can track recipe activity in an audit trail whenever a recipe is uploaded, downloaded, or saved. The Recipe Package provides two types of audit trails: a summary audit trail and a detailed audit trail. The summary audit trail tracks recipe activity of the entire recipe, for example, when a recipe was saved and why. The detailed audit trail tracks recipe activity on individual recipe items, for example, which recipe items were downloaded.

Using the Audit Trail group box, you can select the type of audit you want. By selecting the audit trail type, you instruct the Recipe Package to send the recipe information you want tracked as a message to any alarm destination configured to receive it. Recipe messages are recorded along with any other message the alarm destination is configured to receive. The alarm files that store recipe messages reside in the Alarms path and are named yymmdd.ALM.

To set up an alarm destination to receive recipe messages, select the recipe message alarm areas you need from the Application Message Routing dialog box of the SCU. For more information about configuring alarm destinations, assigning alarm areas, or routing alarms, refer to the Implementing Alarms and Messages manual.

Below is a summary of the Audit Trail group box. By making a selection from this group box you control the type of audit trail the Recipe Builder keeps. Both types of audit trails enable the Recipe Package to track the information described below to the available alarm destinations.

Summary Audit Trail option button — tracks the following information:

When changes to master or control recipes are saved and the name of the logged in user that saved the recipe.
The text entered into the Recipe Mod Log dialog box.
When a recipe is uploaded or downloaded and the name of the logged in user that uploaded or downloaded the recipe.
When an upload or download fails and why.
The Recipe Package records this information whenever a recipe is saved, uploaded, or downloaded. By default, the Summary Audit Trail radio button is selected.

Detail Audit Trail option button — tracks all the summary information listed above. In addition, the Recipe Package also tracks the following download information:

The recipe item values that were downloaded.
The variables that were present in the recipe.
The recipe items that failed to download, if any, and why.

No Audit Trail option button — disables the audit trail for the open recipe.

Using the Recipe Builder, you can enable or disable the audit trail for the open recipe.

To enable or disable the audit trail for the open recipe:

On the Options menu, click Advanced Options. The Advanced Options dialog box appears.
Select either the Summary Audit Trail radio button or the Detail Audit Trail radio button to select the type of audit trail you want. To disable the audit trail, select the No Audit Trail radio button.

The format of a summary message appears below.

date time activity recipe_filename tag_group_name batch_id description by node::user remarks

The following table describes each field in the message.

Summary Message Format
The field...	Contains ...
date	The date when a recipe was uploaded, downloaded, or saved. This field is included if the SCU is set up to include the date in recipe messages. Refer to the section Setting up the Alarm and Message Format in the Implementing Alarms and Messages manual for information on setting the format of these messages.
time	The time when a recipe was uploaded, downloaded, or saved. This field is included if the SCU is set up to include the time in recipe messages. Refer to the section Setting up the Alarm and Message Format in the Implementing Alarms and Messages manual for information on setting the format of these messages.
activity	One of the following descriptions: SAV (when saving a recipe) DWN (when downloading a recipe) UPL (when uploading a recipe)
recipe_filename	The name of the recipe file that was uploaded, downloaded, or saved.
tag_group_name	The file name of the tag group assigned to the recipe. This field is blank if no tag group is assigned to the recipe.
batch_id	One of the following: FILE SAVED OK (if the recipe has been saved successfully) or FILE NOT SAVED (if the save failed). The batch id the operator specifies when downloading a recipe. The batch id is included only when downloading a recipe and is used to identify the download. A blank field, when uploading a recipe.
description	One of the following descriptions: The text specified in the Mod Log field (when saving a recipe). COMP (x ERR) (when a recipe uploads or downloads with x errors). ABRT (reason) (when an upload or download fails. The text reason describes why the upload or download failed).
node	The name of the node the operator is using.
user	The name of the logged in user. If security is disabled, this field is left blank.
remarks	One of the following descriptions: The reason the save failed. (The text reason describes why the save failed). The text specified by the operator when downloading a recipe. The text is included only when downloading a recipe. If you try to re-verify a recipe, the following text appears in this field: Verification retried A blank field, when uploading a recipe.

Examples: Using a Summary Audit Trail

Examples of summary messages appear below:

1/1/98 11:05:12.2 SAV BEER.RCM FERMENT1.TGE FILE SAVED OK CHANGED TEMP FORMULA FERMENT1::JOHN
1/1/98 11:06:23.4 DWN BEER.RCC FERMENT2.TGE LOT033093 COMP(NO ERRORS) FERMENT2::MARY 3rd download
1/1/98 11:08:45.3 UPL BEER.RCC FERMENT3.TGE ABRT(INTERLOCK ACTIVE) FERMENT3::JOE

The format of a detailed message follows.

date time batch_id item_number identifier description value uom result

The following table describes each field. Detailed messages are sent while downloading a recipe.

Detailed Message Format
The field...	Contains...
date	The date when a recipe downloaded. This field is included if the SCU is set up to include the date in recipe messages. Refer to the section Setting up the Alarm and Message Format in the Implementing Alarms and Messages manual for information on setting the format of these messages.
time	The time when a recipe downloaded. This field is included if the SCU is set up to include the time in recipe messages. Refer to the section Setting up the Alarm and Message Format in the Implementing Alarms and Messages manual for information on setting the format of these messages.
batch_id	The batch id the operator specifies when downloading a recipe. The batch id is included only when downloading a recipe and is used to identify the download of the recipe.
item_number	The item number of the recipe item.
identifier	The tagname or variable name of the item.
description	A description of the recipe item or variable. This description matches the text that appears in the Description cell for the downloaded item.
value	The downloaded value of the recipe item or variable.
uom	The unit of measure of the recipe item or variable.
result	One of the following: OK (when the recipe item successfully downloads) BAD reason (when the recipe item cannot be downloaded) NOT DOWNLOADED (when variable is included in the recipe)

How Do I...

enable or disable the audit trail for the open recipe