AURA commands

AURA provides the following commands:

1. help

2. define

3. apianalyse

4. version

This is the most basic command and provides the help information about the commands and the available options.

Run the help command as shown below:

aura help [command name]

where, command name is command used to narrow down the help. If you provide a command name along with the help command, than, AURA provides the detailed help on the specified AURA command. For example:

aura help define

This provides the detailed help on the define command.

If no options are provided then the tool will output the general information listing all the available commands and their description.

This command reads the build's or the application's API information from the EDG reports and extracts into the database.

aura define

The define command uses two options to work with the build's API classification file and the application API file.

aura define -a <API file>

The define command option that is used to extract the API information from API Classification document to the database is:

• -a, the complete path to the API classification document

aura define -e <path to the text file which contains the EDG reports information> -i <path to text file which contains the system include files>

The following are the define command options which can be used to extract the API information of a component or an application to the database:

• -e, the complete path to the file containing the list of EDG report files, where EDG report contains source files used for APIs

• -i, the complete path to the file containing the list of include paths.

Use this command to compare and analyse the API information that is stored in the database. This command produces the human readable and non-tampered report based on the comparison and analysis.

aura apianalyse

The apianalyse command provides the following options:

• -r, the report file name and it's location

• -f, the filter level for which the report should be generated

  The available filter levels are publishedAll, publishedPartner, internalAll, internalTechnologyand internalComponent.

For example:

aura apianalyse -r d:\aura_report.xml -f internalAll

where, –r indicates that the aura_report.xml is the report file that is located in d:. -f indicates that the report needs to be generated for the API items that are classified under internalAll.

The apianalyse command first checks for the existence of the data model at the given location that is specified in the configuration file. If the data model exists and it is in good condition, then it sends a query to the data model to get the API usage information from the data model. The resulted data will be the detailed information about the Symbian APIs used in the application. Using this information, AURA will write the APIs used by the application and their classification information to an XML file. Using a stylesheet, AURA will convert the XML file into an HTML file.

If the data model is missing or corrupted, then this command stops comparing and sends an appropriate message back.

The figure shows the flow of the comparison and analysis of the API data:

Use this command to get the version number of the tool.

aura –ver

The versioning will be in the form <Major>.<minor>.<patch>. e.g. 1.0.1000.

You can specify your own properties file to customise the settings to your requirements along with the above commands.

For example:

aura -p M:\epoc32\tools\aura\aura.properties define -a M:\epoc32\data\imrep_03821_Symbian_OS_v9.3.xml