ODDS Parameter List


Sample URL to call odcaw2_cgi.exe

http://..../odcaw2_cgi.exe?DO=ex&FM=p&OP=dl&TP=Document1
This URL calls 'odcaw2_cgi.exe'.
Then 'odcaw2_cgi.exe' redirects the document made from 'Document1' template in PDF format.

Parameter details

Parameter

Meaning

Mandatory

Value

Meaning

Return Value

DO

Task to

Perform

*

ex

execute

HTTP Redirection(when OP=dl,dp,cd,cc)

HTML Response(when OP= pr,px,fx,ml) includes meta data to be used with DO=st,er requests.

META tag
<META name="OPRO_PID" content="ProcessID">  

<META name="DOCUMENT_URL" content="outfile-url/filename"> 

ProcessID Syntax:  

for OP=pr,px,mlUSER_RandomNumber_JobIndex

e.g.:  ADMIN_1027328196886_0

for OP=fx - RandomNumber

e.g.: 1027328196886 

for OP=px,

<META name="RID" content="RequestID">  

RID - RequestID generated by DocumentManager Servlet

sl

Get server list

List separated by LF
HTML Response(possible OP values: OP= pr,fx,ml)

List of available OIPS,OIFS or ODMS names.

META tag
<META name="OPRO_TS" content="TargetServer">

TargetServer: name” attribute of the “URL” node of OIPS_INFO, OIFS_INFO or ODMS_INFO as in ODCAW.xml

pl

Get device(printer) list

List separated by LF

HTML Response(possible OP values: OP= pr,fx,ml)

List of devices (ex. Printers, modems, smtps) available in OIPS, OIFS or ODMS

META tag

for OP=pr

<META name=”OPRO_Printer”   content ="PrinterName">

e.g.:

 <META name=” OPRO_Printer”   content =" \\Oprolanka\HPLaserJ.2">

for OP=fx

<META name=”OPRO_Modem”   content =”ModemPort”>

e.g.1(when modem is on COM1):

 <META name=”OPRO_Modem”   content =”1”>

e.g.2(when using FaxBoard):

 <META name=”OPRO_Modem”   content =”Fax-Board”>

for OP=ml

<META name=”OPRO_SMTP”   content ="smtp">

st

Get status

Status of a given job. (print, fax or mail)

HTML Response.
META tag

<META name="OPRO_PID"  content ="processID">
<META name="OPRO_STATUS"   content ="status">

Status of a given job. (printexchange)

HTML Response.
META tag

eg:
<META name="OPRO_PID" content="ADMIN_1040717957528_0">
<META name="PXC_ID" content="OPROT_spl:1149">
<META name="PXC_JOB_NAME" content="KOPRO__1477164a.opr">
<META name="PXC_current-job-state" content="retained">
<META name="PXC_job-state-reasons" content="successful-completion">
<META name="PXC_previous-job-state" content="printing">
<META name="PXC_job-copies-completed" content=" ">
<META name="PXC_printer-name-requested" content="HP4050PS_lp">
<META name="PXC_assigned-queue" content="HPQ1_q">
<META name="PXC_printers-assigned" content="YO_pp">
<META name="PXC_total-job-octets" content="15200">
<META name="PXC_submission-time" content="24:12:2002:14:19:32">
<META name="PXC_job-submission-complete" content="true">
<META name="PXC_time-at-processing" content="24:12:2002:14:19:40">
<META name="PXC_started-printing-time" content="24:12:2002:14:19:40">
<META name="PXC_completion-time" content="24:12:2002:14:19:40">
<META name="PXC_job-comment" content="ADMIN_1040717957528_0">

er

Get error message

Detailed error message.

HTML Response.

cl

cancel Queued Print/Fax/Mail Jobs

Status of a cancel request.

HTML Response.
META tag
<META name="OPRO_PID" content=" ProcessId ">

<META name="OPRO_STATUS" content="jobStatus ">

eg.

<META name="OPRO_PID" content=" ADMIN_1031897337873_0 ">

<META name="OPRO_STATUS" content="Succesfully Cancelled">

sm

send a execution message to a server

XML response

sv

serverversion html response

<html><head><title>ODCAW Server Build Number</title></head><body>ODCAW 2.0.27.11</body></html>

 

DO=ex (Further Notes)

Parameter

Meaning

Mandatory

