The New option reveals a submenu of options.
Creates an empty template with one Structure element with a placeholder element.
This option opens the following dialog:
When an XML file is selected a new CAM template will be created using the XML as the basis for the initial Structure. All the element and attribute field contents will be surrounded by '%' (percentage) symbols, indicating to CAM that the contents are purely example values. No Rules will be created by the action. The new template will have no name and will need to be saved.
It is possible to create a CAM Template from an existing XML Schema. To do this the following dialog must be completed to allow the import of the correct details into the new CAM template.
As schemas can import many other schemas the first field is the root directory within which files will exist. Then from within that directory the main schema is chosen. If global Elements exist the user must choose from one of these to craete the new CAM Template. If however no global Element exist the user may chose a global Complex Types as the root for the example.
There are a number advanced options that can be accessed by checking the Advanced Options Enabled check box. The first option is the level for log messsages. the higher the number the more output is generated. It is possible to simply extract the simple structure and the rules associated with the node. It is also possible to extract annotations from the schem file. If annotations are imported they can either be generated in a separate file or in-line. Annotations may be namespaced and it is possible to ignore content from namespaces if required. Lastly if annotations exist in the schema they may be structured in which case the user can decide to simply extract the text or pull in the full structure. The last Advanced option allows the user to specify a Pick List. This allows the importing process to select only those parts of the schema that are relevant to the application. (See Export Pick List)
This option opens the following dialog to allow a existing CAM template to be edited.
This option simply saves the current template overwriting the original file.
This option opens the following dialog to allow the user to save the file under a different name and at a different location than the orginal file.
The file is then saved as in the location chosen and under the name selected.
This option closes the current CAM template. If it has changed the following dialog will show:
This option reveals a list of previously used CAM Templates. This allows fast access to previously edited files. The List of files is kept in an XML file called recentFiles.xml which will be in the CAMEditor directory of your runtime eclipse environment.
This option will generate a wantlist based on the current template. It will ask for the filename of the wantlist using the save as dialog and then it will generate the wantlist. A wantlist will only be generated if there are nodes which are marked as Excluded.
Like the Pick List export this will prompt the user for a filename for the compressed file. This will generate a file that will have all the excluded nodes removed. After the file has been generated the user will be asked if they want to load the new compressed file. The format of the compressed file is the cxf format which is an alternative format for the CAM template.
The CAM template standard format has the structure and the rules and the annotations in separate parts of the file. The cxf format calculates the rules and annotations that belong to each node and allocate the details appropriately. This format is easier to produce some forms of documentation and some of the tools that the editor uses. This option will prompt the user for a filename.
This option will export the current template as an XML schema. This may be a set of files as schema can only have one namespace per file.
The first field is the root directory into which the schema file(s) will be exported. The second file is the stub filename that all the schema files will use. The last option is to say if namespaces should be used or not. Use the false option with care.
Each node in a structure can have an annotation explaining what it means. Also nodes may have an special annotation called 'Value'. This is used to indocate either a value for the node or a set of values for the node. The Example generator uses these values to put sensible values in the examples. This option allows the user to export these hints as a separate file, that can then be imported into other CAM Templates.
This option allows a user to generate a set of examples based on the CAM Template rules and the Example Hints.
The Output Location is the directory into which the examples will be placed.
The file name stub is the prefix for all the example files.
The Schema file name is an optional filename for the schema that will be associated with the examples.
Number of examples is a slider that allows the user to select how many examples will be created up to a maximum of 20.
Number of repeats is an optional field that indicates how many times repeatable elements should be repeated with in the example.
Optional values allows the user to select whether optional nodes are put into the resulting examples. The options are 'all' for all optional fields will be included; 'random' to allow the generator to select which fields will be generated; and 'none' meaning only mandatory fields will be produced.
Generate Random Errors allows the user to get the generator to create files that are not valid against the current template.
Where Example hints do not exist for fields the option Default Content defines whether these nodes will contain the name of the type that should be in the node e.g. string or the name of the field.
Use namespaces enables the examples to be generated using namespace or not.
The first advanced option of Hints File allows an external hints file to be used instead of in file annotations.
The second advanced option allows the seed value for the random generator used within the generator to be set. This allows consistent values to be seeded across runs.
The output of the process is a set of examples and a report that points to those examples.
This option allows an example Hints file to be imported into the current template. The process is that the file is merged with the current annotations and an optional hints file. After the merge the file can either be used to replace the current annotations file or simply just a new file (strictly not an import).
This will apply the details of a wantlist to the current template. The user is presented with a file dialog from which they must select a wantlist. This is then applied to the template.
This option shuts down the CAM template editor.
This allows the CAM Template Owner to be set using a simple dialog.
This allows the CAM Template Description to be set using a simple dialog.
This allows the CAM Template Version to be set using a simple dialog.
This allows external codelists or lookup lists to be created and edited from within the CAM editor.
This option allows the user to set the annotation file name for the current template. This will switch the annotations file for the current template to the file selected. Any unsaved annotations will be lost.
This action brings up a dialog box that allows addition Views to be displayed. The dialog looks like:
This option provides an html output of the underlying CAM template in an XML format. The result is saved to a file and is shown in a browser window. It is possible to save the file to a new location by using the Save As button.
This option provides an html output of the underlying CAM template in a structured format showing every aspect of the Template in a seperate table. The result is saved to a file and is shown in a browser window. It is possible to save the file to a new location by using the Save As button.
Example Tabular Documentation Output
This option provides an html output of the underlying CAM template in a tabular format. The result is saved to a file and is shown in a browser window. It is possible to save the file to a new location by using the Save As button.
Example Interactive Documentation Output
This option produces a document based on the TiddlyWiki format. This allows easy navigation around the document.
This option allows the user to see the Lookup lists that have been included in the template. It also allows them to import a list and remove a list from the template.
This menu is related to a set of actions that are applied to an XML file opened with the XML View. Currently only one XML file may be opened at a time. The reason for including this option within the CAM editor was to allow manipulation of XML files that are included into the CAM template. Although this was seen as the primary role it is not restricted to just included files. For mor details on using the XML editor see XML View
Allows the creation of a new XML file. The XMl View is opened with a dummy element called "ReplaceThisElement".
This allows an existing XML file to be opened by launching the Open File dialog. Once a file has been selected it is opened in the XML View.
This saves the current XML file back to its original location overwriting the previous instance.
This allows the XML file to be saved in a different location and possibly under a different name.
As a new feature of the latest CAM implementation, it is possible to put into a XML file a link that points at the CAM template that should be used to validate the XML file. This option adds the link to the XML file if a template is open within the editor.
After this option has been used the XML will contain an extra attribute @asi:templateLocation.
This option will take any text content of elements or attributes and surround them with % (percentage) symbols.
This option closes the current XML file. If changes have been made and not saved a dialog asking if the file should be saved will appear.
This calls the refresh view option on the currently selected view.
This resets the view the user has to the perspective defined by the application.
This runs a validation checker over the current CAM template looking for errors.
An example of the output can be found at : Example Validation Template Output
This option saves the current template in a compiled format that will be used by future JCAM processors as the input format.
This prompts the user for a file that contains the UBL codelist and it will convert it to a CAM lookup List format.
This option allows the CAMV processor to be invoked using the current CAM Template. For more details on the run options see Run options .
When an XML file has been associated with a CAM template it is possible to run the XML file. This means that the XML file is checked against the CAM template it is associated with.
This shows the list of allowed perspectives. This option would not normallly be needed.
This allows the next perspective to be selected. This option would not normallly be needed.
This allows the previous perspective to be selected. This option would not normallly be needed.
If the user has accidently changes the currently open layout of views. They can set them to the default position by using this option. This option would not normallly be needed.
The CAM Editor uses a number of preferences for things like how annotations and lookup list should be stored to the names of stylesheets that are used in the various tools and export and import options. Blank entries mean that no preference is set. The user can use the option to gain access to the various preference screens.
In theory this should display the help content for the CAM editor. This may work. However, the installation of the the help files seems to be problematic.
This opens the About dialog. This shows teh version number of the CAM Editor in use and also provide options to help understand the Eclipse plug-ins used by the Editor and also through the configuration option gain access to the error log in the event of problems.