HornbillLogChangeRequestWebhook.ps1
|
<#PSScriptInfo .VERSION 1.1.2 .GUID 06e5ef5c-99b2-4893-a018-c80d9752c1c0 .AUTHOR steve.goldthorpe@hornbill.com .COMPANYNAME Hornbill .TAGS hornbill powershell azure automation webhook runbook .LICENSEURI https://wiki.hornbill.com/index.php/The_Hornbill_Community_License_(HCL) .PROJECTURI https://github.com/hornbill/powershellHornbillAzureRunbooks .ICONURI https://wiki.hornbill.com/skins/common/images/HBLOGO.png .RELEASENOTES Corrected metadata Included parameter descriptions .DESCRIPTION Azure Automation Runbook to log a new Change Request within Service Manager on a Hornbill instance. For use with Automation Webhooks. #> #.PARAMETER instanceName #MANDATORY: The name of the Instance to connect to. #.PARAMETER instanceKey #MANDATORY: An API key with permission on the Instance to carry out the required API calls. #.PARAMETER WebhookData # MANDATORY: A properly formatted JSON string containing the request properties: # assetIds # A comma-seperated string of asset IDs to attach to the new request, for example: 1,12,36 # bpmName # The name of a BPM to override the Service BPM or Default BPM. # catalogName # The title of the catalog to raise thew request against # categoryId # The ID of the request category # categoryName # The fullname of the request category # changeType # The Change Type (Standard, Emergency for example) # customerId # The ID of the request customer # customerType # The Type of the request customer (0 for Users, 1 for contacts) # description # The request description # ownerId # The ID of the request owner # priorityName # The name of the request Priority # resolutionDetails # The resolution description # serviceName # The name of the service to raise the request against # siteName # The name of the request site # sourceId # The ID of the request source # sourceType # The Type of request source # status # The status of the new request (defaults to status.open) # summary # The request summary # teamId # The ID of the team that the request should be assigned to #Requires -Module @{ModuleVersion = '1.1.0'; ModuleName = 'HornbillAPI'} #Requires -Module @{ModuleVersion = '1.1.1'; ModuleName = 'HornbillHelpers'} # Define output stream type [OutputType([object])] # Define runbook input params Param ( # Instance Connection Params [Parameter (Mandatory= $true)] [string] $instanceName, [Parameter (Mandatory= $true)] [string] $instanceKey, # Webhook Param [object] $WebhookData ) if ($null -ne $WebhookData) { # Define instance details Set-HB-Instance -Instance $instanceName -Key $instanceKey $WebhookBody = $WebhookData.RequestBody $requestObject = ConvertFrom-Json $WebhookBody $searchResultsValue = "" if($requestObject.SearchResults) { $SearchResultsValue = ConvertTo-Json $requestObject.SearchResults.value } $requestDescription = $requestObject.description if($SearchResultsValue -ne ""){ $requestDescription += "'''Alert Results Value JSON:''' "+$SearchResultsValue } # Get service ID from Name $serviceId = "" if($requestObject.serviceName -and $requestObject.serviceName -ne ""){ $serviceObj = Get-HB-ServiceID $requestObject.serviceName if($serviceObj.ServiceID -gt 0) { $serviceId = $serviceObj.ServiceID } } # Get Priority ID from Name $priorityId = "" if($requestObject.priorityName -and $requestObject.priorityName -ne ""){ $priorityObj = Get-HB-PriorityID $requestObject.priorityName if($priorityObj.PriorityID -gt 0) { $priorityId = $priorityObj.PriorityID } } # Get Catalog ItemID from Name $catItemId = "" if($requestObject.catalogName -and $requestObject.catalogName -ne ""){ $catalogObj = Get-HB-CatalogID $requestObject.catalogName $requestObject.serviceName "Change Request" if($catalogObj.CatalogID -gt 0) { $catItemId = $catalogObj.CatalogID } } # Get SiteID from Name $siteId = "" if($requestObject.siteName -and $requestObject.siteName -ne "") { $siteObj = Get-HB-SiteID $requestObject.siteName $siteId = $siteObj.SiteID } # Populate status if null $requestStatus = "status.open" if($requestObject.status -and $requestObject.status -ne "") { $requestStatus = $requestObject.status } Add-HB-Param "summary" $requestObject.summary $false Add-HB-Param "description" $requestObject.description $false Add-HB-Param "customerId" $requestObject.customerId $false Add-HB-Param "customerType" $requestObject.customerType $false Add-HB-Param "ownerId" $requestObject.ownerId $false Add-HB-Param "teamId" $requestObject.teamId $false Add-HB-Param "status" $requestStatus $false Add-HB-Param "priorityId" $priorityId $false Add-HB-Param "categoryId" $requestObject.categoryId $false Add-HB-Param "categoryName" $requestObject.categoryName $false Add-HB-Param "sourceType" $requestObject.sourceType $false Add-HB-Param "sourceId" $requestObject.sourceId $false # Process Assets $arrAssets = $requestObject.assetIds.replace(' ','').split(',') foreach ($asset in $arrAssets) { Add-HB-Param "assetId" $asset $false } Add-HB-Param "serviceId" $serviceId $false Add-HB-Param "resolutionDetails" $requestObject.resolutionDetails $false Add-HB-Param "changeType" $requestObject.changeType $false Add-HB-Param "siteId" $siteId $false Add-HB-Param "siteName" $requestObject.siteName $false Add-HB-Param "catalogId" $catItemId $false Add-HB-Param "catalogName" $requestObject.catalogName $false Add-HB-Param "bpmName" $requestObject.bpmName $false # Invoke XMLMC call, output returned as PSObject $xmlmcOutput = Invoke-HB-XMLMC "apps/com.hornbill.servicemanager/ChangeRequests" "logChangeRequest" $resultObject = New-Object PSObject -Property @{ Status = $xmlmcOutput.status Error = $xmlmcOutput.error RequestRef = "" Warnings = "" ExceptionName = "" ExceptionSummary = "" } # Read output status if($xmlmcOutput.status -eq "ok") { if($xmlmcOutput.params.requestId -and $xmlmcOutput.params.requestId -ne ""){ $resultObject.RequestRef = $xmlmcOutput.params.requestId $resultObject.Warnings = $xmlmcOutput.params.warnings } if($xmlmcOutput.params.exceptionName -and $xmlmcOutput.params.exceptionName -ne ""){ $resultObject.ExceptionName = $xmlmcOutput.params.exceptionName $resultObject.ExceptionSummary = $xmlmcOutput.params.exceptionDescription } } if($resultObject.Status -ne "ok"){ Write-Error $resultObject } else { if($resultOutput.ExceptionName -ne ""){ Write-Warning $resultObject } else { Write-Output $resultObject } } } else { Write-Error "This Runbook is designed to only be started from a Webhook" } |