Here is the introduction.
The next sections describes all parameters that can be passed to the applets divided into the following subsections:
Depending on the above settings, one or more of the sections below should be consulted.
A number of parameters are standard APPLET paramaters and are not specific for OpenOces applets. Of these, only CABBASE is a <PARAM>-tag, the others are attributes to APPLET.
| Name | Value type | Default value | Description |
|---|---|---|---|
| cabbase | absolute or relative URL | no | URL to where cab file path is based - for IE with MS JVM |
| WIDTH | int | no | Width of applet in pixels. Adjust with other size parameters to desired layout |
| HEIGHT | int | no | Width of applet in pixels. Adjust with other size parameters to desired layout |
| code | Qualified name of applet | n/a | Name of BootApplet (i.e. "org.openoces.opensign.client.applet.bootstrap.BootApplet") |
| codebase | relative path between docbase and jar | n/a | Relative path between html-doc with applet-tag and location of jar-file (e.g. ".") |
| archive | Name of jar-file containing applet | no | Name of jar-file containing BootApplet (e.g. "OpenSign-bootstrapped.jar") |
The design of the bootstap applet is explained here. Below is described how to set up the parametes for use by OpenSign/OpenLogon.
Below are some general parameters guiding the execution of the applet.
| Name | Value type | Default value | Description |
|---|---|---|---|
| loglevel | debug, info, warn, error, fatal | debug | loglevel for OpenSign/OpenLogon applet for logging to java console |
| refreshcerts | true | false | true | Indicates if the certificates should be read again when applet is started. Otherwise they can be cached between invocations (beware if setting it to true - users may be confused when e.g. cd-card is inserted but not noticed) |
These parameters gives some control of the layout of the applet. See additional parameters in the sections about OpenSign and OpenLogon
You configure which mode to use with these parameters
| opensign.doappletrequest | {"true","false"} | "false" | Configures the applet to use either the 2-step mode or the 3-step mode. If the parameter is set to true, the 3-step mode is used. |
| opensign.doappletrequestonmac | {"true","false"} | "false" | Configures the applet to use either the 2-step or the 3-step mode on MacOS X. If the parameter is set to true, the 3-step mode is used when the applet is run on the MacOS X platform. |
You can limit the list of certificates shown to the user with these filters.
| Name | Value type | Default value | Description |
|---|---|---|---|
| subjectdnfilter | val | n/a | Base64 encoding of a string the subject dn must contain |
| sernofilter | val | n/a | Base64 encoding of a string the serial number must contain |
| issuerdnfilter | val | n/a | Base64 encoding of a string the issuer dn must contain |
These parameters are currently only supported when the "GUI"-parameter has been set to "CLASSIC".
| Name | Value type | Default value | Description |
|---|---|---|---|
| certificateid | base64 encoded certificate | n/a | Identification of certificate to pre-select. Note: it must match by name shown in listbox! |
| socialsecuritynumber | boolean (yes/no) | no | If yes: also show textfield for entry of social security number. Only supported when "GUI"-parameter is "classic" |
| optionalid | {"CUSTOMERID","USERID"} | no | If you want an extra textfield for entry of CUSTOMERID or USERID. It will be part of the signed document. |
| optionalentrylen | integer | 16 | The length of the textfield for CUSTOMERID or USERID |
A number of parameters depends on the selection of the above mentioned parameters. They are described in this section.
If you want to use 3-step mode a number of parameters must be set up.
| Name | Value type | Default value | Description |
|---|---|---|---|
| opensign.alerturi | An url | n/a | Configures the url to which the user is directed if an unexpected situation occurs while executing the applet. |
| opensign.canceluri | An url | n/a | Configures the url to which the user is directed if the user refuses to sign the document by cancelling the applet. |
| opensign.erroruri | An url | n/a | Configures the url to which the user is directed if an unrecoverable error occurs. |
| opensign.verifiederroruri | An url | n/a | Configures the url to which the user is directed upon unsuccesful completion of step 2. This parameter is only relevant when the applet operates in 3-step mode. |
| opensign.verifiedokuri | An url | n/a | Configures the url to which the user is directed upon succesful completion of step 2. This parameter is only relevant when the applet operates in 3-step mode. |
| opensign.verifieruri | An url | n/a | Configures the url to which the signed document is posted using the http protocol. This parameter is only relevant when the applet operates in 3-step mode. |
| opensign.formdata.count | A number | 0 | The number of hidden form fields to set |
| opensign.formdata.count | A number | 0 | The number of hidden form fields to set |
| opensign.formdata."n".name | A name | n/a | The name of field number "n" starting with 0 |
| opensign.formdata."n".value | A value | n/a | The value of field number "n" starting with 0 |
| opensign.cookiecount | A number | 0 | The number of cookies to post |
| opensign.cookie."n".name | A name | n/a | The name of cookie "n" starting with 0 |
| opensign.cookie."n".value | A value | n/a | The value of cookie "n" starting with 0 |
These parameters only matters for the applet in OpenSign mode.
| Name | Value type | Default value | Description |
|---|---|---|---|
| wrap | {true, false} | false | If true: only vertical scrollbar for text to be signed - text is wrapped. |
| signtextfontname | Name of font - for jdk 1.1: {TimesRoman/Serif, Helvetica/SansSerif, Courier/Monospaced, Dialog, DialogInput} | Courier | Name of font for text to be signed |
| signtextfontsize | [6-32] | 12 | Size of font for text to be signed |
| signtextcols | [5-120] | 80 | Number of columns of area displaying text to be signed. If outside range: dynamically fills vacant space. |
| signtextrows | [5-50] | 15 | Number of rows of area displaying text to be signed. If outside range: dynamically fills vacant space. |
| signtextbgcolor | r;g;b | bgcolor | Color of the background of the text to be signed |
| signtext | Base64 encoded text | no | Base64 encoding of the text to be signed. |
| signproperties | name=val,name=val | no |
These parameters only matters for the applet in OpenLogon mode.
| Name | Value type | Default value | Description |
|---|---|---|---|
| logonto | String | n/a | ? |
The applet can also be operated in a GUI less mode where you can let it do its stuff by calling applet.doService() from JavaScript.
| Name | Value type | Default value | Description |
|---|---|---|---|
| SERVICE_PROVIDER | {capi, pkcs12, cdcard, ...} | n/a | Name of keystore providing the service |
| SERVICE_NAME | String, depending on what is supported | n/a | Name of service |
| SERVICE_PARAM | Depending on service | n/a | Parameter to send to service. |