Versions Compared

Key

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

...

Publish-JS7ReleasableItem

SYNOPSIS

Releases a configuration object scheduling objects such as a scheduleschedules and calendars

SYNTAX

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

DESCRIPTION

This cmdlet releases a configuration object scheduling objects such as schedules and calendars for use with any JS7 ControllerJOC 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 delete 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.

...

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

* INCLUDESCRIPT
* SCHEDULE
* WORKINGDAYSCALENDAR
* NONWORKINGDAYSCALENDAR

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

...

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

...

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

...

-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

...

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

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?4
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

ObjectType

-ObjectType <String>

Required?false
Position?5
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, however, the JOC Cockpit can be configured to enforce require Audit Log comments for any all interventions.

Required?false
Position?46
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?57
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?68
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-------------------------- 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 with from the indicated path for use with a JS7 Controller.

-------------------------- EXAMPLE 2 3 --------------------------

...