Value

Meaning

Remarks

OP

Operation

OPeration

 

  dl

Download

download

OP=dl if not specified.

dp

Direct to print

direct to printer

px

PrinteXchange Request

printexchange

pr

Printer(OIPS)output

printer

fx

FAX(OIFS)output

fax

ml

Mail(ODMS)output

mail

cd

Display a content from OCCS

content display

cc

Send that content is clicked, to OCCS.

clicked content

FM

Format

ForMat

  o

OPR

(OP=dl, pr, px, fx, ml)

FM=p if not specified (when OP=dl,ml)

p

PDF

(OP=dl,ml)

h

HTML

(OP=dl,ml)

h1

HTML in Single page. This is supported for templates with DatasetTables(OP=dl,ml)

c

CSV out from DataSet

(OP=dl,SE=)

x

XML out from DataSet

(OP=dl)

SE

Seperator

SEperator

 

This can be a ",", a space, etc.(single character) or multi character

The separator value is used to separate column data in the output file.

(OP=dl,FM=c)

SE tag will only appear when the

FM = c.

TP

Template

TemPlate

*when DO=ex&

OP=dl,dp,

fx,ml,pr,px

Name of the template

Template file name

(valid only when DO=ex&OP=dl,dp, pr, px, fx,ml)

eg.1 DO=ex&OP=dl&FM=o&TP=templateName&

ES=oddsTemplate file name with extension when DO=ex&OP=dl&ES=odts

eg.2

DO=ex&OP=dl&FM=c&SE=,&

TP=DataSet1.oqm&ES=odts

When the template is not in the root folder of OFMS , subfolders has to be given with the template name. ( Eg: subfolder1/ template)

{TP.LayoutIndex}

TP:TemPlate

LayoutIndex:Index given for the layout

 

value saved in template

Hide Layout if value

(valid only when DO=ex&OP=dl,dp,pr,px,fx,ml)

If the value entered by the user matches the value given in Template.Layout, the layout will be hidden

{DatasetName_1}

.

.

.

{DatasetName_n}

n- KeyIndex

  Query Key value value used in the query

Always associated with a template file

{Request

ParamName}

Name of the OXD Object whose source is Requset

  Parameter value

Used as the value for OXD Component with Request type data-source

Always associated with a template

TS0 .. TSn

Target Server

TargetServer

 

*

when OP= pr, fx, px, ml

 

OIPS Name, for OP=pr or px

OIFS Name, for OP=fx

ODMS Name for OP=ml

name” attribute of the “URL” node of OIPS_INFO, OIFS_INFO or ODMS_INFO as in ODCAW.xml

Applicable only when OP= pr, px, fx, ml.

DN0_0 .. DN0_n

DN1_0 .. DN1_n

DN2_0 .. DN2_n

..

..

..

DNm_0 .. DNm_n

DeviceName

DeviceName

m: Server Index(OIPS,OIFS, ODMS)

n: Device Index

 

for  OIPS: printer_name

for OIFS:

COM Port Number or “Fax-Board”

for ODMS:

smtp server

 

Applicable only when OP= pr, px, fx, ml. If not specified default is assumed.

FN0_0

FN1_0

..

..

FNm_0

Fax Number

FaxNumber

m: Server Index

* when OP=fx

Fax number/s separated by comma

 

Applicable only when OP=fx.

NC0_0 .. NC0_n

NC1_0 .. NC1_n..

..

NCm_0 .. NCm_n

No of copy

Number of Copy m: Server Indexn: Device Index

 

Number of copies

 

Applicable only for OP= pr, px NC=1 if not specified.

GT0_0 .. GT0_n

GT1_0 .. GT1_n

..

GTm_0 .. GTm_n

Generate time

GenerateTime

m: Server Index

n: Device Index

 

Generate time

Time to generate the report in YYYYMMDDhhmmss(fixed digits) format

Specified in GMT. Generate Now if not specified.

FPT0_0 .. FPT0_n

FPT1_0 .. FPT1_n

..

FPTm_0 ..FPTm_n

Fax Print or Mail Time

m: Server Index

n: Device Index

 

Print, Fax or Mail time

Time to print, fax or mail the report in YYYYMMDDhhmmss(fixed digits) format

Specified in GMT Right after GT if not specified.

UN

User Name

UserName

*

