CGI/Servlet parameter list

Following is the summary of the parameter that can be given to OPRO X Server through CGI/Servlet. According to operation type, add "Variable Parameters" to the part denoted by "..." in "Fixed Parameters".

Operation Fixed Parameters Variable Parameters
Document Download DO=ex&OP=dl& ... &ES=odds FM, TP, CS, RF, AF, XT, EXT, and AT
Client Direct Printing DO=ex&OP=dp& ... &ES=odds TP, CS, and RF
Document Creation DO=ex&OP=cr& ... &ES=odds FM, TP, CS, AF, XT, EXT, and AT
Mail Transmission DO=ex&OP=ml& ... &ES=odds FM, UN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, MTn_m, MCCn_m, MBCn_m, MF, RT, MSJ, MB, MA, RRNn_m, HMn_m, TP, CS, XT, EXT, and AT
Fax Transmission DO=ex&OP=fx& ... &ES=odds UN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, FNn_m, TP and CS
Server Side Printing DO=ex&OP=pr& ... &ES=odds UN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, NCn_m, TP and CS
Data Download DO=ex&OP=dl& ... &ES=odts FM, SE, CP, TP, CS, and {USERINPUT}
Server List DO=sl& ... &ES=odds OP
Printer List DO=pl& ... &ES=odds OP, and TSn
Status DO=st& ... &ES=odds OP, TSn, and PID
Queue Information (mail/fax/print) DO=qi& ... &ES=odds OP, TSn, and PID
Cancel Operation (creation/mail/fax/print) DO=pcl& ... &ES=odds OP, TSn, UN, PW, and PID
Error Message DO=er& ... &ES=odds EC
Version Information DO=sv&ES=odcaw -
Re-connection to Databases DO=rc&ES=odcs -
User Input
(such as Request value, Dataset condition, or "Hide Layout if" parameter)
- (example) {Dataset1_1}, {request1}, {template.1}
Managing Contents through OCCS DO=ex& ... &ES=occs OP and CID

Additional Information

Document Download

Downloads the generated document.

Fixed Parameters

DO=ex&OP=dl& ... &ES=odds

Variable Parameters
NameMeaningValue
FM Format of document FM=o (OPR)
FM=x (OXR, decompressed OPR)
FM=p (PDF)
FM=h (HTML)
FM=h1 (HTML in single page)
TP Template name (example) When template name is "sample01.oxt", set
TP=sample01
If TP is omitted, the default template name given under DEFAULT_TEMPLATE in ODCAW.xml is used.
CS Character set for URL parameters (example) When the encoding of URL parameters is Shift_JIS, set
CS=Shift_JIS
RF Refresh time of response HTML (example) When refresh time of the response HTML is 10 seconds, set
RF=10
If RF is omitted or non-positive, OXS does not return the response HTML.
AFn
(n=index for multiple attachments)
File name of Attachment for OPR/OXR Attachment files are stored under ATTACHMENT path in ODCAW.xml
(example) AF0=sample1.doc&AF1=sample2.doc
XT XSLT file name for OXR When FM=x, the generated OXR can be transformed by an XSLT file.
XSLT files are stored under XSLT_IN_FILE path in ODCAW.xml
(example) XT=SampleTranform.xsl
EXT Extension of the transformed file When FM=x and XT parameter are given, the extension of transformed OXR file will be replaced by EXT value.
(example) EXT=txt
AT XSLT file name for HTML When FM=h, HTML is generated by using XSLT file specified at AGENT_TYPE in ODCAW.xml.
(example) When name attribute of AGENT_TYPE is given as <AGENT_TYPE name="sample">, set
AT=sample
Returned Content

The URL of document as Location HTTP header. (RF is omitted or non-positive)
The response HTML page giving status information. (RF is postive)

Client Direct Printing

Directly prints the downloaded document by OPRO X Browser.

Fixed Parameters

DO=ex&OP=dp& ... &ES=odds

Variable Parameters
NameMeaningValue
TP Template name Refer TP of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download"
RF Refresh time of response HTML Refer RF of "Document Download"
Returned Content

The URL of document as Location HTTP header. (RF is omitted or non-positive)
The response HTML page giving status information. (RF is postive)

Document Creation

Creates the document. After creating, it is possible to download it whenever required.

Fixed Parameters

DO=ex&OP=cr& ... &ES=odds

Variable Parameters
NameMeaningValue
FM Format of document Refer FM of "Document Download"
TP Template name Refer TP of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download"
AFn
(n=index for multiple attachments)
Name of the file to be attached to OPR/OXR output Refer AFn of "Document Download"
XT XSL transformation file name Refer XT of "Document Download"
EXT Extension of the transformed file Refer EXT of "Document Download"
AT XSLT name: It gives name attribute of AGENT_TYPE Refer AT of "Document Download"
Returned Content

