• scope, parentId
  Most methods have a scope and parentId Parameter.
  scope is a enum type with the following values (In comet_pdf omit the trailing enum name Scope..)
  • Scope.DOCUMENT
  • Scope.SPREAD
  • Scope.PAGE
  • Scope.COMETGROUP
  • Scope.ELEMENT
  Depending on the scope, parentId is
  • unused (Scope.DOCUMENT)
  • the 0-based spread index (Scope.SPREAD)
  • the 0-based page index (Scope.PAGE)
  • the Comet Group ID (Scope.COMETGROUP)
  • the UID of a frame (Scope.ELEMENT)
  
  
• reorganize
  reorganize is a enum type with the following values (In comet_pdf omit the trailing enum name ReorganizeLevel..)
  • ReorganizeLevel.NONE
  • ReorganizeLevel.PAGE
  • ReorganizeLevel.SPREAD
  • ReorganizeLevel.SUBSEQUENT
  • ReorganizeLevel.FULL
  
  
• recordID
  recordID is a string with a complete definition of a Comet object ID. Format is
  int, int, int, string
  Example : "1, 0, 0, \"116007\""
  
  
• tmpFile
  Results larger than 32kB and binary results are dumped to the given file. Use threshold=your_value (or -1) to increase the 32kB limit for a single call. Use commandline option -cometthreshold your_value (or -1) to increase the 32 kB limit for all calls.
  
  Please note that larger thresholds may crash InDesign if the function was called via CORBA interface.
  
  With trailing ! (e.g. "!/Users/paul/Desktop/abc.xml") the function exports the result to the given filen always.
  
  
• options
  Most methods have a (as implied by the name: optional, but yet very powerful) parameter named options.
  This parameter allows to control the method behaviour or output in various ways, e.g. you can set the JPEG quality, image output format, Color Space etc. with this parameter. See the Options Reference for details
  If the options parameter is non-empty, it must start with the Connect Identifier prologue, this is simply the timestamp, when this InDesign® Server has been started, followed by a semicolon and the interval in milliseconds, when documents should be saved automatically (or -1 to disable autosave). See example below, how to setup this string.

• Start the ExtendScript Toolkit Application. ATTENTION: With InDesign^® 2020 Adobe has discontinued thesupport for ESTK. Here is a description of how Javascript can be executed as of ID 2020. The javascripts listed below remain valid of course.
• Start InDesign® Server. Here's an examnple. More information about the Program Options of InDesign Server can be found here.

  ./InDesignServer -configuration testconfig -previews \
  -cometlog ~/Desktop/comet.log -cometapilog ~/Desktop/api.log - cometcache ~/Desktop/cometcache \
  -cometdrawidle on -cometparanoidredraw on -cometxmlparser fast

  
  
• Type in a script, e.g.

  var documentName   = "test.indd";
  var documentPath   = "/Volumes/Users/me/Desktop/jsxtest/";
  var connectId      = app.comet.ping() + ";-1;";
  
  // open the test document
  app.comet.documentOpen(documentPath + documentName, true, connectId);
  
  // get preview of the first SPREAD
  app.comet.getPreview  (
      documentPath + documentName, 
      Scope.SPREAD, 0,                       // first Spread 
      200,                                   // resolution
      documentPath + "preview.png",          // output file 
      connectId + "layers:+*;format:png;");  // include all layers, create a PNG
                        
  // close the document
  app.comet.documentClose(documentPath + documentName, connectId);
  

• For a complete description on how to connect to a datapool, see here. Here's an example showing how to connect to any priint:comet data pool. Connection is done in two steps : At first you set the environment by calling app.comet.setEnvironment. The environment must my a valid XML data folder. An empty valid priint:comet XML folder you will find here (CometEnvironment.zip). The XML folder must contain a file named connections.xml. In the second step you can connect to your data pool by calling app.comet.use. The function needs the name of an entry in connections.xml and this entry defines your connection.
  
  Hint: To get valid connections.xml entries please manually log in into the requested data pool using InDesign® Desktop and store the login from the Login dialog before. You will find the stored login in the file werkii/xloginhistory.xml inside your local preferences folder .

