A guide to using the ICS Editor
This guide is intended to help you get up and running with the ICS Editor as quickly as possible. While there are more options than those described here, these are sufficient for getting started. You can also view this guide at http://www.opengroup.org/wapics, where a printout can be obtained via your web browser.

You will need to obtain a licence file from the Open Group for the WAP2 ICS Editor to operate. When you have received this file, store it alongside the ICS Editor .jar file.

It is assumed the reader is familiar with the following WAP Technical Specifications: 

  • WAP-262, WAP2 Class Conformance Requirements 
  • WAP-215, WAP June 2000 Class Conformance Requirements 
  • WAP-221, Specification of WAP Conformance Requirements 
This guide is organised to describe the features available from the menus and toolbar, and is ordered in terms of workflow to help you complete and validate an ICS for your implementation. 

The main features to help you develop and validate your ICS are as follows:-

The ICS Editor Frame

Below the toolbar, the ICS Editor frame is split into two panes. The left hand pane, hereafter called the "tree pane", contains the ICS features represented as nodes in an hierarchical tree structure. The right hand pane, hereafter called the "details pane" will show ICS information related to the selection in the ICS tree pane. 

Creating a new ICS

Before beginning work on your ICS we recommend that you first take a few moments to set up your preferred HTML Browser and, if required set up an HTML Proxy. 

When first entering the editor you will notice the "ICS Editor Home" node displayed in the top left hand corner of the tree pane and information relating the ICS Editor in the details pane. You will now need to create a new ICS or open an existing saved ICS. Creating a new ICS can be achieved as follows:-

  • by clicking on the "ICS Editor Home" with the right mouse button and selecting "Create New ICS" from the popup menu, or 
  • by clicking the  option in the toolbar, or
  • by selecting the "Create New ICS" option from the File menu. 
Having selected the feature to create a new ICS, you will need to enter some ICS configuration data. This will be presented using a dialog box. In the dialog, you need to select the Device Type from the drop down list selection, that is WAP2 Client or Server or Smart Card. You will also need to select the ICS Type, that is, certification or refpool.

When confirming the selection the Editor will load in an appropriate template. You will now see an "ICS Document" node appear with a unique name under the "ICS Editor Home".

This "ICS Document" node and its children "SCR Group" nodes can be expanded and collapsed to show the SCR items. This is done by double clicking the nodes with the left mouse button or clicking the corresponding key icon. 

Displaying ICS Details

You can display details for a selected node in the details pane by selecting the node in the tree pane. This is achieved by single clicking the node with the left hand mouse button. You will also inherently select the node when you double click to expand or collapse a node. A selected node will be highlighted with a Gray background. There are four details panes corresponding to each type of node as follows:-
  • ICS Editor Details 
  • ICS Document View 
  • Summary View of SCR Items 
  • SCR Item View 

Selecting SCR features

SCR (Static Conformance Requirements) items fall into four categories:-
  • Mandatory items, will appear using Black text 
  • Optional items which have been omitted (i.e. not selected), will appear using Gray text 
  • Optional items which have been selected, will appear using Blue text 
  • Excluded items will appear using Gray italicised text and smaller font size 

You will need to expand the ICS to expose the SCR items. The optional items can then be selected and deselected by clicking the SCR item using the right mouse button. SCR items can also be selected and deselected from the Summary View by clicking the items in the SCR State column. You can select and deselect all optional SCR items grouped under an "SCR Group" node. This is achieved by clicking the "SCR Group node" with the right mouse button to expose a pop up menu which provides the two selection options.

Saving the ICS

Much time is required to select all the SCR items claimed for the product and to ensure they validate against the inter-specification grammar. A feature is therefore provided to save your ICS as a persistent file in your local file system. The files are stored with file extension .csw. The option to save the file can be found as follows:-
  • by clicking on the selected "ICS Document" node with the right mouse button and selecting "Save ICS" from the popup menu. 
  • clicking the  option in the toolbar 
  • by selecting the "Save ICS" option from the File menu. 
The file can later be reopened. There is also a Save As  feature, to allow you to copy the file. Under no circumstances should the system file (.csw) be edited outside of the ICS editor.

Validating the ICS

When you have completed selecting the SCR items, you will need to validate your ICS. Validation will ensure the grammar associated with inter-specification dependencies of SCR items has NOT been broken. 

The option to select Validation can be found as follows:-

  • clicking the  option in the toolbar 
  • by selecting the option "Validate ICS" from the Certification menu. 
When the validation is complete a window will appear detailing any validation errors. Any SCR items in error will also be coloured Red. In addition any "SCR Group" nodes containing SCR items in error will be coloured Red. As the SCR items in error are modified, they will revert back to the blue/gray (selected/omitted) colouring scheme. A button exists at the top of this window, and when selected a report will be created in an html file and that file will be loaded into your selected html browser. The validation file will be stored as the file name of the .csw file appended by _validation.html. If there are no errors a dialog will be displayed informing you of that fact.

If the device type is a certifiable device type the validation will also ensure the registration details have been satisfactorily completed.

Opening an existing ICS

You can open and edit an existing ICS file, which has been stored in your local file system. The option to open a file can be found as follows:-
  • by clicking on the "ICS Editor Home" with the right mouse button and selecting "Open Existing ICS" from the popup menu, or
  • by clicking the  option in the toolbar, or 
  • by selecting the "Open Existing ICS" option from the File menu. 
