Applies to: Kyvos Reporting

The Format Step is a key step in the Query Object workflow, typically used as the final step. It primarily defines how the fields in the query are displayed and organized for the end users. It allows you to set field captions, group labels, formatting, and other display properties to ensure the data is presented in a user-friendly format.

Key Properties in the Format Step

Property	Sub-field/Option	What it controls	Notes/Examples

Property	Sub-field/Option	What it controls	Notes/Examples
Field	Name of Field; Source	Shows original field name; identifies originating step	Name is read-only; helps trace lineage
Caption	Enter	Display name shown to end users	Customize for clarity
Hyperlink	URL; Drill Down to another Report; Target; Parameters	Makes field clickable to open URL or another report	Supports target frame and passing parameters
Group Label	Enter or Select	Groups related fields for navigation	Useful for large datasets
Hidden	Select/De-select	Hide field in reports or downstream QOs	Controls visibility
Geographic Role	Enter or select from list	Maps field to GIS roles for maps	e.g., country, coordinates
Format	Width; Output Format; Align; Input Format; User Time Zone	Presentation settings for the field	Width 1–100; date/number formats; time zone conversion

Hyperlinking a Field

You can configure a field to act as a hyperlink, enabling users to navigate to other resources or reports directly from a field's value. For example, in a sales report, you could hyperlink the country name to open a detailed report for that specific country.

Hyperlink Options:

Option	What it does	Notes/Examples

Option	What it does	Notes/Examples
URL	Opens a specified external or internal URL when clicked	Use for external docs or dashboards
Drill Down to another Report	Navigates to a detailed report and can pass parameters	Common for multi-level reporting

Hyperlink Dialog Properties:

Property	What it controls	Notes/Examples

Property	What it controls	Notes/Examples
Select Report	Choose the target report for drill-down	Select from available reports
Target	Where the link opens (new/same window)	Browser/window behavior
Report Parameter	Maps current report values to the drill-down	Pass filters/context
System Parameter	Sends system values with the request	e.g., user, locale

Data Format Dialog

The Data Format Dialog allows you to specify how the field’s data should be formatted for input and output.

Format Type	Description/Notes

Format Type	Description/Notes
General	No specific format.
Number	Allows validation and formatting of numbers, including options for decimal places and thousand separators.
Currency	Format as currency, with options for symbols and decimal places.
Date	Format the field as a date, with options to append time or choose a locale-specific format.
Time	Formats the field as a time value.
Percentage	Treats the field as a percentage, multiplying by 100.
Scientific	Formats large numbers in scientific notation.
Text	Allows you to convert text to lower case, upper case, or apply other text formatting.
Network ID	Format for IP addresses and MAC addresses.

Locale Default:

You can apply the locale default format by selecting it from a locale configuration file, which ensures the format aligns with the user's locale settings.