• // *******************************************
  
  // 
  // Connection data
  // Fill in YOUR DATA here
  //
  var gEnvironment = "_xmldata_";  // valid XML folder containing connections.xml
  var gConnectionName = "xxx";     // Entry in connections.xml
  var gInstanceID = 2;             // InDesign® instance ID
  
  // *******************************************
  
  // 
  // Document and script
  // Fill in YOUR DATA here 
  //
  var gDocument  = "test.indd";
  var gScriptID = 2006;
  var gScript = "\
  \
  #include \"internal/types.h\"\
  #include \"internal/text.h\"\
  #include \"internal/products.h\"\
  \
  int main() \
  {\
   	// Do what ever you want.\
   	return 0;\
  }\
  ";
  
  // *******************************************
  
  //
  // Connect
  //
  var gOptions = app.comet.ping () + ";-1;";
  app.comet.setEnvironment (gEnvironment, gInstanceID, ""); 	// XML folder containing connections.xml
  app.comet.use (gConnectionName, "", "", false, "");       	// name of entry in connections.xml
  
  //
  // Work
  //
  
  // Open a document
  app.comet.documentOpen (gDocument, true, gOptions);    
  
  // Some examples
  app.comet.eval (gScript, '', '');			// exec script given by text
  app.comet.exec (gScriptID, "", gOptions);	// exec script defined in data pool
  app.comet.placeTemplate (					// place product
   	gDocument,                    			// document path
   	Scope.SPREAD, 0,              			// spread 0
  	1,                            			// templlate id
   	"1, 0, 0, \"109007\"",  				// product id
   	10.0, 10.0,                   			// position
   	ReorganizeLevel.NONE, gOptions); 
  app.comet.placeholderLoad ( 
   	gDocument,
   	Scope.DOCUMENT,
   	0,
   	new Array (0),               			// placeholder IDs, empty array = all
   	"0,0,0,\"\"",							// RecordIDs, empty (0,0, ...) = all
   	gOptions);
  
  // Save and close document
  app.comet.documentSave (gDocument, gOptions);
  app.comet.documentClose (gDocument, gOptions)

• Choose the InDesign® Server instance you just started as script target and click the run button

In comet_pdf of course there is no JavaScript interpreter available. To support Comet API calls here, please use option -j (--comet-api) instead. The option needs the path (absolut or relative to the renderer itself) to a XML file containing the definition of the Comet API calls. Files must follow this rules:

<?xml version="1.0" encoding="utf-8"?>
<js>
    <j method="methodName" ignoreError="1" activated="1">
        <paramter1>value1</paramter1>
        <paramter2>value2</paramter2>
     <!-- ... -->
    </j>
    <!-- next method call -->
</js>

where:

• methodName is the (case insensitive) name of the method, for instance "elementTransform".
• ignoreError is 0 or 1. 0 will stop executing further calls if one call fails. Optional, default 0.
• activated is 0 or 1. 0 will silently suppress execution of call. Good for test reasons. Optional, default 1.
• parameter1, parameter2, ... are the (case insensitive) names of the parameters in any order. You will find this names in the detailed descriptions of the methods.

<?xml version="1.0" encoding="utf-8"?>
<js>
    <j method="elementTransform" ignoreError="1">
        <path></path>
        <elementID>222</elementID>
        <options>width:123.0;height:456.0;x:46.0;y:46.0;rotate:30.0</options>
    </j>
</js>

Attention I: Methods are working on the current document given by option -i always. The parameter path is ignored (but must be given!).

Attention II: Only a selected list of API calls are implemtented. See below for more informations, implemented methods are marked as available for comet_pdf.

Attention III: Only a sub set of API calls are implemented for now. Implemented functions are marked by a ★ at the left side bar. More functions will follow.

Please contact support@priint.com for more information, though only limited support for this API can be provided.

Here's a simple example on how to use the priint:comet Scripting DOM with AppleScripts (which in turn executes cScript):

tell application "Adobe InDesign CC 2019"
set visible of panel "Product Pool" to 1

set CT to comet 1 -- The 1 is important!!
tell CT
set sc to ""
set sc to sc & "int main () {"
set sc to sc & "    datapool::login (1, \"demo\", \"demo\", \"werk2demo\", \"comet_config_comic\", \"\", 1);"
set sc to sc & "    list::reload (3, 1);"
set sc to sc & "return 0;}"

eval cscript sc argument "" options ""
end tell
end tell

String getScriptIO()
		 throws IdsException

void setScriptIO(String property)
throws IdsException

String about()
   throws IdsException

<j method="about" ignoreError="1">
</j>

String license()
	 throws IdsException

String eval(String cscript,
  String argument,
  String resultPath, /* comet_pdf only */
  String options)
  throws IdsException

<j method="documentGetLayers" ignoreError="1">
  <path></path>
  <cscript>
int main ()
{
  printf ("argument : '%s'\n", gArgument);
  strcpy (gOutput, gArgument);
  strcat (gOutput, "\n");
  strcat (gOutput, gDocumentPath);
  strcat (gOutput, "\n");
  strcat (gOutput, gDocumentID);
  
  return 0;
}
  </cscript>
  <argument>Hello world!</argument>
  <options></options>
  <resultPath>$DESKTOP/aaa/aaa.h</resultPath>
