Editing an existing record

About this task

Procedure

To edit an existing record, follow these steps:
  1. Acquire the Entity object you want to edit by using the methods of the Session object.
    Note: To use the methods of the Session object, you must already know the definition of the record. You can use methods of the Session object to have a query find records that match criteria you define, and then work with the records in the query's result set. To learn how to use the API for queries, see Working with queries.
  2. Call the EditEntity method of the Session object.

    Only one user at a time can edit a record and commit their changes. If one user starts to edit a record while another user is already editing the same record, HCL Compass allows only one of them to commit their changes. The first user who validates and commits their changes is successful. When the other user tries to commit changes, this user receives an error stating that the record was updated while they were editing, and their changes cannot be committed.

Results

Using the methods of the Entity Object, you can perform these tasks:

  • View or modify the values in the record's fields.
  • Get additional information about the type of data in the fields or about the record as a whole.
  • Change the behavior of a field for the duration of the current action.