Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.

Documentation

Skip to end of metadata
Go to start of metadata

In Abiquo, some error messages originate in the UI but the bulk of error messages originate from the Abiquo cloud orchestrator, specifically the Abiquo API. The messages generated by the UI should already be found in the UI language file as described in Abiquo UI Client Language Configuration.

Create a copy of the language file and customize it for your installation. 

The messages generated by the Abiquo API are documented in User Interface Messages

To customize or translate the API messages, add the message code and the desired message text to the UI language file as described in Abiquo UI Client Language Configuration. You can find a list of all the API messages in JSON format in the APIError_lang_enUS.json.txt file attached to this page.

For example, for the following message:

VIMAGE-0

The requested virtual machine template does not exist

NON_EXISTENT_VIRTUAL_MACHINE_TEMPLATE

Use the following format and add a comma at the end of a line between entries:

"Internal Message ID":"Message",

So taking an example from the User Interface Messages list:

"VIMAGE-0":"Your virtual machine image was not found in the Platform Image Library"

For example, considering the end of default the lang_en_US.json file:

    "privilege.description.VDC_MANAGE_NETWORK":"This privilege allows a user to manage private and public VLANS (add, edit and delete)",
    "privilege.description.VDC_MANAGE_STORAGE":"This privilege allows a user to manage storage volumes (add, edit and delete)",
    "privilege.description.VDC_MANAGE_VAPP":"This privilege allows a user to manage Virtual Appliances (add, edit and delete) "
}

You would add the above error message as follows:

    "privilege.description.VDC_MANAGE_NETWORK":"This privilege allows a user to manage private and public VLANS (add, edit and delete)",
    "privilege.description.VDC_MANAGE_STORAGE":"This privilege allows a user to manage storage volumes (add, edit and delete)",
    "privilege.description.VDC_MANAGE_VAPP":"This privilege allows a user to manage Virtual Appliances (add, edit and delete) ",
	"VIMAGE-0":"Your virtual machine image was not found in the Platform Image Library"
}

File format and commas

Check your file format carefully. You must put the internal message ID and the message in quotation marks and separate them with a colon ":". You must put a comma after each entry, except last entry.

To check that your JSON format is correct, you can use a JSON checker such as http://jsonformatter.curiousconcept.com/#jsonformatter

  • No labels