addedValues Plugin

addedValueMacros.serveReportURL

Syntax

{addedValueMacros.serveReportURL(msgnum, reportID, mimetype)}

• msgnum - a message number to provide a context
• reportID - the name of an item detail message report
• mimetype - the value of mimetype to serve this report with, or a suffix that has been mapped to a mimetype in the administration website settings mimetypes page.
• template - optional, default empty, a template name.

Examples

Semantics

serveReportURL returns a url that serves a pointer file as is commonly used by audio visual streaming applications. The format of the pointer files varies according to the vagaries of the intended audience, for example, quicktime versus real audio versus microsoft audio. But they all contain urls to the streaming server, and some additional metadata, which you format using a report tailored for each application's needs. If the browser viewing the page does not have access to the report reportiD, the macro will return an empty string.

If the mimetype value is "html", the macro will return a url that serves a normal HTML page with content built by the report reportID, using the default template unless overridden by a value of the template parameter. This is particularly useful for building content for frames and iframes, with a cut-down template. The second example above, demonstrates how to add an iframe to a page in this way.

See also

• Reports
• addedValueMacros.serveReportURL
• addedValueMacros.suffixToMimetype