Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/123 extend cmdlet get-ishfoldercontent with parameter requestedmetadata #125

Merged
merged 2 commits into from
Apr 8, 2021
Merged

Feature/123 extend cmdlet get-ishfoldercontent with parameter requestedmetadata #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72dd2cf
#123 Parameter RequestedMetadata is added, cs *.cs is done. Next is a…
ddemeyer Apr 3, 2021
6cb08cb
#123 Parameter -RequestedMetadata added similar Search-IshDocumentObj…
ddemeyer Apr 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Doc/ReleaseNotes-ISHRemote-0.13.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,17 +62,18 @@ The alternative is to navigate your data set in smaller chunks, then folders com
1. Base folder `Data` is in practice "General", the repository root folder. Parameter `-FolderTypeFilter` is explicitly set for all content objects, implicitly skipping ISHPublication. Ommitting `-FolderTypeFilter` in practice means no filtering on object type.
1. The pipeline IshFolder objects are passed to `Foreach-Object {...}` (short hand `%{...}`) to create a script block for custom actions.
1. The pipeline IshFolder object in the script block is available as `$PSItem` (short hand `$_`). Initially to print a folder name.
1. The pipeline IshFolder object is passed to retrieve its folder content, specifically all languages on the latest (highest) version.
1. The pipeline IshFolder object is passed to retrieve its folder content, specifically all languages on the latest (highest) version. The `-RequestedMetadata` parameter allows to retrieve extra metadata on top of the IshSession `DefaultRequestedMetadata` (since [#123](https://github.com/sdl/ISHRemote/issues/123)).
1. Returned IshObjects can be further handled like `Set-IshDocumentObj` or write to file, or `Get-IshDocumentObjData` to retrieve the actual files.
1. Optionally in this sample, the pipeline IshObjects are passed to `Out-GridView` for visual representation. Notice the `-PassThru` which allows even further selection in that grid view, after pressing OK the selection is passed to the pipeline again.

```powershell
New-IshSession -WsBaseUrl https://example.com/ISHWS/ -PSCredential Admin
$metadataFilter = Set-IshMetadataFilterField -Level Lng -Name CHECKED-OUT-BY -FilterOperator In -Value ("Admin, Admin2")
$requestedMetadata = Set-IshRequestedMetadataField -Level Lng -Name FISHSTATUSTYPE
$ishObjects = Get-IshFolder -BaseFolder Data -FolderTypeFilter @("ISHModule", "ISHMasterDoc", "ISHLibrary", "ISHIllustration", "ISHTemplate") -Recurse |
Foreach-Object {
Write-Host ("Handling folder[$($PSItem.name)]...")
$ishObjects = Get-IshFolderContent -IshFolder $PSItem -VersionFilter Latest -MetadataFilter $metadataFilter
$ishObjects = Get-IshFolderContent -IshFolder $PSItem -VersionFilter Latest -MetadataFilter $metadataFilter -RequestedMetadata $requestedMetadata
# Create some report, some extra checks, a transformation, etc
Write-Output $ishObjects
} |
Expand Down
2 changes: 1 addition & 1 deletion Source/ISHRemote/Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<Minor>12</Minor>
<Build>$([MSBuild]::Add($([MSBuild]::Multiply(1200, $([MSBuild]::Subtract($([System.DateTime]::UtcNow.Year), 2015)))), $([MSBuild]::Add($([MSBuild]::Multiply(100, $([System.DateTime]::UtcNow.Month))),$([System.DateTime]::UtcNow.Day)))))</Build>
<!-- <AdvBuild>$([System.DateTime]::UtcNow.ToString("HHmmss"))</AdvBuild> -->
<Revision>6</Revision>
<Revision>7</Revision>
<ModuleVersion>$(Major).$(Minor).0.$(Revision)</ModuleVersion>
<ModuleBuildVersion>$(Major).$(Minor).$(Build).$(Revision)</ModuleBuildVersion>
<FullModuleBuildVersion>$(Major).$(Minor).$(Revision)</FullModuleBuildVersion>
Expand Down
10 changes: 7 additions & 3 deletions Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Folder/GetIshFolderContent.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Describe “Get-IshFolderContent" -Tags "Read" {
}

Context "Get-IshFolderContent returns latest IshObject[] object" {
$ishObjects = Get-IshFolderContent -IShSession $ishSession -IshFolder $ishFolderTopic
$requestedMetadata = Set-IshRequestedMetadataField -Level Lng -Name FISHSTATUSTYPE
$ishObjects = Get-IshFolderContent -IShSession $ishSession -IshFolder $ishFolderTopic -RequestedMetadata $requestedMetadata
It "GetType().Name" {
$ishObjects.GetType().Name | Should BeExactly "Object[]"
}
Expand Down Expand Up @@ -83,12 +84,14 @@ Describe “Get-IshFolderContent" -Tags "Read" {
$ishObjects[0].version_version_value -ge 2 | Should Be $true
#language
$ishObjects[0].fstatus.Length -ge 1 | Should Be $true
$ishObjects[0].fstatus_lng_element.StartsWith('VSTATUS') | Should Be $true
$ishObjects[0].fstatus_lng_element.StartsWith('VSTATUS') | Should Be $true
$ishObjects[0].fishstatustype -ge 0 | Should Be $true
}
}

Context "Get-IshFolderContent with empty VersionFilter returns IshObject[] object" {
$ishObjects = Get-IshFolderContent -IShSession $ishSession -VersionFilter "" -IshFolder $ishFolderTopic
$requestedMetadata = Set-IshRequestedMetadataField -Level Lng -Name FISHSTATUSTYPE
$ishObjects = Get-IshFolderContent -IShSession $ishSession -VersionFilter "" -IshFolder $ishFolderTopic -RequestedMetadata $requestedMetadata
It "GetType().Name" {
$ishObjects.GetType().Name | Should BeExactly "Object[]"
}
Expand Down Expand Up @@ -134,6 +137,7 @@ Describe “Get-IshFolderContent" -Tags "Read" {
#language
$ishObjects[0].fstatus.Length -ge 1 | Should Be $true
$ishObjects[0].fstatus_lng_element.StartsWith('VSTATUS') | Should Be $true
$ishObjects[0].fishstatustype -ge 0 | Should Be $true
}
It "ishObjects[0].version_version_value" {
# First version
Expand Down
22 changes: 17 additions & 5 deletions Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Folder/GetIshFolderContent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,12 @@ namespace Trisoft.ISHRemote.Cmdlets.Folder
/// <code>
/// $ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -PSCredential "Admin"
/// $metadataFilter = Set-IshMetadataFilterField -Level Lng -Name FSOURCELANGUAGE -FilterOperator Empty
/// $requestedMetadata = Set-IshRequestedMetadataField -Level Lng -Name FISHSTATUSTYPE
/// Get-IshFolder -FolderPath "\General\Mobile Phones Demo" -Recurse |
/// Get-IshFolderContent -VersionFilter "" -MetadataFilter $metadataFilter
/// Get-IshFolderContent -VersionFilter "" -MetadataFilter $metadataFilter -RequestedMetadata $requestedMetadata
/// </code>
/// <para>New-IshSession will submit into SessionState, so it can be reused by this cmdlet. The metadata filter will filter out source languages and the empty VersionFilter will return all versions of any object. The recursive folder allows you to control which area you do a check/conversion in, and give you progress as well.</para>
/// <para>Note that -RequestedMetadata will be used on every folder passed over the pipeline by Get-IshFolder. Requesting metadata for Topics (ISHModule) might be unexisting on Publication folders or vice versa. Know that Get-IshFolder has a -FolderTypeFilter parameter to workaround that.</para>
/// </example>
/// <example>
/// <code>
Expand All @@ -98,6 +100,16 @@ public sealed class GetIshFolderContent : FolderCmdlet
[ValidateNotNullOrEmpty]
public IshSession IshSession { get; set; }

/// <summary>
/// <para type="description">The metadata fields to retrieve</para>
/// </summary>
[Parameter(Mandatory = false, ValueFromPipelineByPropertyName = false, ParameterSetName = "FolderIdGroup")]
[Parameter(Mandatory = false, ValueFromPipelineByPropertyName = false, ParameterSetName = "FolderPathGroup")]
[Parameter(Mandatory = false, ValueFromPipelineByPropertyName = false, ParameterSetName = "BaseFolderGroup")]
[Parameter(Mandatory = false, ValueFromPipelineByPropertyName = false, ParameterSetName = "IshFolderGroup")]
[ValidateNotNull]
public IshField[] RequestedMetadata { get; set; }

/// <summary>
/// <para type="description">Separated string with the full folder path</para>
/// </summary>
Expand Down Expand Up @@ -280,15 +292,15 @@ protected override void ProcessRecord()
if (documentLogicalIds.Any())
{
Enumerations.ISHType[] ISHType = { Enumerations.ISHType.ISHIllustration, Enumerations.ISHType.ISHLibrary, Enumerations.ISHType.ISHMasterDoc, Enumerations.ISHType.ISHModule, Enumerations.ISHType.ISHTemplate };
IshFields requestedMetadata = IshSession.IshTypeFieldSetup.ToIshRequestedMetadataFields(IshSession.DefaultRequestedMetadata, ISHType, new IshFields(), Enumerations.ActionMode.Read);
IshFields requestedMetadata = IshSession.IshTypeFieldSetup.ToIshRequestedMetadataFields(IshSession.DefaultRequestedMetadata, ISHType, new IshFields(RequestedMetadata), Enumerations.ActionMode.Read);

// Devides the list of LogicalIds in different lists that all have maximally MetadataBatchSize elements
List<List<string>> devidedDocumentLogicalIdsList = DevideListInBatches<string>(documentLogicalIds, IshSession.MetadataBatchSize);
int currentLogicalIdCount = 0;
foreach (List<string> logicalIdBatch in devidedDocumentLogicalIdsList)
{
currentLogicalIdCount += logicalIdBatch.Count;
WriteDebug($"Retrieving DocumentObj.length[{logicalIdBatch.Count}] MetadataFilter.length[{metadataFilterFields.ToXml().Length}] {currentLogicalIdCount}/{documentLogicalIds.Count}");
WriteDebug($"Retrieving DocumentObj.length[{logicalIdBatch.Count}] MetadataFilter.length[{metadataFilterFields.ToXml().Length}] RequestedMetadata.length[{requestedMetadata.ToXml().Length}] {currentLogicalIdCount}/{documentLogicalIds.Count}");

if (VersionFilter != null && VersionFilter.Length > 0)
{
Expand All @@ -311,7 +323,7 @@ protected override void ProcessRecord()
}
else
{
WriteVerbose($"Filtering DocumentObj using MetadataFilter.length[{metadataFilterFields.ToXml().Length}]");
WriteVerbose($"Filtering DocumentObj using MetadataFilter.length[{metadataFilterFields.ToXml().Length}] RequestedMetadata.length[{requestedMetadata.ToXml().Length}]");
xmlIshObjects = IshSession.DocumentObj25.RetrieveMetadata(logicalIdBatch.ToArray(),
DocumentObj25ServiceReference.StatusFilter.ISHNoStatusFilter,
metadataFilterFields.ToXml(),
Expand All @@ -331,7 +343,7 @@ protected override void ProcessRecord()
if (publicationLogicalIds.Any())
{
Enumerations.ISHType[] ISHType = { Enumerations.ISHType.ISHPublication };
IshFields requestedMetadata = IshSession.IshTypeFieldSetup.ToIshRequestedMetadataFields(IshSession.DefaultRequestedMetadata, ISHType, new IshFields(), Enumerations.ActionMode.Read);
IshFields requestedMetadata = IshSession.IshTypeFieldSetup.ToIshRequestedMetadataFields(IshSession.DefaultRequestedMetadata, ISHType, new IshFields(RequestedMetadata), Enumerations.ActionMode.Read);

// Devides the list of LogicalIds in different lists that all have maximally MetadataBatchSize elements
List<List<string>> devidedPublicationLogicalIdsList = DevideListInBatches<string>(publicationLogicalIds, IshSession.MetadataBatchSize);
Expand Down