CLI Reference > Server Administration Commands > im createfield
  
im createfield
creates a field
Synopsis
im createfield [--name=value] [--[no]confirmMultiValued] [--[no]multiValued] [--defaultBrowseQuery=[user:]query] [--description=value] [--position=<number>] [--testResult] [--type=[integer|pick|float|logical|date|shorttext|longtext|user|group|relationship|siproject|range|phase|qbr|ibpl|fva|attachment|sourcelink|ier]] [--associatedField=field] [--loggingText=[none|mostRecentFirst|mostRecentLast]] [--default=value] [--defaultColumns=value] [--displayAs=[default|checkbox]] [--displayTrueAs=value] [--displayFalseAs=value] [--min=value] [--max=value] [--backedBy=value] [--backingFilter=value] [--backingStates=value] [--backingTextField=field] [--backingIBPLTextFormat=value] [--backingType=type] [--[no]sortIBPLDescending] [--sortIBPLField=field] [--backingfilter=<querydefinition>] [--computation=value] [--[no]allowComputationUpdatesOnVersion] [--[no]staticComputation] [--storeToHistoryFrequency=[never|daily|weekly|monthly|delta] [--addEntry=value] [--phases=text:state,state,...:image;...] [--[no]displayAsProgress] [--[no]displayAsLink] [--[no]trace] [--query=[user:]query] [--correlation=src-field:dest-field,...] [--displayRows=value] [--displayStyle=value] [--ranges=text:lowerValue;upperValue:image,...] [--associatedField=fieldName] [--picks=text:value:image,...] [--suggestions=text1,text2,text3,...] [--maxLength=value] [--displayPattern=value] [--displayName=value] [--relevanceRule=rule] [--relevanceRuleFile=filename] [--editabilityRule=rule] [--editabilityRuleFile=filename] [--copyRelevanceRule=field] [--copyEditabilityRule=field] [--allowedTypes=type:type,type,...[;...]] [--addLinkFlags=name=value,displayChar=char,onImage=path,enabled=[true|false],suspect=[true|false];...] [--[no]cycleDetection] [--[no]showTallRows] [--[no]richContent] [--[no]textIndex] [--[no]substituteParams] [--defaultAttachmentField=field] [--showDateTime] [--relationshipBrowseStyle=browseStyle=[query|finder],queryOption=[allQueries|specificQueries],specificQueriesList=query::query::..., finderQuery=[user:]query,outlineFormat=value,relationshipstoFollow=relationship::relationship::...] [--hostname=server] [--password=password] [--port=number] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [--quiet] [-g|--gui] [--settingsUI=[gui|default]] [--status=[none|gui|default]] [--user=value] [--ierDefaultColumns=[server,title,name...]] [--incomingTraceProvider=value]
Description
im createfield creates a field for workflows and documents. For example:
im createfield --hostname=abcFinancial --user=jriley --type=integer --storeToHistoryFrequency=daily --staticcomputation --computation='DaysInPhase("RFC Phase","Submission")' --name="Days_In_Phase"
creates the Days_In_Phase integer field. This field calculates how long an item spends in the RFC Phase and Submission phases, storing the new values on a daily basis.
Computed Fields
In addition to recording information in fields, Windchill RV&S can also perform calculations between fields, storing the result as a read-only value in a computed field. For example, in a Feature type, Windchill RV&S can add the QA Estimated Time and Development Estimated Time fields to determine the value of the Total Estimated Time field (the computed field). Previously, this could only be accomplished by creating an event trigger.
To create a computed field, you choose a field type to configure as a computed field. To specify a field type, use the --type option. Date, floating point, integer, short text, and logical field types can be configured as computed fields. However, only date, floating point, integer, long text, and short text fields can be used in the underlying expression that performs the calculation between fields. Logical fields can only be the result of an expression.
An expression in a computed field is similar to any expression you would find in a programming language. To specify an expression, use the --computation=value option. There are two types of expressions you can create:
intra-issue expressions perform calculations between fields in a single issue, for example, adding the QA Estimated Time and Development Estimated Time fields to produce a value in the Total Estimate Time field.
intra-issue expressions can also retrieve information from an issue using external information functions, such as CPECount(), which counts the number of change package entries in an issue. Using external information functions in expressions allow you to retrieve metrics about your workflow. Once you define an intra-issue expression using external information functions, you can use queries, charts, reports, and dashboards to collect the metric data and report on it. For example, you can create a query that returns issues with a specific number of change packages and use that query in a report, chart, or dashboard.
Inter-issue or aggregation expressions use aggregation functions to perform calculations against fields in a list of issues. For example, using the sum(field) aggregation function in a report you could add the Estimated Cost field in a list of Project issues to produce a total estimated cost.
Creating computed fields to perform calculations between fields is not the only available method, nor is it restricted to administrators. Users can also perform these calculations by creating computed expressions in reports and charts, provided they understand the supported syntax, operators, functions, and operations. For example, using the appropriate report tags and syntax, a user can total the number of Defect issues that have not changed states for 0-5 days, 6-10 days, and 11+ days. For more information on creating reports, see the Windchill RV&S Help Center. For more information on creating charts, see the Windchill RV&S Help Center.
For a complete list of acceptable syntax, operators, functions, and operations, see the Windchill RV&S Help Center.
After you create the expression, you choose how often the computed field calculates the value and select a computation type by using the --storeToHistoryFrequency=value and --[no]staticComputation options.
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.
--[no]confirmMultiValued
specifies whether to confirm the setting of the --[no]multiValued option.
--[no]multiValued
specifies whether to allow users to select multiple pick list values at one time or link to multiple issues in a relationship field.
* 
Caution: Creating a multi-valued pick list permanently changes the storage format and cannot be reverted to single-value storage. However, you can still revert the field to a single-value pick list, if needed.
--defaultBrowseQuery=[user:]query
specifies the user and name of the default Admin query to use when adding a related item by browsing. This option only applies to relationship fields.
--name=value
specifies the name of the field to create. Names can be a maximum of 100 characters and cannot contain square brackets. This option is mandatory.
--description=value
specifies a description of the field.
--position=<number>
specifies the position in the list of fields.
--testResult
specifies whether the field is used for test results only. For more information on using fields for test results, see the Windchill RV&S Help Center.
--type=integer|pick|float|logical|date|shorttext|longtext|user|group|relationship|siproject|range|phase|qbr|ibpl|fva|attachment|sourcelink|ier
specifies the field data type. Fields are categories of data that can be associated with issues. This option is mandatory.
--type=integer
specifies simple, countable items, such as call tracking numbers.
--type=pick
specifies items that should display in a drop-down list, such as predefined product codes.
--type=float
specifies numbers with decimals, such as performance data.
--type=logical
specifies Boolean items (ones that are either true or false), such as whether an issue has been tested. Optionally, you can customize how true and false values display by specifying the --displayTrueAs=value and --displayFalseAs=value options. For example, the logical field can display yes or no values.
--type=date
specifies dates, such as when a defect was fixed. For example, Feb 25, 2007. Optionally, you can include the time by specifying the --showDateTime option.
* 
Displayed date fields do not change based on the time zone in which a user is operating. However, displayed date/time fields and time entries vary based on the time zone in which a user is operating.
Date/time fields cannot be converted to date fields.
--type=shorttext
specifies miscellaneous information, such as a comment field. This data type allows you to define suggestions.
--type=longtext
specifies miscellaneous information. This data type includes an option for displaying rows.
--type=user
specifies users that display in a drop-down list, such as users in a specific group.
--type=group
specifies groups that display in a drop-down list, such as groups assigned to a specific project.
--type=relationship
specifies links to other issues.
--type=qbr
specifies a named query that displays issues meeting the query criteria as a read-only relationships field. This field extends the concept of the relationship field by displaying a large number of related issues. For example, the Features field in a Project issue would display all the Feature issues that are returned by the Release_5_Features query.
--type=range
specifies categorized numeric value ranges in an associated numeric field (integer or floating point). A range field is a computed pick list field associated with a numeric field: range limits and the associated field are stored in the computation expression and the range category name and icon are stored in the database as pick list items. When a value is entered in the associated numeric field, the appropriate range category displays in the range field. Range fields are useful for defining thresholds for numeric data and providing a broad overview of that data. For example, if a Project type has an integer field called Critical Defects that displays the number of Defect issues marked Critical,, you could add a range field called Defect Status that displays one of the following range categories based on the number of issues in the Critical Defects field:
Golden: "Critical Defects" = 0
Acceptable: 1 <= "Critical Defects" <= 6
Watch: 7 <= "Critical Defects" <= 19
Trouble: 20 <= "Critical Defects"
* 
At this time, you can only create ranges using the <= operator.
--type=phase
specifies categorized groups of states in a workflow, essentially creating states (represented by phases) and sub-states (represented by states) for an issue type. A phase field is a computed pick list field associated with states. When a value is entered in the state field, the appropriate phase category displays in the phase field. Phases are useful for organizing an issue type’s workflow if it contains a large number of states and provide users with a broad overview of an issue’s status independent of the workflow. For example, a Feature type could have the following phases (states are in brackets):
Requirements (Draft 1; First Draft Signoff;...)
Design (Update Data Model; ...)
Development (In Development; Unit Testing;...)
Testing (White Box Testing; Black Box Testing; Regression Testing;...)
Implementation (Planning; Implementation;...)
Post-Implementation Maintenance (Patch 1 In Progress;...)
--type=siproject
allows users to specify a related configuration management project, optionally including a checkpoint revision or development path. By creating a configuration management project field and a computed field that uses the SIMetric() external information function, you can retrieve metrics about the specified project, for example, how many lines of code are in the project. For more information on creating configuration management project metrics, external information functions, and computed fields, see the Windchill RV&S Help Center.
* 
Metrics are only maintained against project checkpoints; therefore, to generate metrics, users must specify a checkpoint when they specify the configuration management project.
To allow users to specify a related configuration management project when creating or editing an issue, the workflow and document management, and configuration management integration must be enabled and properly configured. For more information, refer to the Windchill RV&S Help Center.
--type=ibpl
specifies an issue backed pick (IBPL) list field that allows you to share information in one or more issues with other issues. By creating an issue type that acts as a table of information (known as the backing issue type), then creating issues of that type with a non-computed short text field containing the information you want to share, an IBPL field in another issue type can display the values of the short text field as pick text. Whenever a short text field is updated in a backing issue, all issues with IBPL fields that reference the short text field value update to reflect the new value.
For example, if you create a Department issue type with a Manager field, then create several Department issues to record the different departments and managers in your organization, Manager field values in all Department issues appear as pick text in the Department Manager IBPL field in the Defect issue type. If a Department issue's Manager field has a value of Fred and it changes to Ted, all Defect issues with a value of Fred in the Department Manager field automatically update to display Ted.
--type=fva
specifies a field value attribute (FVA) that allows you to share field information in an IBPL field's backing issue with other issues, displaying the field information as a value in the FVA field. An FVA data type is useful for maintaining field information in one issue and sharing the field information with other issues.
For example, if a Defect issue has an IBPL field named Department Manager and a value of Jim, the FVA field named Extension to Call displays x626 because the backing Department issue displays Jim in the Manager field and x626 in the Phone Extension field (the backing field for the FVA field). If the Department Manager field value changes, the Extension to Call field value updates to reflect the new field value.
* 
The name of the IBPL field cannot be the same as the referenced field in the backing issue type.
You cannot create an FVA field backed by a sourcelink field, or a range field that is based on a numerical FVA field.
If you create an FVA rich content field, it can only access attachments from an FVA attachment field over the same relationship as the FVA rich content field. This keeps the text and image data together. If the rich content field is not an FVA field, it should use non-FVA attachment fields. If you create a type with visible FVA and non-FVA rich content and attachment fields, Windchill RV&S only displays visible attachment fields visible to the user in the GUI or Web interface. Fom the CLI, the user must know which attachment fields to use with rich content fields.
--type=attachment
allows users to add attachments to items, such as design documents.
--type=sourcelink
specifies a source link field that allows you to create links to configuration management source files.
sourcelink fields can either be created with trace enabled or disabled.
For example, you could use a sourcelink field with --trace turned on (specifying --trace when creating the field), on a requirement item to track the changes made in order to satisfy that requirement. Viewing the sourcelink traces for a requirement helps you analyze the impact of changing that requirement.
If specified with --notrace (trace is not enabled) the sourcelink field contains one way links between items and source files that don't get updated when the source changes.
--type=ier
specifies an incoming external reference (IER) field, which indicates that a requirement has a trace relationship to an object in a product lifecycle management (PLM) system. This option is only valid when enabled by functionality to create traces between Windchill RV&S and a PLM system.
When specifying this option, you must also specify the --incomingTraceProvider option. Optionally, you can set the --ierDefaultColumns option.
--default=value
specifies the default value for the field.
* 
To include the time with date fields, specify the --showDateTime option and use the mm/dd/yyyy hh/mm/ss format, where hh/mm/ss is the hour, minutes, and seconds. Time is specified from 00:00:00 to 23:59:59 inclusive in 24 hour format. However, Windchill RV&S displays the time in 12 hour format. For example, specifying 13:56:45 displays the time as 1:56:45 PM. To specify an empty value for a date field, type " ".
Integer fields allow a maximum of nine digits and floating point fields allow a maximum of 15 digits.
When editing a floating point field to set the default, minimum, or maximum value, you can enter a negative exponent using the E number notation, for example, -123.1E-3.
--defaultColumns=field1,field2,...,mks:virtualField1,mks:virtualField2...
specifies the default ColumnSet for the field. This option is only valid for the following field data types: Relationship and Query Backed Relationship. This option sets default columns for the relationship field pair.
--displayAs=[default|checkbox]
specifies an alternate display for a logical field. By default, a logical field allows users to select true or false values. However, you can choose to display the field as a checkbox (a checkbox that is checked indicates a true value and a clear checkbox indicates a false value). To display a logical field as a checkbox, specify --displayAs=checkbox. To display a logical field with true or false values, specify --displayAs=default or do not specify the option. This option is only valid with the --type=logical option.
--displayTrueAs=value
specifies the custom value that represents how the true value displays in a logical field, for example, --displayTrueAs=yes. The maximum number of characters is 100 and this option is only valid with the --type=logical and --displayFalseAs=valueoptions.
* 
Important: Specifying custom values for logical fields impacts existing custom scripts that use the default true and false values. PTC recommends reviewing the scripts and making necessary modifications to reflect new custom values.
--displayFalseAs=value
specifies the custom value that represents how the false value displays in a logical field, for example, --displayFalseAs=no. The maximum number of characters is 100 and this option is only valid with the --type=logical and --displayTrueAs=value options.
--min=value
specifies the minimum value for the integer, float, or date type field. See the --default==value option for rules.
--max=value
specifies the maximum value for the integer, float, or date type field. See the --default=value option for rules.
For long text fields, the maximum number of characters is 4,000.
--backedBy=value
specifies the field in the related issue type whose value you want to display in the FVA field, where value uses the format relationship-name.field-name.
relationship-name is the field that contains the backing issue for the FVA field. This field can be any of the following:
A relationship field.
An issue backed pick list field.
The project field, if backing projects are enabled for the issue type.
field-name is the field in the backing issue type whose value you want to display in the FVA field.
This option is used with the --type=fva option.
* 
The relationship field must be single valued.
The referenced field must be visible in the backing issue.
You can set display options such as --displayPattern=value and --[no]displayAsProgress, if the field data type allows them.
--backingFilter=value
specifies a query as the query definition filter to populate the issue backed pick list with.
--backingStates=value
specifies active states to populate the issue backed pick list with. Populating an issue backed pick list with backing issues in specific states essentially allows you to “deactivate” entries in an IBPL. For example, if an Employee issue contains an Active and Inactive state, and you select Active as the active states, only Employee issues in a state of Active display pick text entries in the IBPL. This option is used with the --type=ibpl option.
--backingTextField=field
specifies the non-computed short text field in the backing issue type that you want to use as pick text. For example, if you select the Manager field and James Riley, Sherry Robertson, and Dan Evans are field values in some of the backing issues, those names display as pick text in the issue backed pick list field. This option is used with the --type=ibpl option.
--backingIBPLTextFormat=value
specifies multiple fields in the backing issue type that you want to link together to use as pick text. The format is similar to a JAVA MessageFormat string (that is, it requires { } to surround each field). For example:
--backingIBPLTextFormat="{ID}:{Summary}"
* 
This option overrides any value specified by the --backingTextField option.
--backingType=type
specifies the issue type containing the short text field that you want to reference. This option is used with the --type=ibpl option.
--[no]sortIBPLDescending
specifies the sort order of the field on the backing item type in the IBPL. --[no]sortIBPLDescending sorts the field in ascending order. --sortIBPLDescending sorts the field in descending order. This option is used with the --type=ibpl and --sortIBPLField=field options.
--sortIBPLField=field
specifies a visible field on the backing item type to sort by in the IBPL. For example, if an IBPL field uses a Build item as the backing item type, you could display the most recent build from the Build Number field at the top of the IBPL field. If this option is not specified, field values in the IBPL are sorted alphanumerically. This option is used with the --type=ibpl and --[no]sortIBPLDescending options.
* 
The following field types on the backing item type cannot be sorted: type, attachment, IBPL, FVA, QBR, range, relationship, source link, and SI project fields.
If a field is currently specified as the sorting field and you choose to configure that field as invisible in the item type, a warning message notifies you that this will affect the sort order, allowing you to save or cancel the change. Saving your changes causes field values in the IBPL to be sorted alphanumerically.
--backingfilter=<querydefinition>
specifies a string to define the picklist value constraints. This option is used with the --type=ibpl option. The <querydefinition> must be of the same format as the query definition for a query. For details of the query definition format, see the reference page for the --im createquery command.
* 
The constraints defined for this filter are applied in addition to the filtering specified by the --backingType and the --backingStates options.
--computation=value
specifies a computed expression. For a complete list of acceptable syntax, operators, functions, and operations, see the Windchill RV&S Help Center.
* 
A computed field displays 50 characters. However, it can contain a maximum of 200 characters.
The following are examples of computed field expressions:
To determine how many days a Defect issue has not been worked on, create a computed field called Days Inactive and type the following expression:
now() - "Modified Date"
The Days Inactive field displays the number of days elapsed since the last edit of the Defect issue.
If the Project issue type contains Actual Cost and Expected Cost fields, and you want to determine if and how much the actual cost of a project exceeds the expected cost, create a computed field called Cost Overrun and type the following expression:
"Actual Cost" - "Expected Cost"
If the value of the Actual Cost field exceeds the value of the Expected Cost field, the Cost Overrun field appears after editing the issue, displaying how much the actual cost overran the expected cost.
To build upon the previous example, if you wanted to determine whether the actual cost of a project exceeded 90% of what you budgeted for, type the following expression:
"Actual Cost" > .90 * "Expected Cost"
If the value of the Actual Cost field exceeds the value of the Expected Cost field by 90%, the Cost Overrun field appears after editing the issue, displaying the percentage that the actual cost overran the expected cost.
As project manager, you could closely monitor project budgets by creating a query or email notification that identifies Project issues where the cost has exceeded 90% of the estimated budget.
--[no]allowComputationUpdatesOnVersion
specifies to record the computation value at the time of versioning and prevent further updates. By default, the computation value in versioned items continues to update based on the computed field definition. If you specify --[no]allowComputationUpdatesOnVersion on a non-computed field, an error message displays. If you specify --allowComputationUpdatesOnVersion on a non-computed field, the option is silently ignored.
--[no]staticComputation
specifies the computation type. --staticComputation performs the computation and stores it in the issue’s history based on the value specified in --storeToHistoryFrequency=value. PTC recommends a static computation if your expression involves expensive external functions, such as query or aggregate functions. --[no]staticComputation performs the computation every time field values used in the expression change. --[no]staticComputation is a dynamic computation and is selected by default.
* 
Because dynamically computed fields are not stored in the database, dynamically computed short text fields cannot be located with an all text field search in the Windchill RV&S Client. To search for dynamically computed short text fields, create a query that includes a specific “field” comparision. If the query does not include additional filters, the query may not return optimal results.
--storeToHistoryFrequency=never|daily|weekly|monthly|delta
indicates how often the computed field should be calculated and stored in the issue’s history. Acceptable values are daily, weekly, monthly, delta, or never. delta specifies to store the computed field's value to the item history only when a delta is detected. To specify a custom frequency, specify delta and create an event trigger that specifies the desired frequency. Selecting a frequency is useful for historical charting. delta is specified by default.
* 
Using the im analytics --recomputeHistory command, you can calculate a computed field within a specific time frame, storing the value in the issue history. This command is useful for historical charting and reporting, allowing you to calculate, then compare the stored historical values of the computed field between current and past projects.
--addEntry=value
adds a phase or range field value.
For phases, value is specified as text:state,state,...:image;...., where text specifies the phase name, state specifies an included state, image specifies the file path and the name of a custom image, or none.
Note the following about adding phases:
There is no minimum or maximum amount of phases you can create for a phase field.
States not grouped into a phase are referred to as out of phase states. When an issue is in an out of phase state, the phase field displays Out of Phase.
Images for phases must be GIF or JPEG format, and no larger than 16 by 24 pixels.
No two phases can use the same state.
You cannot edit the Out of Phase phase. This phase identifies the states that are not included in any user defined phase.
For ranges, value is specified as label:lowerValue;upperValue,..., where label specifies the range category name, lowerValue specifies the lower range, upperValue specifies the upper range. For example, --addEntry=Golden:-Infinity;0,Acceptable:1;6,Watch:7;19,Trouble:20;+Infinity. Range category names can be 100 characters long.
Note the following about adding range limits:
You cannot specify different range category names and icons for types. However, you can specify different range limits for types.
Range field values are automatically determined based on an associated numeric field. Range fields cannot be edited in an Issue Details view.
Range value limits can be overridden on a per type basis. However, range category names and icons cannot be overridden.
If lowerValue is not set, -Infinity is automatically entered. If upperValue is not set, +Infinity is automatically entered.
A numeric value must be contained in one defined range; range intersections are invalid. For example, the following ranges are invalid: 0;5 and 4;8, or 0;5 and 5;10. For an integer field, an acceptable range would be 0;5 and 6;10. For a floating point field, an acceptable range would be 0;5 and 5.01;10.
If a value is entered in the associated numeric field that is beyond the set range values, the range field displays Out of Range in the issue. If no value is entered in the associated numeric field, the range field is empty.
--phases=text:state,state,...:image;...
specifies the phase name and the included states, where image can be none, or the file path and the name of a custom image. This option is used with the --type=phase option.
Note the following about creating phases:
States not grouped into a phase are referred to as out of phase states. When an issue is in an out of phase state, the phase field displays Out of Phase.
You cannot edit the Out of Phase phase.
No two phases can use the same state.
Images for phases must be GIF or JPEG format, and no larger than 16 by 24 pixels.
There is no minimum or maximum amount of phases you can create for a phase field.
--ranges=text:lowerValue;upperValue:image,...
specifies the name of the range category and the lower and upper range limits, for example, --ranges=Golden:-Infinity;0,Acceptable:1;6,Watch:7;19,Trouble:20;+Infinity. Range category names can be 100 characters long. This option is used with the --type=range option.
Note the following about setting range limits:
Range field values are automatically determined based on an associated numeric field. Range fields cannot be edited in an Issue Details view.
Range value limits can be overridden on a per type basis. However, range category names and icons cannot be overridden.
If lowerValue is not set, -Infinity is automatically entered. If upperValue is not set, +Infinity is automatically entered.
A numeric value must be contained in one defined range; range intersections are invalid. For example, the following ranges are invalid: 0;5 and 4;8, or 0;5 and 5;10. For an integer field, an acceptable range would be 0;5 and 6;10. For a floating point field, an acceptable range would be 0;5 and 5.01;10.
If a value is entered in the associated numeric field that is beyond the set range values, the range field displays Out of Range in the issue. If no value is entered in the associated numeric field, the range field is empty.
--associatedField=fieldName
specifies the numeric field to associate with the range field. This option is used with the --type option.
* 
Range fields cannot contain an associated field that includes a computed expression with an external information function.
--[no]displayAsProgress
displays the integer value as progress bar in the GUI.
--[no]displayAsLink
displays the selected value in the item backed pick list as a hyperlink to the backing item. The hyperlink displays in the GUI and the Web UI.
--[no]trace
If --trace is used with --type=relationship, sets the field as 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.
If --trace is used with --type=sourcelink, sets the field as a source link field with trace enabled (stores a source trace). This can only be specified when creating the field, and cannot be changed using im editfield.
If --notrace is used with --type=sourcelink, or --type=sourcelink is specified without --trace, sets the field as a source link field. This can only be specified when creating the field, and cannot be changed using im editfield.
--query=[user:]query
specifies an administrator query to use as the backing query for a query backed relationship field.
--correlation=src-field:dest-field,...
specifies a pair of fields to correlate between the type containing the query backed relationship field and the issues returned by the query. For example, if you create a query backed relationship field called Defects for the Feature type and specify Project as the source field and Project as the target field, the Defects field displays all Defect issues that have the same project as the one specified in the Feature type’s Project field. This option is not mandatory. However, if it is not specified, the list of relationships returned does not change with different issues.
--displayStyle=value
specifies whether the attachment, relationship, sourcelink, or query backed relationship field displays in table format or in a comma separated values (CSV) format.
If you specify -g or --gui, the table format allows you to sort the issues and manipulate the columns that display in the table. For attachment, relationship and query backed relationship fields, the CSV format only displays the IDs of the issues. For sourcelink fields, the CSV format only displays the source file name, revision number, server and project.
--picks=text:value:image,...
specifies the list of valid active values for a pick list field, where image can be none, or the file path and the name of a custom image. Pick text must be 100 characters or less in length and empty values are not supported.
* 
This setting requires the complete list of active pick list values to be specified. Unspecified pick list values are inactive. Do not specify duplicate pick field values. Images must be GIF or JPEG format, and no larger than 16 by 24 pixels.
--suggestions=text1,text2,text3,...
specifies a list of suggested values for a short text field.
* 
This setting requires the complete list of suggested values to be specified.
--maxLength=value
specifies the maximum character length value for a short text, long text, or rich content field. The maximum character length is dependant on your database type and setup.
--displayName=value
specifies the name assigned as the display name of the field.
--displayRows=value
specifies the number of rows to display for a long text, rich content, sourcelink, or relationship field. There is a maximum of 80 rows permitted for a long text, sourcelink, or relationship field, and 15 for a rich content field.
--displayPattern=value
assigns a format to floating point or integer field values, known as a display pattern. Display patterns allow you to quantify numeric field values, for example, as currency or percentages. You can define a display pattern by combining a currency symbol, text that represents a measurement, and/or one or more of the following characters:
0 - Displays as a zero in the output. For example, a display pattern of 000.00 displays an input value of 12.14 as 012.14 in the numeric field.
# - Displays as a digit in the output. If the digit is a zero and it is leading or trailing the input value, it is left out of the value displayed in the numeric field. For example, a display pattern of #0.00 displays an input value of 0.126 as 0.13 in the numeric field.
.- Locale specific decimal separator.
- - Minus sign.
,- Locale specific grouping separator.
E - Scientific notation, in the format aEb, where a is any real number, and b is the exponent.
; - Separates positive and negative patterns.
% - Multiplies by 100 and displays as a percentage.
‘ - Escapes special characters. Use ‘’ to create a single quote.
For example, if you specified a display pattern of $#,### and a user types 12345.123 in the associated numeric field, the numeric field displays $12,345. Similarly, if you specified a display pattern of # minutes and a user types 123 in the associated numeric field, the numeric field displays 123 minutes
* 
If the display pattern is invalid or the field type is not an integer or floating point, an error message displays. If no display pattern is specified, the field displays the value in a localized form.
Display patterns appear only when viewing one or more issues. Windchill RV&S stores the field value as an unformatted numeric value in the database.
By default, a floating-point field value displays the same number of decimal places as when the value was entered. Previously, floating point values rounded to three decimal places.
Display patterns are applied to numeric values only when shown in the context of an issue. This means that query filters, rules, and trigger assignments display the unformatted, localized version of the numeric field value.
--relevanceRule=rule
specifies the rules that determine when users see the field. For the rule syntax, see Specifying Rules on the options reference page.
* 
Relevance rules are evaluated on the Windchill RV&S Client’s time zone.
SI project and attachment fields cannot be specified.
--relevanceRuleFile=filename
specifies a file that contains the field relevance rules. See --relevanceRule for notes on the option and obtaining rule syntx for the file format.
--editabilityRule=rule
specifies the rules for when users are permitted to edit the field. For the rule format, see Specifying Rules on the options reference page.
To prevent the field from being edited, specify --editabilityRule="(false)". This option is useful for fields that are updated by event triggers and are not meant to be edited by users. For example, you could create a date field where the date is automatically specified when the issue enters a certain state.
* 
To specify a date and time for a date field, use the MM/dd/yyyy h:mm:ss [AM|PM] format. You can specify a time only if the date field is configured to display the time. To specify the current date for a date or date/time field, type today. To specify an empty value for the date field, type none.
When specifying a user, you can choose yourself by specifying "me". "me" is a symbolic user which refers to the currently logged in user. For example, you could create an editability rule that specifies the Requirements field can be edited if the currently logged in user is one of the users defined in the multi-valued Stakeholders field.
Editability rules are evaluated on the Windchill RV&S Client’s time zone.
By default, --editabilityRule="(false)" is specified for read-only custom fields (i.e. phase, range, computed) and cannot be unspecified.
SI project and attachment fields cannot be specified.
Editability rules cannot include a computed expression that requires an external information function.
--editabilityRuleFile=filename
specifies a file that contains the field editability rules. For the file format, see Specifying Rules on the options reference page.
--copyRelevanceRule=field
copies the relevance rules of an existing field to the one being created.
* 
A false relevance rule (--relevanceRule="(false)") can be copied in the CLI. However, you cannot do this in the GUI.
--copyEditabilityRule=field
copies the editability rules of an existing field to the one being created.
* 
A false editability rule (--editabilityRule="(false)") can be copied in the CLI. However, you cannot do this in the GUI.
--allowedTypes=type:type,type,...[;...]
specifies the types of issues that can be linked using the relationship field. Specify the issue type that will use the relationship field, then list the issue types that can be linked to using the reverse relationship field. For example, for a one-way relationship showing the relationship between documentation issues and bugs, specify Docs:Bugs for the forward field, and Bugs:Docs for the reverse field.
For a two-way relationship, you need to specify allowed types for both sides of the relationship. For example, to allow the field to be used to create relationships between documentation issues and bugs, specify Docs:Bugs;Bugs:Docs.
--addLinkFlags=name=value,displayChar=char,onImage=path,enabled=[true|false],suspect=[true|false];...
defines the relationship flags that can be added to relationships in the relationship field.
--[no]cycleDetection
specifies whether or not the system will prevent relationship loops from occurring in the relationship field. A relationship loop occurs when an issue has both a backward and forward relationship through an issue (or through multiple issues). For more information on relationship loops, see the Windchill RV&S Help Center.
--[no]richContent
specifies whether to configure the long text field as a rich content field. Rich content enhances the display of text in long text fields by adding formatted text, tables, background colors, images, and hyperlinks. This option is enabled by default and does not support logging text fields.
* 
Caution: You can convert rich content fields back to long text fields. However, any existing rich content is displayed as HTML tags and attributes.
Because rich content is expressed using a limited set of HTML elements and attributes, you can define screen and printer Cascading Style Sheets (CSS) that ensure a consistent look when viewing and printing rich content field data in different Web browsers. For more information, see the Windchill RV&S Help Center.
--[no]substituteParams
specifies whether parameter references in this 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.
--defaultAttachmentField=field
specifies the default attachment field that images are retrieved from when inserting images into a rich content field via attachment field. The default is the default Attachment field
--showDateTime
specifies to include the time with the date in a date field.
* 
Important: Once you include the time and save the date field, you cannot change the date field to display the date only.
--relationshipBrowseStyle=browseStyle=[query|finder],queryOption=[allQueries|specificQueries],specificQueriesList=query::query::..., finderQuery=[user:]query,outlineFormat=value,relationshipstoFollow=relationship::relationship::...
specifies the relationship browse style that is used for adding a related item. browseStyle can be either set to query or finder.
After you set the browseStyle to query or finder, the following options can be selected:
queryOption is applicable for browseStyle=query and can be specified as either "allQueries" or "specificQueries". When the browseStyle=query is specified, the queryOption=[allQueries|specificQueries] is mandatory.
specificQueriesList is applicable for queryOption=specificQueries. This option specifies the list of the names of Admin queries, separated by double colons( for example, specificQueriesList="query1::query2::query3).
finderQuery is applicable for browseStyle=finder. This option specifies the name of the Admin query to be used for the content of the Find Items to relate window left pane.
outlineFormat is applicable for browseStyle=finder. This option specifies the outline for the right pane in the Find Items to relate window.
relationshipsToFollow is applicable for browseStyle=finder. This option specifies the list of relationships, separated by double colons(for example, relationshipsToFollow="relationship1::relationship2::...). In the Find Items to relate window, the right pane is populated with the list of related items derived from the selected items in the left pane. The relationshipsToFollow defines the related items with which to populate the right pane.
For example:
When the browseStyle is set to query:
im createfield --name=queryOptionAsSpecificQueriesMentioned --type=relationship --relationshipBrowseStyle=browseStyle=query,queryOption=specificQueries,specificQueriesList="query1::query2::query3"
When the browseStyle is set to finder:
im createfield --name=finderWithAllOptions --type=relationship --relationshipBrowseStyle=browseStyle=finder,finderQuery="query1",outlineFormat="value",relationshipsToFollow="relationship1::relationship2"
--[no]textIndex
specifies whether queries against the field will be treated as word searches.
--[no]showTallRows
specifies whether the relationship field should display variable height rows.
--loggingText=[none|mostRecentFirst|mostRecentLast]
specifies logging text field mode, including the order the entries are displayed in. Logging text field mode is only a valid option for longtext fields.
--ierDefaultColumns=[server,title,name...]
specifies the columns that appear for trace relationships. This option is only valid for a type of ier.
Available values are:
server—Server where the object resides
title—Summary of the object
name—Name of the trace
suspect—Indicates whether the trace is suspect
icon—Icon for this object type
largePreview—Large preview of the object
--incomingTraceProvider=value
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 type of ier.
See Also
Commands: im editfield, im viewfield,im fields, im analytics
Miscellaneous: options