</j>

String exec(int actionID,
  String argument,
  String resultPath, /* comet_pdf only */
  String options)
  throws IdsException

<j method="documentGetLayers" ignoreError="1">
  <path></path>
  <actionID>1011173</actionID>
  <argument>Hello world!</argument>
  <options></options>
  <resultPath>$DESKTOP/aaa/aaa.h</resultPath>
</j>

int getDocumentCount()
 throws IdsException

String[] getDocumentList()
			   throws IdsException

boolean documentOpen(String path,
 boolean openOriginal,
 String options)
 throws IdsException

boolean documentClose(String path,
  String options)
  throws IdsException

String getSpreads(String path,
		int scope,
		int parent,
		String tmpFile,
		String options)
		throws IdsException

boolean documentGeneratePDF(String path,
		String pdfProfile,
		String pdfPath,
		String options)
		throws IdsException

boolean documentCreate(String path,
   String options)
   throws IdsException

boolean documentSetup(String path, boolean applyAdaption, String options) throws IdsException

<j method="documentSetup" ignoreError="1">
  <path></path>
  <applyAdaption>0</applyAdaption>
  <options>width:1000.0;height:1000.0;</options>
</j>

boolean documentDuplicate(String path,
	  String newPath,
	  String options)
	  throws IdsException

boolean documentSave(String path,
 String options)
 throws IdsException

boolean documentSaveAs(String path,
   String newPath,
   String options)
   throws IdsException

String[] documentGetLayers(String path,
				 String resultPath, /* comet_pdf only */
				 String options)
				 throws IdsException

<j method="documentGetLayers" ignoreError="1">
  <path></path>
  <options>visible:false;</options>
  <resultPath>$DESKTOP/aaa/aaa.h</resultPath>
</j>

int documentGetSpreadCount(String path,
	   String options)
	   throws IdsException

<j method="documentGetSpreadCount" ignoreError="1">
  <path></path>
  <options></options>
  <resultPath>$DESKTOP/aaa.txt</resultPath>
</j>

int documentGetPageCount(String path,
	 String options)
	 throws IdsException

<j method="documentGetPageCount" ignoreError="1">
  <path></path>
  <resultPath>$DESKTOP/aaa.txt</resultPath>
</j>

DEPRECATED

int[] documentGetSpreadIDs(String path,
	   String options)
	   throws IdsException

DEPRECATED

int[] documentGetPageIDs(String path,
	 String options)
	 throws IdsException

DEPRECATED

int[] spreadGetPages(String path,
 int spreadUID,
 String options)
 throws IdsException

DEPRECATED

int[] spreadGetPageIDs(String path,
   int spreadUID,
   String options)
   throws IdsException

DEPRECATED

int[] getGroupUIDs(String path,
int scope,
int parent,
String options)
throws IdsException

String getPlaceholders(String path,
			 int scope,
			 int parent,
			 boolean evalSyncStatus,
			 boolean markChanges,
			 String tmpFile,
			 String options)
			 throws IdsException

String getCometGroups(String path,
			int scope,
			int parent,
			String tmpFile,
			String options)
			throws IdsException

String getElementsXML(String path,
		 int scope,
		 int parent,
		 String tmpFile,
		 String options)
		 throws IdsException

String getNotes(String path,
	  int scope,
	  int parent,
	  String tmpFile,
	  String options)
	  throws IdsException

boolean setNotes(String path,
int scope,
int parent,
String notes,
String tmpFile,
String options)
throws IdsException

String getTemplate(int parent,
		 String tmpFile,
		 String options)
		 throws IdsException

int getTemplateID(String path,
int scope,
int parent,
String resultPath, /* comet_pdf only */
String options)
throws IdsException

<j method="getTemplateID" ignoreError="1">
  <path></path>
  <scope>PAGE</scope>
  <parent>3</parent>
  <resultPath>$DESKTOP/aaa/aaa.txt</resultPath>
  <options></options>
</j>

boolean setTemplateID(String path,
  int scope,
  int parent,
  int templateID,
  String options)
  throws IdsException

<j method="setTemplateID" ignoreError="1">
  <path></path>
  <scope>PAGE</scope>
  <parent>3g</parent>
  <templateID>24</templateID>
  <options>apply-master:true;apply-following:empty;</options>
</j>

DEPRECATED

double[] getNextGridPosition(String path,
		 int scope,
		 int parent,
		 int groupUID,
		 double directionX,
		 double directionY,
		 String options)
		 throws IdsException