HTML response giving the status of the document being created.

Mail Transmission

Sends the generated document as an attachment or in the mail body (in case of the HTML mail).

Fixed Parameters

DO=ex&OP=ml& ... &ES=odds

Variable Parameters
NameMeaningValue
FM Format of document Refer FM of "Document Download"
UN Login user name The user name which is given under ODMS_INFO of ODCAW.xml
(example) UN=ADMIN
PW Login password The password which is given under ODMS_INFO of ODCAW.xml
(example) PW=admin
TSn
(n=ServerIndex)
Target server The URL name which is given under ODMS_INFO of ODCAW.xml
(example) TS0=DEFAULT
DNn_m
(n=ServerIndex and m=DeviceIndex)
Device name (Specify SMTP server ) (example) DN0_0=127.0.0.1
GTn_m
(n=ServerIndex and m=DeviceIndex)
Document creation time The time in GMT with yyyyMMddHHmm format
(example) 2003 August 25th 15:00
GT0_0=200308251500
FPTn_m
(n=ServerIndex and m=DeviceIndex)
Schedule time The time in GMT with yyyyMMddHHmm format
(example) 2003 August 25th 15:30
FPT0_0=200308251530
CE Confirmation mail address (example) CE=mail@host
MTn_m
(n=ServerIndex and m=DeviceIndex)
Mail address (To) (example) MT0_0=user1@host
MCCn_m
(n=ServerIndex and m=DeviceIndex)
Mail address (CC) (example) MCC0_0=user2@host
MBCn_m
(n=ServerIndex and m=DeviceIndex)
Mail address (BCC) (example) MBC0_0=user3@host
MF Sender's mail address (example) MF=admin@host
RT Reply mail address (example) RT=admin@host
MSJ Subject (example) MSJ=MailSubject
MB Mail text (example) MB=MailBody
MA File name of the attachment (example) MA=MailAttachement
RRNn_m
(n=ServerIndex and m=DeviceIndex)
Request read notification If the value is true, Read Notification will be requested to the recipient.
(example) RRN0_0=true
HMn_m
(n=ServerIndex and m=DeviceIndex)
HTML mail If the value is true, HTML attachment will be embedded to the mail body.
(example) HM0_0=true
TP Template name Refer TP of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download"
XT XSL transformation file name Refer XT of "Document Download"
EXT Extension of the transformed file Refer EXT of "Document Download"
AT XSLT name: It gives name attribute of AGENT_TYPE Refer AT of "Document Download"
Returned Content

HTML response giving the status of mail transmission.

Fax Transmission

FAX the generated document.

Fixed Parameter

DO=ex&OP=fx& ... &ES=odds

Variable Parameters
NameMeaningValue
UN Login user name The user name which is given under OIFS_INFO of ODCAW.xml
(example) UN=ADMIN
PW Login password The password which is given under OIFS_INFO of ODCAW.xml
(example) PW=admin
TSn
(n=ServerIndex)
Target server The URL name which is given under OIFS_INFO of ODCAW.xml
(example) TS0=DEFAULT
DNn_m
(n=ServerIndex and m=DeviceIndex)
Device name (Specify FAX modem port number) The fax port numbers of the server can be listed with DO=pl request
(example) DN0_0=1
GTn_m
(n=ServerIndex and m=DeviceIndex)
Document creation time Refer GTn_m of "Mail Transmission"
FPTn_m
(n=ServerIndex and m=DeviceIndex)
Schedule time Refer FPTn_m of "Mail Transmission"
CE Confirmation mail address Refer CE of "Mail Transmission"
FNn_m
(n=ServerIndex and m=DeviceIndex)
FAX number (example) FN0_0=0123456789
TP Template name Refer TP of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download"
Returned Content

HTML response giving the status of fax transmission.

Server Side Printing

Prints generated document using a printer attached to the server.

Fixed Parameters

DO=ex&OP=pr & ... &ES=odds

