Syntax for Alternate Languages

The coding syntax throughout this chapter has been Java* based. This syntax is compatible with Java and C# coding environments. However, the syntax is slightly different in other coding environments.

For your convenience, this section contains lookup tables with proper coding syntax for the Corda® Embedder API in the following programming environments:

ASP (VBScript)
Java Tag Library
PERL
PHP

ASP (VBScript)

Most of the time, Active Server Pages (ASP) are scripted using VBScript, whose syntax is somewhat different than the standard Java coding syntax. ASP.NET applications also may be based on VBScript. The tables below illustrate proper VBScript syntax for the complete Corda Embedder API.

Note: When scripting using JScript instead of VBScript, ignore this section and use standard Java coding syntax.

Attribute	ASP Syntax
appendServerInfoSlash	myImage.appendServerInfoSlash = false
autoSwitchToPNG
bgColor	myImage.bgColor = "FFFFFF"
clusterMonitorAddress	myImage.clusterMonitorAddress = "localhost/clusterMonitor"
externalServerAddress	myImage.externalServerAddress = "is.mycompany.com:2001"
extraCTSCommands	myImage.extraCTSCommands = commandstring
extraHTMLAttributes	myImage.extraHTMLAttributes = attributes
fallback	myImage.fallback = {"NONE" \| "LOOSE" \| "STRICT"}
height	myImage.height = 400
htmlHeight	myImage.htmlHeight = "75%"
htmlWidth	myImage.htmlWidth = "100%"
imageTemplate	myImage.imageTemplate = "image_template\bar.itxml"
internalCommPortAddress	myImage.internalCommPortAddress = "10.0.0.1:2002"
isPostRequest	myImage.isPostRequest = true
language	myImage.language = CordaEmbedder.EN
makeFullRequest (deprecated)	myImage.makeFullRequest = true
maxRequestLength	myImage.maxRequestLength = 2000
outputType	myImage.outputType = { "AUTO"\|"EMF"\|"EPS"\|"FLASH"\|"JPEG"\|"PDF"\|"PNG"\|"SVG*"\|"TABLE"\|"TEXTDESC"\|"TIFF"\|"URL" }
password	myImage.password = "password"
pcScript	myImage.pcScript = pcscript
returnDescriptiveLink	myImage.returnDescriptiveLink = true
svgTemplate	myImage.svgTemplate = "svg_templates/grow.svg"
useCache	myImage.useCache = true
useLogData	myImage.useLogData = true
userAgent	myImage.userAgent = userAgentString
width	myImage.width = 600

Method	ASP Syntax
addHTMLTable	myImage.addHTMLTable graph, title
addITXML	myImage.addITXML ITXMLString
addObjectParamTag	myImage.addObjectParamTag name, value
appendDoc
getBytes	myImage.getBytes()
getBytesNTO
getCordaEmbedderVersion	myImage.getCordaEmbedderVersion()
getEmbeddingHTML	myImage.getEmbeddingHTML()
loadCommandFile	myImage.loadCommandFile commandfile, encoding
loadData	myImage.loadData graphname, datasrc, method, HTMLTable, encoding
loadDoc	myImage.loadDoc name
loadFromCordaServer (deprecated)	myImage.loadFromCordaServer imagefile
loadITXML	myImage.loadITXML source
loadMapData	myImage.loadMapData mapname, layer, datasrc, HTMLTable, encoding
lockPDF	myImage.lockPDF username, ownername, options, enc
promptToSave	myImage.promptToSave filename
reset	myImage.reset
saveToAppServer	myImage.saveToAppServer path, name
saveToCordaServer	myImage.saveToCordaServer name
setCookieHeader	myImage.setCookieHeader cookieHeader
setData	myImage.setData graphname, data
setDBQuery	myImage.setDBQuery graphname, "", database, user, password, query
setDoc	myImage.setDoc name, basepath, encoding
setDocRoot	myImage.setDocRoot docRootPath
setLinkBehavior
setMapData	myImage.setMapData mapname, layer, data
setMapDBQuery	myImage.setMapDBQuery mapname, layer, "", database, user, password, query
setMapResultSet	NONE
setOrientation	myImage.setOrientation {"landscape" \| "portrait"}
setOutputName	myImage.setOutputName filename
setPageMargins	myImage.setPageMargin pagemargin
setPageSize	myImage.setPageSize pagesize
setPDFEmbedFonts
setResultSet	NONE
setTypedData
setTypedDBQuery
setTypedResultSet
useCache	myImage.useCache = true \| false

