Add an extra API name to extend the list of names that data mapping lines in ERP Manager can offer, without waiting for a backend release. Use it when a customer needs a mapping field that the built-in list does not include. You add the name on the Extra Api Names screen.
Before you begin
Find the Api model value of the data mapping in ERP Manager that will use the new name. The server rejects an API model that it does not recognize.
Access to this screen follows the sync groups permission, so you need write access to sync groups. The menu entry is hidden from agent-role users.
Steps
In the Admin Panel navigation, select Extra Api Names.
Select CREATE. The Create Extra Api Names form opens.
In Api model, enter the value of the mapping's Api model field in ERP Manager, for example Order, Document or DocumentItem. The value must match exactly.
In Name, enter the API name. Start the name with a letter and use only letters, digits and underscores.
In Type, select the value type. The service accepts exactly one of these types: string, integer, float, boolean, datetime or json.
Optional: In Label, enter a column header. Left empty, the column shows the API name itself.
Optional: In Position, enter the column order. Left empty, the column goes after the built-in ones.
Optional: Under Label translations, enter the label for each language you need.
Select Save. On the empty form, Save is unavailable. It becomes available after you change the form.
Result
The new row appears in the Extra Api Names list. In ERP Manager, data mapping lines whose API model matches now offer the new name as a choice. Reload the ERP Manager page after saving so the new name appears.
If something goes wrong
If you enter an API model and name pair that already exists, the server rejects it and shows its own message. Enter a different name to continue.
If the name does not appear on a data mapping line, check that the mapping uses the same API model you entered, and reload ERP Manager. A mapping that an API endpoint uses is locked with read-only lines, so the name cannot be added there.
Related