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, TM, AF, XT, EXT, FE and AT
Client Direct Printing DO=ex&OP=dp& ... &ES=odds TP, CS, RF and TM
Document Creation DO=ex&OP=cr& ... &ES=odds FM, TP, CS, TM, AF, XT, EXT, FE 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, MDL, MSJ, MB, MA, RRNn_m, HMn_m, TP, DC, TM, CS, XT, EXT, FE and AT
Fax Transmission DO=ex&OP=fx& ... &ES=odds UN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, DC, FNn_m, TP, TM, FR and CS
Fax Transmission (ApeosPort) DO=ex&OP=fxa& ... &ES=odds UN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, DC, FNn_m, TP, TM and CS
Fax Transmission (imagio) DO=ex&OP=fxi& ... &ES=odds UN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, DC, FNn_m, TP, TM and CS
Server Side Printing DO=ex&OP=pr& ... &ES=odds UN, PW, TSn, DNn_m, GTn_m, FPTn_m, CE, DC, NCn_m, TP, TM 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/fax(ApeosPort)/fax(imagio)/print) DO=qi& ... &ES=odds OP, TSn, and PID
Cancel Operation(creation/mail/fax/fax(ApeosPort)/fax(imagio)/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
Name Meaning Value Remarks
FM Format of document FM=o (OPR)
FM=x (OXR, decompressed OPR)
FM=v (OXV, OPRO X Viewer Format)
FM=p (PDF)
FM=h (HTML)
FM=h1 (HTML in single page)
FM=d (XDW, Fuji Xerox DocuWorks Format)
FM=p if not specified
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
If CS is omitted, its set to MS932.
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.
TM Timestamp sever name Timestamp sever name which is given under the name attribute of <ODDS>/<TIMESTAMP>/<SERVER> in configuration of OXS
(example) TM=tsa1
If omitted, no Timestamp Token File is created.
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
If AFn is omitted or the given AFn is non-existant, no attachment file is attached onto the downloaded file.
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
If XT is omitted, no transformation will take place.
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
If EXT is omitted, the extension of the transformed OXR will remain as oxr.
FE Use font embedding When FM=p and if FE is true, PDF document will be generated with the fonts embedded.
(example) FE=true
If FE is omitted, PDF will not have the fonts embedded in it.
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
If AT is omitted, the browsers default user agent is set as the agent type to generate HTML.
DIT(PDF) Title of Document PropertiesSpecify the value of the Title of Document Properties of PDF.If omitted, template name is used.
DIA(PDF) Author of Document PropertiesSpecify the value of the Author of Document Properties of PDF.If omitted, it becomes empty.
DIS(PDF) Subtitle of Document PropertiesSpecify the value of the Subtitle of Document Properties of PDF.If omitted, it becomes empty.
DIK(PDF) Keywords of Document PropertiesSpecify the value of the Keywords of Document Properties of PDF.If omitted, it becomes empty.
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
Name Meaning Value Remarks
TP Template name Refer TP of "Document Download" Refer TP of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download" Refer CS of "Document Download"
RF Refresh time of response HTML Refer RF of "Document Download" Refer RF of "Document Download"
TM Timestamp sever name Refer TM of "Document Download" Refer TM 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
Name Meaning Value Remarks
FM Format of document Refer FM of "Document Download" Refer FM of "Document Download"
TP Template name Refer TP of "Document Download" Refer TP of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download" Refer CS of "Document Download"
TM Timestamp sever name Refer TM of "Document Download" Refer TM 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" Refer AFn of "Document Download"
XT XSL transformation file name Refer XT of "Document Download" Refer XT of "Document Download"
EXT Extension of the transformed file Refer EXT of "Document Download" Refer EXT of "Document Download"
FE Use font embedding Refer FE of "Document Download" Refer FE of "Document Download"
AT XSLT name: It gives name attribute of AGENT_TYPE Refer AT of "Document Download" 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
Name Meaning Value Remarks
FM Format of document Refer FM of "Document Download" Refer FM of "Document Download"
UN Login user name The user name which is given under ODMS_INFO of ODCAW.xml
(example) UN=ADMIN
Can not be omitted
PW Login password The password which is given under ODMS_INFO of ODCAW.xml
(example) PW=admin
Can not be omitted
TSn
(n=ServerIndex)
Target server The URL name which is given under ODMS_INFO of ODCAW.xml
(example) TS0=DEFAULT
Can not be omitted
DNn_m
(n=ServerIndex and m=DeviceIndex)
Device name (Specify SMTP server ) (example) DN0_0=127.0.0.1 If DNn is omitted, the host given under OMPS_COMMON in ODCAW.xml is used as the device name.
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
If GTn_m is omitted, document is created immediately without delay.
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
If FPTn_m is omitted, schedule time is set for immediately.
CE Confirmation mail address (example) CE=mail@host If <CONFIRMATION_SENDER allow="YES"> in ODCAW.xml, and CE is omitted, mail address given under CONFIRMATION_SENDER is used, or if CE is invalid, no confirmation mail is sent.
MTn_m
(n=ServerIndex and m=DeviceIndex)
Mail address (To) (example) MT0_0=user1@host Can only be omitted if values for MCCn_m or MBCn_m are given.
MCCn_m
(n=ServerIndex and m=DeviceIndex)
Mail address (CC) (example) MCC0_0=user2@host If MCCn_m is omitted, no CC is sent.
MBCn_m
(n=ServerIndex and m=DeviceIndex)
Mail address (BCC) (example) MBC0_0=user3@host If MBCn_m is omitted, no BCC is sent.
MF Sender's mail address (example) MF=admin@host If MF is omitted, the mail address given under DEFAULT_FROM in ODCAW.xml is used.
RT Reply mail address (example) RT=admin@host If RT is omitted, reply to address is same as mail from.
MDL Mail Document Location When specified, ignores the MAX_ATTACHMENT given in the ODCAW.xml.
MDL=att (attach document to mail)
MDL=url (specify in the mail body the URL to download)
MDL=none (no attachment and no URL)
If MDL is omitted, mail will be sent in accordance to the other parameters specified.
MSJ Subject (example) MSJ=MailSubject If MSJ is omitted, no subject is set.
MB Mail text (example) MB=MailBody If MB is omitted, no mail text is set.
MA File name of the attachment (example) MA=MailAttachement If MA is omitted, attachment name is assigned KOPRO_ + id generated depending on time + template name.
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
If RRNn_m is omitted, RRNn_m is set to false.
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
If HMn_m is omitted, HMn_m is set to false.
TP Template name Refer TP of "Document Download" Refer TP of "Document Download"
DC Document Path Path from which to get generated document.
(example)
DC=AbsolutePath
DC=URL
If both DC and TP are specified, TP is given priority. If both DC and TP are omitted, the default template name given under DEFAULT_TEMPLATE in ODCAW.xml is used.
TM Timestamp sever name Refer TM of "Document Download" Refer TM of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download" Refer CS of "Document Download"
XT XSL transformation file name Refer XT of "Document Download" Refer XT of "Document Download"
EXT Extension of the transformed file Refer EXT of "Document Download" Refer EXT of "Document Download"
FE Use font embedding Refer FE of "Document Download" Refer FE of "Document Download"
AT XSLT name: It gives name attribute of AGENT_TYPE Refer AT of "Document Download" 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
Name Meaning Value Remarks
UN Login user name The user name which is given under OIFS_INFO of ODCAW.xml
(example) UN=ADMIN
Can not be omitted
PW Login password The password which is given under OIFS_INFO of ODCAW.xml
(example) PW=admin
Can not be omitted
TSn
(n=ServerIndex)
Target server The URL name which is given under OIFS_INFO of ODCAW.xml
(example) TS0=DEFAULT
Can not be omitted
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
If DNn is omitted, then the default fax port number of the target server is assumed.
GTn_m
(n=ServerIndex and m=DeviceIndex)
Document creation time Refer GTn_m of "Mail Transmission" Refer GTn_m of "Mail Transmission"
FPTn_m
(n=ServerIndex and m=DeviceIndex)
Schedule time Refer FPTn_m of "Mail Transmission" Refer FPTn_m of "Mail Transmission"
CE Confirmation mail address Refer CE of "Mail Transmission" Refer CE of "Mail Transmission"
DC Document Path Refer DC of "Mail Transmission" Refer DC of "Mail Transmission"
FNn_m
(n=ServerIndex and m=DeviceIndex)
FAX number (example) FN0_0=0123456789 Can not be omitted
TP Template name Refer TP of "Document Download" Refer TP of "Document Download"
TM Timestamp sever name Refer TM of "Document Download" Refer TM of "Document Download"
FR Fax resolution FR=normal (normal mode fax resolution)
FR=fine (fine mode fax resolution)
The values can be abbreviated so that,
n, no, nor, norm, norma = normal
f, fi, fin = fine
If FR is omitted, the fax resolution given under RESOLUTION in ODCAW.xml is used.
CS Character set for URL parameters Refer CS of "Document Download" Refer CS of "Document Download"
Returned Content

HTML response giving the status of fax transmission.

Fax Transmission (ApeosPort)

FAX the generated document using ApeosPort printer.

Fixed Parameter

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

Variable Parameters
Name Meaning Value Remarks
UN Login user name The user name which is given under MFP_FX_INFO of ODCAW.xml
(example) UN=ADMIN
Can not be omitted
PW Login password The password which is given under MFP_FX_INFO of ODCAW.xml
(example) PW=admin
Can not be omitted
TSn
(n=ServerIndex)
Target server The URL name which is given under MFP_FX_INFO of ODCAW.xml
(example) TS0=DEFAULT
Can not be omitted
DNn_m
(n=ServerIndex and m=DeviceIndex)
Device name (Specify ApeosPort printer name) The ApeosPort printer name of the server can be listed with DO=pl request
(example) DN0_0=FX ApeosPort C7550 I FAX
If DNn is omitted, then the first printer name of the target server, from an alphabetically ascending ordered printers list is assumed as the default printer.
GTn_m
(n=ServerIndex and m=DeviceIndex)
Document creation time Refer GTn_m of "Mail Transmission" Refer GTn_m of "Mail Transmission"
FPTn_m
(n=ServerIndex and m=DeviceIndex)
Schedule time Refer FPTn_m of "Mail Transmission" Refer FPTn_m of "Mail Transmission"
CE Confirmation mail address Refer CE of "Mail Transmission" Refer CE of "Mail Transmission"
DC Document Path Refer DC of "Mail Transmission" Refer DC of "Mail Transmission"
FNn_m
(n=ServerIndex and m=DeviceIndex)
FAX number (example) FN0_0=0123456789 Can not be omitted
TP Template name Refer TP of "Document Download" Refer TP of "Document Download"
TM Timestamp sever name Refer TM of "Document Download" Refer TM of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download" Refer CS of "Document Download"
Returned Content

HTML response giving the status of fax transmission.

Fax Transmission (imagio)

FAX the generated document using imagio printer.

Fixed Parameter

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

Variable Parameters
Name Meaning Value Remarks
UN Login user name The user name which is given under MFP_RICOH_INFO of ODCAW.xml
(example) UN=ADMIN
Can not be omitted
PW Login password The password which is given under MFP_RICOH_INFO of ODCAW.xml
(example) PW=admin
Can not be omitted
TSn
(n=ServerIndex)
Target server The URL name which is given under MFP_RICOH_INFO of ODCAW.xml
(example) TS0=DEFAULT
Can not be omitted
DNn_m
(n=ServerIndex and m=DeviceIndex)
Device name (Specify imagio printer name) The imagio printer name of the server can be listed with DO=pl request
(example) DN0_0=RICOH PCFAX(imagio MP 6000)
If DNn is omitted, then the first printer name of the target server, from an alphabetically ascending ordered  printers list is assumed as the default printer.
GTn_m
(n=ServerIndex and m=DeviceIndex)
Document creation time Refer GTn_m of "Mail Transmission" Refer GTn_m of "Mail Transmission"
FPTn_m
(n=ServerIndex and m=DeviceIndex)
Schedule time Refer FPTn_m of "Mail Transmission" Refer FPTn_m of "Mail Transmission"
CE Confirmation mail address Refer CE of "Mail Transmission" Refer CE of "Mail Transmission"
DC Document Path Refer DC of "Mail Transmission" Refer DC of "Mail Transmission"
FNn_m
(n=ServerIndex and m=DeviceIndex)
FAX number (example) FN0_0=0123456789 Can not be omitted
TP Template name Refer TP of "Document Download" Refer TP of "Document Download"
TM Timestamp sever name Refer TM of "Document Download" Refer TM of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download" 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
Name Meaning Value Remarks
UN Login user name The user name which is given under OIPS_INFO of ODCAW.xml.
(example) UN=ADMIN
Can not be omitted
PW Login password The password which is given under OIPS_INFO of ODCAW.xml.
(example) PW=admin
Can not be omitted
TSn
(n=ServerIndex)
Target server The URL name which is given under OIPS_INFO of ODCAW.xml.
(example) TS0=DEFAULT
Can not be omitted
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
If DNn is omitted, then the default printer of the target server is assumed.
GTn_m
(n=ServerIndex and m=DeviceIndex)
Document creation time Refer GTn_m of "Mail Transmission" Refer GTn_m of "Mail Transmission"
FPTn_m
(n=ServerIndex and m=DeviceIndex)
Schedule time Refer FPTn_m of "Mail Transmission" Refer FPTn_m of "Mail Transmission"
CE Confirmation mail address Refer CE of "Mail Transmission" Refer CE of "Mail Transmission"
DC Document Path Refer DC of "Mail Transmission" Refer DC of "Mail Transmission"
NCn_m
(n=ServerIndex and m=DeviceIndex)
Number of copies of the document to be printed (example) NC0_0=2 If NCn_m is omitted, NCn_m is set to 1.
TP Template name Refer TP of "Document Download" Refer TP of "Document Download"
TM Timestamp sever name Refer TM of "Document Download" Refer TM of "Document Download"
CS Character set for URL parameters Refer CS of "Document Download" 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
Name Meaning Value Remarks
FM Format of document FM=c (CSV)
FM=x (XML)
Can not be omitted
SE Column separator for CSV output Comma (,) or Space ( )
(example) SE=,
If SE is omitted, displayed without column separator.
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
If CP is omitted, the caption is displayed.
TP Template name The OQM file with the extension
When the OQM file is "sample01.oqm", set
(example) TP=sample01.oqm
Can not be omitted
CS Character set for URL parameters Refer CS of "Document Download" 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.
This cannot be omitted if the template requires inputs.
Returned Content

The URL of CSV or XML document

Server List

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

Fixed Parameters

DO=sl& ... &ES=odds

Variable Parameters
Name Meaning Value Remarks
OP Operation OP=ml (Mail Transmission)
OP=fx (Fax Transmission)
OP=fxa(Fax Transmission(ApeosPort))
OP=fxi(Fax Transmission(imagio))
OP=pr (Server Side Printing)
Can not be omitted
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
Name Meaning Value Remarks
OP Operation Refer OP of "Server List" 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=fxa,
the URL name which is given under MFP_FX_INFO of ODCAW.xml.
(example) TS0=MFPFX1
When OP=fxi,
the URL name which is given under MFP_RICOH_INFO of ODCAW.xml.
(example) TS0=MFPPCF1
When OP=pr,
the URL name which is given under OIPS_INFO of ODCAW.xml.
(example) TS0=OIPS1
Can not be omitted
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
Name Meaning Value Remarks
OP Operation OP=cr (Document Creation)
OP=ml (Mail Transmission)
OP=fx (Fax transmission)
OP=fxa(Fax Transmission(ApeosPort))
OP=fxi(Fax Transmission(imagio))
OP=pr (Server Side Printing)
Can not be omitted
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=fxa,
the URL name which is given under MFP_FX_INFO of ODCAW.xml.
(example) TS0=MFPFX1
When OP=fxi,
the URL name which is given under MFP_RICOH_INFO of ODCAW.xml.
(example) TS0=MFPPCF1
When OP=pr,
the URL name which is given under OIPS_INFO of ODCAW.xml.
(example) TS0=OIPS1
Can not be omitted
PID Process ID (example) PID=OPRO__649671573
>From response HTML
Can not be omitted
Returned Content

HTML response like below

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head>
<meta http-equiv="Pragma" content="no-cache" />
<meta http-equiv="Cache-Control" content="no-cache" />
<meta http-equiv="Expires" content="0" />
<meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<title>OPRO X Server - Print Service Request</title>
<meta name="OXS_PID" content="ADMIN_110604032015620_0" />
<meta name="OXS_DOCUMENT_URL" content="C:/Inetpub/wwwroot/odcaw2out/KOPRO__1199315202_1" />
<meta name="OXS_CANCEL_URL" content="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=pcl&OP=pr&TS0=DEFAULT&PID=ADMIN_110604032015620_0&ES=odds" />
<meta name="OXS_STATUS_URL" content="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=st&OP=pr&TS0=DEFAULT&PID=ADMIN_110604032015620_0&ES=odds" />
<meta name="OXS_STATUS" content="Printed" />
<meta name="OXS_PRINT_TYPE" content="ODPS" />
<meta name="OXS_PRINT_OWNER" content="ADMIN" />
<meta name="OXS_PRINT_PRINTER_NAME" content="\\qa1\HP LaserJet 4050 Series PCL 5e" />
<meta name="OXS_PRINT_COPIES" content="1" />
<meta name="OXS_PRINT_PAGESPERCOPY" content="1" />
<meta name="OXS_PRINT_SIZE" content="2" />
<meta name="OXS_PRINT_SUBMIT_TIME" content="200501180925" />
<meta name="OXS_PRINT_PRIORITY" content="1" />
<meta name="OXS_PRINT_GENERATE_TIME" content="" />
<meta name="OXS_PRINT_SCHEDULE_TIME" content="" />
<meta name="OXS_PRINT_PXC_TIME" content="200501180925" />
<meta name="OPRO_EC" content="" />
<meta name="OPRO_ERR_DETAILS" content="" />
<meta name="OPRO_ERR_DES" content="" />
<style type="text/css">
body { margin: 0; padding: 0; border: none; color: #000; background: #fff; font: normal 100%/120% sans-serif; }
h1 { margin: 0; padding: 0.5em 1em; border: none; border-bottom: 2px solid #036; color: #000; background: #def; font: bold 180% sans-serif; }
h2 { margin: 0; padding: 0.5em 1em; border: 1px #036; border-style: solid none; color: #036; background: #fff; font: bold 120% sans-serif; }
dl { margin: 0; padding: 1em; color: #000; background: #def; }
table { margin: 1em; border-collapse: collapse; }
th, td { padding: 0.1em 0.3em; border: 1px solid #999; }
th { color: #036; background: #9cf; font: bold 80% sans-serif; }
td { color: #000; background: #fff; font: normal 90% sans-serif; }
.sub { color: #036; font: bold 80% sans-serif; }
</style>
</head>
<body>
<h1>OPRO X Server <span class="sub">Print Service Request</span></h1>
<h2>Request Job Status</h2>
<dl>
<dt>Latest Status</dt>
<dd><strong>Printed</strong></dd>
<dt><a href="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=st&OP=pr&TS0=DEFAULT&PID=ADMIN_110604032015620_0&ES=odds">Current Status</a></dt>
<dd>Follow the above link to get updated job status.</dd>
</dl>
<dl>
<dt><a href="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=pcl&OP=pr&TS0=DEFAULT&PID=ADMIN_110604032015620_0&ES=odds">CANCEL</a></dt>
<dd>cancels your request to generate a document.</dd>
</dl>
<dl>
<dt><a href="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=va&OP=pr&UN=ADMIN&PW=abcd&TS0=DEFAULT&ES=odds">PRINT Applet for DEFAULT</a></dt>
<dd>shows the status of Print Service requests for DEFAULT.</dd>
</dl>
<h2>Request Parameters</h2>
<table summary="This table charts the name of request parameter, its values, and its role on execution.">
<thead>
<tr><th>Name</th><th>Value</th><th>Role</th></tr>
</thead>
<tbody>
<tr><td>DO</td><td>st</td><td>What to do</td></tr>
<tr><td>OP</td><td>pr</td><td>Operation</td></tr>
<tr><td>UN</td><td></td><td>Login User Name</td></tr>
<tr><td>TS0</td><td>DEFAULT</td><td>Target Server</td></tr>
<tr><td>NC0_0</td><td></td><td>Number of Copies</td></tr>
<tr><td>TP</td><td></td><td>Template</td></tr>
<tr><td>SS</td><td></td><td>Source Service</td></tr>
<tr><td>ES</td><td>odds</td><td>Execution Service</td></tr>
</tbody>
</table>
</body>
</html>

Queue Information (mail/fax/fax(ApeosPort)/fax(imagio)/print)

Fixed Parameters

DO=qi& ... &ES=odds

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

HTML response similar to Status response

Cancel Operation (creation/mail/fax/fax(ApeosPort)/fax(imagio)/print)

Fixed Parameters

DO=pcl& ... &ES=odds

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

HTML response like below

<html>
<head>
<meta http-equiv="Pragma" content="no-cache" />
<meta http-equiv="Cache-Control" content="no-cache" />
<meta http-equiv="Expires" content="0" />
<meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<title>OPRO X Server - Fax Service Request</title>
<meta name="OXS_PID" content="110604254762630" />
<meta name="OXS_DOCUMENT_URL" content="http://192.168.100.91/odcaw2out/KOPRO__3356449932.opr" />
<meta name="OXS_CANCEL_URL" content="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=pcl&OP=fx&TS1=81&PID=110604254762630&ES=odds" />
<meta name="OXS_STATUS_URL" content="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=st&OP=fx&TS1=81&PID=110604254762630&ES=odds" />
<meta name="OXS_STATUS" content="OIFS job canceled." />
<meta name="OPRO_EC" content="" /><meta name="OPRO_ERR_DETAILS" content="" />
<meta name="OPRO_ERR_DES" content="" />
<style type="text/css">
body { margin: 0; padding: 0; border: none; color: #000; background: #fff; font: normal 100%/120% sans-serif; }
h1 { margin: 0; padding: 0.5em 1em; border: none; border-bottom: 2px solid #036; color: #000; background: #def; font: bold 180% sans-serif; }
h2 { margin: 0; padding: 0.5em 1em; border: 1px #036; border-style: solid none; color: #036; background: #fff; font: bold 120% sans-serif; }
dl { margin: 0; padding: 1em; color: #000; background: #def; }
table { margin: 1em; border-collapse: collapse; }
th, td { padding: 0.1em 0.3em; border: 1px solid #999; }
th { color: #036; background: #9cf; font: bold 80% sans-serif; }
td { color: #000; background: #fff; font: normal 90% sans-serif; }
.sub { color: #036; font: bold 80% sans-serif; }
</style>
</head>
<body>
<h1>OPRO X Server <span class="sub">Fax Service Request</span></h1>
<h2>Request Job Status</h2>
<dl>
<dt>Latest Status</dt>
<dd><strong>OIFS job canceled.</strong></dd>
<dt><a href="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=st&OP=fx&TS1=81&PID=110604254762630&ES=odds">Current Status</a></dt>
<dd>Follow the above link to get updated job status.</dd>
</dl>
<dl>
<dt><a href="http://192.168.100.91/scripts/odcaw2_cgi.exe?DO=pcl&OP=fx&TS1=81&PID=110604254762630&ES=odds">CANCEL</a></dt>
<dd>cancels your request to generate a document.</dd>
</dl>
<dl>
<dt><a href="">FAX Applet for </a></dt>
<dd>shows the status of Fax Service requests for .</dd>
</dl>
<h2>Request Parameters</h2>
<table summary="This table charts the name of request parameter, its values, and its role on execution.">
<thead>
<tr>
<th>Name</th>
<th>Value</th>
<th>Role</th>
</tr>
</thead>
<tbody>
<tr><td>DO</td><td>st</td><td>What to do</td></tr>
<tr><td>OP</td><td>fx</td><td>Operation</td></tr>
<tr><td>UN</td><td></td><td>Login User Name</td></tr>
<tr><td>TS0</td><td></td><td>Target Server</td></tr>
<tr><td>FN0_0</td><td></td><td>Fax Number</td></tr>
<tr><td>TP</td><td></td><td>Template</td></tr>
<tr><td>SS</td><td></td><td>Source Service</td></tr>
<tr><td>ES</td><td>odds</td><td>Execution Service</td></tr>
</tbody>
</table>
</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
Name Meaning Value Remarks
EC Error code (example) EC=OXS-00001 If EC is omitted, error code is assigned a empty string value.
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
Name Meaning Value Remarks
{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
If this is omitted the corresponding Dataset will fail when executing queries on the database and hence the generated report will show empty data.
{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
If this is omitted, DBExecute component may execute erroneous scripts on the database.
{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
If this is omitted, the corresponding component will show empty data.
{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
If this is omitted, all the template layouts will be shown.

Managing Contents through OCCS

Fixed Parameters

DO=ex& ... &ES=occs

Variable Parameters
Name Meaning Value Remarks
OP Operation OP=cd (retrieve OCCS content)
OP=cc (register OCCS content has been clicked)
Can not be omitted
CID OCCS Content ID Storage ID of the content in "OPRO Content Control Service Administrator" under "OPRO X Server Administrative Tools"
(example) CID=1
Can not be omitted
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: © 2014 OPRO Japan Co., Ltd. https://www.opro.net