plugins/CleverReach/Private/helper/sync-attributes.ps1
|
function Sync-Attributes { [CmdletBinding()] param ( [Parameter(Mandatory=$true)][String[]]$csvAttributesNames ,[Parameter(Mandatory=$true)][String[]]$csvUrnFieldname ,[Parameter(Mandatory=$true)][String]$groupId ,[Parameter(Mandatory=$false)][String[]]$reservedFields = [Array]@() ,[Parameter(Mandatory=$false)][String[]]$requiredFields = [Array]@() ,[Parameter(Mandatory=$false)][String]$responseUrnFieldname = "urn" ,[Parameter(Mandatory=$false)][int]$maxAttributesCount = 40 ) begin { } process { try { #----------------------------------------------- # CHECK CSV HEADERS #----------------------------------------------- # Check if email field is present $equalWithRequirements = Compare-Object -ReferenceObject $csvAttributesNames.Tolower() -DifferenceObject $requiredFields.Tolower() -IncludeEqual -PassThru | Where-Object { $_.SideIndicator -eq "==" } if ( $equalWithRequirements.count -eq $requiredFields.Count ) { # Required fields are all included } else { # Required fields not equal -> error! throw [System.IO.InvalidDataException] "No email field present!" } #----------------------------------------------- # LOAD ATTRIBUTES #----------------------------------------------- # Load online attributes $object = "attributes" $globalAttributes = @( (Invoke-CR -Object $object -Method "GET" -Verbose ) ) $localAttributes = @( (Invoke-CR -Object $object -Method "GET" -Verbose -Query ( [PSCustomObject]@{ "group_id" = $groupId } )) ) $attributes = $globalAttributes + $localAttributes # Log Write-Log -message "Loaded global attributes: $( $globalAttributes.name -join ", " )" Write-Log -message "Loaded local attributes: $( $localAttributes.name -join ", " )" Write-Log -Message "You have $( $attributes.count )/$( $maxAttributesCount ) attributes now" If ( $attributes.count/$maxAttributesCount -gt 0.7 ) { Write-Log -Message "You have used more than 70% of your attributes" -Severity WARNING } # Use attributes names $attributesNames = @( $attributes | Where-Object { $_.name.Tolower() -notin $requiredFields.Tolower() } ) #----------------------------------------------- # COMPARE COLUMNS #----------------------------------------------- # TODO [x] Now the csv column headers are checked against the description of the cleverreach attributes and not the (technical name). Maybe put this comparation in here, too. E.g. description "Communication Key" get the name "communication_key" #$differences = Compare-Object -ReferenceObject $attributesNames.description -DifferenceObject ( $csvAttributesNames | where { $_.name -notin $requiredFields } ).name -IncludeEqual #-Property Name $differences = Compare-Object -ReferenceObject ( $attributesNames.name.Tolower() + $attributesNames.description.Tolower() ) -DifferenceObject ( $csvAttributesNames.Tolower() | Where-Object { $_.toLower() -notin $requiredFields.Tolower() } ) -IncludeEqual #-Property Name #----------------------------------------------- # WORK OUT ATTRIBUTES TO CREATE #----------------------------------------------- #$differences = Compare-Object -ReferenceObject $attributesNames.name -DifferenceObject ( $csvAttributesNames | where { $_.name -notin $requiredFields } ).name -IncludeEqual #-Property Name #$colsEqual = $differences | Where-Object { $_.SideIndicator -eq "==" } $colsInAttrButNotCsv = $differences | Where-Object { $_.SideIndicator -eq "<=" } $colsInCsvButNotAttr = $differences | Where-Object { $_.SideIndicator -eq "=>" } #----------------------------------------------- # CHECK ATTRIBUTES COUNT #----------------------------------------------- If ( ($attributes.count + $colsInCsvButNotAttr.count) -gt $maxAttributesCount ) { Write-Log -Message "The max amount of attributes would be exceeded with this job. Canceling now!" -Severity ERROR throw [System.IO.InvalidDataException] "Too many attributes!" exit 0 } #----------------------------------------------- # CHECK GLOBAL ATTRIBUTES #----------------------------------------------- If ( $csvUrnFieldname.Tolower() -ne $responseUrnFieldname.Tolower() ) { Write-Log "Be aware, that the response matching won't work if the urn fieldnames are not matching" -severity WARNING } #----------------------------------------------- # CREATE LOCAL ATTRIBUTES #----------------------------------------------- $newAttributes = [Array]@() #$Script:debug = $colsInCsvButNotAttr If ( $colsInCsvButNotAttr.Count -gt 0 ) { Write-Log -Message "Creating new local attributes" } $colsInCsvButNotAttr | ForEach-Object { #$newAttributeName = $_.InputObject.toString() $att = $_.InputObject.toString() # Getting the right attribute regarding lower/uppercase $newAttributeName = $csvAttributesNames | Where-Object { $_.toLower() -eq $att } $body = [PSCustomObject]@{ "name" = $newAttributeName "type" = "text" # text|number|gender|date "description" = $newAttributeName # optional #"preview_value" = "real name" # optional #"default_value" = "Bruce Wayne" # optional } $newAttributes += Invoke-CR -Object "groups" -Method "POST" -Path "/$( $groupId )/attributes" -Body $body -Verbose #$newAttributes += Invoke-RestMethod -Uri $endpoint -Method Post -Headers $header -Body $bodyJson -ContentType $contentType -Verbose } If ( $newAttributes.count -gt 0 ) { Write-Log -message "Created new local attributes in CleverReach: $( $newAttributes.name.Tolower() -join ", " )" -Severity WARNING } else { Write-Log -Message "No new local attributes needed to be created" } #----------------------------------------------- # RETURN #----------------------------------------------- [Hashtable]@{ "global" = $globalAttributes "local" = $localAttributes "new" = $newAttributes "notneeded" = $colsInAttrButNotCsv.InputObject } } catch { $msg = "Failed to sync attributes" Write-Log -Message $msg -Severity ERROR #Write-Log -Message $_.Exception -Severity ERROR throw [System.IO.InvalidDataException] $msg } } end { } } |