Java Tag Library

The tables below illustrate proper Java Tag library syntax for the complete Corda Embedder API.

Attribute	Java Tag Library Syntax
appendServerInfoSlash	<ctl:Corda appendServerInfoSlash="false" />
autoSwitchToPNG
bgColor	<ctl:Corda bgColor="FFFFFF" />
clusterMonitorAddress	<ctl:Corda clusterMonitorAddress="localhost/clusterMonitor" />
externalServerAddress	<ctl:Corda externalServerAddress="is.mycompany.com:2001" />
extraCTSCommands	<ctl:Corda extraCTSCommands="commandstring" />
extraHTMLAttributes	<ctl:Corda extraHTMLAttributes="attributes" />
fallback	<ctl:Corda fallback="NONE \| LOOSE \| STRICT" />
height	<ctl:Corda height="400" />
htmlHeight	<ctl:Corda htmlHeight="75%" />
htmlWidth	<ctl:Corda htmlWidth="100%" />
imageTemplate	<ctl:Corda imageTemplate= "image_templates\bar.itxml" />
internalCommPortAddress	<ctl:Corda internalCommPortAddress="10.0.0.1:2002" />
isPostRequest	<ctl:Corda postRequest="true" />
language	<ctl:Corda language="EN" />
makeFullRequest (deprecated)	<ctl:Corda makeFullRequest="true" />
maxRequestLength	<ctl:Corda maxRequestLength="2000" />
outputType	<ctl:Corda outputType=" AUTO\|EMF\|EPS\|FLASH\|JPEG\|PDF\|PNG\|SVG\|TABLE\|TEXTDESC\|TIFF\|URL " />
password	<ctl:Corda password="password" />
pcScript	<ctl:pcScript> pcscript </ctl:pcScript>
returnDescriptiveLink	<ctl:Corda returnDescriptiveLink="true" />
svgTemplate	<ctl:Corda svgTemplate="svg_templates/grow.svg" />
useCache	<ctl:Corda useCache="false" />
useLogData	<ctl:Corda useLogData="true" />
userAgent	<ctl:Corda userAgent="userAgentString" />
width	<ctl:Corda width="600" />

Method	Java Tag Library Syntax
addHTMLTable	<ctl:addHTMLTable object ="objectname" [title="title" ] />
addITXML	<ctl:addITXML> ITXMLString </ctl:addITXML >
addObjectParamTag	<ctl:addObjectParamTag name ="name" value="value" />
appendDoc
getBytes	NONE
getBytesNTO
getCordaEmbedderVersion	NONE
getEmbeddingHTML	NONE1
loadCommandFile	<ctl:loadCommandFile [encoding="encoding"] source="commandfile" />
loadData	<ctl:loadData graph="graphname" source="datasrc" [method="append"] [table="HTMLTable"] [encoding="encoding"] />
loadDoc	<ctl:Corda loadDoc="webpage" />
loadFromCordaServer (deprecated)	<ctl:loadFromCordaServer source="imagefile" />
loadITXML	<ctl:loadITXML source ="itxmlsrc" />
loadMapData	<ctl:loadMapData map="mapname" source="datasrc" [method="append"] [ table="HTMLTable"] [encoding="encoding"] />
lockPDF	<ctl:lockPDF [userPasswd="password" ownerPasswd="password" lockCode="lockcode" [highEnc="imagefile" ]] />
promptToSave	< ctl:Corda promptToSave= "filename" />
reset	NONE
saveToAppServer	NONE
saveToCordaServer	NONE
setCookieHeader	<ctl:Corda cookieHeader="cookieHeader" />
setData	<ctl:setData graph="graphname" > data </ctl:setData>
setDBQuery	<ctl:setDBQuery graph="graphname" driver="driver" database="database" [user="user"] [password="password"] query="query" />
setDoc	<ctl:setDoc [basepath="path" ] [encoding="encoding "]>...document... </ctl:setDoc>
setDocRoot	<ctl:Corda docRoot ="docRootPath" />
setLinkBehavior
setMapData	<ctl:setMapData map="mapname" layer="layer" > data </ctl:setMapData>
setMapDBQuery	<ctl:setMapDBQuery map="mapname" layer="layer" driver="driver" database="database" [user="user"] [password="password"] query="query" />
setMapResultSet	NONE
setOrientation	<ctl:Corda orientation ="portrait \| landscape" />
setOutputName	<ctl:Corda outputName="$filename" />
setPageMargins	<ctl:Corda pageMargins ="margin" />
setPageSize	<ctl:Corda pageSize ="pagesize " />
setPDFEmbedFonts
setResultSet	NONE
setTypedData
setTypedDBQuery
setTypedResultSet
useCache	<ctl:Corda useCache="false" />