A File Chooser dialog will be presented to help you select a .csw file. Once loaded an "ICS Document" node will appear under the "ICS Editor Home" node. The tree pane will be automatically collapsed to allow you to easily open and start work on the ICS.

Using the ICS Editor "open ICS" feature, the user loads in the selected ICS file (.csw). The Editor loads in the latest template consistent with the header information of the loaded ICS file and copies over the selection states of the optional SCR items from the loaded file. If the ICS file is being loaded into an updated template, the Editor presents a confirmation dialog. If confirmed, the Editor creates an updated ICS file and issues an html report presenting the user with the option to view the report. The import report will be stored as the file name of the .csw file appended by _import.html and will be found in the .icstemp directory.The report details :-

  • The version of the template on which the opened ICS file was based. 
  • The version of new ICS template. 
  • SCR Items available in the opened ICS file, which have been withdrawn from the latest ICS template. 
  • SCR Items available in the latest ICS template, which have been added since the creation of the opened ICS file. 
  • SCR Items set to selected in the opened ICS file and transferred to selected in the latest ICS template. 
  • SCR Items set to selected in the opened ICS file, but not transferred to selected in the latest ICS template. 

Applying for certification

Here is the workflow to submit your ICS application to the Certification Authority: -

Enter registration details

You will need to enter registration details when applying for certification. These details will need to be complete and valid  before submitting your ICS to the Certification Authority.The ICS editor will guide you through this. The registration details can be selected as follows:
  • clicking the  option in the toolbar
  • by selecting the "Enter ICS Registration Details" option from the Certification menu.
A series of dialog boxes will be presented to allow you to enter your registration details. Help text is provided, where necessary, at the top of the entry dialog box.  Once you have completed a dialog, proceed by selecting the "Next" button. If you wish to leave, select the cancel button. You can return later to update the fields. Dialog boxes will be presented in the following order:
  • Product identification
  • Bearer/Connectivity details
  • Parameters required for test session creation
  • Platform information
  • Component information
  • Billing/Invoicing contact details
  • Technical contact details

Validate the ICS

When you have entered your registration details and completed selecting the SCR items, you will need to validate your ICS. 

Upload the ICS

Once the ICS is free of all validation errors, the options to upload the ICS will be enabled. The option to upload the ICS to the CA server can be found as follows:-
  • by clicking the  option in the toolbar, or
  • by selecting the "Submit ICS to Certification Authority" option from the File menu.
and, if the upload is successful
  • Print the Certification or RefPool agreement using your preferred HTML Browser. This will allow you to obtain a hardcopy, sign the agreement and fax or post this to the CA. The agreement file will be stored as the file name of the .csw file appended by _agreement.html.
  • Print the ICS using your preferred HTML Browser. This will allow you to obtain a hardcopy of your ICS file in html format. The agreement file will be stored as the file name of the .csw file appended by _ics.html.
Once the upload is complete, the ICS will be made "READ ONLY" and it will not be possible to re-upload the document. The "ICS Document" node, "SCR Group" nodes and mandatory SCR items will appear in Green. You can, off course, use the "Save As" options to copy the file, the copied file will need to be validated.

You may need to set up an HTTP Proxy to facilitate the upload. 
 

Certification or RefPool agreement

Once you have successfully uploaded the ICS to the CA server, you will need to get a copy of the Certification or RefPool agreement signed off and sent by post or fax to the CA (The CA address is available in ICS Editor Details view).

An html file will be automatically compiled and loaded into your preferred HTML Browser when an ICS has been successfully uploaded to the CA server. Once in the browser you can use the browser's print facility to obtain a hardcopy of the agreement.

Print ICS

This option can be found by selecting the "Print ICS" option from the Certification menu. An option is available to load your ICS data in to your preferred HTML Browser to allow you to view/print the ICS. If your ICS is certifiable, your Product Information and registration details will also be displayed. 
 

Miscellaneous Features

Removing the ICS from the tree

There exists an option to remove the ICS from the tree pane. We recommend you only work on one ICS at a time. This feature allows you to remove an ICS from the editor before creating a new ICS or opening an existing ICS. This option can be selected as follows:-
  • by clicking on the selected "ICS document node" with the right mouse button and selecting "Remove ICS from Tree" from the popup menu, or 
  • by clicking the  option in the toolbar, or
  • by selecting the "Remove ICS from Tree" option from the File menu. 

Set Up Browser

A number of features are provided in the menus which require a path being set up to your preferred HTML Browser. The option to set up your preferred browser can be found by selecting the "Set Up Browser" option from the Tools menu. When selected a File Chooser dialog is provided to allow you to select your preferred HTML browser executable. 

Set Up HTTP Proxy

This option is to allows you to set up the host and port of an HTTP proxy if required to access the CA server. The option can be found by selecting the "Set Up HTTP Proxy" option from the Tools menu. 

Access a bug/problem report database

As long as you have a browser set up, this will take you to the ICS Editor bug/problem reporting system. The option to set up your preferred browser can be found by selecting the "Access Problem Reporting Database" option from the Tools menu. 
© 2004, The Open Group       (Updated on 5th March 2004)