SMAX.psm1
|
$script:ModuleRoot = $PSScriptRoot $script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\SMAX.psd1").ModuleVersion # Detect whether at some level dotsourcing was enforced $script:doDotSource = Get-PSFConfigValue -FullName SMAX.Import.DoDotSource -Fallback $false if ($SMAX_dotsourcemodule) { $script:doDotSource = $true } <# Note on Resolve-Path: All paths are sent through Resolve-Path/Resolve-PSFPath in order to convert them to the correct path separator. This allows ignoring path separators throughout the import sequence, which could otherwise cause trouble depending on OS. Resolve-Path can only be used for paths that already exist, Resolve-PSFPath can accept that the last leaf my not exist. This is important when testing for paths. #> # Detect whether at some level loading individual module files, rather than the compiled module was enforced $importIndividualFiles = Get-PSFConfigValue -FullName SMAX.Import.IndividualFiles -Fallback $false if ($SMAX_importIndividualFiles) { $importIndividualFiles = $true } if (Test-Path (Resolve-PSFPath -Path "$($script:ModuleRoot)\..\.git" -SingleItem -NewChild)) { $importIndividualFiles = $true } if ("<was compiled>" -eq '<was not compiled>') { $importIndividualFiles = $true } function Import-ModuleFile { <# .SYNOPSIS Loads files into the module on module import. .DESCRIPTION This helper function is used during module initialization. It should always be dotsourced itself, in order to proper function. This provides a central location to react to files being imported, if later desired .PARAMETER Path The path to the file to load .EXAMPLE PS C:\> . Import-ModuleFile -File $function.FullName Imports the file stored in $function according to import policy #> [CmdletBinding()] Param ( [string] $Path ) $resolvedPath = $ExecutionContext.SessionState.Path.GetResolvedPSPathFromPSPath($Path).ProviderPath if ($doDotSource) { . $resolvedPath } else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText($resolvedPath))), $null, $null) } } #region Load individual files if ($importIndividualFiles) { # Execute Preimport actions foreach ($path in (& "$ModuleRoot\internal\scripts\preimport.ps1")) { . Import-ModuleFile -Path $path } # Import all internal functions foreach ($function in (Get-ChildItem "$ModuleRoot\internal\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Import all public functions foreach ($function in (Get-ChildItem "$ModuleRoot\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Execute Postimport actions foreach ($path in (& "$ModuleRoot\internal\scripts\postimport.ps1")) { . Import-ModuleFile -Path $path } # End it here, do not load compiled code below return } #endregion Load individual files #region Load compiled code <# This file loads the strings documents from the respective language folders. This allows localizing messages and errors. Load psd1 language files for each language you wish to support. Partial translations are acceptable - when missing a current language message, it will fallback to English or another available language. #> Import-PSFLocalizedString -Path "$($script:ModuleRoot)\en-us\*.psd1" -Module 'SMAX' -Language 'en-US' function Edit-SMAXAssociation { <# .SYNOPSIS Edits associations between entities in the Service Management Automation X (SMAX) platform. .DESCRIPTION The Edit-SMAXAssociation function allows you to create or delete associations between entities in SMAX. You can specify the entity names, IDs, association type, operation (Create or Delete), and bulk operation parameters. .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .PARAMETER EntityType Specifies the name of the source entity from which the association is created. .PARAMETER EntityId Specifies the ID of the source entity from which the association is created. .PARAMETER RemoteId Specifies the ID of the remote entity to associate with. .PARAMETER Association Specifies the type of association between the entities. .PARAMETER Operation Specifies the operation to perform on the associations. It can be "Create" or "Delete." .PARAMETER BulkID Specifies the bulk operation ID when performing bulk association operations. .PARAMETER ExecuteBulk Indicates whether to execute a bulk association operation. .EXAMPLE Edit-SMAXAssociation -EntityType Request -EntityId 400551 -Association FollowedByUsers -remoteId 388154 -Operation Create Adds the person 388154 to the Request 400551 as a follower. .EXAMPLE Edit-SMAXAssociation -EntityType Request -EntityId 400551 -Association FollowedByUsers -remoteId 388154 -BulkID MyBulk Edit-SMAXAssociation -EntityType Request -EntityId 400551 -Association FollowedByUsers -remoteId 115 -BulkID MyBulk Edit-SMAXAssociation -BulkID MyBulk -Operation Create -ExecuteBatch Adds the persons 388154 and 115 to the Request 400551 as a follower in a single web request. .NOTES General notes #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [int]$EntityId, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [int]$RemoteId, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityAssociations")] [string]$Association, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "executeBulk")] [ValidateSet('Create', 'Delete')] [string]$Operation, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "executeBulk")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [string]$BulkID, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "executeBulk")] [switch]$ExecuteBulk ) if (-not $ExecuteBulk){ Write-PSFMessage "No Bulk Execution, creating new relationship object" $definitions = Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).entityDefinition" if ([string]::IsNullOrEmpty($definitions)) { Stop-PSFFunction -EnableException $EnableException -Message "SMAX Entitymodel not initialized, please run Initialize-SMAXEntityModel" } $secondEndpoint = $definitions.$EntityType.associations | Where-Object name -eq $Association | Select-Object -ExpandProperty linkEntityName if ([string]::IsNullOrEmpty($secondEndpoint)) { Stop-PSFFunction -EnableException $EnableException -Message "Could not find secondEndpoint for '$EntityType' association '$Association'" } $newRel = [PSCustomObject]@{ name = $Association firstEndpoint = [PSCustomObject]@{ $EntityType = $EntityId } secondEndpoint = [PSCustomObject]@{ $secondEndpoint = $RemoteId } } } switch -regex ($PSCmdlet.ParameterSetName){ "singleAssociation"{ Write-PSFMessage "SingleRelation" $relationships=@($newRel) # $relationships = new System.Collections.ArrayList } 'Bulk'{ if([string]::IsNullOrEmpty($Script:EntAssBulks)){ Write-PSFMessage "Initialisiere `$Script:EntAssBulks" $Script:EntAssBulks=@{} } if ($Script:EntAssBulks.containskey($BulkID)){ Write-PSFMessage "Using existing Bulk Collection $BulkID" $relationships=$Script:EntAssBulks.$BulkID } else{ Write-PSFMessage "Starting Bulk Collection $BulkID" $relationships = new System.Collections.ArrayList $Script:EntAssBulks.$BulkID = $relationships } } 'BuildBulk'{ [void]$relationships.add($newRel) return } 'executeBulk'{ if ([string]::IsNullOrEmpty($relationships)){ # Write-PSFMessage -Level Warning Stop-PSFFunction -Message "No Bulk Data for '$BulkID' available" -EnableException $EnableException return } } } $apiCallParameter = @{ EnableException = $EnableException # EnablePaging = $EnablePaging Connection = $Connection ConvertJsonAsHashtable = $false LoggingAction = "Edit-SMAXAssociation" LoggingActionValues = @($Operation, $relationships.Count) method = "POST" Path = "/ems/bulk" body = @{ relationships = $relationships operation = $Operation.ToUpper() } } Write-PSFMessage "`$apiCallParameter=$($apiCallParameter|ConvertTo-Json -Depth 5)" $result = Invoke-SMAXAPI @apiCallParameter #| Where-Object { $_.properties} Write-PSFMessage "`$result=$($result|ConvertTo-Json -Depth 5)" if($ExecuteBulk){ Write-PSFMessage "Bulk executed, clearing temp. cache" $Script:EntAssBulks.remove($BulkID) } return $result } function Get-SMAXMetaEntityDescription { <# .SYNOPSIS Retrieves metadata descriptions for entities in the Service Management Automation X (SMAX) platform. .DESCRIPTION The Get-SMAXMetaEntityDescription function allows you to retrieve metadata descriptions for SMAX entities. You can specify the entity name and provide a connection. .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER EntityType Specifies the name of the entity for which metadata descriptions are retrieved. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .EXAMPLE PS C:\> Get-SMAXMetaEntityDescription -Connection $conn -EntityType "Incident" This example retrieves metadata descriptions for the "Incident" entity in the SMAX platform. .NOTES File Name : Get-SMAXMetaEntityDescription.ps1 #> param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [bool]$EnableException = $true ) $apiCallParameter = @{ EnableException = $EnableException Connection = $Connection LoggingAction = "Get-SMAXMetaEntityDescription" method = "GET" Path = "/metadata/ui/entity-descriptors" } $result = Invoke-SMAXAPI @apiCallParameter return $result.entity_descriptors | Where-Object domain -NotMatch 'sample' } function Get-SMAXMetaTranslation { <# .SYNOPSIS Retrieves translations for a specific locale in the Service Management Automation X (SMAX) platform. .DESCRIPTION The Get-SMAXMetaTranslation function allows you to retrieve translations for a specified locale in the SMAX platform. You can provide a connection and specify the desired locale. .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER Locale Specifies the locale for which translations are retrieved. If not provided, it uses the locale associated with the current user obtained from the connection. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .EXAMPLE PS C:\> Get-SMAXMetaTranslation -Connection $conn -Locale "fr-FR" This example retrieves translations for the French (France) locale in the SMAX platform. .EXAMPLE PS C:\> Get-SMAXMetaTranslation -Connection $conn This example retrieves translations for the locale associated with the current user in the SMAX platform. .NOTES File Name : Get-SMAXMetaTranslation.ps1 #> param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), $Locale, [bool]$EnableException = $true ) if ([string]::IsNullOrEmpty($Locale)) { $currentUser = Get-SMAXCurrentUser -Connection $Connection $Locale = $currentUser.Locale } $apiCallParameter = @{ EnableException = $EnableException Connection = $Connection LoggingAction = "Get-SMAXMetaEntityDescription" method = "GET" Path = "/l10n/bundles/saw/$Locale" ConvertJsonAsHashtable = $true } $result = Invoke-SMAXAPI @apiCallParameter $dictionary=@{} foreach ($resourceTable in $result.Bundles.Resources) { $resourceTable.GetEnumerator() | Where-Object { $_.value } | ForEach-Object { $key = $_.name $dictionary.$key=$_.value } } Write-PSFMessage "Gathered $($dictionary.Keys.Count) translations" return $dictionary } function Invoke-SMAXBulk { <# .SYNOPSIS Performs bulk create or update operations on entities in the Service Management Automation X (SMAX) platform. .DESCRIPTION The Invoke-SMAXBulk function allows you to perform bulk create or update operations on SMAX entities. You can specify the entity name, input objects, and the operation type (Create or Update). .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .PARAMETER EntityType Specifies the name of the entity for which the bulk operation is performed. .PARAMETER InputObject Specifies the entities to be created or updated. You can provide an array of SMAX entity objects. They all have to be from the EntityType .PARAMETER Operation Specifies the operation type. It can be either "Create" or "Update." .EXAMPLE PS C:\> $newEntities = @( @{ Title = "New Incident 1" Description = "This is a new incident 1" Category = "Service Request" }, @{ Title = "New Incident 2" Description = "This is a new incident 2" Category = "Incident" } ) PS C:\> Invoke-SMAXBulk -Connection $conn -EntityType "Incident" -InputObject $newEntities -Operation "Create" This example performs a bulk creation operation for two new incidents. .EXAMPLE PS C:\> $updatedEntities = @( @{ Id = 123 Title = "Updated Incident 1" }, @{ Id = 456 Title = "Updated Incident 2" } ) PS C:\> Invoke-SMAXBulk -Connection $conn -EntityType "Incident" -InputObject $updatedEntities -Operation "Update" This example performs a bulk update operation for two existing incidents. .NOTES File Name : Invoke-SMAXBulk.ps1 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $false, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "byEntityId")] [object[]]$InputObject, [ValidateSet('Create', 'Update')] [string]$Operation ) begin { $entityList = new System.Collections.ArrayList $definitions = Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).entityDefinition" if([string]::IsNullOrEmpty($definitions)){ Stop-PSFFunction -EnableException $EnableException -Message "SMAX Entitymodel not initialized, please run Initialize-SMAXEntityModel" } Write-PSFMessage "Load Definition $(Get-SMAXConfPrefix -Connection $Connection).entityDefinition" } process { Write-PSFMessage "processing `$InputObject: $($InputObject|ConvertTo-Json -Compress -Depth 4)" foreach ($obj in $InputObject) { Write-PSFMessage "processing `$Obj: $($obj|ConvertTo-Json -Compress -Depth 4)" $localEntityName = $obj.psobject.TypeNames -match '^SMAX' -replace 'SMAX\.' | Select-Object -First 1 if ([string]::IsNullOrEmpty($localEntityName)) { if ([string]::IsNullOrEmpty($EntityType)) { Stop-PSFFunction -EnableException $EnableException -Message "Neither `$_.PSDataType nor -EntityType param set for object $($obj|ConvertTo-Json -Compress -Depth 4)" continue } $localEntityName = $EntityType } $validProperties = $definitions.$localEntityName.properties | Where-Object readonly -eq $false | Select-Object -ExpandProperty name if ($Operation -eq 'Update') { $validProperties += 'Id' } Write-PSFMessage "`$validProperties=$($validProperties -join ',')" $entity = [PSCustomObject]@{ "entity_type" = $localEntityName "properties" = $obj | ConvertTo-PSFHashtable -Include $validProperties } Write-PSFMessage "adding `$entity: $($entity|ConvertTo-Json -Compress -Depth 4)" [void]$entityList.Add($entity) } } end { Write-PSFMessage "Count of entities: $($entityList.count)" Write-PSFMessage "$($entityList|ConvertTo-Json)" $apiCallParameter = @{ EnableException = $EnableException Connection = $Connection ConvertJsonAsHashtable = $false LoggingAction = "Invoke-SMAXBulk" LoggingActionValues = @($Operation, $entityList.Count) method = "POST" Path = "/ems/bulk" body = @{ entities = $entityList.ToArray() operation = $Operation.ToUpper() } } Write-PSFMessage "`$apiCallParameter=$($apiCallParameter|ConvertTo-Json -Depth 5)" $result = Invoke-SMAXAPI @apiCallParameter #| Where-Object { $_.properties} Write-PSFMessage "`$result=$($result|ConvertTo-Json -Depth 5)" return $result } } function Add-SMAXAssociation { <# .SYNOPSIS Adds associations between entities in the Service Management Automation X (SMAX) platform. .DESCRIPTION The Add-SMAXAssociation function allows you to create associations between entities in SMAX. You can specify the entity names, IDs, association type, and bulk operation parameters. .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .PARAMETER EntityType Specifies the name of the source entity from which the association is created. .PARAMETER EntityId Specifies the ID of the source entity from which the association is created. .PARAMETER RemoteId Specifies the ID of the remote entity to associate with. .PARAMETER Association Specifies the type of association between the entities. .PARAMETER BulkID Specifies the bulk operation ID when performing a bulk association operation. .PARAMETER ExecuteBulk Indicates whether to execute a bulk association operation. .EXAMPLE PS C:\> Add-SMAXAssociation -Connection $conn -EntityType "Incident" -EntityId 123 -RemoteId 456 -Association "RelatesTo" This example creates an association between an incident with ID 123 and another entity with ID 456 of type "RelatesTo." .EXAMPLE Add-SMAXAssociation -EntityType Request -EntityId 400551 -Association FollowedByUsers -remoteId 388154 -BulkID MyBulk Add-SMAXAssociation -EntityType Request -EntityId 400551 -Association FollowedByUsers -remoteId 115 -BulkID MyBulk Add-SMAXAssociation -BulkID MyBulk -ExecuteBatch Adds the persons 388154 and 115 to the Request 400551 as a follower in a single web request. .NOTES File Name : Add-SMAXAssociation.ps1 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [int]$EntityId, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [int]$RemoteId, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityAssociations")] [string]$Association, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "executeBulk")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [string]$BulkID, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "executeBulk")] [switch]$ExecuteBulk ) $bulkParameter = $PSBoundParameters | ConvertTo-PSFHashtable $bulkParameter.Operation = 'Create' Edit-SMAXAssociation @bulkParameter } function Add-SMAXComment { <# .SYNOPSIS Adds comments to entities in the Service Management Automation X (SMAX) platform. .DESCRIPTION The Add-SMAXComment function allows you to add comments to SMAX entities, such as incidents. You can specify the entity name, ID, and an array of comments to add. .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .PARAMETER EntityType Specifies the name of the entity to which comments will be added. .PARAMETER Id Specifies the ID of the entity to which comments will be added. .PARAMETER Comment Specifies the comments to add to the entity. You can provide an array of comment objects. .EXAMPLE $comment=New-SMAXComment -ActualInterface API -Body "This is my comment" -CommentFrom Agent -CommentTo User -FunctionalPurpose Diagnosis -Media UI Add-SMAXComment -Connection $connection -Comment $comment -EntityType Request -Id 4711 Creates a comment and adds it to the Request 4711 .NOTES General notes #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [string]$Id, [parameter(mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "byEntityId")] [object[]]$Comment ) begin { $commentList = @() } process { $commentList += $Comment } end { $apiCallParameter = @{ EnableException = $EnableException Connection = $Connection ConvertJsonAsHashtable = $false LoggingAction = "Add-SMAXComment" LoggingActionValues = @( $commentList.Count, $Id, $EntityType) method = "POST" Path = "/collaboration/comments/bulk/$EntityType/$Id" body = ,$commentList|ConvertTo-Json -Depth 5 } Write-PSFMessage "`$apiCallParameter=$($apiCallParameter|ConvertTo-Json -Depth 5)" $result = Invoke-SMAXAPI @apiCallParameter #| Where-Object { $_.properties} Write-PSFMessage "`$result=$($result|ConvertTo-Json -Depth 5)" # return $result # Invoke-SMAXBulk @bulkParameter } } function Add-SMAXEntity { <# .SYNOPSIS Adds entities to the Service Management Automation X (SMAX) platform. .DESCRIPTION The Add-SMAXEntity function allows you to create new entities in the SMAX platform. You can specify the entity type name and provide an array of input objects to create. .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .PARAMETER EntityType Specifies the name of the entity to create. This parameter is optional when using the pipeline to provide input objects. .PARAMETER InputObject Specifies the entities to create. You can provide an array of SMAX entity objects. .EXAMPLE PS C:\> $newEntity = @{ Title = "New Incident", Description = "This is a new incident", Category = "Service Request" } PS C:\> Add-SMAXEntity -Connection $conn -EntityType "Incident" -InputObject $newEntity This example creates a new incident entity with the specified properties. .NOTES #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $false, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "byEntityId")] [object[]]$InputObject ) begin { $entityList = @() $bulkParameter = $PSBoundParameters | ConvertTo-PSFHashtable -Exclude LoggingActionValues, RevisionNote, LoggingAction, InputObject $bulkParameter.Operation = 'Create' } process { $entityList += $InputObject } end { $bulkParameter.InputObject = $entityList Invoke-SMAXBulk @bulkParameter } } function Connect-SMAX { <# .SYNOPSIS Establishes a connection to the Service Management Automation X (SMAX) platform. .DESCRIPTION The Connect-SMAX function allows you to establish a connection to the SMAX platform by providing the URL, tenant, and credentials. It also supports reusing an existing SMAX connection. .PARAMETER Url Specifies the URL of the SMAX instance to connect to. .PARAMETER Tenant Specifies the tenant ID for the SMAX instance. .PARAMETER Credential Specifies the credentials used for authentication. .PARAMETER OldConnection Specifies an existing SMAX connection to reuse. .PARAMETER SkipCheck Specifies checks to skip during the connection process, such as certificate checks, HTTP error checks, or header validation checks. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .EXAMPLE $connection=Connect-SMAX -Url $url -Credential $cred -Tenant 888220 Connect directly with a Credential-Object .EXAMPLE $connection=Connect-SMAX -Url $url -Credential $cred $connection=Export-Clixml -Path ".\connection.xml" $importedConnection=Import-Clixml -Path ".\connection.xml" $secondConnection=Connect-SMAX -OldConnection $importedConnection Connect with the information from a serialized object .NOTES #> <# .SYNOPSIS Creates a new Connection Object to a SMAX instance. .DESCRIPTION Creates a new Connection Object to a SMAX instance. .PARAMETER Credential Credential-Object for direct login. .PARAMETER Tenant The Tenant ID for the connection .PARAMETER Url The server root URL. .PARAMETER OldConnection An old connection to be revived. This can be obtained e.g. by Export-Clixml/Import-Clixml. .PARAMETER SkipCheck Array of checks which should be skipped while using Invoke-WebRequest. Possible Values 'CertificateCheck', 'HttpErrorCheck', 'HeaderValidation'. If neccessary by default for the connection set $connection.SkipCheck .PARAMETER EnableException Should Exceptions been thrown? .EXAMPLE $connection=Connect-SMAX -Url $url -Credential $cred -Tenant 888220 Connect directly with a Credential-Object .EXAMPLE $connection=Connect-SMAX -Url $url -Credential $cred $connection=Export-Clixml -Path ".\connection.xml" $importedConnection=Import-Clixml -Path ".\connection.xml" $secondConnection=Connect-SMAX -OldConnection $importedConnection Connect with the information from a serialized object .NOTES #> # [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '')] # [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')] [CmdletBinding(DefaultParameterSetName = "credential")] Param ( [parameter(mandatory = $true, ParameterSetName = "credential")] [string]$Url, [parameter(mandatory = $true, ParameterSetName = "credential")] [string]$Tenant, [parameter(mandatory = $true, ParameterSetName = "credential")] [pscredential]$Credential, [parameter(mandatory = $true, ParameterSetName = "oldConnection")] $OldConnection, [ValidateSet('CertificateCheck', 'HttpErrorCheck', 'HeaderValidation')] [String[]]$SkipCheck, [bool]$EnableException = $true ) if ($OldConnection) { Write-PSFMessage "Getting parameters from existing (mistyped) Connection object" $connection = Get-ARAHConnection -Url $OldConnection.ServerRoot -APISubPath "/rest/$($OldConnection.tenantId)" if ($SkipCheck) { $connection.SkipCheck = $SkipCheck } Add-Member -InputObject $connection -MemberType NoteProperty -Name "tenantId" -Value $OldConnection.tenantId Add-Member -InputObject $connection -MemberType NoteProperty -Name "psfConfPrefix" -Value $OldConnection.psfConfPrefix Set-PSFConfig -Module 'SMAX' -Name 'lastConfPrefix' -Value $OldConnection.psfConfPrefix -AllowDelete -Validation string -Description "The last connection prefix; needed for TEPP if no connection available" -PassThru | Register-PSFConfig -Scope UserDefault $token = $OldConnection.authCookie.Value $connection.ContentType = "application/json;charset=UTF-8" $connection.authenticatedUser = $OldConnection.authenticatedUser $Cookie = New-Object System.Net.Cookie $Cookie.Name = "SMAX_AUTH_TOKEN" # Add the name of the cookie $Cookie.Value = $token # Add the value of the cookie $Cookie.Domain = ([System.Uri]$OldConnection.ServerRoot).DnsSafeHost Add-Member -InputObject $connection -MemberType NoteProperty -Name "authCookie" -Value $Cookie Set-PSFConfig -Module 'SMAX' -Name 'LastConnection' -Value $connection -Description "Last known Connection" -AllowDelete return $connection } $connection = Get-ARAHConnection -Url $Url -APISubPath "/rest/$Tenant" if ($SkipCheck) { $connection.SkipCheck = $SkipCheck } Add-Member -InputObject $connection -MemberType NoteProperty -Name "tenantId" -Value $Tenant $psfConfPrefix = ("SMAX." + (([System.Uri]$connection.WebServiceRoot).DnsSafeHost -replace '\.', '_') + ".$Tenant") Add-Member -InputObject $connection -MemberType NoteProperty -Name "psfConfPrefix" -Value $psfConfPrefix Set-PSFConfig -Module 'SMAX' -Name 'lastConfPrefix' -Value $psfConfPrefix -AllowDelete -Validation string -Description "The last connection prefix; needed for TEPP if no connection available" -PassThru | Register-PSFConfig -Scope UserDefault $connection.ContentType = "application/json;charset=UTF-8" $connection.authenticatedUser = $Credential.UserName $restParam = @{ Uri = "$($connection.ServerRoot)/auth/authentication-endpoint/authenticate/token" ContentType = $connection.ContentType Method = "Post" Body = (@{login = $Credential.UserName ; password = $Credential.GetNetworkCredential().Password } | ConvertTo-Json) } $token = Invoke-RestMethod @restParam if ($null -eq $token) { Stop-PSFFunction -Message "No API Results" -EnableException $EnableException -FunctionName $functionName } $Cookie = New-Object System.Net.Cookie $Cookie.Name = "SMAX_AUTH_TOKEN" # Add the name of the cookie $Cookie.Value = $token # Add the value of the cookie $Cookie.Domain = ([System.Uri]$restParam.uri).DnsSafeHost Add-Member -InputObject $connection -MemberType NoteProperty -Name "authCookie" -Value $Cookie Set-PSFConfig -Module 'SMAX' -Name 'LastConnection' -Value $connection -Description "Last known Connection" -AllowDelete return $connection } function Convert-SMAXTimeStamp { <# .SYNOPSIS Converts SMAX Timestamps to/from DateTime objects. .DESCRIPTION Converts SMAX Timestamps to/from DateTime objects. SMAX uses Unix Timestamps in milliseconds for every date/time property. This function helps with converting those to/from a more usable format. .PARAMETER FromTimeStamp The timestamp which should be converted .PARAMETER FromDateTime The datetime object to be converted .PARAMETER FromObject The object whose properties should be converted .PARAMETER ForceResult If used, the autodetection feature will not be used .EXAMPLE Convert-SMAXTimeStamp -FromTimeStamp 1695888000000 Returns an object containing something like "Thursday, 28 September 2023 10:00:00" .EXAMPLE Convert-SMAXTimeStamp -FromDateTime (Get-Date) Returns the current timestamp .EXAMPLE $request=Get-SMAXEntity -EntityType Request -Properties CreateTime -Id 4711 $request.CreateTime Tuesday, 10 January 2023 15:16:58 Convert-SMAXTimeStamp -FromObject $request $request.CreateTime 1673360218000 Converts the propery CreateTime to/from the different formats. If you do not now the current state but the desired state use the -ForceResult parameter .NOTES General notes #> [CmdletBinding()] param ( [parameter(mandatory = $true, ParameterSetName = "FromTimeStamp")] $FromTimeStamp, [parameter(mandatory = $true, ParameterSetName = "FromDateTime")] [datetime]$FromDateTime, [parameter(mandatory = $true, ParameterSetName = "FromObject")] $FromObject, [parameter(mandatory = $false, ParameterSetName = "FromObject")] [ValidateSet('TimeStamp','DateTime')] $ForceResult ) switch ($PSCmdlet.ParameterSetName) { FromTimeStamp { $FromTimeStampSeconds = [int64][math]::Truncate([double]($FromTimeStamp) / 1000) return Get-Date -UnixTimeSeconds $FromTimeStampSeconds } FromDateTime { ([long] (Get-Date -Date $FromDateTime -UFormat %s)) * 1000 } FromObject { $hash = $FromObject | ConvertTo-PSFHashtable $dateTimeKeys = $hash.Keys | Where-Object { $_ -cmatch 'Date|Time' } foreach ($key in $dateTimeKeys) { $value = $FromObject.$key if ($value -match '^\d{12,16}$') { if ($ForceResult -eq 'TimeStamp'){continue} Write-PSFMessage "Converting Property $key from TimeStamp to DateTime" $FromObject.$key=Convert-SMAXTimeStamp -FromTimeStamp $value } elseif ($value -is [datetime]) { if ($ForceResult -eq 'DateTime') { continue } Write-PSFMessage "Converting Property $key from DateTime to TimeStamp" $FromObject.$key=Convert-SMAXTimeStamp -FromDateTime $value } else { Write-PSFMessage "No idea how to handle the property $key with the value $value" } } } } } function ConvertTo-SMAXFlatObject { <# .SYNOPSIS Converts a multi-level HashMap/Object to a single level HashMap. .DESCRIPTION Converts a multi-level HashMap/Object to a single level HashMap. .PARAMETER InputObject The original HashMap/Object .PARAMETER Prefix Should the keys get a prefix? .PARAMETER ReturnMode Either 'HashTable' or 'CustomObject' (Default) .EXAMPLE @{ hubba="Bubba" one=@{ second=@{ third="Nr3" } secondHalf="Life" } }| ConvertTo-SMAXFlatObject | ConvertTo-Json Returns { "one.secondHalf": "Life", "one.second.third": "Nr3", "hubba": "Bubba" } .NOTES General notes #> [CmdletBinding()] param ( [parameter(mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "default")] $InputObject, [string]$Prefix = $null, [ValidateSet('HashTable', 'CustomObject')] [string]$ReturnMode = "CustomObject" ) begin { } process { $result = @{} Write-PSFMessage "Prefix=$Prefix, InputObject=$($InputObject|ConvertTo-Json -Compress), result=$($result|ConvertTo-Json -Compress)" $hash = $InputObject | ConvertTo-Json -Depth 20|ConvertFrom-Json -AsHashtable foreach ($key in $hash.Keys) { if([string]::IsNullOrEmpty($Prefix)){ $newKey = $key }else{ $newKey = Join-String -InputObject $Prefix, $key -Separator '.' } if ($hash.$key -is [hashtable]) { Write-PSFMessage "Sub-Table für Key $key" $subHash = ConvertTo-SMAXFlatObject -Prefix $newKey -Input $hash.$key -ReturnMode HashTable Write-PSFMessage "subHash= $($subHash|ConvertTo-Json -Compress)" $result+= $subHash } else { $result.$newKey = $hash.$key } } if ($ReturnMode -eq 'HashTable') { return $result } return [PSCustomObject]$result } end { } } function Get-SMAXAttachement { <# .SYNOPSIS Downloads an Attachement .DESCRIPTION Downloads an Attachement .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .PARAMETER Id The ID of the attachement .PARAMETER OutFile The destination path to the file .EXAMPLE $request=Get-SMAXEntity -EntityType Request -Properties RequestAttachments -Id 483963 $attachementData=($request.RequestAttachments|ConvertFrom-Json).complexTypeProperties.properties Get-SMAXAttachement -Connection $connection -Id $attachementData.id[0] -OutFile $attachementData.file_name[0] Downloads the first attachement of the given Request .NOTES General notes #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [string]$Id, $OutFile ) $apiCallParameter = @{ EnableException = $EnableException Connection = $Connection LoggingAction = "Get-SMAXAttachement" LoggingActionValues = @($Id) method = "GET" Path = "/frs/file-list/$Id" OutFile = $OutFile } Invoke-SMAXAPI @apiCallParameter } function Get-SMAXComment { <# .SYNOPSIS Retrieves all comments of a given entity .DESCRIPTION Retrieves all comments of a given entity .PARAMETER Connection The connection to SMAX .PARAMETER EnableException If set to $true, an exception will be thrown in case of an error .PARAMETER EntityType The name of the entity .PARAMETER Id The Id of the entity .PARAMETER PrivacyType Filter the comments based on the privavy types 'Public', 'Internal' .EXAMPLE Get-SMAXComment -Connection $connection -EntityType Request -Id 374344 Retrieves all comments of Request 374344 .NOTES General notes #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [int]$Id, [ValidateSet('Public', 'Internal')] [parameter(mandatory = $false, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [string]$PrivacyType ) $apiCallParameter = @{ EnableException = $EnableException EnablePaging = $false Connection = $Connection ConvertJsonAsHashtable = $false LoggingAction = "Get-SMAXComment" LoggingActionValues = @($EntityType, $Id) method = "GET" Path = "/collaboration/comments/$EntityType/$Id" URLParameter = @{} } if($PrivacyType){ $apiCallParameter.URLParameter.PrivacyType=$PrivacyType.ToUpper() } Write-PSFMessage "`$apiCallParameter=$($apiCallParameter|ConvertTo-Json)" $result = Invoke-SMAXAPI @apiCallParameter return $result } function Get-SMAXConfPrefix { <# .SYNOPSIS Returns the PSF Config Prefix of either the already existing connection or from the last opened one. .DESCRIPTION Returns the PSF Config Prefix of either the already existing connection or from the last opened one. .PARAMETER Connection The existing connection to SMAX .EXAMPLE Get-SMAXConfPrefix Returns the internal prefix string .NOTES General notes #> [CmdletBinding()] param ( $Connection = (Get-SMAXLastConnection -EnableException $false) ) if (-not [string]::IsNullOrEmpty($Connection)){ Write-PSFMessage "Returning Prefix from Connection" return $Connection.psfConfPrefix } Write-PSFMessage "Returning Prefix from SMAX.lastConfPrefix" Get-PSFConfigValue -FullName 'SMAX.lastConfPrefix' } function Get-SMAXCurrentUser{ <# .SYNOPSIS Retrieves the current user's properties from the Micro Focus SMAX API. .DESCRIPTION The Get-SMAXCurrentUser function is used to retrieve the properties of the currently logged-in user from the Micro Focus SMAX API. It sends a GET request to the "/personalization/person/me" endpoint of the SMAX API and returns the user's properties. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER EnableException Indicates whether to enable exception handling. If set to $true (default), the function will throw exceptions on API errors. If set to $false, it will return error information as part of the result. .EXAMPLE Get-SMAXCurrentUser Description: Retrieves the current user's properties using the last saved SMAX connection and enables exception handling. .EXAMPLE Get-SMAXCurrentUser -Connection $MyConnection -EnableException $false Description: Retrieves the current user's properties using a specified SMAX connection and disables exception handling. .NOTES General notes #> param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true ) $apiCallParameter = @{ EnableException = $EnableException Connection = $Connection LoggingAction = "Get-SMAXMetaEntityDescription" # LoggingActionValues = @($addressList.count, $explicitADOM) method = "GET" Path = "/personalization/person/me" } $result = Invoke-SMAXAPI @apiCallParameter return $result.entities.properties } function Get-SMAXEntity { <# .SYNOPSIS Retrieves data entities from the Micro Focus SMAX API. .DESCRIPTION The Get-SMAXEntity function retrieves data entities from the Micro Focus SMAX API. You can specify the entity name, properties to retrieve, filtering criteria, sorting order, and other options. It supports two parameter sets: "byFilter" for filtering by criteria and "byEntityId" for retrieving a specific entity by its ID. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER EnableException Indicates whether to enable exception handling. If set to $true (default), the function will throw exceptions on API errors. If set to $false, it will return error information as part of the result. .PARAMETER EnablePaging Enables paging for large result sets. By default, paging is enabled. .PARAMETER EntityType Specifies the name of the entity to retrieve. This parameter supports tab completion using SMAX.EntityTypes. .PARAMETER Properties Specifies the properties to retrieve for the entity. This parameter supports tab completion using SMAX.EntityProperties. Use '*' to retrieve all properties or specify individual properties as an array. .PARAMETER Filter Specifies a filter criteria for selecting entities. Only applicable when using the "byFilter" parameter set. .PARAMETER Order Specifies sorting order for the retrieved entities. Only applicable when using the "byFilter" parameter set. .PARAMETER Id Specifies the ID of the entity to retrieve. Only applicable when using the "byEntityId" parameter set. .PARAMETER FlattenResult If specified, the result is flattened, and only the properties are returned. .EXAMPLE Get-SMAXEntity -EntityType "Incident" -Properties "*" -Filter "Status='New'" Description: Retrieves all properties of new incidents. .EXAMPLE Get-SMAXEntity -EntityType "User" -Properties "Name", "Email" -Order "Name" Description: Retrieves the name and email properties of users, sorted by name. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [bool]$EnablePaging = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byFilter")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $false, ValueFromPipeline = $false, ParameterSetName = "byFilter")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityProperties")] [string[]]$Properties, [parameter(mandatory = $false, ValueFromPipeline = $false, ParameterSetName = "byFilter")] [string]$Filter, [parameter(mandatory = $false, ValueFromPipeline = $false, ParameterSetName = "byFilter")] [string]$Order, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [int]$Id, [switch]$FlattenResult ) if($Properties -contains '*'){ $layout="FULL_LAYOUT" }else{ $layout = $Properties | Join-String -Separator ',' } $apiCallParameter = @{ EnableException = $EnableException EnablePaging = $EnablePaging Connection = $Connection ConvertJsonAsHashtable = $false LoggingAction = "Get-SMAXEntity" LoggingActionValues = @($EntityType, $Properties,$Filter) method = "GET" Path = "/ems/$EntityType" URLParameter = @{ layout = $layout } } switch ($PsCmdlet.ParameterSetName) { 'byEntityId'{ $apiCallParameter.Path = $apiCallParameter.Path+"/$Id" } default{ if (-not [string]::IsNullOrEmpty($Filter)) { $apiCallParameter.URLParameter.filter = $Filter } if (-not [string]::IsNullOrEmpty($Order)) { $apiCallParameter.URLParameter.order = $Order } } } Write-PSFMessage "`$apiCallParameter=$($apiCallParameter|ConvertTo-Json)" $result = Invoke-SMAXAPI @apiCallParameter | Where-Object { $_.properties} foreach ($item in $result) { Add-Member -InputObject $item.properties -MemberType NoteProperty -Name related -Value $item.related_properties $item.properties.PSObject.TypeNames.Insert(0, "SMAX.$($item.entity_type)") } if($FlattenResult){ return $result.properties|ConvertTo-SMAXFlatObject } return $result.properties } function Get-SMAXEntityAssociation { <# .SYNOPSIS Retrieves entity associations from the Micro Focus SMAX API. .DESCRIPTION The Get-SMAXEntityAssociation function retrieves associations for a specified entity from the Micro Focus SMAX API. You can specify the entity name, association type, properties to retrieve, and other options. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER EnableException Indicates whether to enable exception handling. If set to $true (default), the function will throw exceptions on API errors. If set to $false, it will return error information as part of the result. .PARAMETER EnablePaging Enables paging for large result sets. By default, paging is enabled. .PARAMETER EntityType Specifies the name of the entity for which associations are retrieved. This parameter supports tab completion using SMAX.EntityTypes. .PARAMETER Properties Specifies the properties to retrieve for the entity associations. This parameter supports tab completion using SMAX.EntityAssociationProperties. .PARAMETER Association Specifies the type of association to retrieve. This parameter supports tab completion using SMAX.EntityAssociations. .PARAMETER Id Specifies the ID of the entity for which associations are retrieved. .EXAMPLE Get-SMAXEntityAssociation -EntityType "Incident" -Association "linked_ci" -Id 123 Description: Retrieves associations of the "linked_ci" type for the incident with ID 123. .EXAMPLE Get-SMAXEntityAssociation -EntityType "Change" -Association "related_changes" -Id 456 -Properties "Title", "Status" Description: Retrieves the "Title" and "Status" properties of related changes for the change with ID 456. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [bool]$EnablePaging = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityAssociationProperties")] [string[]]$Properties, [parameter(mandatory = $false, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityAssociations")] [string]$Association, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [int]$Id ) $apiCallParameter = @{ EnableException = $EnableException EnablePaging = $EnablePaging Connection = $Connection ConvertJsonAsHashtable = $false LoggingAction = "Get-SMAXEntity" LoggingActionValues = @($EntityType, $Properties,$Filter) method = "GET" Path = "/ems/$EntityType/$id/associations/$Association" URLParameter = @{ layout = $Properties | Join-String -Separator ',' } } Write-PSFMessage "`$apiCallParameter=$($apiCallParameter|ConvertTo-Json)" $result = Invoke-SMAXAPI @apiCallParameter | Where-Object { $_.properties} foreach ($item in $result) { Add-Member -InputObject $item.properties -MemberType NoteProperty -Name related -Value $item.related_properties $item.properties.PSObject.TypeNames.Insert(0, "SMAX.$($item.entity_type)") } return $result.properties } function Get-SMAXEntityDescription { <# .SYNOPSIS Retrieves entity descriptions from the Micro Focus SMAX API. .DESCRIPTION The Get-SMAXEntityDescription function retrieves descriptions of an entity, including its properties and associations, from the Micro Focus SMAX API. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER EnableException Indicates whether to enable exception handling. If set to $true (default), the function will throw exceptions on API errors. If set to $false, it will return error information as part of the result. .PARAMETER EnablePaging Enables paging for large result sets. By default, paging is enabled. .PARAMETER EntityType Specifies the name of the entity for which descriptions are retrieved. This parameter supports tab completion using SMAX.EntityTypes. .EXAMPLE Get-SMAXEntityDescription -EntityType "Incident" Description: Retrieves descriptions of the "Incident" entity, including its properties and associations. .EXAMPLE Get-SMAXEntityDescription -EntityType "Change" Description: Retrieves descriptions of the "Change" entity, including its properties and associations. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [bool]$EnablePaging = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "default")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType ) $sb=new System.Text.StringBuilder $definitions = Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).entityDefinition" $detailsScript = { $property=$_ if ($property.logical_type -eq 'ENTITY_LINK') { "remoteType: $($property.remoteEntityName)" }elseif($property.cardinality){ "remoteType: $($property.linkEntityName)" } elseif ($property.logical_type -eq 'ENUM') { "possible values: $($property.possibleValues|ConvertTo-Json -Compress)" } } [void]$sb.AppendFormat("Entity-Type {0}", $EntityType).AppendLine() [void]$sb.AppendLine("Properties:") [void]$sb.Append(($definitions.$EntityType.properties |Select-Object name, locname, logical_type, @{name = 'details'; expression = $detailsScript } |Sort-Object -Property locname| Format-Table -Wrap | Out-String)) [void]$sb.AppendLine("Associations:") [void]$sb.Append(($definitions.$EntityType.associations | Select-Object name, locname, cardinality, @{name = 'details'; expression = $detailsScript } | Sort-Object -Property locname | Format-Table -Wrap | Out-String)) return $sb.ToString() # return $result.properties } function Get-SMAXEntityList { <# .SYNOPSIS Retrieves a list of entity names from the Micro Focus SMAX API configuration. .DESCRIPTION The Get-SMAXEntityList function retrieves a list of entity names and their localized names from the Micro Focus SMAX API configuration. This can be useful for querying available entities in the SMAX system. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .EXAMPLE Get-SMAXEntityList Description: Retrieves a list of entity names and their localized names from the SMAX configuration. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection -EnableException $false) ) return Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).tepp.EntryNames" | Select-Object @{name = "name"; expression = { $_.Text } }, @{name = "locName"; expression = { $_.ToolTip } } | Sort-Object -Property locName $fullDescription = Get-SMAXMetaEntityDescription -Connection $Connection return $fullDescription | Select-Object -Property locName, name | Sort-Object -Property locName } function Get-SMAXLastConnection { <# .SYNOPSIS Retrieves the last saved connection to the Micro Focus SMAX server. .DESCRIPTION The Get-SMAXLastConnection function retrieves the last saved connection to the Micro Focus SMAX server from the configuration. It is used to reuse previously configured connections when interacting with the SMAX API. .PARAMETER EnableException Indicates whether to enable exception handling. If set to $true (default), the function will throw an exception when there is no last saved connection. If set to $false, it will return $null when no last connection is available. .EXAMPLE Get-SMAXLastConnection Description: Retrieves the last saved connection to the Micro Focus SMAX server. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [bool]$EnableException = $true ) $connection = Get-PSFConfigValue -FullName 'SMAX.LastConnection' if ($null -eq $connection -and $EnableException){ throw "No last connection available" } return $connection } function Get-SMAXUserOption { <# .SYNOPSIS Retrieves user options of an entity from the Micro Focus SMAX API. .DESCRIPTION The Get-SMAXUserOption function retrieves user options for a specified user ID from the Micro Focus SMAX API. User options are used to store user-specific settings and preferences. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER EnableException Indicates whether to enable exception handling. If set to $true (default), the function will throw exceptions on API errors. If set to $false, it will return error information as part of the result. .PARAMETER Id Specifies the ID of the user options for whom further information is retrieved. .EXAMPLE $request=Get-SMAXEntity -EntityType Request -Properties UserOptionsName -Id 123 Get-SMAXUserOption -Id $request.UserOptionsName Description: Retrieves user options for the Request with ID "12345" from the SMAX server. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byId")] [string]$Id ) $apiCallParameter = @{ EnableException = $EnableException Connection = $Connection ConvertJsonAsHashtable = $false LoggingAction = "Get-SMAXUserOption" LoggingActionValues = @($Id) method = "GET" Path = "/user-options/full/$Id" } Write-PSFMessage "`$apiCallParameter=$($apiCallParameter|ConvertTo-Json)" $result = Invoke-SMAXAPI @apiCallParameter #| Where-Object { $_.properties} return $result } function Initialize-SMAXEntityModel { <# .SYNOPSIS Initializes the Micro Focus SMAX entity model for improved performance. .DESCRIPTION The Initialize-SMAXEntityModel function initializes the entity model for the Micro Focus SMAX API. It retrieves and processes entity definitions, properties, associations, and translations from the SMAX server's metadata. The resulting data is stored in the PSFramework configuration for improved performance and ease of use when working with SMAX entities. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER EnableException Indicates whether to enable exception handling. If set to $true (default), the function will throw exceptions on API errors. If set to $false, it will return error information as part of the result. .PARAMETER Persist If specified, the configuration settings for the SMAX entity model will be persisted in the user's default configuration scope. .PARAMETER ExportDevJson If specified, the configuration settings for the SMAX entity model will be exported to JSON files for development and debugging purposes. .EXAMPLE Initialize-SMAXEntityModel -Connection $MyConnection -Persist -ExportDevJson Description: Initializes the SMAX entity model using a specific SMAX connection, persists the configuration settings, and exports them to JSON files for development. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [switch]$Persist, [switch]$ExportDevJson ) $prefix = Get-SMAXConfPrefix -Connection $Connection $apiCallParameter = @{ EnableException = $EnableException Connection = $Connection LoggingAction = "Get-SMAXMetaEntityDescription" # LoggingActionValues = @($addressList.count, $explicitADOM) method = "GET" Path = "/metadata/ui/entity-descriptors" } $result = Invoke-SMAXAPI @apiCallParameter $fullEntityDescription = $result.entity_descriptors | Where-Object domain -NotMatch 'sample' Set-PSFConfig -FullName "$prefix.fullEntityDescription" -Value $fullEntityDescription -AllowDelete -Description "The complete entity metadata for the given server and tennant." Set-PSFConfig -FullName "$prefix.possibleEntityNames" -Value $fullEntityDescription.Name -AllowDelete -Description "The complete list of entity names" $translation = Get-SMAXMetaTranslation -Connection $Connection Set-PSFConfig -FullName "$prefix.translation" -Value $translation -AllowDelete -Description "The translation dictionary" $parsedDefinitions = @{} foreach ($entity in $fullEntityDescription) { $name = $entity.name $newDefinition = @{} $parsedDefinitions.$name = $newDefinition $newDefinition.name = $name $newDefinition.locName = $translation.($entity.localized_label_key) $propertyList = New-Object System.Collections.ArrayList foreach ($property in $entity.property_descriptors) { $newProp = $property | ConvertTo-PSFHashtable -Include name, domain, required, readonly, logical_type $newProp.locName = $translation.($property.localized_label_key) switch ($property.logical_type) { 'BOOLEAN' {} 'COMPLEX_TYPE' {} 'DATE_TIME' {} 'DOUBLE' {} 'ENUM_SET' {} 'INTEGER' {} 'LARGE_TEXT' {} 'MEDIUM_TEXT' {} 'RICH_TEXT' {} 'SMALL_TEXT' {} 'ENUM' { $newProp.enumName = $property.enumeration_descriptor.name $newProp.locEnumName = $translation.($property.enumeration_descriptor.localized_label_key) $possibleEnumValues = @{} foreach ($enum in $property.enumeration_descriptor.values) { $possibleEnumValues."$($enum.name)" = $translation.($enum.localized_label_key) } $newProp.possibleValues = [PSCustomObject]$possibleEnumValues } 'ENTITY_LINK' { $newProp.linkEntityName = $property.relation_descriptor.name $newProp.locLinkEntityName = $translation.($property.relation_descriptor.localized_label_key) $newProp.cardinality = $property.relation_descriptor.cardinality $newProp.remoteEntityName = $property.relation_descriptor.second_endpoint_entity_name } } $propertyList.Add([PSCustomObject]$newProp) | Out-Null } $newDefinition.properties = $propertyList.ToArray() $associationsList = New-Object System.Collections.ArrayList foreach ($relation in $entity.relation_descriptors) { $newRelation = $relation | ConvertTo-PSFHashtable -Include name, domain, cardinality $newRelation.locName = $translation.($relation.localized_label_key) $newRelation.linkEntityName = $relation.second_endpoint_entity_name $associationsList.Add([PSCustomObject]$newRelation) | Out-Null } $newDefinition.associations = $associationsList.ToArray() } Set-PSFConfig -FullName "$prefix.entityDefinition" -Value $parsedDefinitions -AllowDelete -Description "The parsed entity definitions" $teppEntryNames = @() $teppEntryProperties = @{} $teppAssociations=@{} $teppAssociationProperties=@{} foreach ($name in $parsedDefinitions.Keys) { $teppEntryNames += @{Text = $name; ToolTip = $parsedDefinitions.$name.locname } $teppEntryProperties.$name = @() foreach ($property in $parsedDefinitions.$name.properties) { $propName = $property.name $locName = $property.locname $teppEntryProperties.$name += @{Text = $propName; ToolTip = $locName } if ($property.logical_type -eq "ENTITY_LINK") { $linkEntityName = $property.remoteEntityName # Write-Host "Ergänze Props von $propName des Typs $linkEntityName" $subProperties = @() foreach ($subProperty in $parsedDefinitions.$linkEntityName.properties) { $subProperties += @{Text = "$($propName).$($subProperty.name)"; ToolTip = $subProperty.locName } # Write-PSFMessage "`$teppEntryProperties.`"$name.$propName`"+=$(@{Text = "$($propName).$($subProperty.name)"; ToolTip = $subProperty.locName }|ConvertTo-Json -Compress)" } $teppEntryProperties."$name.$propName" = $subProperties } } # Save the Associations $teppAssociations.$name=@() Write-PSFMessage "Query Association für $name" foreach ($association in $parsedDefinitions.$name.associations) { $teppAssociations.$name += @{Text = $association.name; ToolTip = $association.locName } $assPropList = New-Object System.Collections.ArrayList $linkEntityName = $association.linkEntityName # Write-PSFMessage -Level Host "`$parsedDefinitions.$linkEntityName.properties" foreach ($subProperty in $parsedDefinitions.$linkEntityName.properties) { $assPropList.Add(@{Text = "$($subProperty.name)"; ToolTip = $subProperty.locName })|Out-Null } $teppAssociationProperties."$name.$($association.name)" = $assPropList.ToArray() } } Set-PSFConfig -FullName "$prefix.tepp.EntryNames" -Value $teppEntryNames -AllowDelete -Description "The suggestions for Entrynames" Set-PSFConfig -FullName "$prefix.tepp.EntryProperties" -Value $teppEntryProperties -AllowDelete -Description "The suggestions for Entry Property Names" Set-PSFConfig -FullName "$prefix.tepp.EntityAssociations" -Value $teppAssociations -AllowDelete -Description "The suggestions for Entry Association Names" Set-PSFConfig -FullName "$prefix.tepp.EntityAssociationProperties" -Value $teppAssociationProperties -AllowDelete -Description "The suggestions for Entry Association Property Names" if ($Persist) { $configs=Get-PSFConfig | Where-Object fullname -like "$prefix*" Write-PSFMessage "Register configs: $($configs.FullName -join ',')" Register-PSFConfig -config $configs $_ -Scope UserDefault } if ($ExportDevJson) { $cfgFullNames=Get-PSFConfig | Where-Object fullname -like "$prefix*" | Select-Object -ExpandProperty FullName foreach($cfgName in $cfgFullNames){ $filename = Join-Path $moduleRoot "en-us" (($cfgName -replace "SMAX.") + '.json') Write-PSFMessage -Level Host "Exporting PSFConfig $cfgName to $filename" Get-PSFConfigValue -FullName $cfgName|ConvertTo-Json -Depth 10 |Out-File -FilePath $filename -Force } } } function Invoke-SMAXAPI { <# .SYNOPSIS Invokes the Micro Focus SMAX API to perform various operations. .DESCRIPTION The Invoke-SMAXAPI function is used to interact with the Micro Focus SMAX API to perform operations such as retrieving data, creating entities, updating entities, and more. It supports various HTTP methods and provides options for handling API responses. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER Path Specifies the API endpoint path for the operation. .PARAMETER Body Specifies the request body for the API operation. Hashtables are Converted to the POST body by using ConvertTo-Json .PARAMETER Header Specifies custom HTTP headers for the API request. .PARAMETER URLParameter Specifies URL parameters for the API request; Converted to the GET URL parameter set. Example: { id=4 name=Jon Doe } will result in "?id=4&name=Jon%20Doe" being added to the URL Path .PARAMETER Method Specifies the HTTP request method (e.g., GET, POST, PUT, DELETE). .PARAMETER EnableException Indicates whether to enable exception handling. If set to $true (default), the function will throw exceptions on API errors. If set to $false, it will return error information as part of the result. .PARAMETER EnablePaging Enables paging for large result sets. By default, paging is disabled. .PARAMETER LoggingAction Specifies the name of the logging action for tracking purposes. .PARAMETER LoggingLevel Specifies the logging level for the API operation. Valid values are: Critical, Important, Output, Host, Significant, VeryVerbose, Verbose, SomewhatVerbose, System, Debug, InternalComment, and Warning. .PARAMETER ConvertJsonAsHashtable If specified, the JSON response from the API is converted into a hashtable. .PARAMETER OutFile Specifies a file path to which the API response is saved. .PARAMETER LoggingActionValues Additional values to be associated with the logging action. .EXAMPLE $response = Invoke-SMAXAPI -Connection $MyConnection -Path "/incidents/123" -Method Get Description: Sends a GET request to retrieve information about incident ID 123. .EXAMPLE $requestBody = @{ "Title" = "New Incident" "Description" = "This is a new incident." } $response = Invoke-SMAXAPI -Connection $MyConnection -Path "/incidents" -Method Post -Body $requestBody Description: Sends a POST request to create a new incident with the specified request body. .NOTES Date: September 28, 2023 #> [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Medium')] param ( $Connection = (Get-SMAXLastConnection), [string]$Path, $Body, [Hashtable] $Header, [Alias("Query")] [Hashtable] $URLParameter, [parameter(mandatory = $true)] [Microsoft.Powershell.Commands.WebRequestMethod]$Method, [bool]$EnableException = $true, [bool]$EnablePaging = $false, [string]$LoggingAction = "Invoke-SMAXAPI", [ValidateSet("Critical", "Important", "Output", "Host", "Significant", "VeryVerbose", "Verbose", "SomewhatVerbose", "System", "Debug", "InternalComment", "Warning")] [string]$LoggingLevel = (Get-PSFConfigValue -FullName "SMAX.Logging.Api" -Fallback "Verbose"), [switch]$ConvertJsonAsHashtable, [string]$OutFile, [string[]]$LoggingActionValues = "" ) if (-not $Connection) { Write-PSFMessage "Keine Connection als Parameter erhalten, frage die letzte ab" $Connection = Get-SMAXLastConnection -EnableException $EnableException if (-not $Connection) { Stop-PSFFunction "No last connection available" -EnableException $EnableException -AlwaysWarning return } } if ($connection.GetType().Name -ne 'ARAHConnection') { Write-PSFMessage -Level Host "Wandle Connection aus OldConnection um" $Connection = Connect-SMAX -OldConnection $Connection } else { Write-PSFMessage -Level Host "Wandle Connection aus OldConnection NICHT um" } $apiCallParameter = $PSBoundParameters | ConvertTo-PSFHashtable -Exclude LoggingActionValues, RevisionNote, LoggingAction if ($EnablePaging) { $apiCallParameter.PagingHandler = 'SMAX.PagingHandler' } $connection.WebSession.Cookies = [System.Net.CookieContainer]::new() $connection.WebSession.Cookies.Add($Connection.authCookie) Invoke-PSFProtectedCommand -ActionString "APICall.$LoggingAction" -ActionStringValues (, $requestId + $LoggingActionValues) -ScriptBlock { $result = Invoke-ARAHRequest @apiCallParameter #-Verbose -PagingHandler 'SMAX.PagingHandler' } -PSCmdlet $PSCmdlet -EnableException $false -Level $LoggingLevel if ((Test-PSFFunctionInterrupt) -and $EnableException) { Throw "API-Error, statusCode: $statusCode, Message $($result.result.status.Message)" #-EnableException $true -StepsUpward 3 #-AlwaysWarning } return $result } function New-SMAXComment { <# .SYNOPSIS Creates a new comment object for Micro Focus SMAX. .DESCRIPTION The New-SMAXComment function is used to create a new comment object for use with Micro Focus SMAX. Comments are typically used to provide updates and communication within the SMAX system. .PARAMETER ActualInterface Specifies the actual interface through which the comment is made. Valid values are SAW, ESS, EMAIL, API, and SYSTEM. Default is "API". .PARAMETER Body Specifies the text content of the comment. .PARAMETER CommentFrom Specifies the source of the comment. Valid values are Agent, ExternalServiceDesk, SocialUser, System, User, and Vendor. Default is "System". .PARAMETER CommentTo Specifies the target of the comment. Valid values are Agent, ExternalServiceDesk, Stakeholder, User, and Vendor. Default is "Agent". .PARAMETER CompanyVendor Specifies the company or vendor related to the comment. .PARAMETER FunctionalPurpose Specifies the functional purpose of the comment. Valid values include Diagnosis, EndUserComment, FollowUp, ProvideInformation, RequestMoreInformation, Resolution, ResolutionActivity, and StatusUpdate. .PARAMETER Group Specifies the group associated with the comment. .PARAMETER IsSystem Indicates whether the comment is system-generated. Default is $false. If set to $true the comment will get readonly. .PARAMETER Media Specifies the media through which the comment is made. Valid values include Email, Fax, InstantMessage, InternalChat, Phone, UI, and Unknown. Default is "Unknown". .PARAMETER PersonParticipant Specifies the person or participant associated with the comment. .PARAMETER PrivacyType Specifies the privacy type of the comment. Valid values include INTERNAL, PUBLIC, and AGENTPUBLIC. Default is "PUBLIC". .PARAMETER Submitter Specifies the ID of the user who submitted the comment. .EXAMPLE $comment = New-SMAXComment -Body "This is a comment" -CommentFrom "User" -CommentTo "Agent" Description: Creates a new comment object with the specified content, sender, and target. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [ValidateSet("SAW", "ESS", "EMAIL", "API", "SYSTEM")] [parameter(mandatory = $false, ParameterSetName = "default")] [string]$ActualInterface = "API", [parameter(mandatory = $true, ParameterSetName = "default")] [string]$Body, [ValidateSet("Agent", "ExternalServiceDesk", "SocialUser", "System", "User", "Vendor")] [parameter(mandatory = $false, ParameterSetName = "default")] [string]$CommentFrom = "System", [ValidateSet("Agent", "ExternalServiceDesk", "Stakeholder", "User", "Vendor")] [parameter(mandatory = $false, ParameterSetName = "default")] [string]$CommentTo = "Agent", [parameter(mandatory = $false, ParameterSetName = "default")] [string]$CompanyVendor, [ValidateSet("Diagnosis", "EndUserComment", "FollowUp", "ProvideInformation", "RequestMoreInformation", "Resolution", "ResolutionActivity", "StatusUpdate")] [parameter(mandatory = $true, ParameterSetName = "default")] [string]$FunctionalPurpose, [parameter(mandatory = $false, ParameterSetName = "default")] [string]$Group, [parameter(mandatory = $false, ParameterSetName = "default")] [bool]$IsSystem = $false, [ValidateSet("Email", "Fax", "InstantMessage", "InternalChat", "Phone", "UI", "Unknown")] [parameter(mandatory = $false, ParameterSetName = "default")] [string]$Media = "Unknown", [parameter(mandatory = $false, ParameterSetName = "default")] [string]$PersonParticipant, [ValidateSet("INTERNAL", "PUBLIC", "AGENTPUBLIC")] [parameter(mandatory = $false, ParameterSetName = "default")] [string]$PrivacyType = "PUBLIC", [parameter(mandatory = $false, ParameterSetName = "default")] [int]$Submitter ) $data = @{ 'ActualInterface' = "$ActualInterface" 'AttachmentIds' = @($AttachmentIds) 'Body' = "$Body" 'CommentFrom' = "$CommentFrom" 'CommentTo' = "$CommentTo" 'CompanyVendor' = "$CompanyVendor" 'FunctionalPurpose' = "$FunctionalPurpose" 'Group' = "$Group" 'IsSystem' = $IsSystem 'Media' = "$Media" 'PersonParticipant' = "$PersonParticipant" 'PrivacyType' = "$PrivacyType" } if ([string]::IsNullOrEmpty($data.AttachmentIds)) { $data.AttachmentIds = @() } if ($Submitter -gt 0) { $data.Submitter = @{UserId = $Submitter } } return $data } function New-SMAXEntity { <# .SYNOPSIS Creates an empty entity object for Micro Focus SMAX. .DESCRIPTION The New-SMAXEntity function is used to create an empty entity object for use with Micro Focus SMAX. It generates an object with the specified entity type and includes all required properties. You can also select optional properties to include in the object. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER EntityType Specifies the name of the entity type for which the empty object is created. .PARAMETER Properties Specifies an array of property names to include in the empty entity object. .PARAMETER ReturnMode Specifies the return mode for the generated object. Valid values are HashTable, Definition, and DefinitionCopyToClipboard. Default is HashTable. .EXAMPLE $emptyEntity = New-SMAXEntity -EntityType "Incident" -Properties "Title", "Description" Description: Creates an empty incident entity object with the specified properties. .EXAMPLE $emptyEntityDef = New-SMAXEntity -EntityType "Change" -Properties "Title", "ScheduledStartDate" -ReturnMode "Definition" Description: Generates a definition of an empty change entity object with specific properties. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityProperties")] [string[]]$Properties, [ValidateSet('HashTable', 'Definition', 'DefinitionCopyToClipboard')] [string]$ReturnMode = "HashTable" ) Write-PSFMessage "Creating empty entity of type $EntityType with all required properties" $definitions = Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).entityDefinition" if (-not $definitions.containskey($EntityType)) { Write-PSFMessage -Level Critical "Entitytype $EntityType not defined" return } $allPossibleProperties = $definitions.$EntityType.properties $mandatoryProperties = $allPossibleProperties | Where-Object required -eq $true $optionalProperties = $allPossibleProperties | Where-Object required -eq $false $nonExistingProperties = $Properties | Where-Object { ($_ -notin $allPossibleProperties.name) } $alreadyMandatoryProperties = $Properties | Where-Object { ($_ -in $mandatoryProperties.name) } if (-not [string]::IsNullOrEmpty($alreadyMandatoryProperties)) { Write-PSFMessage -Level Warning "The following properties are mandatory and therefor already included: $($alreadyMandatoryProperties -join ',')" } if (-not [string]::IsNullOrEmpty($nonExistingProperties)) { Write-PSFMessage -Level Warning "The following properties do not exist for Entities of type $($EntityType): $($nonExistingProperties -join ',')" } $propertiesToInclude = ($mandatoryProperties + ($optionalProperties | Where-Object name -in $Properties)) | Sort-Object -Property Name switch -Regex ($ReturnMode){ '^HashTable$'{ $result=@{} foreach ($key in $propertiesToInclude.name) { $result.$key="" } } 'Definition'{ $padLeft = ($propertiesToInclude.name | Measure-Object -Maximum -Property Length).Maximum $sb = [System.Text.StringBuilder]::new() [void]$sb.AppendLine( "`$$EntityType=@{" ) [void]$sb.AppendFormat( " # {0,$(-$padLeft+2)} = `"{1}`" # Uncomment if converted to [PSCustomObject] later", @("PSTypeName", "SMAX.$EntityType") ) [void]$sb.AppendLine( ) foreach ($prop in $propertiesToInclude) { [void]$sb.AppendFormat( " {0,-$padLeft} = `"`" # {1}", @($prop.name,$prop.locname) ) if ($prop.required -eq $true) { [void]$sb.Append(', mandatory')} [void]$sb.AppendLine( ) } [void]$sb.AppendLine( "}" ) $result=$sb.ToString() Write-PSFMessage "New Definition=`r$result" if ($_ -match 'CopyToClipboard'){ Write-PSFMessage -Level Host "Definition copied to clipboard" $result|Set-Clipboard } } } return $result } function Optimize-SMAXUserOptions { <# .SYNOPSIS Optimizes user options data obtained from Micro Focus SMAX. .DESCRIPTION The Optimize-SMAXUserOptions function is used to optimize user options data obtained from Micro Focus SMAX. It takes the user options data as input and retrieves the corresponding user options definition to map and label the properties for better readability. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER EnableException Indicates whether exceptions should be enabled. Default is $true. .PARAMETER UserOptions Specifies the user options data to optimize. .EXAMPLE $request=Get-SMAXEntity -EntityType Request -Properties UserOptions -Id 123 $optimizedData = Optimize-SMAXUserOptions -Useroptions $request.useroptions Description: Retrieves user options data from SMAX Request 123 and optimizes it for better readability. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [string]$UserOptions ) $optionsTable = ($UserOptions | ConvertFrom-Json -AsHashtable).complexTypeProperties.properties $UserOptionsType = $optionsTable.DynamicComplexTypeRefName_c $uoDef = Get-SMAXUserOption -Connection $Connection -Id $UserOptionsType $results = [ordered]@{} foreach ($key in $uoDef.userOptionsDescriptor.userOptionsPropertyDescriptors.name) { if ($optionsTable.$key -eq $UserOptionsType) { Continue } $localizationKey = ($uoDef.userOptionsDescriptor.userOptionsPropertyDescriptors | Where-Object name -eq $key).localized_label_key $results.$key = [PSCustomObject]@{ name = $key label = $uoDef.localizedLabels.$localizationKey value = $optionsTable.$key } } return $results } function Remove-SMAXAssociation { <# .SYNOPSIS Removes an association between entities in Micro Focus SMAX. .DESCRIPTION The Remove-SMAXAssociation function allows you to remove an association between entities in Micro Focus SMAX. You can remove a single association or perform bulk association removal by specifying parameters accordingly. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER EnableException Indicates whether exceptions should be enabled. Default is $true. .PARAMETER EntityType Specifies the name of the entity for which the association needs to be removed. .PARAMETER EntityId Specifies the ID of the entity from which the association originates. .PARAMETER RemoteId Specifies the ID of the remote entity involved in the association. .PARAMETER Association Specifies the type of association to be removed. .PARAMETER BulkID Specifies the bulk operation ID when performing bulk association removal. .PARAMETER ExecuteBulk Indicates whether to execute the bulk association removal operation. .EXAMPLE # Remove a single association between two entities. Remove-SMAXAssociation -EntityType "Incident" -EntityId 123 -RemoteId 456 -Association "RelatedIncident" Description: Removes the "RelatedIncident" association between the Incident with EntityId 123 and the Incident with EntityId 456. .EXAMPLE # Build a bulk association removal operation. $bulkParams = @{ EntityType = "Change" EntityId = 789 RemoteId = 987 Association = "RelatedChange" BulkID = "BulkOperation123" } Remove-SMAXAssociation @bulkParams $bulkParams = @{ EntityType = "Change" EntityId = 789 RemoteId = 123 Association = "RelatedChange" BulkID = "BulkOperation123" } Remove-SMAXAssociation @bulkParams Remove-SMAXAssociation -BulkID "BulkOperation123" -ExecuteBulk Description: Builds a bulk association removal operation to remove the "RelatedChange" association between the Change with EntityId 789 and the Change with EntityId 987 and 123 in a single web request. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [int]$EntityId, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [int]$RemoteId, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "singleAssociation")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityAssociations")] [string]$Association, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "executeBulk")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "BuildBulk")] [string]$BulkID, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "executeBulk")] [switch]$ExecuteBulk ) $bulkParameter = $PSBoundParameters | ConvertTo-PSFHashtable $bulkParameter.Operation = 'Delete' Edit-SMAXAssociation @bulkParameter } function Remove-SMAXComment { <# .SYNOPSIS Removes a comment associated with an entity in Micro Focus SMAX. .DESCRIPTION The Remove-SMAXComment function allows you to remove a comment associated with an entity in Micro Focus SMAX. You can remove a comment either by specifying the entity and comment details or by providing the entity's ID and the comment's ID. .PARAMETER Connection Specifies the connection to the Micro Focus SMAX server. If not provided, it will use the last saved connection obtained using the Get-SMAXLastConnection function. .PARAMETER EnableException Indicates whether exceptions should be enabled. Default is $true. .PARAMETER EntityType Specifies the name of the entity for which the comment needs to be removed. Use this parameter in the "byEntity" parameter set. .PARAMETER Id Specifies the ID of the entity for which the comment needs to be removed. Use this parameter in the "byEntity" parameter set. .PARAMETER Comment Specifies the comment object to be removed. Use this parameter in the "byEntity" parameter set. The object must include the .Id property .PARAMETER CommentId Specifies the ID of the comment to be removed. Use this parameter in the "byEntityId" parameter set. .EXAMPLE # Remove a comment associated with an entity using the entity's details. $commentObject = @{ id = "123456" body = "This is a test comment." } Remove-SMAXComment -EntityType "Incident" -Id "789" -Comment $commentObject Description: Removes the comment specified by the comment object associated with the Incident with ID 789. .EXAMPLE # Remove a comment associated with an entity using the entity's ID and comment's ID. Remove-SMAXComment -EntityType "Change" -CommentId "987654" -Id "456" Description: Removes the comment with ID 987654 associated with the Change with ID 456. .NOTES Date: September 28, 2023 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntity")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntity")] [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [string]$Id, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntity")] $Comment, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] $CommentId ) if ($Comment){ $CommentId=$Comment.id } if ([string]::IsNullOrEmpty($CommentId)) { Stop-PSFFunction -EnableException $EnableException -Message "CommentId empty or missing" return } $apiCallParameter = @{ EnableException = $EnableException Connection = $Connection ConvertJsonAsHashtable = $false LoggingAction = "Remove-SMAXComment" LoggingActionValues = @( $CommentId, $Id, $EntityType) method = "DELETE" Path = "/collaboration/comments/$EntityType/$Id/$CommentId" # body = $Comment|ConvertTo-PSFHashtable } Write-PSFMessage "`$apiCallParameter=$($apiCallParameter|ConvertTo-Json -Depth 5)" $result = Invoke-SMAXAPI @apiCallParameter #| Where-Object { $_.properties} Write-PSFMessage "`$result=$($result|ConvertTo-Json -Depth 5)" return $result } function Update-SMAXComment { <# .SYNOPSIS Updates a comment in the Service Management Automation X (SMAX) platform. .DESCRIPTION The Update-SMAXComment function allows you to update an existing comment in SMAX. You can modify various properties of the comment using this function, such as its body or privacy settings. .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .PARAMETER EntityType Specifies the name of the entity associated with the comment. .PARAMETER Id Specifies the ID of the entity associated with the comment. .PARAMETER Comment Specifies the comment to update. This should be a comment object obtained from SMAX. .EXAMPLE PS C:\> $comment = Get-SMAXComment -Connection $conn -EntityType "Incident" -Id "123" -CommentId "456" PS C:\> $comment.Body = "Updated comment body" PS C:\> Update-SMAXComment -Connection $conn -EntityType "Incident" -Id "123" -Comment $comment This example retrieves a comment associated with an incident, updates its body, and then applies the changes to the SMAX platform. .NOTES File Name : Update-SMAXComment.ps1 #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [string]$Id, [parameter(mandatory = $true, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] $Comment ) if ([string]::IsNullOrEmpty($Comment.id)) { Stop-PSFFunction -EnableException $EnableException -Message "Comment.Id empty or missing" return } $apiCallParameter = @{ EnableException = $EnableException Connection = $Connection ConvertJsonAsHashtable = $false LoggingAction = "Update-SMAXComment" LoggingActionValues = @( $comment.ID, $Id, $EntityType) method = "PUT" Path = "/collaboration/comments/$EntityType/$Id/$($Comment.Id)" body = $Comment|ConvertTo-PSFHashtable } Write-PSFMessage "`$apiCallParameter=$($apiCallParameter|ConvertTo-Json -Depth 5)" $result = Invoke-SMAXAPI @apiCallParameter #| Where-Object { $_.properties} Write-PSFMessage "`$result=$($result|ConvertTo-Json -Depth 5)" return $result } function Update-SMAXEntity { <# .SYNOPSIS Updates entities in the Service Management Automation X (SMAX) platform. .DESCRIPTION The Update-SMAXEntity function allows you to update one or more entities in SMAX. You can specify the entity name and provide an array of input objects to update. .PARAMETER Connection Specifies the SMAX connection to use. If not provided, it uses the last established connection. .PARAMETER EnableException Indicates whether exceptions should be enabled. By default, exceptions are enabled. .PARAMETER EntityType Specifies the name of the entity to update. This parameter is optional if the PSCustomObject has a PSTypeName 'SMAX.{EntityType}' .PARAMETER InputObject Specifies the entities to update. You can provide an array of SMAX entity objects. They have to be from the same type .EXAMPLE PS C:\> $entity = Get-SMAXEntity -Connection $conn -EntityType "Incident" -Id "123" -Properties * PS C:\> $entity.Status = "Closed" PS C:\> Update-SMAXEntity -Connection $conn -EntityType "Incident" -InputObject $entity This example retrieves an incident entity, updates its status to "Closed," and then applies the changes to the SMAX platform. .NOTES File Name : Update-SMAXEntity.ps1 #> <# .SYNOPSIS Updates existing entities. .DESCRIPTION Updates existing entities. .PARAMETER Connection The connection to SMAX .PARAMETER EnableException If set to $true, an exception will be thrown in case of an error .PARAMETER EntityType The name of the entity (N). Can be ommited if the PSCustomObject has a PSTypeName 'SMAX.{EntityType}' .PARAMETER InputObject The new object to be created. Either a CustomObject or a HashTable with the new properties. .EXAMPLE $request=Get-SMAXEntity -Connection $connection -EntityType Request -Id 47 # ... Setting the properties $request|Update-SMAXEntity -Connection $connection -EntityType Request .NOTES General notes #> [CmdletBinding()] param ( [parameter(Mandatory = $false)] $Connection = (Get-SMAXLastConnection), [bool]$EnableException = $true, [parameter(mandatory = $false, ValueFromPipeline = $false, ParameterSetName = "byEntityId")] [PSFramework.TabExpansion.PsfArgumentCompleterAttribute("SMAX.EntityTypes")] [string]$EntityType, [parameter(mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "byEntityId")] [object[]]$InputObject ) begin { $entityList = @() $bulkParameter = $PSBoundParameters | ConvertTo-PSFHashtable -Exclude LoggingActionValues, RevisionNote, LoggingAction, InputObject $bulkParameter.Operation = 'Update' # $InputObject | ForEach-Object { "BeginUpdate $($_.Id), Typenames= $($_.psobject.TypeNames -join ',')" | Out-Host } # Write-PSFMessage "BeginUpdate `$InputObject.Gettype(): $($InputObject.GetType())" } process { $entityList += $InputObject } end { $bulkParameter.InputObject = $entityList # $bulkParameter.InputObject | ForEach-Object { "EndUpdate $($_.Id), Typenames= $($_.psobject.TypeNames -join ',')" | Out-Host } Invoke-SMAXBulk @bulkParameter } } <# This is an example configuration file By default, it is enough to have a single one of them, however if you have enough configuration settings to justify having multiple copies of it, feel totally free to split them into multiple files. #> <# # Example Configuration Set-PSFConfig -Module 'SMAX' -Name 'Example.Setting' -Value 10 -Initialize -Validation 'integer' -Handler { } -Description "Example configuration setting. Your module can then use the setting using 'Get-PSFConfigValue'" #> Set-PSFConfig -Module 'SMAX' -Name 'Import.DoDotSource' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be dotsourced on import. By default, the files of this module are read as string value and invoked, which is faster but worse on debugging." Set-PSFConfig -Module 'SMAX' -Name 'Import.IndividualFiles' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be imported individually. During the module build, all module code is compiled into few files, which are imported instead by default. Loading the compiled versions is faster, using the individual files is easier for debugging and testing out adjustments." <# Stored scriptblocks are available in [PsfValidateScript()] attributes. This makes it easier to centrally provide the same scriptblock multiple times, without having to maintain it in separate locations. It also prevents lengthy validation scriptblocks from making your parameter block hard to read. Set-PSFScriptblock -Name 'SMAX.ScriptBlockName' -Scriptblock { } #> Set-PSFScriptblock -Name 'SMAX.PagingHandler' -Scriptblock { # $EnablePaging -eq $true $logTagName = "SMAX.PagingHandler" Write-PSFMessage "Start SMAX.PagingHandler" -FunctionName 'SMAX.PagingHandler' try { if (-not ($result.meta)) { Write-PSFMessage "Paging enabled, but no meta.total_count result" -Level Warning -FunctionName $logTagName } else { $totalCount = $result.meta.total_count Write-PSFMessage "Paging enabled, starting loop, totalCount=$totalCount" -ModuleName ServiceManagementX -FunctionName 'SMAX.PagingHandler' $allItems = $result.entities $resultCount = ($result.entities | Measure-Object).count $allItemsCount = ($allItems | Measure-Object).count write-psfmessage "Current Item-Count: $allItemsCount" -ModuleName ServiceManagementX -FunctionName 'SMAX.PagingHandler' # If no Page was given as a parameter then the returned object count as the configured size if (!($UrlParameter.size)) { $UrlParameter.size = $resultCount } # If no Page was given as a parameter then it was page 1 we just requested if (!($UrlParameter.skip)) { $UrlParameter.skip = 0 } while ($totalCount -gt $allItems.count -and $result.meta.completion_status -eq 'OK') { # Fetch the next page of items $UrlParameter.skip = $allItems.count Write-PSFMessage "totalCount=$totalCount -gt allItems.count=$($allItems.count)" -ModuleName ServiceManagementX -FunctionName 'SMAX.PagingHandler' $nextParameter = @{ Connection = $Connection Path = $Path Body = $Body UrlParameter = $UrlParameter Method = $Method LoggingAction = "Paging" LoggingActionValues = @($allItems.count,$totalCount) # NO EnablePaging in the next Call } write-psfmessage "InvokeAPI with Params= $($nextParameter|convertto-json -depth 10)" -Level Debug -ModuleName ServiceManagementX -FunctionName 'SMAX.PagingHandler' $result = Invoke-SMAXAPI @nextParameter $allItems += ($result.entities) } if ($result.meta.completion_status -ne 'OK') { Write-PSFMessage -Level Warning "completion_status NOT OK, $($result.meta |ConvertTo-Json -Compress)" } return $allItems } } catch { Write-PSFMessage "$_" -ErrorRecord $_ -Tag "Catch" } } <# # Example: Register-PSFTeppScriptblock -Name "SMAX.alcohol" -ScriptBlock { 'Beer','Mead','Whiskey','Wine','Vodka','Rum (3y)', 'Rum (5y)', 'Rum (7y)' } #> Register-PSFTeppScriptblock -Name "SMAX.EntityAssociationProperties" -ScriptBlock { try { if ([string]::IsNullOrEmpty($fakeBoundParameter.Connection)){ $connection = Get-SMAXLastConnection -EnableException $false }else{ $connection = $fakeBoundParameter.Connection } $EntityType = $fakeBoundParameter.EntityType $associationName = $fakeBoundParameter.Association if ([string]::IsNullOrEmpty($EntityType)) { return } if ([string]::IsNullOrEmpty($associationName)) { return } $definitions = Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).tepp.EntityAssociationProperties" if (-not $definitions.containskey("$EntityType.$associationName")) { return } return $definitions."$EntityType.$associationName" } catch { return "Error" } } Register-PSFTeppScriptblock -Name "SMAX.EntityAssociations" -ScriptBlock { try { if ([string]::IsNullOrEmpty($fakeBoundParameter.Connection)) { $connection = Get-SMAXLastConnection -EnableException $false } else { $connection = $fakeBoundParameter.Connection } $EntityType = $fakeBoundParameter.EntityType if ([string]::IsNullOrEmpty($EntityType)) { return } $definitions = Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).tepp.EntityAssociations" if (-not $definitions.containskey($EntityType)) { return } # Write-PSFMessage "$EntityType>$wordToComplete" if ($wordToComplete -match "([^.]+)\..*") { $subPropName = $wordToComplete -replace "([^.]+)\..*", '$1' if ($definitions.containskey("$EntityType.$subPropName")) { # Write-PSFMessage "$EntityType>>$subPropName" # Write-PSFMessage "`$definitions.`"$EntityType.$subPropName`"" return $definitions."$EntityType.$subPropName" #.properties | Select-Object @{name = "Text"; expression = { $_.name } }, @{name = "ToolTip"; expression = { $_.locName}} } } return $definitions.$EntityType #.properties | Select-Object @{name = "Text"; expression = { $_.name } }, @{name = "ToolTip"; expression = { $_.locName}} } catch { return "Error $_" } } Register-PSFTeppScriptblock -Name "SMAX.EntityProperties" -ScriptBlock { try { if ([string]::IsNullOrEmpty($fakeBoundParameter.Connection)) { $connection = Get-SMAXLastConnection -EnableException $false } else { $connection = $fakeBoundParameter.Connection } $EntityType = $fakeBoundParameter.EntityType if ([string]::IsNullOrEmpty($EntityType)){return} switch ($commandName){ 'New-SMAXEntity' { $definitions = Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).entityDefinition" return $definitions.$EntityType.properties | where-object required -eq $false | Select-Object @{name = "Text"; expression = { $_.name } }, @{name = "ToolTip"; expression = { $_.locName}} } default{ $definitions = Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).tepp.EntryProperties" if(-not $definitions.containskey($EntityType)){return} # Write-PSFMessage "$EntityType>$wordToComplete" if ($wordToComplete -match "([^.]+)\..*"){ $subPropName = $wordToComplete -replace "([^.]+)\..*",'$1' if ($definitions.containskey("$EntityType.$subPropName")){ # Write-PSFMessage "$EntityType>>$subPropName" # Write-PSFMessage "`$definitions.`"$EntityType.$subPropName`"" return $definitions."$EntityType.$subPropName" #.properties | Select-Object @{name = "Text"; expression = { $_.name } }, @{name = "ToolTip"; expression = { $_.locName}} } } return $definitions.$EntityType #.properties | Select-Object @{name = "Text"; expression = { $_.name } }, @{name = "ToolTip"; expression = { $_.locName}} } } } catch { return "Error" } } Register-PSFTeppScriptblock -Name "SMAX.EntityTypes" -ScriptBlock { try { if ([string]::IsNullOrEmpty($fakeBoundParameter.Connection)) { $connection = Get-SMAXLastConnection -EnableException $false } else { $connection = $fakeBoundParameter.Connection } if ($commandName -match 'SMAXComment') { # Return only definitions which have a Comments property $definitions = Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).entityDefinition" return ($definitions.Values | Where-Object { $_.properties.name -contains 'Comments' } | Select-Object -ExpandProperty name) } return Get-PSFConfigValue -FullName "$(Get-SMAXConfPrefix -Connection $Connection).tepp.EntryNames" #| Select-Object @{name = "Text"; expression = { $_.name } }, @{name = "ToolTip"; expression = { $_.locName } } } catch { return "Error $_" } } <# # Example: Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name SMAX.alcohol #> New-PSFLicense -Product 'SMAX' -Manufacturer 'Sascha Spiekermann' -ProductVersion $script:ModuleVersion -ProductType Module -Name GPL -Version "3.0.0.0" -Date (Get-Date "2020-09-21") -Text @" GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/licenses/why-not-lgpl.html>. "@ #endregion Load compiled code |