Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Removes scheduling objects such as workflows, schedules etc. from a local Git repository.

SYNTAX

Remove-JS7RepositoryItem [[-Path] <String>] [[-Type] <String>] [[-Folder] <String>] [-Local] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

...

This cmdlet removes scheduling objects such as workflows, schedules etc. from a local Git repository.

The following REST Web Service API resources are used:

* /inventory/repository/delete

PARAMETERS

Path

-Path <String>
Specifies the folder and sub-folders of the scheduling object to be removed.

Required?truefalse
Position?1
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-Type <String>
Specifies the object type which is one of:

* Any object typestype
** FOLDER
* Deployable object types:
** WORKFLOW
** FILEORDERSOURCE
** JOBRESOURCE
** NOTICEBOARD
** LOCK
* Releasable object types:
** SCRIPTINCLUDEINCLUDESCRIPT
** JOBTEMPLATE
** WORKINGDAYSCALENDAR
** NONWORKINGDAYSCALENDAR
** SCHEDULE
** REPORT

Required?false
Position?2
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Folder

-Folder <String>
Alternatively to use of -Path the parameter specifies a JOC Cockpit inventory folder to be used to
remove the respecive folder and objects from a local Git repository.

Required?false
Position?3
Default valueFOLDER
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Local

-Local <SwitchParameter>
Specifies that a repository holding scheduling objects that are local to the environment should be used.
This corresponds to the LOCAL category. If this switch is not used then the
ROLLOUT category is assumed for a repository that holds scheduling objects
intended for rollout to later environments such as test, prod.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-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 the JOC Cockpit.
This parameter is not mandatory. However, however, the JOC Cockpit can be configured to enforce require Audit Log comments for any all interventions.

Required?false
Position?34
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is visible with shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.

Required?false
Position?45
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobSchedulerJS7.

This information is visible with shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobSchedulerJS7.

Required?false
Position?56
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-------------------------- EXAMPLE 1 --------------------------

PS > Remove-JS7InventoryItem JS7RepositoryItem -Path Folder /some_folder/some_sub_folder -Type 'FOLDER'

Removes any scheduling objects from the indicated folder in the local "rollout" repository.

-------------------------- EXAMPLE 2 --------------------------

PS > Remove-JS7InventoryItem JS7ReposioryItem -Path /some_folder/sampleWorkflow -Type 'WORKFLOW'

Removes the indicated worfklow "sampleWorkflow" from the local "rollout" repository.

-------------------------- EXAMPLE 3 --------------------------

PS > Remove-JS7ReposioryItem -Path /some_folder/sampleSchedule -Type 'SCHEDULE' -Local

Removes the indicated schedule "sampleSchedule" from the "local" repository.