Report Definitions - SmartPlant Foundation - IM Update 48 - Help - Hexagon

Allows you to select the item type for which you want to generate a report.

Description - Displays the descriptions of the available item types.

Allows you to define the criteria for the content in tag registers, as well as the format in which they will be generated.

Report output style - Allows you to specify the output format of the tag register. The two output types are Excel Register and ASCII. If you select Excel Register, you can select one of the default Microsoft Excel templates or a custom Microsoft Excel template. If you select ASCII, you can provide the delimiter in the Delimiter box. The default delimiter value is a comma.

Report details - Includes a list of properties for tags and related items, defined using a view definition. Select the properties you want to include in the report.

Related Item - Specifies the category of the property that you want to read from the database and put into the report.

Caption - Displays the names of the properties that can be selected for your output report. You can type a new name.

Sort - Allows you to select a sort type of either ascending or descending.

Sort Order - Allows you to sort the order of the properties selected for the report.

You can assign a sort order value to a property by right-clicking or left-clicking the Sort Order column for that property:

• By right-clicking the column, the greatest value incremented by one is assigned to the property.

• By left-clicking the column, the greatest value incremented by one is assigned to the property; meanwhile, a spin box is shown, allowing you to change the value.

Criteria - Allows you to define a value for your query criteria.

Prompt - Allows you to prompt the user for query criteria.

Select All - Allows you to select all the properties listed.

Clear All - Allows you to clear all the selected properties.

Display latest values only - For reports that include published data, displays the latest published values shown in the CDW domain.

When this option is used, the report also highlights inconsistent property values in the published data.

Run in Background - Allows you to schedule a task for running the report definition.

Start date - Allows you to provide the start date and time of the scheduled task.

Move Up - Moves the selected row up one position in the report definition.

Move Down - Moves the selected row down one position in the report definition.

Schedule ad hoc report

Run in background - Allows you to run the ad hoc report in the background.

Start date - Allows you to specify the date and time to run the ad hoc report in the background.

Download or Compress

Download Files - Allows you to download physical files to a specified shared location.

Download Path - Allows you to specify a shared location to save physical files.

Download as Zip File - Allows you to download physical files in a zipped format.

Apply - Displays the report using its current format.

Save - Saves the report in its current format for later use.

For more detailed information, see Ad-hoc reports in SmartPlant Foundation Desktop Client User's guide.

Allows you to specify the criteria to use to filter the contents of the selected report column.

Clear criteria for this property - Allows any value for the property in the report.

Define criteria for this property - Allows you to specify criteria for the property in the report.

Currently defined criteria for [property name] - Lists the criteria defined for the property. You can define multiple criteria statements for a single column.

Operator - Allows you to specify search operators to refine your search to a specific set of objects. There are two sets of operators you can use, equals and like, depending on the property type selected.

If the property is a value in a list available by default or if you use the words Null or Blank as the value, only the equals operator is available. The operator automatically changes to equals when you type Null or Blank.

You can use wildcards to define search criteria for a string property that matches one or more characters using the like or equals operator.

The following table shows the operators for strings, doubles, integers, small integers, and select lists:

The behavior of the equals and like operators is identical. You can use either of these when you are defining the search criteria using wildcards.

• An asterisk (*) matches zero or more characters in your search. For example, if you specify pa*, the software returns objects where that property value contains words that start with the characters pa, such as pan, park, part, and so on.

• You can use an underscore (_) or a question mark (?) to match a single character. For example, if you specify pi_ or pi?, the software returns pid, pit, and pip, but not pipe.

• To search for objects where the property value includes an underscore, question mark, or asterisk character, enclose them in square brackets. For example, use 100[*] to return 100*, but not 100abc.

• You can search for objects with a property that contains a single character in a specific range of characters by enclosing them in square brackets. For example, using [a-f] returns only objects where this property's value includes a to f in a set of characters. So, if you specify pi[a-p], the software returns objects where the property value is pid and pip, but not pit, as 't' is outside the range.

• You can use a caret (^) character to search for objects where a property value does not include a character in a range or set. For example, if you specify pi[^a-p], the software returns objects where the property value is pit, but not pid or pip, as 'd' and 'p' are in the range a-p.

Value - Allows you to type a value for the property upon which you are basing your query criteria. 

Join criterion - Specifies whether to join multiple criteria using AND or OR for this single report column. You cannot mix AND and OR when defining multiple criteria for a single column.

• Use AND if you want all the criteria to match before including the item in the report. This option is more restrictive than OR.

• Use OR if you want only a single criterion to match before including the item in the report.

Add Criterion - Adds the specified operator and value to the list of defined criteria.

Update Criterion - Updates a selected criterion when you change the operator, the value, or both.

Delete All Criteria - Deletes all criteria from the list.

Delete Selected Criterion - Deletes the selected criterion from the list.

Set Date and Time dialog box

Allows you to specify additional filter criteria on properties that store a date and time.

Calendar - Allows you to select a specific date.

Today - Selects today's date. If you want to set a date that is a specific period from today, select Today plus (+) or minus (-) number of Days, Weeks, or Months.

Ignore non-working days - Allows you to ignore non-working days in the default calendar for the site when calculating the duration. The default calendar is selected using the system options. For more information on the system options, see Configure the system options.