Skip to Content

Wiki source code of 06i. Extension Management

Last modified by Tom Jardine on 06/11/2025, 14:23
Hide last authors
Tom Jardine 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] is pre-configured with adapters for the most common extension and MIME types. Administrators can further extended Indexing compatibility as new extension and MIME types are created.
6
7 An Indexing adapter is a custom Java class that enables [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] to Index files in file systems or databases that have a particular extension type, such as .pdf or .html, or files on websites that have a particular MIME types, such as "text/html" or "application/acrobat".
8
9 Creating either an **Extension Type** or **MIME Type** adapter is a three stage process. First, the custom Java class must be created in the appropriate third-party application before being associated with with an adapter type in CXAIR. The adapter can then be mapped to an extension or MIME type.
10
11 = Adapters =
12
13 There are two adapter types that can be created: **Extension Type** and **MIME Type** adapters.
14
15 == Creating Adapters ==
16
17 To create an adaptor for either type, navigate to the Adapter Management screen by clicking **Setup**, **Extensions** then **Adapters**.
18
19 Enter a **Name** and **Display Name** for the new adapter in the relevant textboxes and enter the path of the custom Java class in the **Java Class Name** textbox.
20
21 Click **Create Adapter** to save the entries or **Cancel** to discard changes.
22
23 == Mapping Created Adapters ==
24
25 Once the relevant adapter has been created, this will now need to be mapped in the relevant screen.
26
27 For **MIME Type** adapters, navigate to the MIME Mappings screen by clicking **Setup**, **Extensions** then **MIME Mappings**.
28
29 For **Extension Type** adapters, navigate to the MIME Mappings screen by clicking **Setup**, **Extensions** then **Extension Mappings**.
30
31 When in the desired screen, enter a name for the **MIME** or **Extension** type and selected the entry created previously from the **Mapped Adaptor** drop-down list.
32
33 Click **Create** to save the entries, or click **Cancel** to discard the changes.
34
35 = Jar Files =
36
37 Custom .jar files can also be loaded into the system to extend Indexing compatibility.
38
39 To import a .jar file, navigate to the Jar Management screen by clicking **Setup**, **Extensions** then **Jars**.
40
41 Click **Choose File**, select the required file from the file explorer and click **Upload Jar** to upload the file and complete the process.
42
43 Please note that while .jar files can also be added directly to the [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] directory, they will be removed if the system is upgraded. To ensure imported .jar files do not get removed, always import the files using the Jar Management screen.
44