Name
Remove-JS7InventoryItem
SYNOPSIS
Removes an object such as a workflow from the JOC Cockpit inventory.
SYNTAX
Remove-JS7InventoryItem [-Path] <String> [-Type] <String> [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet removes an object such as a workflow form the JOC Cockpit inventory.
Consider to commit removals by deploying or releasing the object,
see the Publish-JS7DeployableObject and Publish-JS7ReleasableObject cmdlets.
PARAMETERS
Path
-Path <String>
Specifies the folder and sub-folders of the object.
Required? | true |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Type
-Type <String>
Specifies the object type which is one of:
* WORKFLOW
* JOBCLASS
* LOCK
* JUNCTION
* WORKINGDAYSCALENDAR
* NONWORKINGDAYSCALENDAR
* SCHEDULE
Required? | true |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
AuditComment
-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.
The Audit Comment is visible from the Audit Log view of JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforece Audit Log comments for any interventions.
Required? | false |
Position? | 3 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
AuditTimeSpent
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.
Required? | false |
Position? | 4 |
Default value | 0 |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
AuditTicketLink
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobScheduler.
This information is visible with the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobScheduler.
Required? | false |
Position? | 5 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Remove-JS7InventoryItem -Path /some_folder/sampleWorkflow -Type 'WORKFLOW'
Removes the indicated worfklow from the JOC Cockpit inventory.