Schleupen.CS.AP.BI.Powershell

Aktualisiere-VorlageElementVerweise

Parameters

Name Alias Description Required? Pipeline Input Default Value
-NewVorlageElementVersionId Keine true false
-SessionToken Keine true false
-VersionIds Keine true false
-VorlageelementVersionToChangeId Keine true false

Configure-AuftraegeVerarbeitenActivityService

Erlaubt die Konfiguration des AuftraegeVerarbeitenActivityService.

Erlaubt die Konfiguration des AuftraegeVerarbeitenActivityService.

Syntax 

Configure-AuftraegeVerarbeitenActivityService [-SessionToken] <String> [-PeriodInSeconds] <Int32> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken Der SessionToken legt fest auf welchem Knoten der Systemstruktur konfiguriert werden soll. true false
-PeriodInSeconds Legt fest in wieviel Sekunden nach einem Aufruf der nächste Aufruf erfolgen soll. true false 0

Examples

BEISPIEL 1 
$sessionToken = Request-SessionToken ......
Configure-AuftraegeVerarbeitenActivityService -SessionToken $sessionToken -PeriodInSeconds 27

Top of page

Configure-BirtOidc

Konfiguriert den Zugriff auf die BIRT-Javakomponente für OIDC.

Konfiguriert den Zugriff auf die BIRT-Javakomponente für OIDC.

Syntax 

Configure-BirtOidc -ClientId <String> -ClientSecret <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ClientId Die zu verwendende OIDC-ClientId true false
-ClientSecret Das zur ClientId gehörige Secret true false

Examples

BEISPIEL 1 
# Erstellt eine neue Konfiguration für SI vom Typ Geschaeftsjahr. Der SessionToken wird im Einzelnen angegeben.
Configure-BirtOidc -ClientId cs-reporting -ClientSecret geheim123

Top of page

Configure-IsServBirdEnabled

Aktiviert/Deaktiviert die Dokumentenerstellung über ServBIRD.

Aktiviert/Deaktiviert die Dokumentenerstellung über ServBIRD.

Syntax 

Configure-IsServBirdEnabled [-IsEnabled] <Boolean> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-IsEnabled $true Aktiviert die Dokumentenerstellung über ServBIRD.
$false Deaktiviert die Dokumentenerstellung über ServBIRD.		 true false False

Examples

BEISPIEL 1 
Configure-IsServBirdEnabled -IsEnabled $false

Top of page

Configure-ServBirdConnectionAccount

Konfiguriert die Credentials für die Verbindung zu einem ServBIRD.

Konfiguriert die Credentials für die Verbindung zu einem ServBIRD.

Syntax 

Configure-ServBirdConnectionAccount [-Username] <String> [-DecryptedPassword] <String> 
[-AuthorizedAccounts] <String[]> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Username Der Name des ServBIRD-Benutzers true false
-DecryptedPassword Das Kennwort für den ServBIRD-Nutzer true false
-AuthorizedAccounts Das Kennwort für den ServBIRD-Nutzer true false

Examples

BEISPIEL 1 
Configure-ServBirdConnectionAccount -Username "admin" -DecryptedPassword "changeit" -AuthorizedAccounts ("SCHLEUPEN-AG\CS_Applikation","SCHLEUPEN-AG\CS_Deployment","SCHLEUPEN-AG\CS_Praesentation","SCHLEUPEN-AG\CS_Monitoring")

Top of page

Convert-CSReports

Startet die automatische Migration der Reports.

Startet die automatische Migration der Reports.

Syntax 

Convert-CSReports [<CommonParameters>]

Examples

BEISPIEL 1 
Convert-CSReports -Verbose

Top of page

Delete-Vorlageelements

Parameters

Name Alias Description Required? Pipeline Input Default Value
-keepFiles Keine true false
-sessionToken Keine true false
-vorlageIds Keine true false

Delete-VorlageelementVersions

Parameters

Name Alias Description Required? Pipeline Input Default Value
-keepFiles Keine true false
-sessionToken Keine true false
-versionIds Keine true false