boolean getPreview(String path,
int scope,
int parent,
double resolution,
String tmpFile,
String options)
throws IdsException

boolean getPreviewOfClipping(String path,
		 int scope,
		 int parent,
		 double resolution,
		 double x,
		 double y,
		 double width,
		 double height,
		 String tmpFile,
		 String options)
		 throws IdsException

int placeTemplate(String path,
int scope,
int parent,
int templateID,
String recordID,
double x,
double y,
int reorganize,
String resultPath, /* comet_pdf only */
                  String options)
throws IdsException

<j method="placeTemplate" ignoreError="1">
  <path></path>
  <scope>SPREAD</scope>
  <parent>2</parent>
  <templateID>5</templateID>
  <recordID>2, 0, 0, ""</recordID>
  <x>36.0</x>
  <y>36.0</y>
  <reorganize>NONE</reorganize>
  <resultPath>$DESKTOP/abc.txt</resultPath>
  <options>snap-to-template:false;layer:Ebene 6;build-prescript:0;build-pageitem:0;</options>
</j>

int build(String path,
int scope,
int parent,
String itemsXML,
double x,
double y,
String resultPath, /* comet_pdf only */
String options)
throws IdsException

<j method="documentGetLayers" ignoreError="1">
  <path></path>
  <scope>SPREAD</scope>
  <parent>1</parent>
  <itemsXML>%DESKTOP/items.xml</itemsXML>
  <x>700.0</x>
  <y>0.0</y>
  <options></options>
  <resultPath>$DESKTOP/aaa/aaa.h</resultPath>
</j>

boolean cometGroupDeleteGroup(String path,
		  int groupUID,
		  int reorganize,
		  String options)
		  throws IdsException

<j method="cometGroupDeleteGroup" ignoreError="1">
  <path></path>
  <groupUID>237</groupUID>
  <reorganize>NONE</reorganize>
  <options></options>
</j>

String[] cometGroupGetPreviews(String path,
					 int groupUID,
					 double resolution,
					 String tmpFile,
					 String resultPath, /* comet_pdf only */
					 String options)
					 throws IdsException

<j method="cometGroupGetPreviews" ignoreError="1">
  <path></path>
  <groupUID>237</groupUID>
  <resolution>360</resolution>
  <tmpFile>/Users/paul/Desktop/myPreviews/aaa.jpg</tmpFile>
  <options></options>
</j>

int cometGroupInsertAfter(String path,
	  int groupUID,
	  int templateID,
	  String recordID,
	  int reorganize,
	  String resultPath, /* comet_pdf only */
	  String options)
	  throws IdsException

<j method="cometGroupInsertAfter" ignoreError="1">
  <path></path>
  <groupUID>574</groupUID>
  <templateID>1</templateID>
  <recordID>1, 0, 0, "116007"</recordID>
  <reorganize>FULL</reorganize>
  <resultPath>$DESKTOP/abcd.txt</resultPath>
  <options>layer:de;</options>
</j>

var gOptions = app.comet.ping() + ";-1;";


app.comet.setEnvironment ("/Users/paul/Desktop/fifo/priint 5.5/xmldata", 1401, "");
app.comet.use ("demo", "", "", false, "");


app.comet.documentOpen ("/Users/paul/Desktop/bbb.indd", true, gOptions);


app.comet.cometGroupInsertAfter (
    "/Users/paul/Desktop/bbb.indd", 
    574, 1, "1, 0, 0, \"116007\"", 
    ReorganizeLevel.FULL, 
    gOptions+"layer:Ebene 1;");

int cometGroupInsertBefore(String path,
	   int groupUID,
	   int templateID,
	   String recordID,
	   int reorganize,
	   String resultPath, /* comet_pdf only */
	   String options)
	   throws IdsException

<j method="cometGroupInsertBefore" ignoreError="1">
  <path></path>
  <groupUID>574</groupUID>
  <templateID>1</templateID>
  <recordID>1, 0, 0, "116007"</recordID>
  <reorganize>FULL</reorganize>
  <resultPath>$DESKTOP/abcd.txt</resultPath>
  <options>layer:de;</options>
</j>

var gOptions = app.comet.ping() + ";-1;";


app.comet.setEnvironment ("/Users/paul/Desktop/fifo/priint 5.5/xmldata", 1401, "");
app.comet.use ("demo", "", "", false, "");


app.comet.documentOpen ("/Users/paul/Desktop/bbb.indd", true, gOptions);


app.comet.cometGroupInsertBefore (
    "/Users/paul/Desktop/bbb.indd", 
    574, 1, "1, 0, 0, \"116007\"", 
    ReorganizeLevel.FULL, 
    gOptions+"layer:Ebene 1;");

