History of Changes (History Management)

Last modified on 2022/08/01 18:25

Definition

The history of changes permits to keep a record of all updates carried out on certain fields of the Service Manager objects, in order to have a trace the changes of accomplished changes and to follow their development. 

EndDefinition
  • It is consultable:
    • via a History of Changes dedicated tab on the forms;
    • via specific reportings when the tab is unavailable.
  • It is defined by the use of history rules permitting to keep the date of the modification, the user that made the modification, the old one and the new value of the updated field.

Example

Definition of a history rule to keep trace of the change in the history for the equipment whenever a new user is assigned to equipment, by keeping the email address of the previous user and the one of the new user.

  • Table impacted: Equipment table AM_ASSET
  • Email address is a key field ==> The field selection for the history is done in the related table: Relation between the table AM_ASSET and the table AM_EMPLOYEE on the key field EMPLOYEE_ID
  • Field impacted: Field Next User NEXT_USER_ID
  • Field for the history: Field Email Addres of the user E_MAIL

==> At each update of the Next User of an equipment, a line is displayed in the History of Changes tab of the Equipment form with the:

  • Update date
  • The email address of the previous user and the one of the new user

Notes

  • Standard rules are delivered by EasyVista.
    • They are disabled by default. To consult them, use the filter None in List mode.
    • Each customer also has the the possibility of defining his own rules depending on his needs.

example  Keep the history about location changes of equipment; Keep the changes about the next decision made for the renewal of a contract

  • For each table, EasyVista defines the list of fields that can be used for the history.
  • A key field cannot be used for the history.
  • Dates are recorded in the AM_HISTORY table in the time zone of the connected user.
  • The elements of the rule cannot be modified.
  • A rule applied at least once cannot be deleted, but you may disable it.

Best Practice

  • Before creating a rule, verify that it does not exist with a disables status; to verify, enable the filter None in List mode.
  • In this case it is necessary to select the field for the history in the related table (The related table and the relation key with the selected table are automatically displayed).
  • To stop to keep the history of a field updates, disable the rule (via the field Available): the old history values are kept and may be consulted.

Menu access

Administration > Parameters > History Management

Screen description

          History parameters.png

Description of the Rule: Name of the history rule. 

Available: Indicates if the rule is applied when an update is carried out on the related field (checkbox checked) or if it is disabled (checkbox not checked).

Table Name: Table name to which belongs the field for the history.

Field Name: Field name for the history. Notes: The list of available fields is actualized when the table is selected. Only the fields that have not been assigned to a history rule will be available.

Target Table (Notes: Only if the field for the history is a key. It cannot be changed): Name of the main table of the key field related to the field for the history.

Relation Key (Notes: Only if the field for the history is a key. It cannot be changed): Name of the key field related to the field for the history. 

Displayed Field (Note: Only if the field for the history is a key): Name of the field to be displayed on the history. Note: Only the fields that have not been assigned to a history rule will be available.

Procedure and Wizards

How to create a history rule

1.  Proceed to the page Administration > Parameters > History Management.

2. Click on + New.

3. Complete the elements of the rule.

Note: If you have selected a key field, you must select the field for the history among the fields that can be used for history of the related table.

4. Click on Finish

5. Check that the new rule has been implemented:

  • Proceed to a form using the table related to the rule and update the concerned field;
  • Proceed to the History of Changes tab and check that the updates have been kept.

Wizards

Update
Delete

Tags:
Powered by XWiki © EasyVista 2022