1. The getEmbeddingHTML() method is executed automatically when the <ctl:Corda> tag closes. Effectively, </ctl:Corda> executes myImage.getEmbeddingHTML().

PERL

The tables below illustrate proper PERL syntax for the complete Corda Embedder API.

Attribute	PERL Syntax
appendServerInfoSlash	$myImage->appendServerInfoSlash (0);
autoSwitchToPNG
bgColor	$myImage->bgColor ("FFFFFF");
clusterMonitorAddress	$myImage->clusterMonitorAddress ("localhost/clusterMonitor");
externalServerAddress	$myImage->externalServerAddress ("is.mycompany.com:2001");
extraCTSCommands	$myImage->extraCTSCommands ($commandstring);
extraHTMLAttributes	$myImage->extraHTMLAttributes ($attributes);
fallback	$myImage->fallback ({"NONE" \| "LOOSE" \| "STRICT"});
height	$myImage->height (400);
htmlHeight	$myImage->htmlHeight ("75%");
htmlWidth	$myImage->htmlWidth ("100%");
imageTemplate	$myImage->imageTemplate ("image_templates\bar.itxml");
internalCommPortAddress	$myImage->internalCommPortAddress ("10.0.0.1:2002");
isPostRequest	$myImage->isPostRequest (1);
language	$myImage->language ("EN");
makeFullRequest (deprecated)	$myImage->makeFullRequest (1);
maxRequestLength	$myImage->maxRequestLength (2000);
outputType	$myImage->outputType ({"AUTO"\|"EMF"\|"EPS"\|"FLASH"\|"JPEG"\|"PDF"\|"PNG"\|"SVG"\|"TABLE"\|"TEXTDESC"\|"TIFF"\|"URL"});
password	$myImage->password ("password");
pcScript	$myImage->PCScript ($pcscript);
returnDescriptiveLink	$myImage->returnDescriptiveLink (1);
svgTemplate	$myImage->svgTemplate ("svg_templates/grow.svg");
useCache	$myImage->useCache (0);
useLogData	$myImage->useLogData (1);
userAgent	$myImage->userAgent ($userAgentString);
width	$myImage->width (600);

Method	PERL Syntax
addHTMLTable	$myImage->addHTMLTable ($graph,$title);
addITXML	$myImage->addITXML ($ITXMLString);
addObjectParamTag	$myImage->addObjectParamTag ($name,$value);
appendDoc
getBytes	$myImage->getBytes();
getBytesNTO
getCordaEmbedderVersion	$myImage->getCordaEmbedderVersion();
getEmbeddingHTML	$myImage->getEmbeddingHTML();
loadCommandFile	$myImage->loadCommandFile ($commandfile, $encoding);
loadData	$myImage->loadData( $graphname, $datasrc, $method, $HTMLTable, $encoding);
loadDoc	$myImage->loadDoc ($name);
loadFromCordaServer (deprecated)	$myImage->loadFromCordaServer($ imagefile);
loadITXML	$myImage->loadITXML ($xmlsrc);
loadMapData	$myImage->loadMapData( $mapname, $layer, $datasrc, $HTMLTable, $encoding);
lockPDF	$myImage->lockPDF ($username, $ownername, $options, $enc);
promptToSave	$myImage->promptToSave ($filename);
reset	$myImage->reset();
saveToAppServer	$myImage->saveToAppServer ($path, $name);
saveToCordaServer	$myImage->saveToCordaServer($ name);
setCookieHeader	$myImage->setCookieHeader(cookieHeader);
setData	$myImage->setData ($graphname, $data);
setDBQuery	NONE
setDoc	$myImage->setDoc( $name, $basepath, $encoding);
setDocRoot	$myImage->setDocRoot(docRootPath);
setLinkBehavior
setMapData	$myImage->setMapData ($mapname, $layer, $data);
setMapDBQuery	NONE
setMapResultSet	NONE
setOrientation	$myImage->setOrientation ("landscape" \| "portrait");
setOutputName	$myImage->setOutputName ($filename);
setPageMargins	$myImage->setPageMargin ($pagemargin);
setPageSize	$myImage->setPageSize($ pagesize);
setPDFEmbedFonts
setResultSet	NONE
setTypedData
setTypedDBQuery
setTypedResultSet
useCache	$myImage->useCache (0);

