JDBC Driver for SuiteCRM

Build 22.0.8462

ReportFields

Create, update, delete, and query the saved report fields.

Table Specific Information

Select

You can query the Report Fields table using any criteria in the WHERE clause. The driver will use the SuiteCRM API to filter the results.

SELECT * FROM [Report Fields] WHERE Module = 'Spots'

Insert

Create a Report Field by specifying any writable column.

INSERT INTO [Report Fields] (Name,Module,Function) VALUES ('New Field','Reports','COUNT')

Update

You can update any Report Field column that is writable, by specifying the Id.

UPDATE [Report Fields] SET Display = false WHERE Id = 'Test123' 

Delete

Remove a Report Field by specifying the Id.

DELETE FROM [Report Fields] WHERE Id = 10003

Columns

Name Type ReadOnly Description
ID [KEY] String False

The unique identifier of the report field entry.

CreatedById String True

The Id of the user who created the record.

CreatedByName String True

DateCreated Datetime True

The date the record was created.

DateModified Datetime True

The date the record was last modified.

Deleted Bool False

The record deletion indicator.

Description String False

Description for the report field entry

Display Bool False

Whether to display the selected field in the report

Field String False

The module field targeted for the report

FormatOptions String False

Additional format options

Function String False

Function to be applied for the field

Group Bool False

Whether the results from this field are grouped

GroupOrder String False

The order of the group by

Label String True

The field's label in its own module

LBL_AOR_REPORT_ID String False

The report Id the report field will be applied to

LBL_GROUP_DISPLAY Int False

Whether to display the group

Link Bool False

Whether to enable a link to the field

ModifiedById String True

The Id of the user who last modified the record.

ModifiedByName String True

The name of the user who last modified the record.

Module String False

The module to retrieve the report field from

Name String False

Name assigned to the report field entry

Order Int False

The ordering of the report field

Sort String False

Sort this field by ASC or DESC

SortOrder String False

The ordering of the sort for the report field

Total String True

The function that adds the results of the report query

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462