Using Zen Reports - InterSystems Documentation

More documents

Recommendations

Info

XData ReportDefinitionAttributenameDescriptionThe generates an XML element of this name in the output.If you do not provide a value for name, the generates aname for itself based on the Zen report class name. If the group isa the name attribute is required.Aside from name, and attributes fall into two categories related to acquiring andorganizing the source data for the report. The next two topics in this section discuss them:• Building the Query• Break On Field or Expression3.6.2 Building the QueryA or requires a resultset to generate a report. A or can either:• Generate a resultset by providing the query attributes described in this topic;or:• Use the resultset generated by the query that is defined by its containing or .For details, see the section “Nested Groups.”AttributeOnCreateResultSetqueryClassqueryNameruntimeModeDescription(Optional) The name of a server-side callback method to call tocreate a %ResultSet object. The OnCreateResultSet value must bethe name of a server-only class method defined in the Zen reportclass. See the details following this table.(Optional) The name of the class containing the query. You mustalso provide a value for queryName.(Optional) The name of the class query that will provide the%ResultSet for this list. You must also provide a value forqueryClass.SQL runtime mode to apply to the %ResultSet object used to fetchresults for this report. The default runtimeMode of 2 is appropriatefor most cases and usually does not need to be changed. Possiblevalues are: 0 for LOGICAL mode, 1 for ODBC mode, and 2 forDISPLAY mode.30 Using Zen Reports
AttributesqlDescription(Optional) Server-side SQL query to get contents of the or list.This attribute has the underlying data type %ZEN.Datatype.sql. Thismeans it cannot be accessed from the client. Its value is encrypted(using the current session key) when it is sent to the client. If thisvalue is returned to the server, it is automatically decrypted. Thismakes it possible to place sensitive data on the client for futureprocessing on the server, without letting a user view this data.If you use the OnCreateResultSet attribute to specify a server-side callback method, as in this example:Then the method named by the OnCreateResultSet attribute must be defined within the page class withthe specific signature shown in the following example:ClassMethod CreateRS(ByRef pSC As %Status, ByRef pParameters) As %ResultSet{set rs = ##class(%ResultSet.SQL).%New()set sql = "SELECT Name FROM Sample.Person where Home_State=?"set pSC = rs.Prepare(sql)set pSC = rs.Execute(pParameters(1))quit rs}Where:• The callback method must instantiate and return a new instance of a %ResultSet object. Thisresultset then becomes the source of data for the or .• The callback method must return a status code by reference to indicate whether or not there wereany errors encountered in creating the %ResultSet object.• The required inbound argument pParameters is an array that, at runtime, automatically containsany values that you supplied in the or definition, such as the value"AL" for Home_State in the example above.The pParameters array is subscripted by a 1–based number that indicates the order of theseparameters in the or definition. Even if there are no elements, ifyou omit the inbound argument pParameters from the callback method signature, the resultingreport will be empty.Using Zen Reports 31
Page 1 and 2: Using Zen ReportsVersion 2008.210 O
Page 3 and 4: Table of ContentsAbout This Book ..
Page 5 and 6: List of FiguresHow a Zen Report Cla
Page 7: About This BookThis book explains h
Page 10 and 11: Building a Zen Report1.1 Preparing
Page 14 and 15: Building a Zen Report14. Compile th
Page 16 and 17: Building a Zen ReportTutorial Sales
Page 19 and 20: 2Zen Report Class ParametersA Zen r
Page 21 and 22: EMBEDXSLA user can override the cur
Page 23 and 24: Zen Report Class ParametersPRIVATEA
Page 25: Zen Report Class ParametersUSETEMPF
Page 28 and 29: XData ReportDefinition}field="Num"c
Page 30 and 31: XData ReportDefinitionAttributeexpr
Page 32 and 33: XData ReportDefinitionAttributefiel
Page 34 and 35: XData ReportDefinitionThe median of
Page 38 and 39: XData ReportDefinitionAlthough the
Page 40 and 41: XData ReportDefinitionAttributebrea
Page 42 and 43: XData ReportDefinitionThe following
Page 44 and 45: XData ReportDefinition...In this ca
Page 46 and 47: XData ReportDisplay• Style and ap
Page 48 and 49: XData ReportDisplayAttributenamesty
Page 50 and 51: XData ReportDisplayAttributenameDes
Page 52 and 53: XData ReportDisplayth.myTable {back
Page 54 and 55: XData ReportDisplayReport Display A
Page 56 and 57: XData ReportDisplayAttributenameDes
Page 58 and 59: XData ReportDisplayAttributeDisplay
Page 60 and 61: XData ReportDisplayAttributespecial
Page 64 and 65: XData ReportDisplayAttributelayoutD
Page 68 and 69: Charts in Zen ReportsAttributedataG
Page 70 and 71: Zen Reports from a Web Browser• T
Page 72 and 73: Zen Reports from a Web Browser• T
Page 75 and 76: 7Configuring Zen for PDF OutputWhen
Page 77 and 78: 8Zen Reports from a Command LineBef
Page 79 and 80: 9Troubleshooting Zen ReportsThis ch
Page 81 and 82: Viewing Intermediate Files9.2 Viewi
Page 83 and 84: Viewing Intermediate Files9.2.3 The
Page 85 and 86: You can run a session like this wit
Page 87 and 88:
IndexSymbols$DATASOURCE, 14$EMBEDXS
Page 89:
PRIVATE, 17Qqueryreport, 30queryCla
show all

Using Zen Reports - InterSystems Documentation

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?