Nerd Alert!
- I compiled this blog for Airbus pilots and ground staff who need to access the Airbus FOCT manuals. It is written for those who wish to learn more about how to make full use of the impressive (but undocumented) search features in the Airbus FOCT.
- This blog has NO relevance for any other people. In fact this blog will make NO SENSE to people outside this piloting community.
- Some of the information is technical and might not make sense to people with less than advanced computer skills.
- The following is NOT official information. This information is NOT provided in the FOCT. This is my personal information that I offer in the hope that it may help you.
How to search Airbus FOCT manuals more efficiently
The Airbus Flight Operations Consultation Tool (FOCT) comprises the user interface (Java) and data files that present relevant Airbus and airline manuals to pilots and other interested parties. My A380 FOCT for the A380 comprises 2.4GB of data spanning 2,600 files. The FOCT supports other Airbus aircraft types.
I investigated the FOCT in detail in 2008 before the first A380 arrived at my airline. I assisted my airline to optimise the our electronic manuals and made recommendations to Airbus to improve the FOCT. The “DU Search” was one facility that I request in 2008 and that was subsequently released in the FOCT update in 2014.
The FOCT provides limited documentation on how to search itself for information.
I provide the following notes to help others search the FOCT more effectively. I use these tools every time I search the FOCT for data. I have shared this guide with my airline and friends, all who later comment how it helped them to make faster and more narrowed searches.
I hope that this information helps you.
Understanding the FOCT Search Indexes
The FOCT uses the Lucene search engine. Lucene is an open source, high-performance Java utility that provides search functions for compatible index files for almost unlimited data.
It is possible to view the structure of the FOCT indices. The Luke (Lucene Index Toolbox) toolkit can open Lucene indices in the FOCT manuals, displaying the structure and showing interesting statistics. For instance, the FOCT supports Lucene version 1 indices (Lucene is currently up to version 5). Opening up the ECAM index reveals that there are currently 1,229 ECAM checklists in the A380 (up slightly from the 1,225 checklists that I described at page 157 of “QF32″ that I produced in 2011). Likewise, the TITLE index reveals that there are just 6,931 pages in the A380 Flight Crew Operations Manual (up from 6,334 in January 2010) and just 257 pages in the Flight Crew Training Manual. This is irrelevant information except perhaps to consider the saving and benefits in using electronic rather than paper manuals. Given that an FCOM “page” can span any length, we would need to use AT LEAST seven reams of paper to print just the FCOM and FCTM!
Every FOCT manual has a corresponding set of indices that are used to enable searches of that manual:
- FCOM – contents, context, ecam, title
- FCTM – contents, title
- MEL – contents, ecam, func_code, title
FOCT Indices:
The FOCT includes many instances of the following indices: (important indices bolded)
- contents – Contains a listing of the unique words (except for stop words) for the selected manual. For example the FCOM contains 18,000 unique words. The “contents” index is used by default. Word Search window uses this index. For example: “contents:fire” or “fire”
- context – index not populated.
- ecam – ECAM checklists. This index is used for internal FOCT purposes and is not user-friendly. So there is little point searching this index. For example, the Word Search of “ecam:al_29_10_060_01″ retrieves the ECAM “HYD G(Y) RSVR LEVEL LO” checklist.
- func_code – Index of MEL entries. For example, to find the “78-30-04 Thrust Reverser Lock” ECAM search using either the Word Search using “func_code:78-30-04″, or the Functional Code search using “78-30-04″
- title – this is the page name / global display unit / GDU. The discussion of his topic is now outside the scope of this document. The title search was useful before Airbus updated the FOCT to provide the “DU Search” window. For example, the DU Search of “4192” finds the same Autopilot page as the Word Search of the page “title: lg01087*”
Search using the following expression: [indexname:]search_expression
- indexname is one of the index names listed above (in lower case). The colon marks the end of the index name (ie func_code:23-72-01)
- search-expression is the alphanumeric search text
Understanding the FOCT Search Windows
The FOCT includes search windows for:
- Word Search – defaults to “contents” index
- Interface Search – enable by setting “isInterfaceSearchActivated = true” in ..\foct-conf\ct-access-search.config
- Index Search – Index not populated. Not worth enabling.
- ECAM Search
- Functional Code Search – defaults to ” “func_code” index
- DU Search – Search Display Units
As described previously, the Functional Code Search is similar to the Word Search, except that the Functional Code Search defaults to the “func_code” index. For example, these two searches both locate the same MEL (DDG) page for “24-21-01 Engine Electrical Generator”:
- FUNCTIONAL CODE SEARCH – “24-21-01″ (defaults to func_code index)
- WORD SEARCH – “func_code:24-21-01″ (forced to search “func-code” index instead of default “contents” index)
FOCT Search
Knowledge is everywhere. The challenge for knowledge management systems is to quickly identify then dive for just the pearls of wisdom rather than drown the in the ocean of big data.
The FOCT’s success as an electronic bookshelf depends upon the quality of the search engine and your ability to quickly find just the information that you need. Unfortunately the FOCT provides little information about how to use the many search windows and no information about Lucene searches.
The challenge … dive for just the pearls of wisdom rather than drown the in the ocean of big data.
Enabled Search Features
Here are some search expressions that the FOCT’s search windows support.
Search Operators |
AND && |
ie: ICING AND Fuel (Operator must be ALL CAPS) |
OR |
ie: ICING OR Fuel (default: ie same as icing fuel) (Operator must be ALL CAPS) |
|
NOT ! |
ie: ICING AND NOT Fuel (Operator must be ALL CAPS) |
|
Punctuation |
“ |
Use double inverted commas to specify an exact search phrase ie: “Brake Pressure” |
* ? |
Multiple character wildcard Single character wildcard Wildcards are NOT permitted at the start of the word (to optimise speed) To search for “tyre, tire, tires, tyres”: OK: “t*”, “t?re*”, “t?re?” NOT OK: “*yre”, “t?re”? “T?re” is a great example. The 2015 A380 FOCT still uses instances of “tire” and “tyre” to describe the same thing. |
|
Fuzzy Searches |
~ |
Syntax: <word>~[distance] Distance: <0.x> – based on the Levenstheim distance (0 (distant) to 1 (close)). Example 1 “obstruct” – 1 found “obstruct~” – 82 found (finds many more (includes “construct” in the search) “obstruct~0.1″ – 8921 found “obstruct~0.7″ – 28 found “obstruct~0.9″ – 1 found |
Proximity Operators |
~x |
This operator is very powerful though probably seldom used. It finds the words separated by no more than x words. “APPLY FIRST” (0 results) “APPLY FIRST”~1 (1 results) “APPLY FIRST”~2 (2 results) (finds first apply .. “APPLY FIRST”~6 (3 results) Find the words in either order “APPLY FIRST”~2 (2 results) Will search for “apply first” and “first apply” Find the words only if separated “ECAM ACTION”~6 – “ECAM ACTION”~2 (1 results) |
Range Search |
Syntax: <field>:[( | [] <range1> TO <range2> [] | )] <field>: – optional (suggest leave blank) “” (inverted commas) – exclusive () (curly brackets) – inclusive Example 1 “Oxy to Oxygen” Search for all titles between Oxy and Oxygen, excluding the terms Example 2 (Oxy to Oxygen) Search for all titles between Oxy and Oxygen , including the terms |
Stop Words |
Stop Words are not indexed or searchable. Stop words are listed at ..\foct-conf\ct-viewer.config Search expressions are parsed and the following words are remove before the search is conducted: A AN ARE AS AT BE BUT BY FOR IF IN INTO IS IT NO OF ON S SUCH T THAT THE THEIR THEN THERE THESE THEY THIS TO WAS WILL WITH |
Prefix |
Action |
Notes |
+ <plus> |
Must Include |
Similar to “AND” Caution. When using, every word must have a prefix, otherwise unreliable results are returned. |
– <minus> |
Must Not Include |
Similar to “AND NOT” |
<blank> or <comma> |
Should Include |
Similar to “OR” |
Complex Search Examples
The following searches use various combinations of two words (icing and fuel) to show the options and their corresponding search results.
Note: These search results were compiled in 2010 using the FOCT at that time. Your search results may vary.
Expression |
Search Results (pages) |
Notes |
Icing contents:icing title:icing context:icing ecam:icing |
132 132 0 0 0 |
|
Fuel contents:fuel |
881 881 |
|
Icing and Fuel contents:(+icing +fuel) +Icing +Fuel Icing +Fuel |
23 23 23 881 |
AND example Must Have Icing. Must Have fuel Must Have Icing. Must Have fuel Danger. When using a + prefix, every word must have a prefix, otherwise incorrect results are returned |
Icing or Fuel contents:(icing fuel) Icing Fuel Icing , Fuel |
990 990 990 990 |
OR example When no operator is specified, the default operator “OR” is applied |
Icing and not Fuel Icing -Fuel |
109 109 |
NOT example Must Have Icing. Must Not Have fuel |
Icing and not Fuel and not ECAM |
86 |
Overly complex and verbose NOT example. Not recommended! |
Icing -Fuel -ECAM |
86 |
Simple exclusion example. Must Have Icing. Must Not Have fuel. Must Not Have ECAM. |
+Icing -Fuel -ECAM |
86 |
(equivalent to above) |
Fuel and not Icing |
863 |
NOT example |
Fuel -Icing |
863 |
Must Have Fuel. Must Not Have Icing. |
+Fuel -Icing |
863 |
(equivalent to above) |
Icing and not Fuel or ECAM Icing not Fuel Icing – Fuel |
109 109 109 |
Danger. Too complex a boolean search not supported by the FOCT. Incorrect (unexpected) result |
Icing + Fuel Fuel + Icing |
881 132 |
Danger. When using a + prefix, every word must have a prefix, otherwise incorrect results are returned |
Notes:
- All searches are case insensitive
- The search operation only searches for valid search words (not including Stop Words)
- You cannot search for a combined phrase with a trailing wildcard such as “t?re”?
- FOCT boolean (AND OR NOT) queries do not obey a strict boolean logic. “A AND B” or “A AND NOT B” will work as expected, but “A AND B OR C” will give unexpected results. It’s best when thinking of the logic to think in terms of the logic simply being applied one step at a time from the left to the right. It’s also easiest to think in terms of MUST and MUST_NOT (“+”, “-” ) instead of in terms of AND, OR, and NOT.
- Caution. When using a + prefix, every word must have a prefix, otherwise unexpected results are returned.
- The FOCT also includes other utilities that could provide additional functionality (i.e. ACE viewers).
- I am happy to share more deeper technical information about searching the many FOCT indexes if requested.
Suggested FOCT Modifications
Increase Search Results Window size |
Open the file ..\foct-conf\ct-access-search.config Increase the number at the end of the line “#maximum number of DU displayable in result window” from 50 to (say) 500 |
