If your instruments have a specific naming convention or other characteristics, this functionality will allow you to rename and further modify them to ensure your users have a consistent experience everywhere in your platform.
What instrument fields can be modified
Pretty much all brokers that we work with have their own naming conventions for the symbols that are displayed in various tools. This could range from symbols or tickers to instrument names.
To ensure that our tools can be customized in such a way, that makes it frictionless for traders to start using them within the brokers’ platforms, and for the brokers to integrate them, we support modifying instruments.
The following fields can currently be modified:
- Instrument Name (example: Apple Inc. CFD vs. Apple Inc.)
- Instrument Ticker/Symbol (example: EURUSD.p vs. EURUSD)
- Digits or Rounding Precision (example: 1.09940 vs. 1.0994)
- Instrument Identifier
Modification process
Instruments can be modified either individually or in bulk via a file import. Both of the methods need to be carried out on the My Assets page.
Individual instrument modification
To modify instruments individually, simply search for the instrument in question or find it in the full list of instruments, and click the pencil icon on the right side of the row.
This will open a modal window where you can edit the values.
Changes are applied as soon as you click Save in the modal window.
After saving, the changes will start appearing in the widgets after about 20 minutes, because they need to propagate to all servers that we are using.
If you want to reverse a change, simply find the instrument using the search box, click the pencil icon, and click RESET.
Bulk modification via a file import
If you have a large number of instruments to modify, it’s best to use the import feature as it will save you a lot of time.
The import functionality accepts a file as input, with the following columns:
- Asset ID: this is the Acuity asset identifier which will be used to identify the correct instrument to update
- Asset Name (max. length: 250 characters)
- Asset Ticker (max. length: 20 characters)
The file can either be in .xls, .xlsx, or .csv format.
How to find Acuity asset IDs for the import file
To find identifiers to add into the first column of the instrument renaming CSV import file, please utilize the Export functionality.
The exported file will contain the following columns:
-
Id: this is the Acuity Asset ID
-
Name: this is the Acuity asset name
-
TickerName: Acuity Ticker/Symbol
-
CustomName: the modified instrument name (if applicable)
-
CustomTicker: the modified ticker/symbol (if applicable)
-
ExternalId: modified asset identifier
-
Created: date when this modification record was created
-
CreatedBy: name of the user that created the record
-
CreatedById: ID of the user that created the record
-
Modified: date when this modification record was modified (if applicable)
-
ModifiedBy: name of the user that modified the record
-
ModifiedById: ID of the user that modified the record
Use the downloaded file to modify the required instruments, and then upload to My Assets via the Import function.
Clearing the changes
If you want to reset all the modifications that were applied to the instruments, simply click the CLEAR ALL button at the top of the page.
Quick identification of modified assets
In addition to the Export functionality, it’s possible to quickly identify instruments that were modified by clicking the “Show modified assets only” switch next to the search box.
This will display only the instruments that previously had any of the fields modified.
