Configuring auditing

To enable auditing for a form

1. In Developer Studio, open the form that you want to audit.
2. Click the Definitions tab, and expand the Other Definitions panel and then the Audit panel.
   
3. From the Audit Style list, select the type of audit that you want to perform:
   • None—No auditing is performed.
   • Form—A snapshot of the audited form is saved to the audit form you specify. Only the audit and copy fields in the audit form contain values.
   • Log—Whenever a form is saved after an audit field or set of fields changes values, an entry is created in the log form that you specify.
     
4. From the Audit State field, select Enable.
   You can select Disable to disable audit functionality temporarily. Any other audit configuration values you have specified remain intact.
5. From the Audit Only Changed Fields field, select how the audit function operates when no field is changed:
   • Default—Use the setting defined in the Configuration tab of the Remedy AR System Administration: Server Information form.
   • Yes—Auditing occurs only when at least one field value changes as the result of an operation.
   • No—Auditing occurs whenever there is any create, update, or delete operation on the form.
6. If you specified a form audit, enter an audit form name in the Audit Form field.
7. If you specified a log audit, enter a log form name in the Log Form field.
   The audit or log form you specify is created when you save the main form.
8. (Optional) Specify a qualification.
   The incoming entry is audited only if it satisfies this qualification.
9. Click OK.
   In the audit form's Audit panel, the name of the main form is displayed next to the Audit From Form label.
   In the log form's Audit panel, the number of forms using the log form is displayed next to the Audit From Ref Count label.

Specifying fields to be audited

On a form configured for auditing, you specify which fields should be audit fields, which should be copy fields, and which should be audit and copy. Audit field values and copy field values are copied from the main form to the audit or log form, but only changes to audit fields trigger audit processing. 

Audit fields are copied only if their value changes. For copy fields, either the value in the current transaction is taken (if present) or the value is taken from the database. If an entry is created and no value is entered for a copy field, nothing is copied. Fields specified as audit and copy trigger an audit and are copied if changed. If not changed, they behave like copy fields.

System fields, including Create Date and Last Modified By, cannot be audited.

To specify fields to be audited

1. In Developer Studio, open a form for which auditing is enabled.
2. Select the fields you want to audit.
3. In the Properties tab, set the value for the Audit Option property.
   The options are:
   • None—Changes to this field are not recorded by any audit processing.
   • Audit—Changes to this field trigger audit processing and its new value is recorded in the audit form or log form, depending on the audit style you specified at the form level. If the value does not change, its value is not recorded.
   • Copy—The database value or the value in the current transaction if present is recorded during an audit, but does not trigger audit processing.
   • Audit and Copy—Changes to this field trigger audit processing. If the value has not changed, the value from the database is recorded (similar to the behavior of the Copy option).
4. (For log-form audits only) In the Properties tab, set the values for the Audit Log Key property:
   • Key 1—The value of this field appears in the Log Key 1 field in the log form.
   • Key 2—The value of this field appears in the Log Key 2 field in the log form.
   • Key 3—The value of this field appears in the Log Key 3 field in the log form.
5. Save the form.

Changing character field properties on the main form

When you modify the following properties of character fields on the main form, the AR System server updates the audit form:

• Attributes
• Field limits
• Display properties
• Help text

When you modify the following properties, the audit form is unchanged:

• Entry mode
• Index for FTS
• Permissions

Fields on audit forms are always read-only.

Table fields in audit forms

If a form is enabled but has auditing disabled and has no audit form, the AR System server tries to create an audit form for it. If the main form has a table field, the AR System server tries to create the table field in the audit form while creating the form. If the table field's form is missing, the audit form is not created, and you receive the following errors:

• Could not create the Archive or Audit Form specified. Archive/Audit for this form has been disabled. (ARWARN 8992)
• Form does not exist on server Form1: (ARWARN 303).

The problem is that the AR System server is attempting to create the table field in the audit form, but because the table field's form is missing, it cannot pass the validation. 

To resolve this problem, create the table field's form, or delete the table field from the main form.