Output Fields tab
The Output Fields settings define fields and field names in the output. These settings also define whether the stage output is in flat or hierarchical format.
- Override query results
- Check this check box to configure the result configuration. The default is to use the query result names defined by the query as they initially appear in the Query Results list. The order of result names in the list defines the hierarchical output. Check this check box to change result names, edit paths, or create flat instead of hierarchical output. To write flat data output,you can use the Write to File or Write to DB stages. To write hierarchical output, you can use the Write to XML stage.Note: Query results overrides are not supported by Enterprise Designer. If you configure query result overrides in Flow Designer, the overrides will not appear if you open the workflow in Enterprise Designer.
- Query results
- This box lists query results associated with each step in a saved query. The default result names are typically
Root, Step1, Step2
, and so forth, although they may have other names depending on the query.
Result Configuration
These options allow you to edit the name and path for the result. You can also choose to output field values in a hierarchical list or as flat data. You must check the Override query resultscheck box to edit these options for a the result that is currently selected in the Query Results box.
- Include in results
- Check or uncheck this check box to include or remove a result from the output. Clearing this check box removes the corresponding result fields from the stage field table. Do not uncheck this check box for the last result in a series or when there is only one result in the series. This check box is selected by default.
- Name
- The name for a result in the output. The default is the result name initially shown in the Query Results box. If the List check box is checked, this name designates a level in the hierarchy. It is the name of a level in hierarchical output, and by default, it also prefixes the property name for each output field.
- Path
- Shows the path for a result in the output hierarchy. By default, the path incorporates names of the preceding results. For any result, you can click to select one of the paths from a preceding result and thereby change the output hierarchy.
- Use type names
- Check this check box to include the entity or relationship type name for a step in the output. Entities use the entity type and relationships use the relationship label for the type name. For example, if you do not select this option and the result name that shows in the Name box is
Afghanistan
, then the output fields forLatitude
andDate
properties would beAfghanistan.Latitude
andAfghanistan.Date
. If you select this option, then the entity type name,Person
for this example, will prefix the property name. The output fields would then beAfghanistan.Person.Latitude
andAfghanistan.Person.Date
. You can use this option to help identify hierarchical relationships in flat data output. You cannot simultaneously select both the Use type names and List check boxes. - List
- Check this check box to create hierarchical output for the currently selected result. The result name then forms one level in the hierarchy and the output fields for the result are inserted as its children. Uncheck this check box to combine output fields for a result with the output fields of the previous result. Clear this check box for every result for an entirely flat output. In both flat and hierarchical outputs, result names prefix output field names unless you choose to remove them by clicking Remove result name on the edit menu above the stage fields table.
Stage fields table
This table shows the result hierarchy. If also shows output fields for any results that are currently selected in the Query Results box. In this table, you can select the check boxes to include results and fields in the output. You can edit individual field names. You also can remove the result name prefix from the field names. The hierarchy shown in the table depends on the Result Configuration settings for each result in the Query Results results list.
- Remove result name
- To remove the result name prefix from output fields, click the edit menu above the stage fields table, then click Remove result name. Result names are prefixed to output field names. They are especially useful to distinguish fields and avoid conflicts when hierarchical data is flattened and output to rows. You can use this option to remove the result names if they are not needed.
- Include
- Check this check box to include a field in the output. Uncheck a check box to exclude a field from the output. Uncheck or check the check box next to a result name to uncheck or check all fields under that result. This can speed configuration when you want check the check box for one or two fields amongst many fields.
- Stage Field
- Shows the name of a field included in the output. You can click any field to edit its name.
- Property
- The entity or relationship property name from the model that corresponds to an output field.
- Type
- Specifies the type of output field. This may be any one of the data types for properties (
boolean
,string
,double
,float
,integer
,long
,date
,time
,datetime
, orbigdecimal
).