Modify HPD Product Status

The ModifyHPDProductStatus process sets or changes the product status, release status or retirement status of an HPD product.

This process requires the same permissions that you need to set the status in the Product Management Centre.

Long	Description	Can Repeat	Notes
--product-status	String that specifies the new product status: • ACTIVE: Sets the product status to active. This is the default status of a product. An active product can be opened and edited, and is always displayed in lists of available products. • LOCKED: Sets the product to locked. Locked products cannot be edited or published, but can be opened as read-only. Locked products can be made active again if required. • REJECTED: Sets the product to rejected. Rejecting an unwanted vector product is the first step to deleting it permanently from an HPD database. Rejected vector products are not included in lists of available products. A rejected product can be restored but a deleted product cannot. If the product is already in this state, then it does nothing.	FALSE	Optional
--release-status	String that specifies the new release status. The product must currently be EXPORTED: • RELEASED: Sets the product to released, indicating that the product is released from the database. This prevents it from being accidentally re-opened for further editing and allows a new update product to be created. • OPEN: Clears the export information. This process cannot set the product to EXPORTED. If the product is already in this state, then it does nothing.	FALSE	Optional
--retirement-status	String that specifies whether the edition is retired: • RETIRED: Sets the status to retired. • ACTIVE: Sets the status to active. If the product is already in this state, then it does nothing.	FALSE	Optional

Long

Short

Description

Can Repeat

Notes

--product-status

String that specifies the new product status:

• ACTIVE: Sets the product status to active. This is the default status of a product. An active product can be opened and edited, and is always displayed in lists of available products.

• LOCKED: Sets the product to locked. Locked products cannot be edited or published, but can be opened as read-only. Locked products can be made active again if required.

• REJECTED: Sets the product to rejected. Rejecting an unwanted vector product is the first step to deleting it permanently from an HPD database. Rejected vector products are not included in lists of available products. A rejected product can be restored but a deleted product cannot.

If the product is already in this state, then it does nothing.

FALSE

Optional

--release-status

String that specifies the new release status. The product must currently be EXPORTED:

• RELEASED: Sets the product to released, indicating that the product is released from the database. This prevents it from being accidentally re-opened for further editing and allows a new update product to be created.

• OPEN: Clears the export information.

This process cannot set the product to EXPORTED.

If the product is already in this state, then it does nothing.

FALSE

Optional

--retirement-status

String that specifies whether the edition is retired:

• RETIRED: Sets the status to retired.

• ACTIVE: Sets the status to active.

If the product is already in this state, then it does nothing.

FALSE

Optional

Objective	Change the product, release and retirement status of a product.
Description		Command Line Syntax
Set the product status to active for further editing.		`--product-status ACTIVE`
Set the release status to open.		`--release-status OPEN`
Retire the product.		`--retirement-status RETIRED`
Path of the HPD product to update.		`hpd://username:password@database?ProductVersionId=3`
Command Line	`carisbatch --run ModifyHPDProductStatus --product-status ACTIVE --release-status OPEN --retirement-status RETIRED hpd://username:password@database?ProductVersionId=3`
Outcome	The product status, release status and retirement status are modified.