com.crystaldecisions.report.web.viewer
Class CrystalReportSmartTagInfoParser

java.lang.Object
  |
  +--com.crystaldecisions.report.web.viewer.CrystalReportSmartTagInfoParser

public class CrystalReportSmartTagInfoParser

extends java.lang.Object

This class used in conjunction with the Java report page or Java report part viewers to parse smart tags. A smart tag is an embedded link to a report that is created by copying and pasting a report part into an Office XP document. By clicking a report part (that is, the smart tag object) in a Word XP document, an Excel XP spreadsheet, or an Outlook XP e-mail, users can quickly view the original Crystal Report from which the data was taken.

You can copy chart, text, or field objects as Crystal Reports smart tag objects. The CrystalReportSmartTagInfoParser parses the information passed by the smart tag object. The user can use this information to set the report viewer or report part viewer to display the original report.

Note: BusinessObjects Enterprise includes crsmarttag.jsp to handle the viewing of the report part defined in the smart tag. When you create the smart tag you specify where crsmarttag.jsp is located on your web server. You can use this page as an example if you want to customize how your web server handles the smart tag information. The file is installed in the C:\Program Files\Common Files\Business Objects\3.0\crystalreportviewers11 directory.

Note: Smart Tag refresh only supports a report with one database logon. If the report is connected to multiple data sources then each data source must have the same user ID and password.

Constructor Summary

CrystalReportSmartTagInfoParser()

Method Summary

ConnectionInfos	getDatabaseLogonInfos() Returns the information required to log on to the database.
java.lang.String	getDataContext() Returns the data context for the smart tag report object.
PropertyBag	getEnterpriseLogonInfo() Returns the BusinessObjects Enterprise logon information to use.
java.lang.String	getObjectName() Returns the name of the report object.
Fields	getParameterFields() Returns the parameter fields for the report.
ReportPartsDefinition	getReportParts() Returns a report part from the report.
java.lang.String	getReportSource() Returns the name of the report.
void	init(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context) Initializes the smart tag parser.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CrystalReportSmartTagInfoParser

public CrystalReportSmartTagInfoParser()

Method Detail

getDatabaseLogonInfos

public ConnectionInfos getDatabaseLogonInfos()

Returns the information required to log on to the database. The returned value can be set using the setDatabaseLogonInfos method.
Note: There is no default value for this property. Calling the init method creates a value for this property.

Returns:

The information required to log on to the database as a ConnectionInfos object.

getDataContext

public java.lang.String getDataContext()

Returns the data context for the smart tag report object.
Note: The data context represents the whole group tree or a sub tree in the group tree. There is no default value for this property. Calling the init method creates a value for this property.

Returns:

The data context for the smart tag report object as a String.

getEnterpriseLogonInfo

public PropertyBag getEnterpriseLogonInfo()

Returns the BusinessObjects Enterprise logon information to use. The returned value can be set using the setEnterpriseLogon method.
Note: There is no default value for this property. Calling the init method creates a value for this property.

Returns:

The BusinessObjects Enterprise logon information to use as a PropertyBag object.

getObjectName

public java.lang.String getObjectName()

Returns the name of the report object.
Note: There is no default value for this property. Calling the init method creates a value for this property.

Returns:

The name of the report object as a String.

getParameterFields

public Fields getParameterFields()

Returns the parameter fields for the report. The returned value can be set using the setParameterFields method.
Note: The parameter values are copied to the smart tag object when the user copies the object from the report.

Returns:

The parameter fields for the report as a Fields object.

getReportParts

public ReportPartsDefinition getReportParts()

Returns a report part from the report. The returned value can be set using the setReportParts method.
Note: There is no default value for this property. Calling the init method creates a value for this property.

Returns:

A report part from the report as a ReportPartsDefinition object.

getReportSource

public java.lang.String getReportSource()

Returns the name of the report.
Note: There is no default value for this property. Calling the init method creates a value for this property.

Returns:

The name of the report as a String.

init

public void init(javax.servlet.http.HttpServletRequest request,
                 javax.servlet.ServletContext context)
          throws ReportSDKParameterFieldException,
                 java.io.UnsupportedEncodingException,
                 WebReportingException

Initializes the smart tag parser.

Parameters:

request - The HttpServletRequest object used to initialize the CrystalReportSmartTagInfoParser object.

context - The ServletContext object used to communicate with the Servlet container.

Throws:

ReportSDKParameterFieldException - This is thrown when there is an error setting a parameter field.

UnsupportedEncodingException - This is thrown when the Character Encoding is not supported.

WebReportingException