JS7 JobScheduler

Space shortcuts

Page tree

Name

Set-JS7InventoryItem

SYNOPSIS

Stores the configuration of a JOC Cockpit inventory item, e.g. a workflow

SYNTAX

Set-JS7InventoryItem [-Path] <String> [-Type] <String> [-Object] <PSObject> [-Valid] [[-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

Path

-Path <String>
Specifies the folder, sub-folder and name of the object, e.g. a workflow path that should be
stored to the inventory.

Required?true
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:

** FOLDER
* Deployable object types
** WORKFLOW
** FILEORDERSOURCE
** JOBRESOURCE
** NOTICEBOARD
** LOCK
* Releasable object types
** INCLUDESCRIPT
** JOBTEMPLATE
** WORKINGDAYSCALENDAR
** NONWORKINGDAYSCALENDAR
** SCHEDULE
** REPORT

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

Object

-Object <PSObject>
Specifies the object that should be stored to the inventory. This parameter expects a PowerShell
custom object [PSCustomObject] as e.g. returned by the Get-JS7InventoryItem cmdlet.

The custom object is converted to JSON by this cmdlet.

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

Valid

-Valid <SwitchParameter>
Specifies that the inventory object has been validate before using this cmdlet

If such orders exist with a Controller and the -Submit parameter is used then they are cancelled and re-created.

Required?false
Position?named
Default valueFalse
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?4
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?5
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?6
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 > $fos = Get-JS7InventoryItem -Path '/JS7Demo/08_FileWatching/jdFilesTxt' -Type 'FILEORDERSOURCE';
Set-JS7InventoryItem -Path '/JS7Demo/08_FileWatching/jdFilesTxt' -Type 'FILEORDERSOURCE' -Object $fos

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

  • No labels