Get-CurrentVorlageelementVersion

Ermittelt die aktuellste Vorlageelementversion anhand des Vorlageelementkürzels.

Ermittelt die aktuellste Vorlageelementversion anhand des Vorlageelementkürzels.

Syntax 

Get-CurrentVorlageelementVersion [-SessionToken] <String> [[-VorlageelementKuerzel] <String>] 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken true false
-VorlageelementKuerzel Das Kürzel des Vorlagelementes false false

Examples

BEISPIEL 1 
Get-Vorlageelements -Verbose

Top of page

Get-LibraryVorlageelements

Ermittelt alle installierten Birt-Bibliotheken.

Ermittelt alle installierten Birt-Bibliotheken.

Syntax 

Get-LibraryVorlageelements [-SessionToken] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken true false

Examples

BEISPIEL 1 
Get-Vorlageelements -Verbose

Top of page

Get-ReportVorlageelements

Ermittelt alle installierten Birt-Reports.

Ermittelt alle installierten Birt-Reports.

Syntax 

Get-ReportVorlageelements [-SessionToken] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken true false

Examples

BEISPIEL 1 
Get-Vorlageelements -Verbose

Top of page

Get-ResourceVorlageelements

Ermittelt alle installierten Birt-Resourcen.

Ermittelt alle installierten Birt-Resourcen.

Syntax 

Get-ResourceVorlageelements [-SessionToken] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken true false

Examples

BEISPIEL 1 
Get-Vorlageelements -Verbose

Top of page

Get-SessionInfo

Überführt einen serialisierten SessionToken in eine Datenstruktur.

Überführt einen serialisierten SessionToken in eine Datenstruktur.

Syntax 

Get-SessionInfo [-SessionToken] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken true false

Examples

BEISPIEL 1 
Get-SessionInfo -SessionToken $sessionToken

Top of page

Get-SystemstructureTree

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ElementName Keine true false

Get-VorlageelementVersionById

Ermittelt eine Vorlageelementversion anhand des VorlageelementversionId.

Ermittelt eine Vorlageelementversion anhand des VorlageelementversionId.

Syntax 

Get-VorlageelementVersionById [-SessionToken] <String> [[-VorlageelementVersionId] <Guid>] 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken true false
-VorlageelementVersionId false false

Examples

BEISPIEL 1 
Get-Vorlageelements -Verbose

Top of page

New-TestReport

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ausgabeformat Keine false false
-documentId Keine false false
-filingCabinetShortcut Keine true false
-quantity Keine false false
-sessionToken Keine true false

Publish-Reportdesign

Veröffentlicht eine Reportdesigndatei auf dem ServBird

Veröffentlicht eine Reportdesigndatei auf dem ServBird

Syntax 

