About alias names during operations
- Last UpdatedJun 12, 2025
- 2 minute read
Objects retain their aliases when objects are exported, backed up, and loaded as part of a Galaxy operation. Also, object aliases can be programmatically set and returned using the GRAccess ToolKit.
Alias retention in galaxy operations
Alias names assigned to Galaxy objects are retained for the following Galaxy operations:
-
Export and import of a Galaxy
-
Back up and restore a Galaxy
-
Migrate a Galaxy
-
Exporting instances to and importing them from a CSV file
Alias names in the export and import of a galaxy
When objects assigned alias names are exported to an aaPKG file, object Alias names are retained when the aaPKG file is imported into another Galaxy with the following exception:
AliasName is a reserved keyword in System Platform 2020 R2 and newer versions. If an import package contains previous versions of objects with name “AliasName”, the import process skips the attribute and logs a warning message in the OCMC log. Attributes with name AliasName are not imported.
Alias names in backup and restore of a galaxy
When objects assigned alias names are backed up to a CAB file, object alias names are retained when the CAB file is restored to another Galaxy.
Migrate a galaxy
When objects assigned alias names are migrated, object Alias names are retained when migrated to another Galaxy with the following exception:
AliasName is a reserved keyword in System Platform 2020 R2 and newer versions. If a migration package contains previous versions of objects with name “AliasName”, the migration process skips the attribute and logs a warning message in the OCMC log. Attributes with name AliasName are not migrated.
Alias names when exporting to and importing from a csv file
When one or more objects are selected and exported to a CSV (Comma-Separated Value) file, you can import the contents of the CSV file into another Galaxy. Objects retain their alias names when imported to the new Galaxy.
Assign an alias name programmatically using the GRAccess Toolkit
You can use the GRAccess object model to write programs that automate the configuration of local and remote Galaxies. You can rename object aliases using the Alias property that programmatically gets or sets the alias name of an object.
Class
IgObject
Syntax
[C#]
string AliasName { set; get; };
[Visual C++]
[propget]
HRESULT Alias(
[out, retval] BSTR* theAlias
);
[propput]
HRESULT Alias(
[in] BSTR newAlias
);
Parameters
theAlias
The current alias of this object.
newAlias
The new alias of this object, or blank if the object does not have an alias. The object does not need to be checked out. The alias rename operation is immediate.