Name
Add-JS7InventoryItem
SYNOPSIS
Adds a scheduling object such as a workflow from a PowerShell object to the JOC Cockpit inventory
SYNTAX
Add-JS7InventoryItem [-Path] <String> [-Type] <String> [-Item] <Object> [[-DocPath] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
Scheduling objects can be represented in JSON format, however, they have to be converted to PowerShell objects
to be processed by the cmdlet.
Basic examples how to convert JSON to PowerShell objects:
* '{ "limit": 1 }' | ConvertFrom-Json
** The JSON representation is converted from a string to a PowerShell object
* Get-Content /tmp/myForkExample.workflow.json -Raw | ConvertFrom-Json -Depth 100
** The contents of a file holding the JSON representation is converted to a PowerShell object
This cmdlet accepts scheduling objects and stores them with the JOC Cockpit inventory.
Consider that added objects have to be deployed or released with the Deploy-JS7DeployableItem and Deploy-JS7ReleasableItem cmdlets.
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 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:
* Deployable object types
** WORKFLOW
** FILEORDERSOURCE
** JOBRESOURCE
** NOTICEBOARD
** LOCK
* Releasable object types
** INCLUDESCRIPT
** 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 creating 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 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? | 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 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? | 6 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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.
| Required? | false |
| Position? | 7 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
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 inventory. 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.
Overview
Content Tools