jssitemdeletion (centrally places Items into the Waiting to be deleted status)

Organization of this page

Description
Format
Required execution permission
Storage folder
Arguments
Return values
Prerequisites for executing the command
Remarks

Description

This command places unnecessary Items registered in the Item management database in the Waiting to be deleted status in a batch. Note that the command does not actually delete Items from the Item management database.

To Page Top

Format

jssitemdeletion {-s -id ID | -p -id ID [-pi process-work-board-serial-number]}
               [-n update-date | 
                -ct start-date-end-date | 
                -et start-date-end-date]
               [-a]
               [-q]
               [-b]

To Page Top

Required execution permission

Administrator permissions

To Page Top

Storage folder

JP1/SS-path\bin\

To Page Top

Arguments

`-s`

Specify this argument when you select a target system for the Items to be placed in the Waiting to be deleted status. Specify the system ID with the -id option.

`-p`

Specify this argument when you select a process work board for the Items to be placed in the Waiting to be deleted status. Specify the process work board ID with the -id option.

`-id` `ID`

Specifies the ID of a target system or a process work board. You can specify the ID using 1 to 64 half-width alphanumeric characters. When you specify the -s option, ID is replaced by a system ID. When you specify the -p option, ID is replaced by a process work board ID.

`-pi` `process-work-board-serial-number`

Specifies the process work board serial number of the Item to be placed in the Waiting to be deleted status in the process work board specified by the -p option.

`-n` `update-date`

When you specify the -n option, all the Items that were updated on and before the specified date enter the Waiting to be deleted status. For update-date, specify the update date, in YYYY/MM/DD format, of the Items you want to place in the Waiting to be deleted status. For example, if you specify 2008/04/01 for update-date, all the Items that were updated on and before 2008/04/01 23:59:59(.999) enter the Waiting to be deleted status.

For update-date, you can specify a date in the range from 1970/01/01 to 2107/01/01.

If you do not specify the -n, -ct, and -et options, all the Items enter the Waiting to be deleted status.

When using the jssitemdeletion command to place Items in the Waiting to be deleted status again after you release them from the Waiting to be deleted status by using the jssrev command: When you release an Item from the Waiting to be deleted status by using the jssrev command, the update date is changed to the date when the jssrev command is executed. For this reason, make sure that the date you specify in the -n option is the correct date for the Item you want to place in the Waiting to be deleted status.

`-ct` `start-date-end-date`

If you want to place the Items that were registered during a specific period in the Waiting to be deleted status, use this argument to specify that period in YYYY/MM/DD format. Insert a hyphen (-) between the start date and the end date.

For start-date and end-date, you can specify dates in the range from 1970/01/02 to 2036/12/31. For start-date, specify a date earlier than end-date.

The descriptions of the start date and the end date are as follows.

start-date: Places the Items that were registered on and after this date in the Waiting to be deleted status. If you specify a non-existent date within the specifiable range, the system moves the specified date forward to an existing date and places the Items that were registered on after that date in the Waiting to be deleted status.
end-date: Places the Items that were registered on and before this date in the Waiting to be deleted status. If you specify a non-existent date within the specifiable range, the system moves the specified date back to an existing date and places the Items that were registered on and before that date in the Waiting to be deleted status.

For example, if you specify 2013/04/01-2013/04/07, the Items that were registered between 2013/04/01 00:00:00(.000) and 2013/04/07 23:59:59(.999) enter the Waiting to be deleted status.

If you do not specify the -n, -ct, and -et options, all the Items enter the Waiting to be deleted status.

`-et` `start-date-end-date`

If you want to place the Items that were updated during a specific period in the Waiting to be deleted status, use this argument to specify that period in YYYY/MM/DD format. Insert a hyphen (-) between the start date and the end date.

For start-date and end-date, you can specify dates in the range from 1970/01/02 to 2036/12/31. For start-date, specify a date earlier than end-date.

The descriptions of the start date and the end date are as follows.

start-date: Places the Items that were updated on and after this date in the Waiting to be deleted status. If you specify a non-existent date within the specifiable range, the system moves the specified date forward to an existing date and places the Items that were updated on after that date in the Waiting to be deleted status.
end-date: Places the Items that were updated on and before this date in the Waiting to be deleted status. If you specify a non-existent date within the specifiable range, the system moves back the specified date back to an existing date and places the Items that were updated on and before that date in the Waiting to be deleted status.

For example, if you specify 2013/04/01-2013/04/07, the Items that were updated between 2013/04/01 00:00:00(.000) and 2013/04/07 23:59:59(.999) enter the Waiting to be deleted status.

If you do not specify the -n, -ct, and -et options, all the Items enter the Waiting to be deleted status.

`-a`

If you specify the -a option, the Items of all statuses enter the Waiting to be deleted status. If you do not specify the -a option, the items in Close status enter the Waiting to be deleted status.

`-q`

If you specify the -q option, Items enter the Waiting to be deleted status without displaying a confirmation message. If you do not specify the -q option, a message appears asking whether to continue processing.

`-b`

If you specify the -b option, you can execute the jssitemdeletion command without stopping the JP1/Service Support service, the JP1/Service Support - Web Service service, and the JP1/Service Support - Task Service service. If you do not specify the -b option, you need to inactivate those services in advance.

To Page Top

Return values

Return value	Meaning
`0`	Normal end
`1`	Abnormal end

To Page Top

Prerequisites for executing the command

For details about which services need to be active or inactive when this command is executed, see Status of services when commands are executed in Chapter 12. Commands.
While the jssitemdeletion command is being executed, do not execute other JP1/Service Support commands.
Only one jssitemdeletion command can be executed at a time.

To Page Top

Remarks

If you use Ctrl+C to cancel the jssitemdeletion command while the command is being executed, the Items up to that point enter the Waiting to be deleted status and the command ends.
When you execute the jssitemdeletion command, the applicable Items enter the Waiting to be deleted status regardless of the status of the target system or process work board. This rule also applies to the Items that are being edited. Note that when this occurs, the editing status of the Items is not canceled.
When you use the jssitemdeletion command to place Items in the Waiting to be deleted status, the update date for the Items changes to the date when the jssitemdeletion command is executed. If that is a problem, use a backup file that was obtained beforehand to recover the old update date. Note that if you use the jssrev command to release the Items from the Waiting to be deleted status, the update date does not change to the previous update date. Instead, the update date changes to the date when the jssrev command is executed.
Items stored in the Item storage database are not deleted.

To Page Top