int cometGroupReplaceGroup(String path,
	   int groupUID,
	   int templateID,
	   String recordID,
	   int reorganize,
	   String resultPath, /* comet_pdf only */
	   String options)
	   throws IdsException

<j method="cometGroupReplaceGroup" ignoreError="1">
  <path></path>
  <groupUID>574</groupUID>
  <templateID>188</templateID>
  <recordID>0, 0, 0, ""</recordID>
  <reorganize>FULL</reorganize>
  <resultPath>$DESKTOP/abcd.txt</resultPath>
  <options>layer:de;</options>
</j>

boolean cometGroupMoveBy(String path,
	 int groupUID,
	 double offsetX,
	 double offsetY,
	 String options)
	 throws IdsException

<?xml version="1.0" encoding="utf-8"?>
<js>
  <j method="cometGroupMoveBy" ignoreError="1">
    <path></path>
    <groupUID>237</groupUID>
    <offsetX>20</offsetX>
    <offsetY>20.0</offsetY>
    <options></options>
  </j>
</js>

boolean cometGroupMoveTo(String path,
	 int scope,
	 int parent,
	 int groupUID,
	 double left,
	 double top,
	 String options)
	 throws IdsException

<?xml version="1.0" encoding="utf-8"?>
<js>
  <j method="cometGroupMoveBy" ignoreError="1">
    <path></path>
    <scope>PAGE</scope>
    <groupUID>237</groupUID>
    <left>20</left>
    <top>20.0</top>
    <options></options>
  </j>
</js>

int importGroup(String path,
String source,
int scope,
int parent,
int groupUID,
double left,
double top,
String options)
throws IdsException

boolean execTemplate(int templateID,
 String recordID,
 String outPath,
 String options)
 throws IdsException

boolean documentReorganize(String path,
	   int pageIndex,
	   int reorganize,
	   String options)
	   throws IdsException

<j method="documentReorganize" ignoreError="1">
  <path></path>
  <pageIndex>0</pageIndex>
  <reorganize>FULL</reorganize>
  <options></options>
</j>

boolean pageApplyGrid(String path,
  int scope,
  int parent,
  int gridid,
  int reorganize,
  String options)
  throws IdsException

boolean applyMasterpage(String path,
	int scope,
	int parent,
	String masterPageName,
	String options)
	throws IdsException

<j method="applyMasterpage" ignoreError="1">
 <path></path>
 <scope>SPREAD</scope>
 <parent>1</parent>
 <masterPageName>B-KUGEL</masterPageName>
 <options></options>
</j>

short adapt(double width,
double height)
throws IdsException

<j method="adapt" ignoreError="1">
  <width>1000.0</width>
  <height>1000.0</height>
</j>

boolean modifyCometGroup(String path,  // ignored by comet_pdf
	 int scope,
	 int parent,
	 int[] targetElements,
	 String command,
	 String options)
	 throws IdsException

<j method="modifyCometGroup" ignoreError="1">
  <path></path>
  <scope>ELEMENT</scope>
  <parent>261</parent>
  <targetElements>
    <i>284</i>
    <i>289</i>
  </targetElements>
  <command>add</command>
  <options></options>
</j>

<j method="modifyCometGroup" ignoreError="1">
  <path></path>
  <scope>DOCUMENT</scope>
  <parent></parent>
  <targetElements>
    <i>284</i>
  </targetElements>
  <command>show</command>
  <options></options>
</j>

<j method="modifyCometGroup" ignoreError="1">
  <path></path>
  <scope>DOCUMENT</scope>
  <parent></parent>
  <targetElements>
    <i>284</i>
  </targetElements>
  <command>hide</command>
  <options></options>
</j>

<j method="modifyCometGroup" ignoreError="1">
  <path></path>
  <scope>ELEMENT</scope>
  <parent>231</parent>
  <targetElements></targetElements>
  <command>resolve</command>
  <options>subgroups:true;</options>
</j>

<j method="modifyCometGroup" ignoreError="1">
  <path></path>
  <scope>ELEMENT</scope>
  <parent>231</parent>
  <targetElements>
    <i>284</i>
    <i>254</i>
  </targetElements>
  <command>remove</command>
  <options></options>
</j>

<j method="modifyCometGroup" ignoreError="1">
  <path></path>
  <scope>DOCUMENT</scope>
  <parent></parent>
  <targetElements>
    <i>372</i>
    <i>308</i>
    <i>343</i>
  </targetElements>
  <command>join</command>
  <options></options>
</j>

