|
Broadcast Document Functions |
  
|
|
Broadcast Document Functions |
|
Function Name: Faxin
Notify faxed-in document name, or modify the set of job documents
Inputs: Parm1 = UJP pathname
Parm2 = Filename of faxed-in document [|content-ID]
Parm2 = Parm3 = 0 to delete all documents
Parm3 = Job Document item (base 1) to be updated from FAXIN
Parm3 = 0 to add a new job document
Parm3 < 0 to update any FAXIN/WATERMARK items found
Returns: 0 for success or <0 if error
This function is deprecated except for internal use to process FAXIN/WATERMARK items: for general-purpose list manipulation use InsertDocument instead.
Function Name: DeleteDocument
This function deletes a job document from the UJP. It can be used for all levels of UJP.
Inputs: Parm1 = UJP pathname
Parm3 = Index (base 1) of document to delete
Parm3 = 0 to delete all documents
Status: For an instance, must not be 24, 25, or greater than 29.
Returns: 0 = success
-1 = cannot lock UJP
-2 = cannot open UJP
-3 = cannot read UJP
-4 = cannot write UJP
-6 = instance not at correct status
-7 = document not found at index
Function Name: GetDocumentCount
This function returns the count of job documents in the passed UJP
Inputs: Parm1 = UJP pathname
Status: Not checked
Returns: non-negative: count of documents
-1 = cannot lock UJP
-2 = cannot open UJP
-3 = cannot read UJP
Function Name: GetDocumentPath
This function returns a job document pathname.
Inputs: Parm1 = UJP pathname
Parm3 = Index (base 1) of document to return
Status: Not checked
Outputs: Parm2 = Document Pathname (with "|content-ID" if applicable)
Returns: 0 = success
-1 = cannot lock UJP
-2 = cannot open UJP
-3 = cannot read UJP
-7 = document not found at index
Function Name: InsertDocument
This function inserts a document into the UJP. It can be used for all levels of UJP. A duplicate document is not an error: it may be supplied for faxing without a content-ID and for e-mail with a content-ID. The function does not check that the document exists.
The content-ID part can be a complex expression as described for $email_attach (e.g. application/msword;"name=docname.doc") , without the double-quoting which will be applied automatically by InsertDocument.
Inputs: Parm1 = UJP pathname
Parm2 = Pathname of document [|content-ID]
Parm3 = Index (base 1) to insert document ahead of
Status: For an instance, must not be 24, 25, or >29.
Returns: 0 = success
-1 = cannot lock UJP
-2 = cannot open UJP
-3 = cannot read UJP
-4 = cannot write UJP
-5 = duplicate document name
-6 = instance not at correct status
Topic url: http://www.copia.com/support/refmanual/index.html?job_admin_broadcast_document_f.htm