KLA allows you to define and modify custom metadata files. This tool helps you to ease the process of finding existing metadata files, creating, and editing custom metadata.
In addition, this tool helps the configurator to see KLA configuration path indicating if they are custom or default (read-only), filter them by language and framework, and search by class, method, and function.
This configurator guides you with tooltips, examples, and any checks or necessary validations. It will show you the process of adding all mandatory elements and attributes.
Types of custom metadata files
Custom metadata files can be configured at three levels. These levels are in order of precedence, the higher ones take precedence over the lower ones. Review the following table to learn about the three levels of configuration:
Level | Description |
|---|---|
Application-specific
| These XML files are located at {KLA_HOME}/conf/apps/{APPNAME}/libraries/<tech> Custom metadata in these files apply to all analyses of applications with a name {APPNAME} |
System-wide
| These XML files are located at {KLA_HOME}/conf/libraries/<tech> Custom metadata in these files apply to all analyses of all applications. |
Single analysis
| These XML files are located at {ANALYSIS_BASEDIR}/libraries/<tech> Custom metadata in these files apply only to analyses in the folder {ANALYSIS_BASEDIR}. |
Exceptions to these rules are the following:
- C++ engine reads from same folders as C (that is, <tech> for C++ is “c”)
- Objective-C engine reads from both “objective C” and “c” folders
For more information about metadata details and definition, review Custom Neutralizations.
Create a new metadata file
In the Analysis Configuration, click Customize Metadata, and select New.
Create a new metadata file by selecting the specific scope for your file, choosing the location, the language, or the associated programming language with the file, and typing a name for the file.
Below, find more information about the parameters when creating a new metadata file.
Location
Select a location for saving the new metadata file.
- Custom configuration for current application: Select this location to save the metadata file in the folder where the custom configuration files for the current application are stored
- Current application basedir analysis: Select this location to save the metadata file in the folder identified for the current application's basedir analysis
- Other: Select this location to save the metadata file in the folder of your preference.
Language
Select from the drop-down list the language to associate the files to a programming language.
Name
Specify a filename for the new metadata file. Notice that all metadata files are saved as XML, and they should follow the correct format, for example:
metadata_custom_<framework-name | library_name>.xml
If you do not add content, the metadata file will not be saved.
Edit a Metadata File
Kiuwan Local Analyzer allows you to edit your custom Metadata Files. The edited custom metadata files are saved in XML format in your selected location.
In the Analysis Configuration, click Customize Metadata, and select Edit.
Set the location of the files to be edited and filter them by language.
Below, find more information about the parameters when editing a metadata file:
Location
Set the location of the files you want to edit, the available options under this criteria are the following:
- Kiuwan Local Analyser default configuration (read-only): View the content of the files in this location and use them for analysis purposes.
- Systemwide Custom configuration: View and edit the related files.
- Custom configuration for current application: View and edit the files in this location.
- Current application basedir analysis: View and edit the files in this location.
- Other: View and edit metadata files in your available folders.
Language
Filter your metadata files by language and select from the drop-down list the language associated to your file.
Name
Lists all the metadata files under your filter criteria.
Select this location to save the metadata file in any folder of your choice.