boolean placeholderLoad(String path,
	int scope,
	int parent,
	int[] placeholderID,
	String recordID,
	String options)
	throws IdsException

<j method="cometGroupDeleteGroup" ignoreError="1">
  <path></path>
  <scope>SPREAD</scope>
  <parent>2</parent>
  <placeholderID>
    <i>10</i>
    <i>40</i>
  </placeholderID>
  <recordID>0,0,0,""</recordID>
  <options></options>
</j>

boolean placeholderSync(String path,
	int scope,
	int parent,
	int[] placeholderIDs,
	String recordID,
	String options)
	throws IdsException

boolean placeholderSetValue(String path,
		int scope,
		int parent,
		int placeholderID,
		String recordID,
		String value,
		boolean execSaveMethod, // ignored by comet_pdf
		String options)
		throws IdsException

<j method="placeholderSetValue" ignoreError="1">
  <path></path>
  <scope>PAGE</scope>
  <parent>0</parent>
  <placeholderID>3</placeholderID>
  <recordID>1,0,0,"1010097"</recordID>
 <value>%!TT&lt;cColor:Red&gt;Hall&ouml;chen&lt;cColor:&gt; and Hi!</value>
 <execSaveMethod>0</execSaveMethod>
  <options></options>
</j>

boolean placeholderSetImage(String path,
		int scope,
		int parent,
		int placeholderID,
		String recordID,
		String imagePath,
		boolean execSaveMethod, // ignored by comet_pdf
		String options)
		throws IdsException

<j method="placeholderSetImage" ignoreError="1">
  <path></path>
  <scope>SPREAD</scope>
  <parent>2</parent>
  <placeholderID>70</placeholderID>
  <recordID>2,0,0,""</recordID>
 <imagePath>$DESKTOP/Bilder/here_we_are.png</imagePath>
 <execSaveMethod>0</execSaveMethod>
  <options></options>
</j>

boolean placeholderUpdate(String path,
	  int scope,
	  int parent,
	  String options)
	  throws IdsException

boolean elementSetValue(String path,
	int elementID,
	String elementFragment,
	String value,
	String options)
	throws IdsException

boolean elementSetImage(String path,
	int elementID,
	String imagePath,
	String options)
	throws IdsException

<j method="elementSetImage" ignoreError="1">
  <path></path>
  <elementID>937</elementID>
  <imagePath>$DESKTOP/Bilder/here_we_are.png</imagePath>
  <options>image-pos:bottomright;image-scale:fitFrame;</options>
</j>

boolean use(String service,
String user,
String password,
boolean forceReconnect,
String options)
throws IdsException

1. Predefined
2. By endpoint
3. Direct login [since v4.1 R21457]
4. Batch Configuration [since v4.3 R35590]

The predefined method is done in two steps:

1. First an environment is set by using the first parameter of app.comet:setEnvironment .

2. Then a connection defined in this environment is used to login by the first parameter app.comet.use.

The environment must be an valid Comet XML folder. For performance reasons, the XML folder should be as empty as possible.

CometEnvironment.zip is a complete and usable example of an Comet XML folder.

Here's a valid connection.xml with a defined connection to a mySQL database:

<connection>
	<id>1</id>
	<name>demo</name>
	<type>odbc_utf8</type> <!-- xml | odbc[_utf8 | _unicode | _unicode32] | soap -->
	<server>demo</server>
	<password>***</password>
	<db>comet_config</db>
	<lang></lang>
	<client></client>>
	<passcredentials></passcredentials>
</connection>

Example of predefined method to login:

var gOptions = app.comet.ping() + ";-1;";

app.comet.setEnvironment ("/Users/paul/priint_test/xmldata", 1401, "");
app.comet.use ("demo", "", "", false, gOptions);

Endpoint connections are defined only for SOAP/Publishing Server connetions. The endpoint connection is done in two steps:

1. First the endpoint is defined by using the third app.comet:setEnvironment .

2. The following call to app.comet:.use will then connect to the endpoint using the given user name and password. Please note, endpoint connections cannot set a specific language!

Example of endpoint connection to login:

var gOptions = app.comet.ping() + ";-1;";

app.comet.setEnvironment ("", 1401, "http://localhost_40080_CometBridge_Comet3Service");
app.comet.use ("", "user", "password", false, gOptions);

Direct login can be done by a single call to app.comet.use. After a trailing ##, the connection is described in the first parameter of the function by a semicolon delimited key-values list. The following keywords are supported:

• server - Database service name from odbc.ini or http(s) server address
• folder - Complete path to an valid Comet XML Offline folder
• type - Connection type, one of the following:
  • odbc, odbc_utf8, odbc_unicode
  • oci, oci_utf8, oci_unicode
  • soap, soap_utf8, soap_unicode
  • xmlfolder