DO=ex or DO=cl and OP=pr, px, fx, ml

User Name

User Name specified in the ODCAW.xml

Applicable when DO=ex or DO=cl and OP=pr, px, fx,ml

PW

PassWord

PassWord

*

DO=ex or DO=cl and OP=pr, px, fx, ml

Password Password specified in the ODCAW.xml for the specified user. Applicable when DO=ex or DO=cl and OP=pr, px, fx, ml

CE

Confirmation Email

Confirmation Email

 

  Email Address Recipients of the confirmation email

Confirmation Mail Recepient list seperated by comma or semi-colon

The first recepient address will be used as the From address Applicable only for

OP=pr, px, fx,  ml

MT0_0..MT0_n

MT1_0..MT1_n

..

MTm_0..MTm_n

Mail To

Mail To

* Email Address Recipients of ODMS mail

Mail Recipient list seperated by comma or semi-colon Applicable only for OP=ml

MBC0_0..MBC0_n

MBC1_0..MBC1_n

..

MBCm_0.MBCm_n

Mail Blind Carbon Copy

Mail Blind Carbon Copy

m: Server Index

n: Device Index

  Email Address Recipients of MBCs of ODMS mail

Mail Recipient list seperated by comma or semi-colon Applicable only for OP=ml

MCC0_0..MCC0_n

MCC1_0..MCC1_n

..

MCCm_0.MCCm_n

 

MailCarbonCopy

MailCarbonCopy

 

m: Server Index

n: Device Index

  Email Address Recipients of CCs of ODMS mail

Mail Recipient list seperated by comma or semi-colon Applicable only for OP=ml

MSJ

Mail Subject

MailSubJect

  Subject Subject of the Mail

Applicable only for OP=ml

MB

Mail Body

MailBody

  Message Mail Body

Applicable only for OP=ml

MA

Mail Attachement

MailAttachement

  Attachment  

Attachment name. If no value specified, ODDS output file name will be used.Applicable only for OP=ml

RT

Reply To

Reply To

  Email Address Default reply address

Reply to address.Applicable only for OP=ml

MF

From

MailFrom

  Email Address Mail from address

From address. Applicable only for OP=ml

RRN0_0. RRN0_n

RRN1_0..RRN1_n

RRNm_0.RRNm_n

Request Read Notification

m: Server Index

n: Device Index

  Boolean  value(true/false) If the value is true, Read Notification will be requested from the recipients

Applicable only for OP=ml

HM0_0…HM0_n

HM1_0..HM1_n

HMm_0….  HMm_n

Html Mail

Html Mail

m: Server Index

n: Device Index

  Boolean  value(true/false) If the value is true, HTML attachment will be embedded to email body

Applicable only for OP=ml and FM=h

SS

Source Server

 

ofms

Template file is retrieved from SS.

If not specified, Template file is obtained from the <IN_FILE>

CID

ID of the content in OCCSContent ID   Integer value greater than 0.

Apply only when DO=ex&OP=cc,cd

CS

Request Character Set

CharacterSet

  Supported character sets.  

Default is Shift_JIS

RID RequestID   String Generated by DocumentManager servlet

Default is opr file name

ES

Execution Server

Execution Server

*

odds,odms,oips,oifs,

occs,odts,osms,ofms

decides the server that will execute the command

 

 

DO=sl

Parameter

Meaning

Mandatory

Value

Meaning

Remarks

OP

Operation
OPeration

* pr, fx, ml

pr-Print

fx-Fax

ml-Mail

Applicable only for OP=fx, pr or ml

ES

Execution Server

Execution Server

*

odds

ODDS will be executing this command

 

 

DO=pl

Parameter

Meaning

Mandatory

Value

Meaning

Remarks

OP

Operation
OPeration

* pr, fx, ml

pr-Print

fx-Fax

ml-Mail

Applicable only for OP=fx, pr or ml

TS0

TS1

..

TSm

Target server
TargetServer

m-Server Index

*

OP=pr: OIPS Name

OP=fx: OIFS Name

OP=ml:ODMS Name

“name” attribute of the “URL” node of OIPS_INFO, OIFS_INFO or ODMS_INFO as in ODCAW.xml
ES

Execution Server

Execution Server

*

odds

ODDS will be executing this command

DO=st

Parameter

Meaning

Mandatory

Value

Meaning

Remarks

OP

