Composite definitions

Several composites are used when working with Report Lists. Use the information about these composites as you write scripts for your Report List integration.

syReportData

The syReportData composite contains information about a specific report in the Report List.

[spacer]

Component

Data Type

Description

Report Type

Integer

Specifies the type of report. Refer to Report types for a list.

Product ID

Integer

The ID of the product to which the report belongs.

Report Series DictID

Integer

The ID of the product that defines the report series the report is part of. If it’s a predefined Microsoft Dynamics GP core series, the value will be 0.

Report Series ID

Integer

Uniquely identifies the report series (within the report series defined for the specified product) that the report will be assigned to.

Report Category ID

Integer

Specified the category the report is assigned to.

Report ID

Integer

The unique ID for the report. For SmartList favorites, this is the object ID (ASI_Favorite_Type).

Report Option ID

Currency

The ID of the report option.

Report Option Name

String

The name of the report option to use for the report. For SmartList favorites, this contains the favorite name. Leave this component blank to have all SmartList favorites of the specified type listed.

My Report Name

String

The name assigned to the report when it was added to the My Reports list.

VisibleTo

Integer

For SmartList favorites, specifies who can see the item:

1 - SMARTLIST_VISIBLETO_SYSTEM - Visible to all users in all companies

2 - SMARTLIST_VISIBLETO_COMPANY - Visible to users in a specific company

3 - SMARTLIST_VISIBLETO_USERCLASS - Visible to users in a specific class

4 - SMARTLIST_VISIBLETO_USERID - Visible to a specific user

User ID

String

The SmartList favorite User ID. Applies only when VisibleTo is set to 4.

User Class

String

The SmartList favorite User Class. Applies only when VisibleTo is set to 3.

Company ID

Integer

The SmartList favorite Company ID. Applies only when VisibleTo is set to 2.

String A 255

String

A generic string that can be used to help identify reports.

Report Options Table Ref

Reference

A reference to a table that contains report option information. Integrating applications can use this reference if needed in their implementation.

Report Names Table Ref

Reference

A reference to a table that contains report option names. Integrating applications can use this reference if needed in their implementation.

DictID

Integer

The ID of the dictionary that contains the definition for the report.

Resid

Integer

The resource ID of the report.


ReportDestOptions

The ReportDestOptions composite is used to pass report destination information into the procedure that displays or prints reports.

[spacer]

Component

Data Type

Description

Control Type

Integer

Not used for Report List.

Ask Each Time

Check Box

Indicates whether the user should be asked for the report’s destination.

Print to Screen

Check Box

The value true specifies printing to the screen.

Print to Printer

Check Box

The value true specifies printing to the printer.

Print to File

Check Box

The value true specifies printing to a file.

Export File Type

Drop-down List

Not used for Report List.

File Export Name

String

Specifies the complete path for the export file

Export Type

Integer

Specifies the type to use for the export file. Use the following constants to specify the value: TEXTFILE, TABFILE, COMMAFILE, HTMLFILE, PDFFILE

If File Existing

Radio Group

Specifies the action if the export file already exists:

0 - Append

1 - Replace


ListObjState

The ListObjState composite provides access to the Report List window. The following are the components of this composite used for the Report List:

[spacer]

Component

Data Type

Description

SubList

Long integer

Indicates with report series is being displayed.

Table Reference

Table reference

A reference to the report list temporary table.

SortIndex

Integer

Indicates which index to use when filling the Report List from the temporary table.

ActionsBDLRef

Field reference

Obsolete

ListOptionsDDLRef

Field reference

Obsolete

DefaultAction

Long integer

Contains the ID of the default action to execute when the user double-clicks a row in the Report List.

Find Text

String

Contains the string to search for in the Report List.



Documentation Feedback