PHP

The tables below illustrate proper PHP syntax for the complete Corda Embedder API.

Attribute	PHP Syntax
appendServerInfoSlash	$myImage->appendServerInfoSlash = false;
autoSwitchToPNG
bgColor	$myImage->bgColor = "FFFFFF";
clusterMonitorAddress	$myImage->clusterMonitorAddress = "localhost/clusterMonitor";
externalServerAddress	$myImage->externalServerAddress = "is.mycompany.com:2001";
extraCTSCommands	$myImage->extraCTSCommands = $commandstring;
extraHTMLAttributes	$myImage->extraHTMLAttributes = $attributes;
fallback	$myImage->fallback = {"NONE" \| "LOOSE" \| "STRICT"};
height	$myImage->height = 400;
htmlHeight	$myImage->htmlHeight = "75%";
htmlWidth	$myImage->htmlWidth = "100%";
imageTemplate	$myImage->imageTemplate = "image_templates\bar.itxml";
internalCommPortAddress	$myImage->internalCommPortAddress = "10.0.0.1:2002";
isPostRequest	$myImage->isPostRequest = true;
language	$myImage->language = "EN";
makeFullRequest (deprecated)	$myImage->makeFullRequest = true;
maxRequestLength	$myImage->maxRequestLength = 2000;
outputType	$myImage->outputType = {"AUTO"\|"EMF"\|"EPS"\|"FLASH"\|"JPEG"\|"PDF"\|"PNG"\|"SVG"\|"TABLE"\|"TEXTDESC"\|"TIFF"\|"URL"};
password	$myImage->password = "password";
pcScript	$myImage->PCScript = $pcscript;
returnDescriptiveLink	$myImage->returnDescriptiveLink = true;
svgTemplate	$myImage->svgTemplate = "svg_templates/grow.svg";
useCache	$myImage->useCache = false;
useLogData	$myImage->useLogData = true;
userAgent	$myImage->userAgent = $userAgentString;
width	$myImage->width = 600;

Method	PHP Syntax
addHTMLTable	$myImage->addHTMLTable ($graph, $title);
addITXML	$myImage->addITXML ($ITXMLString);
addObjectParamTag	$myImage->addObjectParamTag ($name, $value);
appendDoc
getBytes	$myImage->getBytes();
getBytesNTO
getCordaEmbedderVersion	$myImage->getCordaEmbedderVersion() ;
getEmbeddingHTML	$myImage->getEmbeddingHTML() ;
loadCommandFile	$myImage->loadCommandFile ($commandfile, $encoding);
loadData	$myImage->loadData( $graphname, $datasrc, $method, $HTMLTable, $encoding);
loadDoc	$myImage->loadDoc ($name);
loadFromCordaServer (deprecated)	$myImage->loadFromCordaServer($imagefile);
loadITXML	$myImage->loadITXML ($xmlsrc);
loadMapData	$myImage->loadMapData( $mapname, $datasrc, $layer, $HTMLTable, $encoding);
lockPDF	$myImage->lockPDF ($username, $ownername, $options, $enc);
promptToSave	$myImage->promptToSave = $filename;
reset	$myImage->reset():
saveToAppServer	$myImage->saveToAppServer ($path, $name);
saveToCordaServer	$myImage->saveToCordaServer($name);
setCookieHeader	$myImage->setCookieHeader(cookieHeader);
setData	$myImage->setData ($graphname, $data);
setDBQuery	NONE
setDoc	$myImage->setDoc( $name, $basepath, $encoding);
setDocRoot	$myImage->setDocRoot(docRootPath);
setLinkBehavior
setMapData	$myImage->setMapData ($mapname, $layer, $data);
setMapDBQuery	NONE
setMapResultSet	NONE
setOrientation	$myImage->setOrientation ("landscape" \| "portrait");
setOutputName	$myImage->setOutputName ($filename);
setPageMargins	$myImage->setPageMargin ($pagemargin);
setPageSize	$myImage->setPageSize($pagesize);
setPDFEmbedFonts
setResultSet	NONE
setTypedData
setTypedDBQuery
setTypedResultSet
useCache	$myImage->useCache = false;