• db - Database name (ODBC/OCI only)
• language - Use language (SOAP only)
• client - Client name

Example of direct login:

app.comet.use (
    "##server:demo;type:odbc_utf8;db:comet_config",
    "demo",
    "***",
    false,
    gOptions);

The Batch Configuration was actually created to support the Comet Batch. However, you can also use this configuration for ‘normal’ InDesign® Server operation. All you have to do for that is place a file called config.xml into the priint:comet plug-ins folder. InDesign® Server will then automatically connect to the data source defined in config.xml at startup. And, especially nice: If the config.xml is changed during the server is running, the server will also automatically change the data connection.

But since this function was developed for Comet Batch in the past, another small step is necessary: You have to ‘tell’ InDesign® Server that the data connection from config.xml can be used globally. The corresponding incantation is batch.config.xml as to be the service name:

app.comet.use (
    "batch.config.xml",
    "",
    "",
    false,
    gOptions);

Hier die Syntax der config.xml:

<?xml version="1.0" encoding="latin1"?>
<config>
  <database>
    <type>xml</type> <!-- xml | odbc[_utf8 | _unicode | _unicode32] | soap -->
    <dsn>$DESKTOP/Design-Norm</dsn> 
    <user/>
    <password/>
    <db/>
    <client/>
    <language/>
  </database>
</config>

boolean setEnvironment(String initRoot,
   int instanceID,
   String pathResolvePattern)
   throws IdsException

DEPRECATED

boolean registerResource(String path,
	 int tmpPath)
	 throws IdsException

int ping()
throws IdsException

DEPRECATED

boolean applicationShutdown(String options)
		throws IdsException

DEPRECATED

boolean reloadConfig(String service,
 String config,
 String options)
 throws IdsException

boolean elementMove(String path, // ignored by comet_pdf
int scope,
int parent,
int elementID,
double left,
double top,
String options)
throws IdsException

<j method="elementMove" ignoreError="1">
  <path></path>
  <scope>SPREAD</scope>
  <parent>2</parent>
  <elementID>222</elementID>
  <left>46.0</left>
  <top>46.0</top>
  <options>move-relative:0;</options>
</j>

boolean elementDelete(String path, // ignored by comet_pdf
  int elementID,
  String options)
  throws IdsException

<j method="elementDelete" ignoreError="1">
  <path></path>
  <elementID>905</elementID>
  <options></options>
</j>

boolean elementTransform(String path,
	 int elementID,
	 String options)
	 throws IdsException

<j method="elementTransform" ignoreError="1">
  <path></path>
  <elementID>222</elementID>
  <options>width:100.0;height:100.0;reference-point:rb</options>
</j>

var gOptions = app.comet.ping() + ";-1;";
var myPath = "/Users/paul/Desktop/resize_frame.indd";

app.comet.setEnvironment ("/Users/paul/Desktop/fifo/5. print.day/xmldata", 1401, "");
app.comet.use ("printday5.5", "", "", false, "");
app.comet.documentOpen (myPath, true, gOptions);
app.comet.elementTransform (myPath, 225, gOptions+";width:100.0;height:100.0;reference-point:rb");

boolean elementInsertPara(String path,
	  int elementID,
	  String elementFragment,
	  boolean beforePara,
	  String value,
	  String options)
	  throws IdsException

boolean generatePDF(String path,
int scope,
String pagesOrSpreads,
String pdfProfile,
String tmpFile,
String options)
throws IdsException

DEPRECATED

boolean generateSWF(String path,
int scope,
String pagesOrSpreads,
String tmpFile,
String options)
throws IdsException

DEPRECATED

int buildDynamic(String path,
int scope,
int parent,
String itemsXML,
String templatesXML,
String options)
throws IdsException

boolean elementDeletePara(String path,
	  int elementID,
	  String elementFragment,
	  String options)
	  throws IdsException

boolean spreadGetElementsPreview(String path,
			 int scope,
			 int parent,
			 double resolution,
			 int[] elements,
			 String tmpFile,
			 String options)
			 throws IdsException

boolean spreadGetCometGroupsPreview(String path,
				int scope,
				int parent,
				double resolution,
				int[] groups,
				String tmpFile,
				String options)
				throws IdsException

boolean spreadGetElementsSnippet(String path,
			 int scope,
			 int parent,
			 int[] elements,
			 String tmpFile,
			 String options)
			 throws IdsException

boolean spreadGetCometGroupsSnippet(String path,
				int scope,
				int parent,
				int[] groups,
				String tmpFile,
				String options)
				throws IdsException