Publish-Reportdesign [-SessionToken] <String> [[-Filepath] <String>] [[-Filename] <String>] 
[[-Category] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken true false
-Filepath Pfad zu der Reportdesigndatei false false
-Filename Name der Reportdesigndatei in ServBird-Repository false false
-Category Kategorie der Reportdesigndatei in ServBird-Repository.
Falls der Wert Null oder leer ist, wird die Kategorie aus dem Sessiontoken berechnet.		 false false

Examples

BEISPIEL 1 
Publish-Reportdesign -SessionToken $sessionToken -FilePath "C:\Work\halloWelt_01.rptdesign" -Filename "halloWelt.rptdesign"

Top of page

Publish-Reportresource

Veröffentlicht eine Ressourcendatei auf dem ServBird

Veröffentlicht eine Ressourcendatei auf dem ServBird

Syntax 

Publish-Reportresource [-SessionToken] <String> [[-Filepath] <String>] [[-Filename] <String>] 
[[-Path] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken true false
-Filepath Pfad zu der Ressourcendatei false false
-Filename Name der Ressourcendatei in ServBird-Repository false false
-Path Pfad der Reportdesigndatei in ServBird-Repository.
Falls der Wert Null oder leer ist, wird die Kategorie aus dem Sessiontoken berechnet.		 false false

Examples

BEISPIEL 1 
Publish-Reportresource -SessionToken $sessionToken -FilePath "C:\Work\halloWelt_01.png" -Filename "halloWelt.png" -Path "Schleupen/Test"

Top of page

Remove-VorlageelementKonfiguration

Entfernt eine Vorlageelement-Konfiguration.

Entfernt eine Vorlageelement-Konfiguration.

Syntax 

Remove-VorlageelementKonfiguration [-SessionToken] <Object> [-VorlageelementKuerzel] <String> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken Der gesamte Session Token. true false
-VorlageelementKuerzel Das Kürzel des Vorlageelementes. (Sollten Leerzeichen enthalten sein, werden diese entfernt!) true false

Examples

BEISPIEL 1 
$sessionToken = Request-SessionToken .........
Remove-VorlageelementConfiguration -SessionToken $sessionToken -VorlageelementKuerzel "cs.ap.bi.testvorlage"

Top of page

Select-VorlageelementKonfiguration

Liest eine Vorlageelement-Konfiguration.

Liest eine Vorlageelement-Konfiguration.

Syntax 

Select-VorlageelementKonfiguration [-SessionToken] <Object> [-VorlageelementKuerzel] <String> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken Der gesamte Session Token. true false
-VorlageelementKuerzel Das Kürzel des Vorlageelementes. (Sollten Leerzeichen enthalten sein, werden diese entfernt!) true false

Examples

BEISPIEL 1 
$sessionToken = Request-SessionToken .........
Select-VorlageelementKonfiguration -SessionToken $sessionToken -VorlageelementKuerzel "cs.ap.bi.testvorlage"

Top of page

Set-VorlageelementKonfiguration

Erstellt eine neue Vorlageelement-Konfiguration.

Erstellt eine neue Vorlageelement-Konfiguration für eine Vorlage.

Syntax 

Set-VorlageelementKonfiguration [-SessionToken] <Object> [-VorlageelementKuerzel] <String> 
[-Ausgabeformat] <String> [-Archivierung] <Boolean> [-Dokumentenausgabe] <Boolean> 
[-Dokumentenart] <String> [-Portionsgroesse] <Single> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken Der gesamte Session Token. true false
-VorlageelementKuerzel Das Kürzel des Vorlageelementes. (Sollten Leerzeichen enthalten sein, werden diese entfernt!) true false
-Ausgabeformat true false
-Archivierung Soll das Dokument archiviert werden. true false False
-Dokumentenausgabe Soll eine Dokumentenausagabe erfolgen. true false False
-Dokumentenart Die Art des Dokumentes. true false
-Portionsgroesse Wieviele Dokumente sollen zu einer Portion zusammengefasst werden. true false 0

Examples

BEISPIEL 1 
$sessionToken = Request-SessionToken .........
Create-VorlageelementKonfiguration -SessionTokeen $sessionToken -VorlageelementKuerzel "cs.ap.bi.test" -Ausgabeformat "Pdfa_1b" -Archivierung $false -Dokumentenausgabe $true -Dokumentenart "Testdokument" -Portionsgroesse 100

Top of page

UpdateTimeStamp-VorlageelementById

Ermittelt eine Vorlageelement anhand des VorlageelementId.

Ermittelt eine Vorlageelement anhand des VorlageelementId.

Syntax 

UpdateTimeStamp-VorlageelementById [-SessionToken] <String> [[-VorlageelementId] <Guid>] 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken true false
-VorlageelementId Die Id des Vorlagelements false false

Examples

BEISPIEL 1 
Get-VorlageelementById -Id Guid.Parse("292b1859-702e-406f-adb7-1f90f56458b0") -SessionToken $sessionToken -Verbose

Top of page

Add-VorlageelementVersion

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ArtifactId Keine SessionToken. false true (ByValue)
-Confirm cf false false
-SessionToken Keine SessionToken. true true (ByValue)
-VorlageelementVersion Keine VorlageelementVersion. true true (ByValue)
-WhatIf wi false false