Data Structures
struct	parameter_descriptors_s

Macros
#define	VR_Split_String "{;}"

Typedefs
typedef struct parameter_descriptors_s	parameter_descriptors_t

typedef enum SSR_value_types_e	SSR_value_types_t

Enumerations
enum	SSR_value_types_e { SSR_UNKNOWN, SSR_BOOLEAN, SSR_STRING, SSR_CHARACTER, SSR_DATE, SSR_DOUBLE, SSR_INTEGER, SSR_TYPEDREFERENCE, SSR_UNTYPEDREFERENCE, SSR_EXTERNALREFERENCE, SSR_LONGSTRING, SSR_TYPEDRELEATION, SSR_UNTYPEDRELEATION }

Functions
QRY_API int	SSR_create_external_related_objects (tag_t parent_tag, int num_related_objs, tag_t **related_obj_tags)

QRY_API int	SSR_create_property_objects (tag_t parent_tag, int num_props, tag_t **property_obj_tags)

QRY_API int	SSR_create_related_objects (tag_t parent_tag, int num_related_objs, tag_t obj_tags, tag_t *related_obj_tags)

QRY_API int	SSR_create_report_property_objects (tag_t visual_report_obj_tag, int num_props, tag_t **report_property_obj_tags)

QRY_API int	SSR_create_visual_report_objects (tag_t ctx_tags, int num_ctx_tags, tag_t *visual_report_obj_tags)

QRY_API int	SSR_get_property_descriptors (tag_t visual_report_tag, const char report_descriptor, int num_parameter_descriptors, parameter_descriptors_t **pd)

QRY_API int	SSR_log_error (tag_t object_tag, int severity, int ifail, const char s1, const char s2, const char s3, const char s4, const char s5, const char s6, const char *s7)

QRY_API int	SSR_set_external_related_object_data (tag_t related_obj_tag, const char extObjectID, const char extObjectSource, const char extObjectName, const char extObjectType, const char extObjectaccessURL, const char typeOfRelation)

QRY_API int	SSR_set_property_data (tag_t property_obj_tag, const char name, const char displayName, SSR_value_types_t valueType, int numValues, const char values, const char relatedUID, const char source, const char propertyGroup, const char unit, const char accessURL)

QRY_API int	SSR_set_related_object_data (tag_t related_obj_tag, const char *typeOfRelation)

QRY_API int	SSR_set_report_property_data (tag_t report_property_obj_tag, const char name, const char displayName, SSR_value_types_t valueType, int numValues, const char values, const char relatedUID, const char source, const char propertyGroup, const char unit, const char accessURL)

Detailed Description

The SSR module is a sub module in the QRY module. It provides the interfaces to manage Server Side Reports.

Macro Definition Documentation

#define VR_Split_String "{;}"

Definition at line 45 of file ssr.h.

Typedef Documentation

typedef struct parameter_descriptors_s parameter_descriptors_t

typedef enum SSR_value_types_e SSR_value_types_t

Enumeration Type Documentation

enum SSR_value_types_e

Enumerator
SSR_UNKNOWN
SSR_BOOLEAN
SSR_STRING
SSR_CHARACTER
SSR_DATE
SSR_DOUBLE
SSR_INTEGER
SSR_TYPEDREFERENCE
SSR_UNTYPEDREFERENCE
SSR_EXTERNALREFERENCE
SSR_LONGSTRING
SSR_TYPEDRELEATION
SSR_UNTYPEDRELEATION

Definition at line 28 of file ssr.h.

Function Documentation

QRY_API int SSR_create_external_related_objects	(	tag_t	parent_tag,
		int	num_related_objs,
		tag_t **	related_obj_tags
	)

Creates external (non-teamcenter) objects for report property or related objects These objects do not have a teamcenter representation in the database. "related_obj_tags" are transient tags generated by teamcenter which can be used to set data on this external object.

Parameters

parent_tag	(I) Parent object tag
num_related_objs	(I) Number of related objects required
related_obj_tags	(OF) Array of related object tags created

QRY_API int SSR_create_property_objects	(	tag_t	parent_tag,
		int	num_props,
		tag_t **	property_obj_tags
	)

Creates a SSR property object for report property or related objects. These objects are non-persistent and are not stored in the database. "property_obj_tags" are transient tags generated to identify the property objects.

Parameters

parent_tag	(I) Parent object tag
num_props	(I) Number of SSR properties required
property_obj_tags	(OF) Array of SSR property object tags

QRY_API int SSR_create_related_objects	(	tag_t	parent_tag,
		int	num_related_objs,
		tag_t *	obj_tags,
		tag_t **	related_obj_tags
	)

Creates related objects for report property or related objects.These objects are non-persistent and are not stored in the database. "related_obj_tags" are transient tags generated to identify the related objects.

Parameters

parent_tag	(I) Parent object tag
num_related_objs	(I) Number of related objects required
obj_tags	(I) Array of object tags
related_obj_tags	(OF) Array of related object tags

QRY_API int SSR_create_report_property_objects	(	tag_t	visual_report_obj_tag,
		int	num_props,
		tag_t **	report_property_obj_tags
	)

Creates report property objects. These objects are non-persistent and are not stored in the database."report_property_obj_tags" are transient tags generated to identify the report property objects.

