Package Creator

Home > Administration > ITOM > Package Creator

Index

Introduction The Package Creator allows a user, with the necessary programming background and ability, to create Operations within Packages. A Package consists of a single Package Info file and with additional resource files where required. The info file contains all the details regarding operations and all parameters that may be necessary. Although it is possible to manually create a Package, a form-based editor is provided to simplify the process. An interface is also provided to facilitate the uploading and organisation of resources that may be required to facilitate operations. These resources may be scripts, executables or other required files. In addition to uploading scripts, an interface is also provided to allow for various file types to be created via the browser interface.

Related Articles ITOM Package Library

Package Creator List

Package Unique name given to the Package Purpose Summary of the intended use of the package Target OS Operating System that the package was designed for execution Published Late Published version of the packacge

Created On Date that the package was created Created By The account used to create the package Last Updated On Date the package was last updated Last Updated By The account last used to update the package

Toolbar

Refresh Target OS All Unknown Windows 32-bit Windows 64-bit Windows Universal

Purpose Dynamic list populated from the Purpose field of entriies in the list Filter Free text filter on Package Cereate a Package Create an IT Automation Package Delete Delete selected Package(s)

Create a Package

Select the [+] button from the toolbar and when requested, enter a unique Package name. This will display Package Details where the package can be Configured and Updated via the Package Content Frame and Properties Form.

Package Content Toolbar

• Upload

Uploads files to the current folder

• New Folder

Creates a new Folder

• New File

Creates a new file in the current folder

• Baseline

Creates a new baseline of the current package

• Save

Saves amended package details

Selecting Package Info file enables the file to be modified via a form or in its native XML format, which is selectable via the toggle buttons.

• Package ID

A GUID which uniquely identifies the package) will be generated on creation

• Package

• Description

Description of the packages content

• Purpose

Summary of the intended use of the package

• Vendor ID

Defined by the creator of the package (Hornbill packages will set to "private:hornbill")

• Target OS

Defines Target OS platform that the package is designed

• Windows 32-bit

• Windows 64-bit

• Windows Universal

Package can be invoked on either Windows 32 or 64-bit

Package Operations

Operations various actions to be configured, which execute a single command, executable, script or installer package. An Operation is created by clicking on the Add Operation button within the Form View.

• Operation

Mandatory Name used to select the package when creating a Job

• Description

Describes the functionality provided by the operation

• Command Type

Provides a list of supported command types

• Run Command

Executes a standalone command

• Windows Installer

Executes an uploaded Windows Installer(.msi) package, with one of four actions are available

• Install Software

Installs the .msi package

• Run Program

Executes the Installed program

• Uninstall Software

Uninstall an .msi package

• Update Software

Update an Installed .msi package

• Windows Executable

Executes a windows executable, selected from the Run File list

• Batch Script

Excutes a Windows batch script (.cmd or .bat), selected from the Run File list

• Windows PowerShell

Execute a Windows Powershell script, selected from the Script list

• PowerShell Core

Execute a Windows Powershell Core script, selected from the Script list

• Timeout

Numeber of seconds before the SIS execution will timeout

• Options / Args

Specifies arguments that can be sent to the pecified command. Input parameters can be used to provide dynamic values

• Input Parameters

Allows for one or more input parameters that can be required or optional, to be specified

• Output Parameters

Allows for one or more output parameters that can be required or optional, to be specified

Input parameters once created can be referrenced using the following format:

{param.<input_parameter_name>}

<input_parameter_name> should substituted for the relevant parameter name such as {param.host}

Using the above format an input parameter can be used as the value for an argument to be sent to the relevant Command Type executable component. The following example shows how a parameter can be used to provide the value to the -n argument used by the ping command:

-n 2 "{param.host}"

Default value and a hint can be set for the Input Parameter. If the Input Parameter is set as sensitive (struck out eye), then the parameters will be encrypted in transmission as the Credentials are.

• the parameters are substituted, the character escaping needs to be handled by the developer.
• It might be that n/m-dash are substituted with hyphens.
• Fancy quotes might also get added to the substitution list

It is also possible to pass user credentials to the command line. The credentials should be added to the "Extra Credentials" section of the Job definition. To use the credentials use:

{creds:credential_name.credential_property_name}

eg:

{creds:credential1.apikey}

It would be well advised to ensure there is clear user documentation as to what Extra Credentials need setting (their exact names as well as their types) when creating these Packages.

Output Parameters can also be configured, the resulting Console Output is then expected to contain text in the following format:

{{SISJobOutputParameterStart:output_variable_name}}output_data{{SISJobOutputParameterEnd}}

The output data can then be used as input for a subsequent Automation call within the Runbook or Business Process (if passed on via the Runbook's Output Parameters).

Script Creation

Supported File Types

.bat Command Prompt Batch process files .sh Powershell and Powershell Core scripts .js Javascript

.txt Text format file .json JavaScript Object Notation file .csv Comma Seperated Value file

Some of the supported file types require disabling security.fileUploadRestriction.entity.fileAttachments.enable or remove the extensions from the security.fileUploadRestriction.entity.fileAttachments.types list.

Baselining

In order to keep track of your package developments, you will invariably be working on a Draft. Once you are happy with your draft, baseline the draft. A new version will become the new published version of the package and ALL existing scheduled jobs using operations from the package will be using this new package.

when the Baseline action is clicked, the resulting context will be left in Draft mode. Select a specific version before releasing a home-baked creation to the world (by packaging it).

To recognise in what developing context is, look for View Draft button and the sub-header on the page which states the version number before (Readonly Baseline)

ITOM Package Baseline

Use the down-arrow next to the Baseline button to select the between the different versions of your package - this can be used to compare those versions.

ITOM Package Baseline Version Selection

There are various actions you can select from on a particular baseline:

• Package and Install

this will set the current baseline up as the active baseline for existing items on the Job Scheduling

• Package and Download

this will result in a .pkg being downloaded which can be shared and uploaded in the Installed Packages section

ITOM Package Baseline Options