Operation
OPeration

* pr, px, fx, ml

pr,px-Print

fx-Fax

ml-Mail

 

TS0

Target server
TargetServer

*

OP=pr, px: OIPS Name

OP=fx: OIFS Name

OP=ml:ODMS Name

“name” attribute of the “URL” node of OIPS_INFO, OIFS_INFO or ODMS_INFO as in ODCAW.xml

 

   

 

PID0

PID1

…..

PIDn

ProcessID
ProcessID

n-any integer

* processID Return value of DO=ex

    

ES

Execution Server

Execution Server

*

odds

ODDS will be executing this command

 

DO=cl

Parameter

Meaning

Mandatory

Value

Meaning

Remarks

OP

Operation
OPeration

* pr, fx, ml

pr-Print

fx-Fax

ml-Mail

 

TS0

Target server
TargetServer

*

OP=pr: OIPS Name

OP=fx: OIFS Name

OP=ml:ODMS Name

“name” attribute of the “URL” node of OIPS_INFO, OIFS_INFO or ODMS_INFO as in ODCAW.xml

 

PID0

PID1

…..

PIDn

ProcessID
ProcessID

n-any integer

* processID Return value of DO=ex

 

ES

Execution Server

Execution Server

*

odds

ODDS will be executing this command

 

DO=er

Parameter

Meaning

Mandatory

Value

Meaning

Remarks

EC

Error code
ErrorCode

* error code

EC(errorcode)received by DO=ex or DO=st

Eg.

ODCAW-00002

 

ES

Execution Server

Execution Server

*

odds

ODDS will be executing this command

 

 

DO=sm

Parameter

Meaning

Mandatory

Value

Meaning

Remarks

ME

Message content to be sent
Message

* XML Message

Please refer ODTSDeveloper, OSMSDeveloper, OFMSDeveloper and  OCCSDeveloper Guide for valid values for “ME”.

The message must not be URL Encoded

ES

Execution Server

Execution Server

*

odts, osms, ofms, occs

Middle server names of ODCAW

 

    

 

DO=sv

Parameter

Meaning

Mandatory

Value

Meaning

Remarks

ES

Execution Server

Execution Server

*

odcaw

 

 

    

 

 

Notes

Note1: Order dependency of HTML form parameters.

Form parameters submitted to ODCAW server can occur in any order except for the following:

1. Must begin with 'DO' .

2. Must end with 'ES'.

3. If more than one 'TP' parameters exist(Multiple Templates) and all are of same value, 'Query Parameters' and 'Request Paramters' of one 'TP' should occur in full, before the next 'TP' begins.

Note2: Syntax for Multiple Template Requests.

Query Parameters : {tp_DatasetName_KeyIndex}

Request Parameter : {tp_RequestParamName}

where

tp - Value of the parameter TP.

DatasetName -Name of the Dataset used in the template tp.

KeyIndex - Index given in the template tp.

RequestParamName - Name of the 'OXD Object' used in the template tp ,with 'Request' type data-source.

Examples:

single template with Qury Parameters

DO=ex&OP=dl&FM=o&TP=T2&{Dataset1_1}=-1&{Dataset1_2}=50&ES=odds

multiple template with Qury Parameters

DO=ex&OP=dl&FM=o&TP=T2&{T2_Dataset1_1}=-1&{T2_Dataset1_2}=50&TP=T1&{T1_Dataset1_1}=10&{T1_Dataset1_2}=50&ES=odds

single template with Qury Parameters and Request Parameters

DO=ex&OP=dl&FM=o&TP=T2&{Dataset1_1}=-1&{Dataset1_2}=50&{RQparam}=wwwww&ES=odds

multiple template with Qury Parameters and Request Parameters

DO=ex&OP=dl&FM=o&TP=T2&{T2_Dataset1_1}=-1&{T2_Dataset1_2}=50&{T2_RQparam}=wwwww&TP=T1&{T1_Dataset1_1}=10&{T1_Dataset1_2}=50&ES=odds

multiple template but template names are same

DO=ex&OP=dl&FM=o&TP=T2&{T2_Dataset1_1}=-1&{T2_Dataset1_2}=50&{T2_RQparam}=wwwww&TP=T2&{T2_Dataset1_1}=0&{T2_Dataset1_2}=40&{T2_RQparam}=mmmmmm&ES=odds