int spreadPlaceDocument(String path,
	int scope,
	int parent,
	double x,
	double y,
	boolean createGroup,
	String tmpFile,
	String options)
	throws IdsException

boolean setItems(String path,
int scope, // IGNORED
int parent,// IGNORED
String items,
String tmpFile,
String options)
throws IdsException

<j method="setitems" ignoreError="1">
  <path></path>
  <scope>PAGE</scope>
  <parent>0</parent>
  <items>$DESKTOP/pp.xml</items>
  <options>localize-masteritems:true;</options>
</j>

String getItems(String path,
int scope,
int parent,
String tmpFile,
String options)
throws IdsException

boolean documentOpenCached(String path,
	   boolean openOriginal,
	   String[] cacheOptions,
	   String options)
	   throws IdsException

boolean addSpreadOrPage(String path, // IGNORED by comet_pdf
	int scope,
	int behind,
	int count,
	String masterPageName,
	String options)
	throws IdsException

<j method="addSpreadOrPage" ignoreError="1">
  <path></path>
  <scope>SPREAD</scope>
  <parent>1</parent>
  <masterPageName>B-Masterpage</masterPageName>
  <options>pages-per-spread:2;</options>
</j>

boolean deleteSpreadOrPage(String path,  // IGNORED by comet_pdf
	   int scope,
	   int first,
	   int count,
	   String options)
	   throws IdsException

<j method="deleteSpreadOrPage" ignoreError="1">
  <path></path>
  <scope>SPREAD</scope>
  <parent>2</parent>
  <count>-1</count>
  <options></options>
</j>

String matchItems(String path,
		int scope,
		int parent,
		String items,
		String tmpFile,
		String options)
		throws IdsException

<j method="matchItems" ignoreError="1">
  <path></path>
  <scope>PAGE</scope>
  <parent>0</parent>
  <items>$DESKTOP/ccc.xml</items>
  <tmpFile>!$DESKTOP/ccc_new.xml</tmpFile>
  <options>xmlindent:true;</options>
</j>

boolean moveSpreadsOrPages(String path,
	   int scope,
	   int behind,
	   int start,
	   int count,
	   String options)
	   throws IdsException

<j method="matchItems" ignoreError="1">
  <path></path>
  <scope>PAGE</scope>
  <start>3</start>
  <count>4</count>
  <parent>8</tmpFile>
  <options></options>
</j>

String[] getPdfProfiles(String options)
			  throws IdsException

DEPRECATED

String getDocumentStyles(String path,
			   int scope,
			   int parent,
			   String tmpFile,
			   String options)
			   throws IdsException

int runPanelAction(String path,
int scope,
int parent,
int actionID,
String selection,
String tmpFile,
String options)
throws IdsException

String getIDML(String path,
	 int scope,
	 int parent,
	 String idmlPart,
	 String tmpFile,
	 String options)
	 throws IdsException

String doc.frameSetOrigin(int frameUID, int originUID) throws IdsException

Set the origin UID in master of a given frame. The function is required only for synchronizations. It defines the corresponding frame in the master of a frame of a variant.

Please note: This function is not handled in the comet suite but directly by a document!

int doc.frameSetOrigin(int frameUID)

Get the origin frame UID in master of a given frame. The function is required only for synchronizations. It returns the corresponding frame in the master of a frame of a variant.

Please note: This function is not handled in the comet suite but directly by a document!

String doc.pageSetOrigin(int pageUID, int originUID) throws IdsException

Set the origin UID in master of a given page. The function is required only for synchronizations. It defines the corresponding page by UID in the master of a page of a variant.

Please note: This function is not handled in the comet suite but directly by a document!

int doc.pageGetOrigin(int frameUID)

Get the origin page UID in master of a given page. The function is required only for synchronizations. It returns the corresponding page UID in the master of a page of a variant.

Please note: This function is not handled in the comet suite but directly by a document!

int doc.getTemplateID()

[Since v4.1.6 R26580] The function determines whether the document is a priint:comet template or not.

Return Values

• > 0 : The document is a template opened in the background or a template editor. With smart-template editors, the ID of the first sub template of the smart template is returned.
• < 0 : The document was opened as a helper document in the background by the priint:comet plugins (e.g. snippets).
• 0 : Normal document

Please note: This function is not handled in the comet suite but directly by a document!

int doc.getPageTemplateID()

[Since v4.1.6 R26580] The function determines whether the document is a priint:comet page template or not.

Return Values

• > 0 : The document is a page template.
• 0 : Normal document

Please note: This function is not handled in the comet suite but directly by a document!