Parameters

visual_report_obj_tag	(I) Visual report object tag
num_props	(I) Number of report properties required
report_property_obj_tags	(OF) Array of report property object tags

QRY_API int SSR_create_visual_report_objects	(	tag_t *	ctx_tags,
		int	num_ctx_tags,
		tag_t **	visual_report_obj_tags
	)

Creates visual report objects. These objects are non-persistent and are not stored in the database. "visual_report_obj_tags" are transient tags generated to identify the visual report objects.

Parameters

ctx_tags	(I) Array of context object tags
num_ctx_tags	(I) Number of context object tags
visual_report_obj_tags	(OF)Array of visual report object tags

QRY_API int SSR_get_property_descriptors	(	tag_t	visual_report_tag,
		const char *	report_descriptor,
		int *	num_parameter_descriptors,
		parameter_descriptors_t **	pd
	)

Gets the visual report parameter descriptors.

Parameters

visual_report_tag	(I) Visual report definition tag
report_descriptor	(I) Type of report parameter: "general", "search", "property"
num_parameter_descriptors	(O) Number of parameter descriptors.
pd	(OF) Array of parameter descriptors

QRY_API int SSR_log_error	(	tag_t	object_tag,
		int	severity,
		int	ifail,
		const char *	s1,
		const char *	s2,
		const char *	s3,
		const char *	s4,
		const char *	s5,
		const char *	s6,
		const char *	s7
	)

Adds the specified error message to a SSR Object.

String arguments are substituted into the translated UIL string when the error string is written into the XML, where %n$ in the UIL string gives the n'th argument to substitute (XPG3 printf).

If the error code is not resolved, the parameters s1 thru s7 are concatenated with VR_Split_String as separator and output as a single error message into the XML.

Parameters

object_tag	(I) Object tag
severity	(I) EMH_severity_error, EMH_severity_warning, or EMH_severity_information
ifail	(I) Code of the error being stored
s1	(I) Character string being substituted into the internationalized message associated with this ifail code
s2	(I) Character string being substituted into the internationalized message associated with this ifail code
s3	(I) Character string being substituted into the internationalized message associated with this ifail code
s4	(I) Character string being substituted into the internationalized message associated with this ifail code
s5	(I) Character string being substituted into the internationalized message associated with this ifail code
s6	(I) Character string being substituted into the internationalized message associated with this ifail code
s7	(I) Character string being substituted into the internationalized message associated with this ifail code

QRY_API int SSR_set_external_related_object_data	(	tag_t	related_obj_tag,
		const char *	extObjectID,
		const char *	extObjectSource,
		const char *	extObjectName,
		const char *	extObjectType,
		const char *	extObjectaccessURL,
		const char *	typeOfRelation
	)

Sets external related objects data. The "extObjectID" is used to uniquely identify this object. Properties and related objects of external objects having the same "extObjectID" are merged while writing them to the XML. If "extObjectSource" is NULL, then default value of "External" will be used.

Parameters

related_obj_tag	(I) External related object transient tag
extObjectID	(I) External object ID
extObjectSource	(I) Source of the External object type
extObjectName	(I) External object display name
extObjectType	(I) External object type
extObjectaccessURL	(I) The URL to directly access the external object
typeOfRelation	(I) External Object relationship type

QRY_API int SSR_set_property_data	(	tag_t	property_obj_tag,
		const char *	name,
		const char *	displayName,
		SSR_value_types_t	valueType,
		int	numValues,
		const char *	values,
		const char *	relatedUID,
		const char *	source,
		const char *	propertyGroup,
		const char *	unit,
		const char *	accessURL
	)

Sets the values in the SSR property object.

Parameters

property_obj_tag	(I) SSR Property tag
name	(I) Name of property report results
displayName	(I) Display name of property
valueType	(I) Type of property value
numValues	(I) Number of property values
values	(I) Array of property values separated by the delimiter
relatedUID	(I) If it is a typedreference type property, it is the UID of reference object
source	(I) Source of the property
propertyGroup	(I) Category within a source
unit	(I) Unit of the property
accessURL	(I) Access URL of the property

QRY_API int SSR_set_related_object_data	(	tag_t	related_obj_tag,
		const char *	typeOfRelation
	)

Sets the related objects data. Properties and related objects of objects having the same "UID's" are merged before writing them in the XML.

Parameters

related_obj_tag	(I) related object tag
typeOfRelation	(I) Object relationship type

QRY_API int SSR_set_report_property_data	(	tag_t	report_property_obj_tag,
		const char *	name,
		const char *	displayName,
		SSR_value_types_t	valueType,
		int	numValues,
		const char *	values,
		const char *	relatedUID,
		const char *	source,
		const char *	propertyGroup,
		const char *	unit,
		const char *	accessURL
	)

Set report property data.

Parameters

report_property_obj_tag	(I) Report property object tag
name	(I) Name of property report results
displayName	(I) Display name of property
valueType	(I) Type of property value
numValues	(I) Number of property values
values	(I) Array of property values separated by the delimiter
relatedUID	(I) If it is a typedreference type property, it is the UID of reference object
source	(I) Source of the property
propertyGroup	(I) Category within a source
unit	(I) Unit of the property
accessURL	(I) Access URL of the property

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation