JS7 JobScheduler

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Next »

Name

Add-JS7InventoryItem

SYNOPSIS

Add a configuration object such as a workflow from a JSON file to the JOC Cockpit inventory

SYNTAX

Add-JS7InventoryItem [-Path] <String> [-Type] <String> [-Item] <Object> [[-DocPath] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

This cmdlet reads configuration objects from JSON files and stores them with JOC Cockpit.
Consider that imported objects have to be deployed with the Deploy-JS7DeployableObject and Deploy-JS7ReleasableObject cmdlets.

PARAMETERS

Path

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

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

Type

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

* WORKFLOW
* JOBCLASS
* LOCK
* JUNCTION
* FILEORDERSOURCE
* WORKINGDAYSCALENDAR
* NONWORKINGDAYSCALENDAR
* SCHEDULE

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

Item

-Item <Object>
Specifies the PowerShell object that represents the JSON item to be added. Consider to create a PowerShell object from JSON like this:

'{ "limit": 1 }' | ConvertFrom-Json

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

DocPath

-DocPath <String>
Specifies the path to the documentation that is assigned the object.

Required?false
Position?4
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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforce Audit Log comments for any interventions.

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

Required?false
Position?6
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 JobScheduler.

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

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

about_JS7

EXAMPLES

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

PS > Add-JS7InventoryItem -Path /some/directory/sampleLock -Type 'LOCK' -Item ( '{ "limit": 1 }' | ConvertFrom-Json )

On-the-fly adds a resource lock to the invnetory. The JSON document for the resource lock is specified with the -Item parameter.

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

PS > Add-JS7InventoryItem -Path /some/directory/sampleLock -Type 'LOCK' -Item (Get-Content /tmp/myForkExample.workflow.json -Raw | ConvertFrom-Json -Depth 100)

Reads a resource lock from a file and adds it to the invnetory.

  • No labels