PowerShell CLI 2.0 - Cmdlets - Set-JS7RepositoryItem

Name

Set-JS7RepositoryItem

SYNOPSIS

Stores scheduling objects from the JS7 inventory to a local Git repository

SYNTAX

Set-JS7RepositoryItem [[-Path] <String>] [[-Type] <String[]>] [[-Folder] <String>] [-Recursive] [-Local] [[-ControllerId] <String>] [-Valid] [-NoDraft] [-NoDeployed] [-NoReleased] [-Latest] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet stores JS7 scheduling objects to a local Git repository. The JS7 settings
determine which object types such as schedules, workflows are considered for a repository
of category LOCAL and of category ROLLOUT respectively.

The following REST Web Service API resources are used:

* /inventory/deployable
* /inventory/deployables
* /inventory/releasable
* /inventory/releasables
* /inventory/repository/store

PARAMETERS

Path

-Path <String>
Specifies the folder, sub-folder and name of the scheduling object, for example a workflow path,
that should be stored to the repository.

Type

-Type <String[]>
Specifies the scheduling object type that is one or more of:

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

If no object type is specified then any object types will be used.

Folder

-Folder <String>
Alternatively to use of -Path the parameter specifies a JOC Cockpit inventory folder to be used to
store objects to a local Git repository.

Recursive

-Recursive <SwitchParameter>
Specifies that all sub-folders should be looked up if the -Folder parameter is used.
By default no sub-folders will be looked up.

Local

-Local <SwitchParameter>
Specifies that a repository holding scheduling objects that are local to the environment should be used.
This corresponds to the LOCAL category. If this switch is not used then the
ROLLOUT category is assumed for a repository that holds scheduling objects
intended for rollout to later environments such as test, prod.

ControllerId

-ControllerId <String>
Optionally limits the selection of deployed scheduling objects to the Controller indicated with the Controller ID.
Objects that are deployed to other Controllers will not be stored to the repository.

Valid

-Valid <SwitchParameter>
Limits the scope to valid schedudling objects only.

NoDraft

-NoDraft <SwitchParameter>
Specifies that no draft objects should be stored. This boils down to the fact
that only previously deployed or released objects will be stored.

NoDeployed

-NoDeployed <SwitchParameter>
Specifies that no previously deployed objects should be stored.

NoReleased

-NoReleased <SwitchParameter>
Specifies that no previously released objects should be stored.

Latest

-Latest <SwitchParameter>
If used with the -Path parameter then -Latest specifies that only the latest deployed object will be considered.
This parameter is not considered if the -NoDeployed parameter is used.

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 > Set-JSRepositoryItem -Folder /TestCases/sampleWorkflows -Recursive

Stores any scheduling objects of the indicated folder and sub-folders to the repository of category ROLLOUT.

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

PS > Set-JS7RepositoryItem -ControllerId testsuite,standalone -Path /TestCases/sampleWorkflow_001 -Type 'WORKFLOW'

Stores the workflow from the specified path to the local repository of category ROLLOUT provided that the workflow has previously been deployed to both indicated Controller instances.

-------------------------- EXAMPLE 3 --------------------------

PS > Set-JS7RepositoryItem -ControllerId testsuite -Folder /Samples -NoDraft

Stores any objects such as workflows, resource locks etc from the specified folder to the repository of category ROLLOUT. No sub-folders and no draft versions of objects are considered.

-------------------------- EXAMPLE 4 --------------------------

PS > Set-JS7RepositoryItem -ControllerId testsuite -Folder /Samples -Recursive -Local

Stores any objects such as job resources and schedules from the specified folder recursively to the repository of category LOCAL. Deployable objects are considered only if previously deployed to the indicated Controller.