Name

Publish-JS7ReleasableItem

SYNOPSIS

Releases scheduling objects such as schedules and calendars

SYNTAX

Publish-JS7ReleasableItem [[-Path] <String>] [[-Type] <String[]>] [[-Folder] <String>] [-Recursive] [[-UpdateDailyPlanFrom] <DateTime>] [-UpdateDailyPlanNow] [-Delete] [-Valid] [-NoDraft] [-NoReleased] [[-ObjectName] <String>] [[-ObjectType] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

This cmdlet releases scheduling objects such as schedules and calendars for use with JOC Cockpit.
Such objects are not deployed to a JS7 Controller, instead they are used for example to automatically
create orders for the daily plan from a JOC Cockpit service.

Releasing can include to permanently deleting previously removed objects from the inventory.

The following REST Web Service API resources are used:

* /inventory/releasable
* /inventory/releasables
* /inventory/release

PARAMETERS

Path

-Path <String>
Specifies the folder, sub-folder and name of the object, e.g. a schedule path.

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

Type

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

* INCLUDESCRIPT
* JOBTEMPLATE
* SCHEDULE
* WORKINGDAYSCALENDAR
* NONWORKINGDAYSCALENDAR
* REPORT

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

Folder

-Folder <String>
Optionally specifies the folder for which included inventory objects should be published.
This parameter is used alternatively to the -Path parameter that specifies to publish an individual inventory object.

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

Recursive

-Recursive <SwitchParameter>
Specifies that all sub-folders should be looked up. By default no sub-folders will be considered.

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

UpdateDailyPlanFrom

-UpdateDailyPlanFrom <DateTime>
Specifies the Daily Plan date starting from which orders from the Daily Plan should be updated to use the latest deployed version of a workflow.

This parameter can be used alternatively to -UpdateDailyPlanNow. If none of the parameters is specified, then the Daily Plan will not be updated.

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

UpdateDailyPlanNow

-UpdateDailyPlanNow <SwitchParameter>
Specifies that any scheduled orders from the Daily Plan should be updated to use the latest deployed version of a workflow.

This parameter can be used alternatively to -UpdateDailyPlanFrom. If none of the parameters is specified, then the Daily Plan will not be updated.

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

Delete

-Delete <SwitchParameter>
Specifies the action to permanently delete previously removed objects.
Without this switch objects are released for use with any JS7 Controller.

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

Valid

-Valid <SwitchParameter>
Limits the scope to valid scheduling objects only.

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

NoDraft

-NoDraft <SwitchParameter>
Specifies that no draft objects should be released. This boils down to the fact that only previously released objects will be released.

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

NoReleased

-NoReleased <SwitchParameter>
Specifies that no previously released objects should be released.

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

ObjectName

-ObjectName <String>
Internal use for pipelining.

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

ObjectType

-ObjectType <String>

Required?false
Position?6
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 the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.

Required?false
Position?7
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 shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.

Required?false
Position?8
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 JS7.

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

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

about_JS7

EXAMPLES

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

PS > Publish-JS7ReleasableItem -Folder /TestCases -Recursive

Releases any object types from the indicated folder and any sub-folders for use with a JS7 Controller.

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

PS > Publish-JS7ReleasableItem -Path /TestCases/sampleSchedule001 -Type 'SCHEDULE'

Releases the specified schedule from the indicated path for use with a JS7 Controller.

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

PS > Publish-JS7ReleasableItem -Path /TestCases/sampleSchedule001 -Type 'SCHEDULE' -Delete

Marks for deletion the specified schedule.

  • No labels