message exchange protocol between to healthcare partners
 IGeneralNotificationManager::Print method |
 |
||
|---|---|---|---|
|
The Print method is a visualization aid to preview/print the currently loaded data on screen or onto the local printer. However, the generalNotification paradigm in its core is an electronic message exchange system. Thus, at the very end an XML infoset must be generated and sent to the recipient.
The bstrPrintTemplate variable obeys a special syntax and can be used to set special print commands like producing PDFs or changing print objects dynamically.
Note: the usage of the SetReply method defines a singularity in the data space and the semantic interpretation of the data. As a consequence the print output differs before and after IGeneralNotificationRequest::SetReply! IMPORTANT LICENSE NOTE The report engine used is Hexatech's ViewPro (www.hexatech.com). If you supply your own template files then you must have your own ViewPro license. By using this COM module you implicitly agree upon this restriction! |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/IGeneralNotificationManager/Print | ||
| [JSON input data] | pIGeneralNotificationManager: bstrPrintTemplate: lGenerationAttributes: ePrintPreview: |
longValue, //interface address "utf8StringValue", longValue, longValue |
|
| [JSON result data] | pbstrPDFFile: pbStatus: |
"utf8StringValue", booleanValue |
|
| [HTTP result status] | 200 | Return status 200 signals a successful method call | |
| 204 | Return status 204 (noContent) signals that the end of an iteration is reached | ||
| >= 400 | Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do. | ||
| |||
| C/C++ calling syntax |
|||
| HRESULT Print( | BSTR
long YesNoType VARIANT_BOOL |
bstrPrintTemplate,
lGenerationAttributes, ePrintPreview, *pbStatus); |
|
| [C/C++ return value] | S_OK | This value is returned if the function call was successful. | |
| S_FALSE | This value is returned if the end of an iteration is reached | ||
| E_name | This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions. | ||
| |||
| Calling argument description |
|||
| [in] BSTR | bstrPrintTemplate | The bstrPrintTemplate variable is used to explicitly change print template reports and/or print objects as defined in "Syntax of the printTemplate variable".
If bstrPrintTemplate is empty then the default print template of the defined data language ( IGeneralNotificationRequest:: Initialize method) is used. |
|
| [in] long | lGenerationAttributes | This variable overrules the default behavior of the print process.
lGenerationAttributes is a 32-bit integer where the possible "commands" are values from the generationAttributes data type ORed together to form the overall command. |
|
| [in] YesNoType | ePrintPreview | A Boolean that defines if print preview is used (enYes) or printing is done (enNo)
In Restful Webservice system: ePrintPreview is automatically set to enNo no matter what the input value is. Furthermore, printing is automatically redirected to a PDF output file since there are no printers available. |
|
| [out] BSTR | *pbstrPDFFile | In Restful webservice output: pbstrPDFFile is a relative URL to a PDF file holding the result of the Print method. Therefore, after receiving the JSON result data do GET pbstrPDFile such as to have the produced printout. |
|
| [out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string. | |
|
|||