Search-TssReportSchedule - Rename class, add format

thycotic-ps · Jan 20, 2021 · 77b2a6f · 77b2a6f
1 parent 2dd809f
commit 77b2a6f
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 27 deletions.
diff --git a/src/Thycotic.SecretServer.Format.ps1xml b/src/Thycotic.SecretServer.Format.ps1xml
@@ -343,5 +343,58 @@
       </TableControl>
     </View>
 
+  <!-- Getting TssReportScheduleSummary -->
+    <View>
+      <Name>TssReportScheduleSummary</Name>
+      <ViewSelectedBy>
+        <TypeName>TssReportScheduleSummary</TypeName>
+      </ViewSelectedBy>
+      <TableControl>
+        <TableHeaders>
+          <TableColumnHeader>
+          </TableColumnHeader>
+          <TableColumnHeader>
+          </TableColumnHeader>
+          <TableColumnHeader>
+          </TableColumnHeader>
+          <TableColumnHeader>
+          </TableColumnHeader>
+          <TableColumnHeader>
+          </TableColumnHeader>
+          <TableColumnHeader>
+          </TableColumnHeader>
+          <TableColumnHeader>
+          </TableColumnHeader>
+        </TableHeaders>
+        <TableRowEntries>
+          <TableRowEntry>
+            <TableColumnItems>
+              <TableColumnItem>
+                <PropertyName>ScheduleReportId</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>Name</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>LastRun</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ChangeType</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>StoredReportCount</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ReportId</PropertyName>
+              </TableColumnItem>
+              <TableColumnItem>
+                <PropertyName>ReportName</PropertyName>
+              </TableColumnItem>
+            </TableColumnItems>
+          </TableRowEntry>
+        </TableRowEntries>
+      </TableControl>
+    </View>
+
   </ViewDefinitions>
 </Configuration>
diff --git a/...asses/reports/TssReportSchedule.class.ps1 → ...eports/TssReportScheduleSummary.class.ps1 b/...asses/reports/TssReportSchedule.class.ps1 → ...eports/TssReportScheduleSummary.class.ps1
@@ -1,4 +1,4 @@
-class TssReportSchedule {
+class TssReportScheduleSummary {
     # Schedule change type
     [ValidateSet('Daily','Weekly','Monthly')]
     [string]$ChangeType

diff --git a/src/en-us/about_tssreportschedule.help.txt b/src/en-us/about_tssreportschedule.help.txt
diff --git a/src/en-us/about_tssreportschedulesummary.help.txt b/src/en-us/about_tssreportschedulesummary.help.txt
@@ -0,0 +1,21 @@
+TOPIC
+    This help topic describes the TssReportScheduleSummary class in the Thycotic.SecretServer module
+
+CLASS
+    TssReportScheduleSummary
+
+INHERITANCE
+    None
+
+DESCRIPTION
+    The TssReportScheduleSummary class represents the ReportScheduleSummaryModel object returned by Secret Server endpoint /reports/schedules
+
+CONSTRUCTORS
+    new()
+
+PROPERTIES
+    Documented in the REST API doc for Secret Server, see ReportScheduleSummaryModel /reports/schedules
+METHODS
+
+RELATED LINKS:
+    Search-TssReportScheduleSummary
diff --git a/src/functions/reports/Search-ReportSchedule.ps1 b/src/functions/reports/Search-ReportSchedule.ps1
@@ -67,7 +67,7 @@
                 Write-Warning "No report schedules found"
             }
             if ($restReponse.records) {
-                . $TssReportScheduleObject $restReponse.records
+                . $TssReportScheduleSummaryObject $restReponse.records
             }
         } else {
             Write-Warning "No valid session found"

diff --git a/src/parts/TssReportScheduleObject.ps1 → src/parts/TssReportScheduleSummaryObject.ps1 b/src/parts/TssReportScheduleObject.ps1 → src/parts/TssReportScheduleSummaryObject.ps1
@@ -1,8 +1,8 @@
 <#
     .Synopsis
-        Creates a TssReportSchedule class in the Thycotic.SecretServer module.
+        Creates a TssReportScheduleSummary class in the Thycotic.SecretServer module.
     .Description
-        Creates an instance of the TssReportSchedule class to output the ReportScheduleSummaryModel object
+        Creates an instance of the TssReportScheduleSummary class to output the ReportScheduleSummaryModel object
 #>
 param(
     [pscustomobject]$Object
@@ -14,14 +14,14 @@ begin {
 
 process {
     foreach ($s in $Object) {
-        $outReportSched = [TssReportSchedule]::new()
+        $outReportSched = [TssReportScheduleSummary]::new()
         foreach ($rsProp in $Properties) {
             if ($rsProp -in $outReportSched.PSObject.Properties.Name) {
                 if ($s.$rsProp) {
                     $outReportSched.$rsProp = $s.$rsProp
                 }
             } else {
-                Write-Warning "Property $rsProp does not exist in the TssReportSchedule class. Please create a bug report at https://github.com/thycotic-ps/thycotic.secretserver/issues/new/choose"
+                Write-Warning "Property $rsProp does not exist in the TssReportScheduleSummary class. Please create a bug report at https://github.com/thycotic-ps/thycotic.secretserver/issues/new/choose"
             }
         }
     }