im fields
displays a list of fields used to define custom fields
Synopsis
im fields [--fields=field1[:width1],field2[:width2]...] [--fieldsDelim=value] [--height=value] [--width=value] [-x value] [-y value] [--user=name] [--hostname=server] [--password=password] [--port=number] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--[no]asAdmin] [--cwd=directory] [--forceConfirm=[yes|no]] [-g|--gui] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] field .....
Description
im fields displays a list of defined fields. By default, all fields are selected to be displayed.
Options
This command takes the universal options available to all
im commands, as well as some general options. See the
options reference page for descriptions.
• --fields=field1[:width1],field2[:width2]...
where field n can be any of the following:
◦ allowedTypes
displays the issue types that can be linked to the relationship field.
◦ cycleDetection
displays whether or not the system will prevent relationship loops from occurring in the relationship field.
◦ name
displays the name of the field. By default, only the name is shown.
◦ displayName
displays the name assigned as the display name of the field.
◦ pairedField
displays the field name of the paired relationship field. For forward relationship fields, the corresponding backward relationship field displays; for backward relationship fields the corresponding forward relationship field displays.
◦ rules
displays the trigger rules associated with the field.
◦ paramSubstitution
displays whether or not parameter references in the text field are replaced with parameter values when you view the item through a view or report that supports parameter substitution. For more information on how parameter values are determined, see the Windchill RV&S Help Center.
◦ isMultiValued
displays whether or not the field can contain multiple values.
◦ description
displays a description of the field.
◦ type
displays the field data type.
◦ default
displays default value for the field (CLI only).
◦ defaultAttachmentField
displays default attachment field for the rich content field.
◦ defaultBrowseQuery
displays the default Admin query to use when adding a related item by browsing to the relationship field.
◦ displayAsLink
displays whether or not the selected value in the item backed pick list field displays as a hyperlink to the backing item in the GUI and the Web UI.
◦ min
displays the minimum value for the field for integer, float, and date fields (CLI only).
◦ max
displays the maximum value for the field for integer, float, and date fields (CLI only).
◦ displayAsProgress
displays whether or not the value of the integer field is displayed as progress bar in the GUI.
◦ displayLocation
displays the name of the issue tab where the relationship field is displayed (field or relationship).
◦ picks
displays the list of valid values for a pick list field, of the form text:value:image (CLI only).
◦ suggestions
displays the list of suggested values for a short text field (CLI only).
◦ textindex
displays whether or not queries against the field will be treated as word searches.
◦ trace
is valid for both relationship fields and sourcelink fields.
For relationship fields, displays whether or not the field is a trace relationship. Trace relationships are defined via field pairs and are presented to the user in domain-specific language, for example, Test and Requirements. To learn more about trace relationships, see the Windchill RV&S Help Center.
For sourcelink fields, displays true if it is a trace field, and false if it is a non-trace (links-only) field.
◦ relevanceRule
displays the relevance rule for the field (CLI only).
◦ editabilityRule
displays the editability rule for the field (CLI only).
◦ id
displays the database ID of the field. This is for PTC Technical Support only.
◦ isForward
displays whether or not the field is a forward relationship field.
◦ linkFlags
displays relationship flags for the relationship field.
◦ maxLength
displays the maximum length of a long or short text field (CLI only).
◦ displayRows
displays the number of rows used for a long text field or a relationship field.
◦ displayStyle
displays the format used for the field: table or csv (comma separated values).
◦ loggingText
displays the logging type of field. Valid for long text fields only (CLI only).
◦ position
displays the position in the list of fields.
◦ computation
displays the expression for the computed field.
◦ staticComputation
displays whether the computed field is a static or dynamic computation.
◦ storeToHistoryFrequency
displays the frequency at which the computed field is calculated and stored to issue history.
◦ lastcompute
displays the date and time that the computed field was last calculated.
◦ references
displays a list of object references.
◦ associatedField
displays the field associated with a field value attribute.
◦ backedBy
displays the issue backed picklist that backs the field value attribute.
◦ backingStates
displays the active states that back the issue backed picklist.
◦ backingTextField
displays the short text field containing text for an issue backed picklist.
◦ backingTextFormat
displays the fields containing values that are linked together to form the picklist values for an issue backed picklist.
◦ backingType
displays the type that backs an issue backed picklist.
◦ backingFilter
displays the filter applied to values in an issue backed picklist.
◦ correlation
displays the field contained in the type containing the query backed relationship field and a field in the issues returned by the query.
◦ defaultColumns
displays the default columns for the relationship field.
◦ displayPattern
displays the display pattern for a numeric field.
◦ isSystemManagedFields
displays whether the field is system-managed. Possible values are true and false.
◦ phases
displays the phases for a phase field.
◦ query
displays the query for the query backed relationship field.
◦ ranges
displays the ranges for the range field.
◦ richContent
displays whether the field supports rich content and the specified screen and printer CSS files.
◦ showTallRows
displays if the field displays variable height rows. Possible values are true and false.
◦ sortIBPLDescending
displays the sort order of the field on the backing item type in the IBPL. This is only displayed when a sort field and a direction have been set on an IBPL field.
◦ sortIBPLField
displays the field on the backing item to sort by. This is only displayed when a sort field and a direction have been set on an IBPL field.
◦ relationshipBrowseStyle
displays the relationship browse style for the relationship specified. The relationship browse style can be either set to Queries or Finder through the im createfield command.
◦ incomingTraceProvider
displays the name of the incoming trace provider that is used to retrieve external references. If you are using ThingWorx, this is the name of the ThingWorx thing that returns IER values. This option is only valid for a field with a type of ier.
• --[no]asAdmin
allows non-admin access to fields. This option is used specifically for third party integrations using the Windchill RV&S API. The default setting is --asAdmin which requires ViewAdmin permissions. Specifying --noasAdmin prevents visibility to fields that give information about other users. This option overrides the fields specified using the --fields option. Accessible and non-accessible fields are defined by the system for this command.
To learn more about the API, see the Windchill RV&S Integrations Builder Guide.
• --fieldsDelim=value
specifies the string to be used as a delimiter between fields displayed in the CLI.
• field...
specifies the name of the fields to display.
See Also