Name

Set-JS7NotificationConfiguration

SYNOPSIS

Stores the configuration of JOC Cockpit notifications

SYNTAX

Set-JS7NotificationConfiguration [-XmlConfiguration] <XmlDocument> [[-JsonConfiguration] <PSObject>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Any inventory objects can be stored to JOC Cockpit. The objects are passed on as PowerShell
objects and are converted by the cmdlet to their native JSON reperesentation.

The following REST Web Service API resources are used:

* /inventory/store

PARAMETERS

XmlConfiguration

-XmlConfiguration <XmlDocument>
Specifies the XML object that holds the configuration for notifications that should be stored to the inventory.

The argument is used alternatively to -JsonConfiguration.

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

JsonConfiguration

-JsonConfiguration <PSObject>
Specifies the PowerShell object that holds the configuration for notifications that should be stored to the inventory.

The argument is used alternatively to -XmlConfiguration.

Required?false
Position?2
Default value
Accept pipeline input?true (ByValue, 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?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 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?4
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?5
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

WhatIf

-WhatIf <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

Confirm

-Confirm <SwitchParameter>

Required?false
Position?named
Default value
Accept pipeline input?false
Accept wildcard characters?false

about_JS7

EXAMPLES

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

PS > [xml] $xmlConf=(Get-JS7NotificationConfiguration).configuration
[PSCustomObject] $jsonConf=((Get-JS7NotificationConfiguration).configurationJson | ConvertFrom-Json -Depth 100)
Set-JS7NotificationConfiguration -XmlConfiguration $xmlConf -JsonConfiguration $jsonConf

Reads and stores the inventory object of a file order source.

  • No labels