Record.Rename(Any [, Any,...]) Method

Version: Available or changed with runtime version 1.0.

Changes the value of a primary key in a table.


[Ok := ]  Record.Rename(Value1: Any [, Value2: Any,...])


 Type: Record
An instance of the Record data type.

 Type: Any

[Optional] Value2
 Type: Any

Return Value

[Optional] Ok
 Type: Boolean
true if the operation was successful; otherwise false. If you omit this optional return value and the operation does not execute successfully, a runtime error will occur.


Use the Rename method, for example, if you use the customer's telephone number as the customer number. You can use this method to change the customer number in case the telephone number changes.

Certain tables you cannot rename, for example:

  • Tables in which the user cannot rename the Document No. field for legal or business reasons.
  • Tables in which an Option data type field, such as Document Type, is part of the primary key.

Examples of tables that you cannot rename are:

  • Table 36, Sales Header
  • Table 38, Purchase Header
  • Table 5405, Production Order
  • Table 5766, Warehouse Activity Header

If an end-user modifies a record between the time that another end-user or another process reads the record and modifies it, then the second user must refresh the value of the record variable before editing the record. Otherwise, the end-user receives the following run-time error:

Another user has modified the record for this <Table Name> after you retrieved it from the database. Enter your changes again in the updated window, or start the interrupted activity again.

You must design your application so that you use the most up-to-date version of the record for modifications to the database. You use the Get Method to refresh the record with the latest version. The second example illustrates this situation.

When a record is renamed, the change is written and committed to the database without calling the OnModify Trigger. This is done because renaming a record changes the primary key and updates the primary key value in all related tables. Therefore, you should use the Rename method and the Record.Modify([Boolean]) Method on a record separately.

Example 1

    CustRec	Record Customer


Example 2

This example shows that you get an error if you attempt to rename a record after a newer version of the record has been written and committed to the database.

In this example, you get a copy of a record from the Customer table and put it into the CustRec1 variable, then you modify the record. Next, you get a copy of the same record from the Customer table and put it into the CustRec2 variable. You modify the record and commit the changes to the database. Now the CustRec1 variable is out of date with the value in the database. If you were allowed to modify the record using the CustRec1 record, then the changes that you made with CustRec2 would be overwritten by the values in the CustRec1 variable. It is not allowed to rename a record with the old version of the record.


If you do not call the Commit method in this example, then you do not receive an error.

    CustRec1: Record Customer;
    CustRec2: Record Customer;
    CustRec1."Address 2" := 'Suite 102';

    CustRec2."Phone No." := '206-555-0109';


    CustRec1."Phone No." := '425-555-0184';

The changes to the Customer record cannot be saved because some information on the page is not up-to-date. Close the page, reopen it, and try again. Identification fields and values: No.='20000'

See Also

Record Data Type
Get Started with AL
Developing Extensions