Variable Parameters
NameMeaningValue
UN Login user name The user name which is given under OIPS_INFO of ODCAW.xml.
(example) UN=ADMIN
PW Login password The password which is given under OIPS_INFO of ODCAW.xml.
(example) PW=admin
TSn
(n=ServerIndex)
Target server The URL name which is given under OIPS_INFO of ODCAW.xml.
(example) TS0=DEFAULT
DNn_m
(n=ServerIndex and m=DeviceIndex)
Device name (printer name) The printer names of the server can be listed with DO=pl request
(example) DN0_0=Printer1
GTn_m
(n=ServerIndex and m=DeviceIndex)
Document creation time Refer GTn_m of "Mail Transmission"
FPTn_m
(n=ServerIndex and m=DeviceIndex)
Schedule time Refer FPTn_m of "Mail Transmission"
CE Confirmation mail address Refer CE of "Mail Transmission"
NCn_m
(n=ServerIndex and m=DeviceIndex)
Number of copies of the document to be printed (example) NC0_0=2
TP Template name Refer TP of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download"
Returned Content

HTML response giving the status of printing.

Data Download

Downloads the result of OQM file (Query file) as CSV or XML. Dataset in OPRO X Designer template can be saved as a OQM file.

Fixed Parameters

DO=ex&OP=dl& ... &ES=odts

Variable Parameters
NameMeaningValue
FM Format of document FM=c (CSV)
FM=x (XML)
SE Column separator for CSV output Comma (,) or Space ( )
(example) SE=,
CP Display Caption for CSV output When the value is true, display caption of columns of CSV data in the first row, or when the value is false, don't display caption.
(example) CP=true
TP Template name The OQM file with the extension
When the OQM file is "sample01.oqm", set
(example) TP=sample01.oqm
CS Character set for URL parameters Refer CS of "Document Download"
{USERINPUT} User input (example) {USERINPUT}=value01
* When multiple {USERINPUT}'s exist, it is necessary to request in the order given in the OQM file.
Returned Content

The URL of CSV or XML document

Server List

Gives the list of URL names of under ODMS_INFO, OIFS_INFO and OIPS_INFO of ODCAW.xml.

Fixed Parameters

DO=sl& ... &ES=odds

Variable Parameters
NameMeaningValue
OP Operation OP=ml (Mail Transmission)
OP=fx (Fax Transmission)
OP=pr (Server Side Printing)
Returned Content

HTML response like below

<html>
<head>
<title>OPRO Server List Response</title>
<META name="OPRO_TS" content="DEFAULT">
<META name="OPRO_TS" content="OIPS1">
<META name="OPRO_TS" content="OIPS_SOAP">
</head>
<body>DEFAULT OIPS1 OIPS_SOAP</body>
</html>

Printer List

Gives a list of available devices to the server.

Fixed Parameters

DO=pl& ... &ES=odds

Variable Parameters
NameMeaningValue
OP Operation Refer OP of "Server List"
TSn
(n=ServerIndex)
Target server When OP=ml,
the URL name which is given under ODMS_INFO of ODCAW.xml.
(example) TS0=ODMS1
When OP=fx,
the URL name which is given under OIFS_INFO of ODCAW.xml.
(example) TS0=OIFS1
When OP=pr,
the URL name which is given under OIPS_INFO of ODCAW.xml.
(example) TS0=OIPS1
Returned Content

HTML response like below

<html>
<head>
<title>OPRO Device List Response</title>
<META name="OPRO_Printer" content="FAX">
<META name="OPRO_Printer" content="APF Fax Printer">
</head>
<body>
FAX
APF Fax Printer
</body>
</html>

Status

Gives the status of the job in OXS.

Fixed Parameters

DO=st& ... &ES=odds

Variable Parameters
NameMeaningValue
OP Operation OP=cr (Document Creation)
OP=ml (Mail Transmission)
OP=fx (Fax transmission)
OP=pr (Server Side Printing)
TSn
(n=ServerIndex)
Target server When OP=cr, this is not needed.
When OP=ml,
the URL name which is given under ODMS_INFO of ODCAW.xml.
(example) TS0=ODMS1
When OP=fx,
the URL name which is given under OIFS_INFO of ODCAW.xml.
(example) TS0=OIFS1
When OP=pr,
the URL name which is given under OIPS_INFO of ODCAW.xml.
(example) TS0=OIPS1
PID Process ID (example) PID=OPRO__649671573
From response HTML
Returned Content

HTML response like below

