Failure Customization
Contents
1 Introduction
Customization is only available for Professional licenses
Due to certification process, it may be required to hide some failures or change the presented text to comply with regulations.
This can be done with a xml failures customization file (failures.xml) located at c:\ProgramData\ProSim-AR\<product>
File does not exist by default. If customization is required, it needs to be manually created.
A template can be retrieved from here: http://%PROSIM_SYSTEM_ADDRESS%:8080/failuresManualXML
2 Example
<failures> <failure id="2176" hide="true" /> <failure id="1801"> <description>"APU total failure"</description> </failure> </failures>
The above example will hide the failure with the id 2176 (APU Overspeed)
And will update the description of the failure id 1801(APU Fail) to APU total failure
3 Format
3.1 Failure attributes
id: Failure Id
It can be found calling the 127.0.0.1:8080/failuresManual web call to ProSim web server
The output will be similar to this:
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ATA 49 - APU ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -------- APU Id: 1801 Name: FAIL Description: APU Fail Help: APU has been shutdown because of a failure and will not provide bleed air or electric power. Id: 2176 Name: OVERSPEED Description: APU Overspeed Help: APU RPM limit has been exceeded resulting in an automatic shutdown
hide: hides the failure and it will not be available for selection from the IOS
3.2 Failure elements
groupName: Group name as string
groupMember: Group member as string
description: Description(name) text as string
help: Help text as string
ata: ATA chapter as integer
Used to group failures under the same category based in the following criteria (ATA: short name, long name):
21: Air, Air Conditioning
22: AutoFlight, AutoFlight
23: Communications, Communications
24: Elec, Electrical power
26: Fire, Fire protection
27: Flight controls, Flight controls
28: Fuel, Fuel
29: Hydraulic, Hydraulic power
30: Ice/Rain, Ice and rain protection
31: Indicating/Recording, Indicating/Recording system
32: Gear, Landing gear
33: Lights, Lights
34: Navigation, Navigation
35: Oxygen, Oxygen
36: Pneumatic, Pneumatic
46: Information, Information systems
49: APU, APU
52: Doors, Doors
70: Engines, Power plant
73: Engine Faults, Engine faults
80: Start Faults, Start faults
3.3 Failure Parameters
Some failures can have custom parameters, like a leak failure where you can set a specific rate.
If a failures shows a parameter list, then it can be customized.
<failure id="2390" hide="false"> <description>Hydraulic A pressure line leak</description> <help>Hydraulic A pressure line has a leak.</help> <groupName>Pressure Line Leak</groupName> <groupMember>Hydraulic A</groupMember> <ata>29</ata> <parameters> <parameter name="rate" description="US Gallons per minute" value="1"/> </parameters> </failure>
It is important that NAME is not changed as it is used as KEY and description shows internal unit used, so any value must be in that specific unit.
