PowerShell CLI 2.0 - Cmdlets - Submit-JS7Notice

Name

Submit-JS7Notice

SYNOPSIS

Submits a Notice to a Notice Board in the JOC Cockpit

SYNTAX

Submit-JS7Notice [-NoticeBoardPath] <String> [-NoticeId] <String> [[-EndOfLifeDate] <DateTime>] [[-EndOfLifeRelativeDate] <String>] [[-Timezone] <TimeZoneInfo>] [[-ControllerId] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet submits a Notice to a Notice Board in the JOC Cockpit.

The following REST Web Service API resources are used:

* /notice/post

PARAMETERS

NoticeBoardPath

-NoticeBoardPath <String>
Specifies the path to the Notice Board which includes the folder, sub-folders and the name of the Notice Board.

NoticeId

-NoticeId <String>
Specifies the identifier of the Notice to be submitted.

EndOfLifeDate

-EndOfLifeDate <DateTime>
Specifies an absolute date for the lifetime of the Notice, e.g.

* (Get-Date).AddSeconds(10): 10s from now
* (Get-Date).AddDays(1).AddHours(4).AddSeconds(10): 1 day, 4 hours and 10s from now

Note that the cmdlet converts the data specified to UTC.

EndOfLifeRelativeDate

-EndOfLifeRelativeDate <String>
Specifies a relative date for the lifetime of the Notice, e.g.

* 1s, 2s: one second from now, two seconds from now
* 1m, 2m: one minute from now, two minutes from now
* 1h, 2h: one hour from now, two hours from now
* 1d, 2d: one day from now, two days from now
* 1w, 2w: one week from now, two weeks from now
* 1M, 2M: one month from now, two months from now
* 1y, 2y: one year from now, two years from now

Optionally a time offset can be specified, e.g. -1d+02:00, as otherwise midnight UTC is assumed.
Alternatively a timezone offset can be added, e.g. by using -1d+TZ. This will be calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.

Timezone

-Timezone <TimeZoneInfo>
Specifies the timezone for which dates should be converted to from the history information.
A timezone can e.g. be specified like this:

Submit-JS7Notice -Timezone (Get-Timezone -Id 'GMT Standard Time')

All dates in JS7 are UTC and can be converted e.g. to the local time zone like this:

Submit-JS7Notice -Path /ProductDemo/Seaqencning/pdSequenceSynchroneously -NoticeId 2022-07-14 -EndOfLifeRelativeDate 3h -Timezone (Get-Timezone)

Default: Dates are specified in UTC.

ControllerId

-ControllerId <String>
Optionally specifies the identification of the Controller to which to submit Notices.

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.

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.

AuditTicketLink

-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.

WhatIf

-WhatIf <SwitchParameter>

Confirm

-Confirm <SwitchParameter>

RELATED LINKS

about_JS7

EXAMPLES

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

PS > Submit-JS7Notice -NoticeBoardPath -Folder /ProductDemo/Sequencing/pdSequenceSynchroneously -NoticeId 2022-03-24

Submits a Notice to the indicated Notice Board.