<html lang="en">
<head>
<title>OPRO X Server - OMPS Response</title>
<META name="OXS_SID" content="KOPRO__020594554">
<META name="OXS_DOCUMENT_URL" content="http://192.168.100.58/odcaw2/odds_out/KOPRO__020594554OTD2.opr">
<META name="OXS_STATUS" content="Printed">
<META name="OXS_PID" content="ADMIN_1076304279117156_0">
</head>
<body>
<h1>OPRO X Server</h1>
<h2>Submitted OMPS Request</h2>
<dl>
<dt><a href="http://192.168.100.58/2.2scripts/odcaw2_cgi.exe?DO=st&OP=pr&UN=ADMIN& TS0=OIPS58&PID=ADMIN_1076304279117156_0&ES=odds">Current Status</a></dt>
<dd><p>Follow this link to get updated job status.</p></dd>
</dl>
<table id="AutoNumber1">
<tr>
<td>Download url</td>
<td>http://192.168.100.58/odcaw2/odds_out/KOPRO__020594554OTD2.opr</td>
</tr>
<tr>
<td>Session ID</td>
<td>KOPRO__020594554</dd></td>
</tr>
<tr>
<td>Status</td>
<td>Printed</dd></td>
</tr>
<tr>
<td>Error Code</td>
<td></td>
</tr>
<tr>
<td>Error Details</td>
<td></td>
</tr>
<tr>
<td>Error Description</td>
<td></td>
</tr>
<tr>
<td>PID</td>
<td>ADMIN_1076304279117156_0</td>
</tr>
</table>
<dl><dt><a href="">OMPS applet for DEFAULT</a></dt>
<dd>shows the status of OMPS common parameters for DEFAULT.</dd></dl>
</body>
</html>

Queue Information (mail/fax/print)

Fixed Parameters

DO=qi& ... &ES=odds

Variable Parameters
NameMeaningValue
OP Operation Refer OP of "Server List"
TSn
(n=ServerIndex)
Target server Refer TSn of "Printer List"
PID Process ID Refer PID of "Status"
Returned Content

HTML response similar to Status response

Cancel Operation (creation/mail/fax/print)

Fixed Parameters

DO=pcl& ... &ES=odds

