class Joria.Joria extends %SOAP.WebClient

This class is the interface to the ReportWeaver WebService. It can be used to retrieve the available templates and run the templates to generate output as html, pdf, xml, csv and to the printer. Html output is more complex, because of the possibility of generated pictures and charts These will be referenced in the generated html with a fixed prefix part, a number and a fixed postfix part. Both fixed parts are parameters of all run html methods. To be able generate URL's for drilldown reports, the parameter "drilldownUrlPrefix" must contain a pattern for the URL. In this pattern {0} will be replaced by the name of the report and {1} will be replaced by the id of the object for the drilldown. The third part is the mapping of external resources like static pictures to URL's. The mapping is transfered in the file2UrlMap parameter.

Class Parameters

• parameter LOCATION [= http://localhost:8180/joriaWebService/services/Joria]
This is the URL used to access the web service. It may be needed to adjust the host and the port, depending on the tomcat installation
• parameter NAMESPACE [= http://joria]
This is the namespace used by the Service
• parameter SERVICENAME [= JoriaWebServiceService]
This is the name of the Service
• parameter TIMEOUT [= 1800]
This is the default timeout for the web service operations.

Methods

• method %OnNew() returns%Status
This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status

• final method existsReport(name As %String) returns %Boolean
check if a report with that name exists
• final method getFirstReportStep(name As %String, presetVariables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String ) returns Joria.ReportProcessStepInfo
get the first step for requesting the variable values for a report use if needsParameterDialog returns true name is name of the template presetVariables stores any already known variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented
• final method getFirstReportStepForObject(name As %String, loid As %Stream , presetVariables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String ) returns Joria.ReportProcessStepInfo
get the first step for requesting the variable values for a report for a drilldown report use if needsParameterDialog returns true name is the name of the template loid is id of the persisent object to use as report root. It is coded as {class}|{id} presetVariables stores any already known variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented
• final method getFirstReportStepTarget(name As %String, presetVariables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String , target As %String ) returns Joria.ReportProcessStepInfo
get the first step for requesting the variable values for a report for a specific target specialy for email generation, which may need additional variables to be set. use if needsParameterDialog returns true name is name of the template presetVariables stores any already known variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented target name of the output target, only "email" supported for now
• final method getFirstReportStepTargetForbjct(name As %String, loid As %String , presetVariables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String , target As %String ) returns Joria.ReportProcessStepInfo
get the first step for requesting the variable values for a report for a drilldown report for a specific target. specialy for email generation, which may need additional variables to be set. use if needsParameterDialog returns true name is the name of the template loid is id of the persisent object to use as report root. It is coded as {class}|{id} presetVariables stores any already known variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented target name of the output target, only "email" supported for now
• final method getTemplateForID(id As %Integer, langDef As Joria.LanguageDefinition ) returns Joria.TemplateDefinition
get the template definition for a template id name is the name of the template langDef stores the language information for localized values
• final method getTemplateForName(name As %String, langDef As Joria.LanguageDefinition ) returns Joria.TemplateDefinition
get the template definition for a template name name is the name of the template langDef stores the language information for localized values
• final method getTemplates(langDef As Joria.LanguageDefinition) returns Joria.impl.ArrayOftns1TemplateDefinition
get all non drilldown reports langDef stores the language information for localized values
• final method getTemplatesForClass(clazz As %String, langDef As Joria.LanguageDefinition ) returns Joria.impl.ArrayOftns1TemplateDefinition
get all non drilldown reports with a specific definition class clazz name of the definition class langDef stores the language information for localized values
• final method getTemplatesForClassDrilldown(clazz As %String, langDef As Joria.LanguageDefinition ) returns Joria.impl.ArrayOftns1TemplateDefinition
get all drilldown reports with a specific definition class clazz name of the definition class langDef stores the language information for localized values
• final method getVariablesForTemplate(name As %String, langDef As Joria.LanguageDefinition ) returns Joria.impl.ArrayOftns1VariableInformation
get the list of all needed variables for a template an empty array means no variables, a $$$nulloref means that the variables contain a database pick and getFirstReportStep* is needed. name is the name of the template langDef stores the language information for localized values
• final method getVariablesForTemplateTarget(name As %String, langDef As Joria.LanguageDefinition , target As %String ) returns Joria.impl.ArrayOftns1VariableInformation
get the list of all needed variables for a template for a specific target. specialy for email generation, which may need additional variables to be set. an empty array means no variables, a $$$nulloref means that the variables contain a database pick and getFirstReportStep* is needed. name is the name of the template langDef stores the language information for localized values target name of the output target, only "email" supported for now
• final method needsConfigForTarget(name As %String, target As %String ) returns %Boolean
returns if the output target has been configurated. Only needed for email right now target name of the output target, only "email" supported for now
• final method needsParameterDialog(name As %String) returns %Boolean
check if the report needs a parameter dialog name is the name of the template
• final method needsParameterDialogTarget(name As %String, target As %String ) returns %Boolean
check if the report needs a parameter dialog for a specific target. specialy for email generation, which may need additional variables to be set. name is the name of the template target name of the output target, only "email" supported for now
• final method processReportStep(reportStep As Joria.ReportProcessStepInfo ) returns Joria.ReportProcessStepInfo
after the user has entered the parameter dialog information, use this method to get the information for the next parameter dialog step reportStep is the information about the already entered variable data
• final method reloadRepository() returns%SOAP.OneWay
reload the repository to make changes visible to the webservice
• final method runComplexReportEMail(reportStep As Joria.ReportProcessStepInfo ) returns %SOAP.OneWay
run the report after requesting the needed variables to email reportStep is the information about the already entered variable data
• final method runComplexReportHtml(reportStep As Joria.ReportProcessStepInfo, generateContentPrefix As %String , file2UrlMap As Joria.impl.ArrayOftns1Pair , generatedContentPostfix As %String , drilldownUrlPrefix As %String ) returns Joria.impl.ArrayOftns1HttpContentElement
run the report after requesting the needed variables to html output reportStep is the information about the already entered variable data the other parameters are described in the class description.
• final method runComplexReportPrinter(reportStep As Joria.ReportProcessStepInfo, printer As %String ) returns %SOAP.OneWay
run the report after requesting the needed variables to printer output reportStep is the information about the already entered variable data printer is the name of the printer where the output is send. If this parameter is unused, the output is send to the default printer
• final method runComplexReportToPdf(reportStep As Joria.ReportProcessStepInfo ) returns %BinaryStream
run the report after requesting the needed variables to pdf output reportStep is the information about the already entered variable data
• final method runComplexReportToXml(reportStep As Joria.ReportProcessStepInfo ) returns %CharacterStream
run the report after requesting the needed variables to xml output reportStep is the information about the already entered variable data
• final method runReportCSV(name As %String, variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String , seperator As %xsd.byte , quote As %xsd.byte , lineSep As %String , encoding As %String ) returns %BinaryStream
run the report to csv output name is the name of the report variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented seperator is the seperating character. Normally a ',' is used quote is the quoting character. Normaly a '"" is used linesep can be either "Unix", "Mac" or "Windows" to specify the end of line characters used. encoding is the encoding used for the values.
• final method runReportCSVComplex(reportStep As Joria.ReportProcessStepInfo, seperator As %xsd.byte , quote As %xsd.byte , lineSep As %String , encoding As %String ) returns %BinaryStream
run the report after requesting the needed variables to csv output reportStep is the information about the already entered variable data langDef stores the language information for localized values seperator is the seperating character. Normally a ',' is used quote is the quoting character. Normaly a '"" is used linesep can be either "Unix", "Mac" or "Windows" to specify the end of line characters used. encoding is the encoding used for the values.
• final method runReportCSVForObject(name As %String, loid As %String , variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String , seperator As %xsd.byte , quote As %xsd.byte , lineSep As %String , encoding As %String ) returns %BinaryStream
run the report for an object to csv output name is the name of the report loid is id of the persisent object to use as report root. It is coded as {class}|{id} variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented seperator is the seperating character. Normally a ',' is used quote is the quoting character. Normaly a '"" is used linesep can be either "Unix", "Mac" or "Windows" to specify the end of line characters used. encoding is the encoding used for the values.
• final method runReportEMail(name As %String, variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String ) returns %SOAP.OneWay
run the report to email output name is the name of the report variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented
• final method runReportEMailForObject(name As %String, loid As %String , variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String ) returns %SOAP.OneWay
run the report for an object to email output name is the name of the report loid is id of the persisent object to use as report root. It is coded as {class}|{id} variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented
• final method runReportHtml(name As %String, variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String , generateContentPrefix As %String , file2UrlMap As Joria.impl.ArrayOftns1Pair , generatedContentPostfix As %String , drilldownUrlPrefix As %String ) returns Joria.impl.ArrayOftns1HttpContentElement
run the report to html output name is the name of the report variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented the other parameters are described in the class description.
• final method runReportHtmlForObject(name As %String, loid As %String , variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String , generateContentPrefix As %String , file2UrlMap As Joria.impl.ArrayOftns1Pair , generatedContentPostfix As %String , drilldownUrlPrefix As %String ) returns Joria.impl.ArrayOftns1HttpContentElement
run the report for an object to html output name is the name of the report loid is id of the persisent object to use as report root. It is coded as {class}|{id} variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented the other parameters are described in the class description.
• final method runReportPDF(name As %String, variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String ) returns %BinaryStream
run the report to pdf output name is the name of the report variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented
• final method runReportPDFForObject(name As %String, loid As %String , variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String ) returns %BinaryStream
run the report for an object to pdf output name is the name of the report loid is id of the persisent object to use as report root. It is coded as {class}|{id} variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented
• final method runReportPrinter(name As %String, variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String , printer As %String ) returns %SOAP.OneWay
run the report to printer output name is the name of the report variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented printer is the name of the printer where the output is send. If this parameter is unused, the output is send to the default printer
• final method runReportPrinterForObject(name As %String, loid As %String , variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String , printer As %String ) returns %SOAP.OneWay
run the report for an object to printer output name is the name of the report loid is id of the persisent object to use as report root. It is coded as {class}|{id} variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented printer is the name of the printer where the output is send. If this parameter is unused, the output is send to the default printer
• final method runReportRTF(name As %String, variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String ) returns %BinaryStream
run the report to rtf output name is the name of the report variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented
• final method runReportRTFComplex(reportStep As Joria.ReportProcessStepInfo ) returns %BinaryStream
run the report after requesting the needed variables to rtf reportStep is the information about the already entered variable data
• final method runReportRTFForObject(name As %String, loid As %String , variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String ) returns %BinaryStream
run the report for an object to rtf output name is the name of the report loid is id of the persisent object to use as report root. It is coded as {class}|{id} variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented
• final method runReportXML(name As %String, variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String ) returns %String
run the report to xml output name is the name of the report variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented
• final method runReportXMLForObject(name As %String, loid As %String , variables As Joria.impl.ArrayOftns1Pair , langDef As Joria.LanguageDefinition , userName As %String ) returns %String
run the report for an object to xml output name is the name of the report loid is id of the persisent object to use as report root. It is coded as {class}|{id} variables are the predefined variable values langDef stores the language information for localized values userName stores the name of the user if rights for reports are implemented