Discussion
Pegasystems Inc.
GB
Last activity: 28 Oct 2019 11:40 EDT
Powershell script : example
Here's a basic Microsoft Windows Powershell script which shows how easily you can build a set of scripts that communicate directly with the 'Pega API'.
This basic script will create a new Case - populating 'Hard Drive', 'Memory Size' and 'hostname' properties automatically from the Windows host you are one.
First create a CASE in PRPC - in this example I created 'ComputerAudit' and three properties (unfortunately - just realised I spelled 'hard drive' wrong :-)
Now: assuming a couple of other things:
- You have set up Powershell to run on your Windows machine.
(out of scope for this - but check here for instance.
- You have edited the script to match your system coordinates
- You ensure you are connecting with a PRPC Operator who has Pega API access (check access groups).
Here's the basic script:
$remote_PRPC_URL="https://prpchost.lab.pega.com:443"
$hdd_size=Get-Disk|select-object -Property @{n="HDDSize"; expression={[int]($_.Size/1gb)}}|select HDDSize
$ram_size=(Get-WmiObject win32_physicalmemory|Measure-Object capacity -sum).sum/1gb
$hostname="MyLaptop" # use "$env::COMPUTERNAME" for real hostname
$JSONRecord=@"
{
"caseTypeID": "OKE8TW-Gcs-Work-ComputerAudit",
"processID": "pyStartCase",
"content": { "Hostname": "$($hostname)", "HardriveSize": "$($hdd_size.HDDSize)", "MemorySizeGB": "$($ram_size)" }
}
"@
if ( !( [bool](Get-Variable 'cred' -Scope 'Global' -EA 'Ig') ) ) {
$cred=get-credential
}
else {
write-information -MessageData "Using Cached Credentials (unset 'cred' variable to reset)" -InformationAction Continue
}
$url="{0}/{1}" -F $remote_PRPC_URL, "prweb/api/v1/cases"
$result=Invoke-RestMethod -Method Post -Credential $cred -body $example -Uri $url
write-information -MessageData ("Case Created: {0}" -F $result.ID) -InformationAction Continue
$result | out-gridview
NB: there is no error handling in this script; and there are probably better ways of getting the information (for disks, memory etc) - but it should demonstrate the principle well enough.
Running this should result in an output in a window like this:
As well as text output on the console:
And here's the same case information in a PRPC Portal:
Pegasystems Inc.
GB
Just noticed an error (I had edited the script before posting).
The Invoke-RestMethod was posting the body with a variable $example - should be
$JSONRecord.
Also (in comments) - should be $ENV:computername (not double colons "::").
$result=Invoke-RestMethod -Method Post -Credential $cred -body $JSONRecord -Uri $url
Pegasystems Inc.
GB
Re-wrapped into a function ("Add-PegaCase") with parameters - with basic help.
Once the function is built: run
PS> GET-HELP Add-PegaCase -detailed
Also (for no reason at all, except fun) added Speech Synthesizer output.
Still not properly handling errors. (I believe Powershell will *halt* - even on handled - on exceptions - but I need to check that).
Set variables $PEGAHOST (and optionally) $CRED before calling.
(You'll get an error the first time you run this - those variables aren't set).
Re-wrapped into a function ("Add-PegaCase") with parameters - with basic help.
Once the function is built: run
PS> GET-HELP Add-PegaCase -detailed
Also (for no reason at all, except fun) added Speech Synthesizer output.
Still not properly handling errors. (I believe Powershell will *halt* - even on handled - on exceptions - but I need to check that).
Set variables $PEGAHOST (and optionally) $CRED before calling.
(You'll get an error the first time you run this - those variables aren't set).
function New-PegaCase() {
<#
.SYNOPSIS
Invokes Pega REST API to create a CASE.
.DESCRIPTION
Note: this is only an example and is currently hardcoded with regard to property names
Error handling is also very shabby.
.EXAMPLE
$PEGAHOST="mypegahost"
$CRED=(get-credential)
$result=New-PegaCase -ComputerName $PEGAHOST -Credential $CRED
#>
[CmdletBinding()]
param(
[Parameter()]
[string]$ComputerName="$($env:Computername)",
[System.Management.Automation.PSCredential]$Credential=(Get-Credential),
[string]$CaseTypeID="OKE8TW-Gcs-Work-ComputerAudit"
)
$Uri="https://$($Computername)/prweb/api/v1/cases"
$hdd_size=Get-Disk|select-object -Property @{n="HDDSize"; expression={[int]($_.Size/1gb)}}|select HDDSize
$ram_size=(Get-WmiObject win32_physicalmemory|Measure-Object capacity -sum).sum/1gb
$hostname="MyLaptop" # use "$env::COMPUTERNAME" for real hostname
$JSONRecord=@"
{
"caseTypeID": $($CaseTypeID),
"processID": "pyStartCase",
"content": { "Hostname": "$($hostname)", "HardriveSize": "$($hdd_size.HDDSize)", "MemorySizeGB": "$($ram_size)" }
}
"@
$result=Invoke-RestMethod -Method Post -Credential $Credential -body $JSONRecord -Uri $Uri -TimeoutSec 5
return $result
}
# Main Block / Testing.
Add-Type -AssemblyName System.Speech
$synthesizer = New-Object -TypeName System.Speech.Synthesis.SpeechSynthesizer
try {
$result=$none
$result=New-PegaCase -ComputerName $PEGAHOST -Credential $CRED
$synthesizer.speak("Created Case: $($result.id.split()[1])")
$result|format-table
}
catch { write-host ($_)
$synthesizer.speak("Uh oh, something went wrong") }
BPM Company
NL
awesome)
Is it only for the purpose of showing how can we create a case using PowerShell or you have maybe a business case for that?
btw, have you a version for bash script?
Pegasystems Inc.
GB
Hi Vaspoz,
No real use case in mind - it was just a way for me to test out the REST API using something other than a browser (or Python as I have used in the past).
I don't have BASH version for Linux - maybe that would be good challenge to leave for the community ! :-)
Here's some possible starting points:
awk ' /MemTotal/ { printf("%d\n",$2/(1024*1024)) } ' /proc/meminfo
https://unix.stackexchange.com/questions/424489/how-to-calculate-total-disk-space-using-df
And using 'curl' (or wget maybe I guess) instead of 'Invoke-WebRequest' / 'Invoke-RestMethod'.
Cheers
John