Variable Parameters
NameMeaningValue
OP Operation Refer OP of "Server List"
TSn
(n=ServerIndex)
Target server Refer TSn of "Printer List"
UN Login user name
  • When OP=ml,
    the user name which is given under ODMS_INFO of ODCAW.xml.
    (example) UN=ADMIN
    When OP=fx,
    the user name which is given under OIFS_INFO of ODCAW.xml.
    (example) UN=ADMIN
    When OP=pr,
    the user name which is given under OIPS_INFO of ODCAW.xml.
    (example) UN=ADMIN
  • PW Login password
  • When OP=ml
    the password which is given under ODMS_INFO of ODCAW.xml.
  • (example) PW=admin
    When OP=fx
    the user name which is given under OIFS_INFO of ODCAW.xml.
    (example) PW=admin
    When OP=pr
    the user name which is given under OIPS_INFO of ODCAW.xml.
    (example) PW=admin
  • PID Process ID Refer PID of "Status"
    Returned Content

    HTML response like below

    <html>
    <head>
    <title>OPRO Cancel Job Response</title>
    <META name="OPRO_PID" content="ADMIN_107631628841170_0">
    <META name="OPRO_STATUS" content="Succesfully Cancelled">
    </head>
    <body></body>
    </html>

    Error Message

    Gives the error message for the error code. The error message file is given under MSG_FILE node of ODCAW.xml (usually it is [OXS installation directory]/conf/Error_descriptionJ.err). It contains the description and detail under each error code.

    Fixed Parameters

    DO=er& ... &ES=odds

    Variable Parameters
    NameMeaningValue
    EC Error code (example) EC=OXS-00001
    Returned Content

    HTML response like below

    <html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS">
    <title>OPRO X Server - Error Message</title>
    <META name="OPRO_EC" content="OXS-04110">
    <META name="OPRO_ERR_DES" content="Invalid Target Server specified">
    <META name="OPRO_ERR_DETAILS" content="The Target Server(TS) you specified is not listed in the ODCAW.xml.">
    </head>
    <body>
    <h1>Invalid Target Server specified</h1>
    <p>OXS-04110: The Target Server(TS) you specified is not listed in the ODCAW.xml.</p>
    </body>
    </html>

    Version Information of the Server

    Gives the version information of OXS.

    Fixed Parameters

    DO=sv&ES=odcaw

    Returned Content

    HTML response like below

    <html>
    <head><title>OPRO X Server Build Number</title></head>
    <body>OXS 2.2.0.0</body>
    </html>

    Re-connect to Databases

    When OXS is started it connects to databases under DATABASES node in the ODCAW.xml. If for some reasons OXS connection to one of these databases are lost, re-connect to databases can be used to establish the connection.

    Fixed Parameters

    DO=rc&ES=odcs

    Returned Content

    HTML response like below

    <html>
    <head><title>ODCS Reconnect Status</title></head>
    <body>Reconnected to :MSSQL_JDBC.</body>
    </html>

    User Input

    Variable Parameters
    NameMeaningValue
    {DatasetName_1} ... {DatasetName_n}
    *Name of Dataset given in the OXD template.
    User input for Dataset component (example) {Dataset1_1}=value01
    * "value01" denotes the value which the search condition should satisfy.
    In the case of multiple template request, parameter names should be changed to
    {TemplateName_DatasetName_n}
    TemplateName denotes name of the template.
    (example) {sample01_Dataset1_1}=value01
    {DBExecuteName_1} ... {DBExecuteName_n}
    *Name of DBExecute given in the OXD template.
    User input for DBExecute component (example) {DBExecute1_1}=value01
    * "value01" denotes the value given by the user.
    In the case of multiple template request, parameter names should be changed to
    {TemplateName_DBExecuteName_n}
    TemplateName denotes name of the template.
    (example) {sample01_DBExecutet1_1}=value01
    {RequestParamName}
    * The value "Request Parameter Name" given a component OXD template.
    User input for OXD component whose Data Type is "Request". (example){ Request1}=value01
    * In OXD, if the Type of Data property is "Request" with value "request1", it denotes the value given for "Request Parameter Name".
    * "value01" denotes the value given by the user.
    In the case of multiple template request, parameter names should be changed to
    {TemplateName_RequestParamName}
    TemplateName denotes name of the template.
    (example) {sample01_request}=value01
    {TP.LayoutIndex}=value
    * TP is the template name
    * LayoutIndex is the index number of the Layout in the OXD template.
    * value is the content given for {USERINPUT} defined in of "Hide Layout if" property of the Layout.
    User input for "Hide Layout if" function, used by OXD template layouts If the template name is "sample.oxt" whose "Hide Layout if" property of first Layout set as "{USERINPUT}=hide" and if you need to hide the first Layout, set
    {Sample.1}=hide

    Managing Contents through OCCS

    Fixed Parameters

    DO=ex& ... &ES=occs

    Variable Parameters
    NameMeaningValue
    OP Operation OP=cd (retrieve OCCS content)
    OP=cc (register OCCS content has been clicked)
    CID OCCS Content ID Storage ID of the content in "OPRO Content Control Service Administrator" under "OPRO X Server Administrative Tools"
    (example) CID=1
    Returned Content

    In case of OP=cd, URL of the content. In case of OP=cc, URL assigned to the content.

    Additional Information

    About ServerIndex and DeviceIndex

    ServerIndex
    The consecutive number which is allocated to the TS parameter when requesting (0 ... n)
    DeviceIndex
    The consecutive number which is allocated to the parameter where ServerIndex is added (0 ... m)

    Order of Parameters

    The rule for the order of parameter as given below.

    1. You must start with "DO".
    2. You must end with "ES".
    3. If request contain multiple "TP" with same template name having "User Input for Dataset" and "User Input for component whose Data Type is Request", then these User Inputs must immediately follow the respective template name, which uses them.
      For example, when multiple template request is done with "sample01.oxt"
      DO=ex&OP=dl&FM=o&TP=sample01&{sample01_Dataset1_1}=value01&TP=sample01&{sample01_Dataset1_1}=value02&ES=odds
      Here the "{sample01_Dataset1_1}=value01" belongs to first "sample01" template
      and "{sample01_Dataset1_1}=value02" belongs to second "sample01" template.

    Examples of Multiple User Input for Multiple Templates

    Single template with multiple "user inputs for a Dataset"
    DO=ex&OP=dl&FM=o&TP=sample01&{Dataset1_1}=value01&{Dataset1_2}=value02&ES=odds
    Multiple templates with multiple "user inputs for a Dataset"
    DO=ex&OP=dl&FM=o&TP=sample02&{sample02_Dataset1_1}=value01&{sample02_Dataset1_2}=value02&
    TP=sample01&{sample01_Dataset1_1}=value03&{sample01_Dataset1_2}=value04&ES=odds
    Single template with multiple "user inputs for a Dataset" and "user input for OXD component whose Data Type is defined as Request"
    DO=ex&OP=dl&FM=o&TP=sample01&{Dataset1_1}=value01&{Dataset1_2}=value02&{request}=value03&ES=odds
    Multiple templates with multiple "user inputs for a Dataset" and "user input for OXD component whose Data Type is defined as Request"
    DO=ex&OP=dl&FM=o&
    TP=sample02&{sample02_Dataset1_1}=value01&{sample02_Dataset1_2}=value02&{sample02_request}=value03&
    TP=sample01&{sample01_Dataset1_1}=value04&{sample01_Dataset1_2}=value05&ES=odds
    Copyright: © 2004 OPRO Japan Co., Ltd. https://www.opro.net