im timeentries

CLI Reference > Workflows and Documents Commands > im timeentries

im timeentries

displays time entries

Synopsis

Description

The im timeentries command allows you to view all time entries created by you or another user. Time entries are not private and can be viewed by any user; however, only the user who created a time entry can edit or delete it. To create, edit, or delete time entries, see the Windchill RV&S Hilfe-Center.

For example,

im timeentries --entryUser=jriley --fields=createdDate,duration,issue

displays the creation date, amount of time, and the item the time was recorded against for all time entries entered by jriley.

Displayed time entries vary based on the time zone that a user is operating in.

Options

This command takes the universal options available to im commands, as well as some general options. See the options reference page for descriptions.

• --entryUser=user

specifies the user whose time entries you want to view or edit.

You can specify only one of the following options in a command: --entryUser, --filter, --query, or --queryDefinition.

• --fields=field1[:width1],field2[:width2]...

specifies the time entry fields to display and the width of each field in characters. If the output is directed to the GUI, the width is specified in pixels.

The time entry fields you can specify are:

◦ createdBy

displays the name of the user who created the time entry.

◦ createdDate

displays the date the time entry was created.

◦ duration

displays the duration of the time entry. All time entries are represented in hours and formatted to two decimal places.

◦ entryDate

displays the date the time entry was recorded to.

◦ issue

displays the ID of the issue that the time entry was recorded to.

◦ modifiedBy

displays the name of the user who last modified the time entry.

◦ modifiedDate

displays the date that the time entry was last modified on.

◦ notes

displays notes added to the time entry. Notes are optional.

◦ sourceDisplayName

displays the display name of the source that entered the time entry, for example, Windchill RV&S.

◦ sourceName

displays the name of the source that entered the time entry, for example, mks_integrity.

◦ user

displays the name of the user whose time entries you are viewing.

• --fieldsDelim=value

specifies the string to be used as a delimiter between the fields in the display.

• --filter=value

specifies a filter to display time entries by.

You can specify only one of the following options in a command: --entryUser, --filter, --query, or --queryDefinition.

The filters you can specify are:

◦ issue:expression

displays time entries in a specific issue ID or range of issue IDs. If you are specifying a range of issue IDs, use conditions and logical operators, for example,

issue: > 1000 AND 2000.

◦ user:name

displays time entries belonging to one or more users, where name is the user's name. Use spaces to specify more than one user.

◦ entrydate:date

displays time entries recorded on a specific date or during a time period, where date is the specified date or time period. If you are specifying a time period, use conditions and logical operators, for example, entrydate: between 11/01/2004 AND 11/01/2005.

◦ source:name

displays time entries created by a specific source, where name is the source name.

◦ creationdate:date

displays time entries created on a specific date or during a time period, where date is the specified date or time period. If you are specifying a time period, use conditions and logical operators, for example, creationdate: between 11/01/2004 AND 11/01/2005.

◦ createdby:name

displays time entries created by one or more users, where name is the user's name. Use spaces to specify more than one user.

◦ modificationdate:date

displays time entries modified on a specific date or during a time period, where date is the specified date or time period. If you are specifying a time period, use conditions and logical operators, for example, modificationdate: between 11/01/2004 AND 11/01/2005.

◦ modifiedby:name

displays time entries modified by one or more users, where name is the specified user name. Use spaces to specify more than one user.

• --mode=[view|edit|viewany|editany]

specifies whether to display or edit personal time entries (--mode=view|edit) or time entries belonging to another user (--mode=viewany|editany). The --mode=edit option can only be specified with the -g or --gui option.

You can also edit a time entry when you edit an issue assigned to you (in the GUI or Web interface only).

• --query=[user:]query

specifies the query used to filter time entries by issue. Includes the name of the user who the query belongs to and the query name, for example, mchang:ActiveDefects. You do not have to specify the user name, but you must specify the query name. This option is useful when multiple users have the same name for a query.

• Windchill RV&S initially assumes that text before the first colon (:) is a user name and text after it is a query name. If Windchill RV&S fails to find a matching user name and query name, it searches for a query name matching the exact text. For example, if you type mchang:ActiveDefects, Windchill RV&S searches for the Active Defects query created by mchang. If Windchill RV&S cannot find the query and/or user, it searches for the mchang:ActiveDefects query created by any user.

• You can specify only one of the following options in a command: --entryUser, --filter, --query, or --queryDefinition.

• --queryDefinition=value

specifies a string to define the query constraints for the query used to define the selection criteria for time entries. For details of the query format, see the im createquery reference page.

You can specify only one of the following options in a command: --entryUser, --filter, --query, or --queryDefinition.