Schleupen.CS.PI.AIF.PowerShell

Set-ScheduledService

Aktiviert oder deaktiviert den anzugebenden Job für die gesamte Systemstruktur.

Aktiviert oder deaktiviert den anzugebenden Job für die gesamte Systemstruktur. Dabei wird über
alle Elemente der Systemstruktur iteriert.
Auch die Verwendungszwecke werden berücksichtigt.

Syntax 

Set-ScheduledService [-ServiceId] <String> [-IsInActive] [<CommonParameters>]

Set-ScheduledService [-ServiceId] <String> [-IsActive] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ServiceId true false
-IsActive true false False
-IsInActive true false False

Examples

BEISPIEL 1 
Set-ScheduledService -ServiceId 'Schleupen.CS.PI.AIF.ScheduledServices.TestScheduledServicesActivityService_3.1' -IsActive -Verbose

Top of page

Set-ScheduledServiceOnSystemStructureElement

Aktiviert oder deaktiviert den anzugebenden Job für das gegebene SessionToken.

Aktiviert oder deaktiviert den anzugebenden Job für das gegebene SessionToken.

Syntax 

Set-ScheduledServiceOnSystemStructureElement [-SessionToken] <String> [-ServiceId] <String> 
[-IsInActive] [<CommonParameters>]

Set-ScheduledServiceOnSystemStructureElement [-SessionToken] <String> [-ServiceId] <String> 
[-IsActive] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken true false
-ServiceId true false
-IsActive true false False
-IsInActive true false False

Examples

BEISPIEL 1 
$sessionToken = Request-SystemSessionToken
Set-ScheduledServiceOnSystemStructureElement -SessionToken $sessionToken -ServiceId 'Schleupen.CS.PI.AIF.ScheduledServices.TestScheduledServicesActivityService_3.1' -IsActive -Verbose

Top of page

Write-ScheduledServiceInfoToHost

Schreibt alle aktivierten und deaktivierten Jobs der gesamten Systemstruktur auf die Konsole.

Schreibt alle aktivierten und deaktivierten Jobs der gesamten Systemstruktur auf die Konsole.
Dabei werden alle relevanten
Informationen ausgegeben.

Syntax 

Write-ScheduledServiceInfoToHost [<CommonParameters>]

Examples

BEISPIEL 1 
Write-ScheduledServiceInfoToHost

Top of page

Add-LicenseFileToSystemStructureElement

Verknüpft eine Lizenzdatei mit einem Systemstrukturelement.

Verknüpft anhand der Kundennummer eine Lizenzdatei mit einem Systemstrukturelement.

Syntax 

Add-LicenseFileToSystemStructureElement [-SessionToken] <string> [-CustomerId] <string> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken, aus dem das SystemStructureElement gelesen wird, zu welchem die Lizenzdatei
zugeordnet werden soll.		 true false
-CustomerId Kundennummer, die dem Systemstrukturelement zugeordnet werden soll. true false

Examples

EXAMPLE 1 
Add-LicenseFileToSystemStructureElement -SessionToken $systemStructureElementSessionToken -CustomerId 1111111
Verknüpft die Lizenz der Kundennummer 1111111 mit dem "System"-Strukturelement.

Top of page

Get-CabinetFile

Ruft eine Datei aus der Dateiablage ab.

Ruft eine Datei aus der Dateiablage ab und speichert sie im aktuellen Verzeichnis.

Syntax 

Get-CabinetFile -CabinetFileName <string> -SessionToken <string> 
[-DisableSystemStructureNavigation <SwitchParameter>] [-FilingCabinetName <string>] 
[<CommonParameters>]

Get-CabinetFile -SessionToken <string> [-CabinetFileId <Guid>] [-DisableSystemStructureNavigation 
<SwitchParameter>] [-FilingCabinetId <Guid>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FilingCabinetName Name der Dateiablage. false false
-FilingCabinetId ID der Dateiablage. false false
-CabinetFileName Name der Datei. true false
-CabinetFileId ID der Datei. false false
-DisableSystemStructureNavigation Angabe, ob die Navigation in der Systemstrukur deaktiviert werden soll. false false False
-SessionToken SessionToken. true false

Examples

EXAMPLE 1 
Get-CabinetFile -FilingCabinetName Rechnungen -CabinetFileName Rechnung_Kunde_32542_201510.pdf -SessionToken $sessionToken
>Ruft die Datei "Rechnung_Kunde_32542.pdf" ab und speichert sie auf dem Datenträger.

Top of page

Import-LicenseFile

Importiert eine Lizenzdatei.

Nimmt eine Lizenzdatei entgegen und legt sie in das konfigurierte Lizenzverzeichnis ab.

Syntax 

Import-LicenseFile [-LicenseFilePath] <string> [[-Force] <SwitchParameter>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-LicenseFilePath Pfad zur Lizenzdatei, die importiert werden soll. true false
-Force Wenn angegeben, werden eventuell vorhandene Lizenzdateien überschrieben. false false False

Examples

EXAMPLE 1 
Import-LicenseFile -LicenseFilePath "C:\Lizenzen\1111111.Schleupen AG.Test.License.xml" -Force
Importiert die Lizenzdatei 1111111.Schleupen AG.Test.License.xml.

Top of page

New-AccessRule

Erstellt eine neue Zugriffsregel ohne diese zu persistieren.

Erstellt eine neue Zugriffsregel ohne diese zu persistieren.

Syntax 

New-AccessRule [-IdentityId] <Guid> [-Privileges] <Privilege[]> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-IdentityId ID des Benutzers oder der Gruppe. true true (ByValue) 00000000-0000-0000-0000-000000000000
-Privileges Angabe, welche Rechte der Benzuer oder die Gruppe hat true false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Guid ID des Benutzers oder der Gruppe.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.FilingCabinets.AccessRule

Examples

EXAMPLE 1 
New-AcccessRule -IdentityId $identityId -Privileges Read,Write,Delete
Legt die Zugriffsregel mit den angegebenen Eigenschaften an.

Top of page

New-FilingCabinet

Legt eine neue Dateiablage an.

Legt eine neue Dateiablage mit den angegebenen Eigenschaften an.

Syntax 

New-FilingCabinet [-ArtifactIdentifier] <string> [-Description] <string> 
[[-IsCheckInCommentRequired] <SwitchParameter>] [[-IsCheckOutCommentRequired] <SwitchParameter>] 
[[-MaxFileSizeInMegabytes] <int>] [-FilingCabinetTypeName] <string> [[-Name] <string>] 
[[-IsCompressed] <SwitchParameter>] [<CommonParameters>]

New-FilingCabinet [-ArtifactIdentifier] <string> [-Description] <string> 
[[-IsCheckInCommentRequired] <SwitchParameter>] [[-IsCheckOutCommentRequired] <SwitchParameter>] 
[[-MaxFileSizeInMegabytes] <int>] [-FilingCabinetTypeName] <string> [[-Name] <string>] 
[[-IsCompressed] <SwitchParameter>] [-AccessRules] <AccessRule[]> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ArtifactIdentifier Identifier der Dateiablage. true true (ByValue)
-Description Beschreibung der Dateiablage. true true (ByValue)
-IsCheckInCommentRequired Angabe, ob ein Eincheckkommentar benötigt wird. false false False
-IsCheckOutCommentRequired Angabe, ob ein Auscheckkommentar benötigt wird. false false False
-MaxFileSizeInMegabytes Angabe der maximalen Dateigröße in MB. false false
-FilingCabinetTypeName Name der Dateiablageart. true false
-Name false false
-IsCompressed Angabe, ob die Dateien der Dateiablage bei der Ablage in der Datenbank komprimiert werden sollen. false false False
-AccessRules Zugriffsregeln. true false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String Identifier der Dateiablage. System.String Beschreibung der Dateiablage.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.FilingCabinets.FilingCabinet Dateiablage.

Examples

EXAMPLE 1 
New-FilingCabinet -ArtifactIdentifier "Schleupen.CS.PI.AIF.Test_1.0" -Description "Test" -FilingCabinetTypeName "Schleupen.CS.PI.AIF.TestDateiablageart_1.0" -IsCompressed $false
Legt die Datieablage mit den angegebenen Eigenschaften an.
EXAMPLE 2 
New-FilingCabinet -ArtifactIdentifier "Schleupen.CS.PI.AIF.Test_1.0" -Description "Test" -FilingCabinetTypeName "Schleupen.CS.PI.AIF.TestDateiablageart_1.0" -Name "Test Dateiablage" -IsCompressed
Legt die Dateiablage mit den angegebenen Eigenschaften an. In diesem Beispiel wird zusätzlich ein Name angegeben. Ohne Angabe eines Namens wird der Artifact Identifier verwendet.

Top of page

New-FilingCabinetType

Legt eine neue Dateiablageart an.

Legt eine neue Dateiablageart mit den angegebenen Eigenschaften an.

Syntax 

New-FilingCabinetType [-ArtifactIdentifier] <string> [-Description] <string> 
[[-IsCheckInCommentRequired] <SwitchParameter>] [[-IsCheckOutCommentRequired] <SwitchParameter>] 
[[-MaxFileSizeInMegabytes] <int>] [[-IsCompressed] <SwitchParameter>] [[-Name] <string>] 
[<CommonParameters>]

New-FilingCabinetType [-ArtifactIdentifier] <string> [-Description] <string> 
[[-IsCheckInCommentRequired] <SwitchParameter>] [[-IsCheckOutCommentRequired] <SwitchParameter>] 
[[-MaxFileSizeInMegabytes] <int>] [[-IsCompressed] <SwitchParameter>] [[-Name] <string>] 
[-AccessRules] <AccessRule[]> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ArtifactIdentifier Identifier der Dateiablage. true true (ByValue)
-Description Beschreibung der Dateiablage. true true (ByValue)
-IsCheckInCommentRequired Angabe, ob ein Eincheckkommentar benötigt wird. false false False
-IsCheckOutCommentRequired Angabe, ob ein Auscheckkommentar benötigt wird. false false False
-MaxFileSizeInMegabytes Angabe der maximalen Dateigröße in MB. false false
-IsCompressed Angabe, ob die Dateien der Dateiablage bei der Ablage in der Datenbank komprimiert werden sollen. false false False
-Name Der Name der Dateiablagenart. false false
-AccessRules Zugriffsregeln. true false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String Identifier der Dateiablage. System.String Beschreibung der Dateiablage.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.FilingCabinets.FilingCabinetType Dateiablageart. Dateiablageart.

Examples

EXAMPLE 1 
New-FilingCabinetType -ArtifactIdentifier "Schleupen.CS.PI.AIF.Test_1.0" -Description "Test" -SessionToken $sessionToken
Legt die Dateiablageart mit den angegebenen Eigenschaften an.

Top of page

New-ScheduledService

Erstellt einen neuen ScheduledService.

Erstellt einen neuen ScheduledService.

Syntax 

New-ScheduledService [-ServiceId] <string> [-Name] <string> [-Request] <object> [[-MessageAction] 
<string>] [[-MessageProtocol] <string>] [[-Force] <SwitchParameter>] [[-ArtifactIdentifier] 
<string>] [[-Id] <Guid>] [-Description] <string> [[-DetailDescription] <string>] [-Weekday] 
<SwitchParameter> [[-Start] <DateTimeOffset>] [-Weekdays] {Monday | Tuesday | Wednesday | Thursday 
| Friday | Saturday | Sunday} [[-IsDisabled] <SwitchParameter>] [-SessionToken] <string> 
[<CommonParameters>]

New-ScheduledService [-ServiceId] <string> [-Name] <string> [[-MessageAction] <string>] 
[[-MessageProtocol] <string>] [[-Force] <SwitchParameter>] [[-ArtifactIdentifier] <string>] [[-Id] 
<Guid>] [-Description] <string> [[-DetailDescription] <string>] [-Onetime] <SwitchParameter> 
[[-Start] <DateTimeOffset>] [[-IsDisabled] <SwitchParameter>] [-SessionToken] <string> [-Request] 
<object> [<CommonParameters>]

New-ScheduledService [-ServiceId] <string> [-Name] <string> [-SessionToken] <string> [-Request] 
<object> [[-MessageAction] <string>] [[-MessageProtocol] <string>] [[-Force] <SwitchParameter>] 
[[-ArtifactIdentifier] <string>] [[-Id] <Guid>] [-Description] <string> [-Cyclic] 
<SwitchParameter> [[-DetailDescription] <string>] [[-Start] <DateTimeOffset>] [-Period] {Seconds | 
Minutes | Hours | Days | Weeks | Months} [-PeriodValue] <int> [[-IsDisabled] <SwitchParameter>] 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id ID als Primärschlüssel des ScheduledService. false true (ByValue)
-ServiceId ID des Webservice. true true (ByValue)
-Name Name des geplanten Serviceaufrufs. true true (ByValue)
-ArtifactIdentifier Name des geplanten Serviceaufrufs. false true (ByValue)
-Description Kurzbeschreibung des geplanten Serviceaufrufs. true true (ByValue)
-DetailDescription Langbeschreibung des geplanten Serviceaufrufs. false true (ByValue)
-Weekday Angabe, dass es sich um einen per Wochentag gestarteten Service handelt. true true (ByValue) False
-Onetime Angabe, dass es sich um einen einmalig gestarteten Service handelt. true true (ByValue) False
-Cyclic Angabe, dass es sich um einen zyklisch gestarteten Service handelt. true true (ByValue) False
-Start Startzeitpunkt des einmalig gestarteten Service bzw. initialer Start des zyklisch gestarteten
Service.		 false true (ByValue) 30.10.2024 09:48:29 +01:00
-Weekdays Die Wochentage.


Possible values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday		 true true (ByValue) 0
-Period Die Art des Zyklus.


Possible values: Seconds, Minutes, Hours, Days, Weeks, Months		 true true (ByValue) Seconds
-PeriodValue Die Wert des Zyklus. true true (ByValue) 0
-IsDisabled Angabe, ob der geplante Serviceaufruf deaktiviert angelegt wird. false true (ByValue) False
-SessionToken Das SessionToken. true true (ByValue)
-Request Die WCF-Message. true true (ByValue)
-MessageAction Das Protokoll der WCF-Message. false true (ByValue)
-MessageProtocol Das Protokoll der WCF-Message. false true (ByValue) http
-Force Angabe, ob der geplante Serviceaufruf deaktiviert angelegt wird. false true (ByValue) False

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Guid ID als Primärschlüssel des ScheduledService. System.String ID des Webservice. System.String Name des geplanten Serviceaufrufs. System.String Name des geplanten Serviceaufrufs. System.String Kurzbeschreibung des geplanten Serviceaufrufs. System.String Langbeschreibung des geplanten Serviceaufrufs. System.Management.Automation.SwitchParameter Angabe, dass es sich um einen per Wochentag gestarteten Service handelt. System.Management.Automation.SwitchParameter Angabe, dass es sich um einen einmalig gestarteten Service handelt. System.Management.Automation.SwitchParameter Angabe, dass es sich um einen zyklisch gestarteten Service handelt. System.DateTimeOffset Startzeitpunkt des einmalig gestarteten Service bzw. initialer Start des zyklisch gestarteten Service. Schleupen.CS.PI.AIF.ScheduledServices.Weekdays Die Wochentage. Schleupen.CS.PI.AIF.ScheduledServices.Period Die Art des Zyklus. System.Int32 Die Wert des Zyklus. System.Management.Automation.SwitchParameter Angabe, ob der geplante Serviceaufruf deaktiviert angelegt wird. System.String Das SessionToken. System.Object Die WCF-Message. System.String Das Protokoll der WCF-Message. System.String Das Protokoll der WCF-Message. System.Management.Automation.SwitchParameter Angabe, ob der geplante Serviceaufruf deaktiviert angelegt wird.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.ScheduledServices.ScheduledService Ein zyklisch ausgeführter Service. Ein zyklisch ausgeführter Service.

Examples

EXAMPLE 1 
New-ScheduledService -ServiceId 'Schleupen.CS.PI.AIF.TestActivityService_3.0' -Weekday -Weekdays Monday -Start '01-01-2019 22:00:00' -SessionToken $sessionToken -Message $message
Erstellt einen neuen ScheduledService, der jeden Montag um 22 Uhr läuft.
EXAMPLE 2 
New-ScheduledService -ServiceId 'Schleupen.CS.PI.AIF.TestActivityService_3.0' -Cyclic -Period Hours -PeriodValue 2 -Start '01-01-2019 22:00:00' -SessionToken $sessionToken -Message $message
Erstellt einen neuen ScheduledService, der ab 1.1.2019 alle 2 Stunden läuft.
EXAMPLE 3 
New-ScheduledService -ServiceId 'Schleupen.CS.PI.AIF.TestActivityService_3.0' -Onetime -Start '01-01-2019 22:00:00' -SessionToken $sessionToken -Message $message
Erstellt einen neuen ScheduledService, der einmalig am 1.1.2019 um 22 Uhr läuft.

Top of page

New-ScheduledServiceType

>Erzeugt einen ScheduledServiceType.

Erzeugt einen neuen, persistenten ScheduledServiceType.

Syntax 

New-ScheduledServiceType [-ServiceId] <string> [[-DialogFlowId] <string>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ServiceId Identifier der Dateiablage. true true (ByValue)
-DialogFlowId Identifier der Dateiablage. false true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String Identifier der Dateiablage. System.String Identifier der Dateiablage.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.PowerShell.ScheduledServices.ScheduledServiceType Art des ScheduledService.

Examples

EXAMPLE 1 
New-ScheduledServiceType -ServiceId "Schleupen.CS.PI.BPE.Tasks.CreateTaskActivityService_3.1" -DialogFlowId "Schleupen.CS.PI.AIF.ScheduledServices.CreateTaskExample_3.1" -SystemStructureViewId 0357aeb0-d3df-4765-b630-596625953505 -SystemStructureElementName 9999 -SystemStructureElementTypeId d60c85f8-483a-43fc-88f2-c93e22770584
Erzeugt einen neuen (persitenten) ScheduledServiceType.

Top of page

New-ServiceRequestFactory

Erstellt eine neue ServiceRequestFactory.

Erstellt eine neue ServiceRequestFactory, die zur Erzeugung von Webservice-Requests verwendet wird.

Syntax 

New-ServiceRequestFactory [-ServiceId] <string> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ServiceId ID des Webservice. true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String ID des Webservice.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.ScheduledServices.ServiceRequestFactory Hilfsklasse zur Erzeugung von Webservice-Requests.

Examples

EXAMPLE 1 
$systemSessionToken = Request-SystemSessionToken
$factory = New-ServiceRequestFactory -ServiceId $serviceId 
$request = $factory.CreateRequestForMessageAction("Execute")
$request.SessionToken = $systemSessionToken
$request.CustomProperty = $factory.CreateCustomObject("MyCustomType")
Der aus technischen Gründen benötigte Namensraum für die Generierung der Client-Klassen wird von der Factory gekapselt.

Top of page

Remove-FilingCabinet

Entfernt Dateiablagen.

Entfernt Dateiablagen.

Syntax 

Remove-FilingCabinet [-Id] <Guid> [-SessionToken] <string> [<CommonParameters>]

Remove-FilingCabinet [-ArtifactIdentifier] <string> [-SessionToken] <string> [<CommonParameters>]

Remove-FilingCabinet [-FilingCabinet] <FilingCabinet> [-SessionToken] <string> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id ID der Dateiablage. true true (ByValue)
-ArtifactIdentifier Identifier der Dateiablage. true true (ByValue)
-FilingCabinet Zu löschende Dateiablage. true true (ByValue)
-SessionToken SessionToken. true false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Guid ID der Dateiablage. System.String Identifier der Dateiablage. Schleupen.CS.PI.AIF.FilingCabinets.FilingCabinet Zu löschende Dateiablage.

Examples

EXAMPLE 1 
Remove-FilingCabinet -ArtifactIdentifier "Schleupen.CS.PI.AIF.Test_1.0".
Entfernt die Dateiablage mit dem Identifier "Schleupen.CS.PI.AIF.Test_1.0".

Top of page

Remove-FilingCabinetType

Entfernt Dateiablagearten.

Entfernt Dateiablagearten.

Syntax 

Remove-FilingCabinetType [-Id] <Guid> [-SessionToken] <string> [<CommonParameters>]

Remove-FilingCabinetType [-ArtifactIdentifier] <string> [-SessionToken] <string> 
[<CommonParameters>]

Remove-FilingCabinetType [-FilingCabinetType] <FilingCabinetType> [-SessionToken] <string> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id ID der Dateiablageart. true true (ByValue)
-ArtifactIdentifier Identifier der Dateiablageart. true true (ByValue)
-FilingCabinetType Zu löschende Dateiablageart. true true (ByValue)
-SessionToken SessionToken. true false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Guid ID der Dateiablageart. System.String Identifier der Dateiablageart. Schleupen.CS.PI.AIF.FilingCabinets.FilingCabinetType Zu löschende Dateiablageart.

Examples

EXAMPLE 1 
Remove-FilingCabinetType -ArtifactIdentifier "Schleupen.CS.PI.AIF.Test_1.0" -SessionToken $sessionToken.
Entfernt die Dateiablageart mit dem Identifier "Schleupen.CS.PI.AIF.Test_1.0".

Top of page

Remove-LicenseFileToSystemStructureElement

>Entfernt die Verknüpfung einer Lizenzdatei mit einem Systemstrukturelement.

Entfernt die Verknüpfung einer Lizenzdatei mit einem Systemstrukturelement.

Syntax 

Remove-LicenseFileToSystemStructureElement [-SessionToken] <string> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken, aus dem das SystemStructureElement gelesen wird, zu welchem die Lizenzdateizuordnung
entfernt werden soll.		 true false

Examples

EXAMPLE 1 
Remove-LicenseFileToSystemStructureElement -SessionToken $systemStructureElementSessionToken
Entfernt die Verknüpfungen des Systemstrukturelements.

Top of page

Remove-ScheduledService

Entfernt ScheduledServices.

Entfernt ScheduledServices.

Syntax 

Remove-ScheduledService [-Id] <Guid> [-SessionToken] <string> [<CommonParameters>]

Remove-ScheduledService [-InputObject] <ScheduledService> [-SessionToken] <string> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id ID des Webservice. true true (ByValue) 00000000-0000-0000-0000-000000000000
-InputObject ScheduledService Der zu löschende ScheduledService. true true (ByValue)
-ScheduledService ScheduledService Der zu löschende ScheduledService.


This is an alias of the InputObject parameter.		 true true (ByValue)
-SessionToken Das SessionToken. true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Guid ID des Webservice. Schleupen.CS.PI.AIF.ScheduledServices.ScheduledService Der zu löschende ScheduledService. System.String Das SessionToken.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.ScheduledServices.ScheduledService Ein zyklisch ausgeführter Service. Ein zyklisch ausgeführter Service.

Examples

EXAMPLE 1 
Remove-ScheduledService -Id '72CA24FF-86BF-4F38-814B-29C0C7EABC1A'
Entfernt den ScheduledService mit der angegebeben ID.
EXAMPLE 2 
Remove-ScheduledService -InputObject $scheduledService
Entfernt den übergebenen ScheduledService.

Top of page

Remove-ScheduledServiceType

Löscht ScheduledServiceType(s).

Löscht ScheduledServiceType(s).

Syntax 

Remove-ScheduledServiceType [-ServiceId] <string> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ServiceId Id des Webservice. true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String Id des Webservice.

Examples

EXAMPLE 1 
Remove-ScheduledServiceType -ServiceId "Schleupen.CS.PI.AIF.Test_1.0"
Testet die aktuelle SMTP-Konfiguration.

Top of page

Save-CabinetFile

Lädt Dateien in die Dateiablage hoch oder aktualisiert vorhandene Dateien.

Mit diesem Powershell Commandlet können Sie Dateien in die Dateiablage hochladen. Wenn Die Datei
bereits in der Dateiablage vorhanden ist, können Sie diese Datei mit diesem Commandlet auch
überschreiben.

Syntax 

Save-CabinetFile -File <string> -SessionToken <string> [-AlternativeFileName <string>] 
[-CabinetFileId <Guid>] [-CheckInComment <string>] [-Description <string>] 
[-DisableSystemStructureNavigation <SwitchParameter>] [-FilingCabinetName <string>] 
[<CommonParameters>]

Save-CabinetFile -Description <string> -File <string> -SessionToken <string> [-CabinetFileId 
<Guid>] [-CheckInComment <string>] [-DisableSystemStructureNavigation <SwitchParameter>] 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-FilingCabinetName Name der Dateiablage. false false
-CabinetFileId Id der Datei in der Dateiablage. false false
-File Die hochzuladende Datei. true false
-AlternativeFileName Der alternative Name der Datei. false false
-Description Beschreibung. true false
-CheckInComment Eincheckkommentar. false false
-DisableSystemStructureNavigation Angabe, ob die Navigation in der Systemstrukur deaktiviert werden soll. false false False
-SessionToken SessionToken. true false

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.FilingCabinets.FilingCabinet Dateiablage.

Examples

EXAMPLE 1 
Save-CabinetFile -FilingCabinetName Rechnungen -File Rechnung_Kunde_32542_201510.pdf -AlternativeFileName Rechnung_32542_2015_Oktober.pdf -Description "Rechnung des Kunden 32542 für Oktober 2015" -CheckInComment "Monatsabrechnung 201510" -SessionToken $sessionToken
Lädt die Datei "Rechnung_Kunde_32542_201510.pdf" unter dem alternativen Namen "Rechnung_32542_2015_Oktober.pdf" unter der Dateiablage "Rechnungen" hoch.

Top of page

Save-FilingCabinet

Speichert Änderungen an einer Dateiablage.

Speichert Änderungen an einer Dateiablage.

Syntax 

Save-FilingCabinet [-Entity] <FilingCabinet> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Entity FilingCabinet Dateiablage, die aktualisiert werden soll. true true (ByValue)
-FilingCabinet FilingCabinet Dateiablage, die aktualisiert werden soll.


This is an alias of the Entity parameter.		 true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Schleupen.CS.PI.AIF.FilingCabinets.FilingCabinet Dateiablage, die aktualisiert werden soll.

Examples

EXAMPLE 1 
Save-FilingCabinet -FilingCabinet $entity
Speichert Änderungen an der Dateiablage.

Top of page

Save-FilingCabinetType

Speichert Änderungen an einer Dateiablageart.

Speichert Änderungen an einer Dateiablageart.

Syntax 

Save-FilingCabinetType [-Entity] <FilingCabinetType> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Entity FilingCabinetType Dateiablageart, die aktualisiert werden soll. true true (ByValue)
-FilingCabinetType FilingCabinetType Dateiablageart, die aktualisiert werden soll.


This is an alias of the Entity parameter.		 true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Schleupen.CS.PI.AIF.FilingCabinets.FilingCabinetType Dateiablageart, die aktualisiert werden soll.

Examples

EXAMPLE 1 
Save-FilingCabinetType -FilingCabinetType $entity -SessionToken $sessionToken
Speichert Änderungen an der Dateiablageart.

Top of page

Save-JobServerConfiguration

Speichert die Konfiguration des Schleupen.CS3 JobServers.

Der JobServer ist ein Windowsdienst zur zeitgesteuerten Ausführung von CS3-Services.

Syntax 

Save-JobServerConfiguration [-JobServerConfiguration] <JobServerConfiguration> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-JobServerConfiguration Konfigurationsobjekt für die Jobserverkonfiguration true false

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.ScheduledServices.Scheduling.JobServerConfiguration Konfiguration des CS-3.0-JobServers

Examples

EXAMPLE 1 
$config = Select-JobServerConfiguration
$config.MaximumJobExecutionAttempts = 3
$config.BlacklistedSystemUsageIds = @('00000000-0000-0000-0000-000000000001','00000000-0000-0000-0000-000000000002')
$config.BlacklistedSystemStructureElementIds = @('C778D996-A8F2-415F-BC9A-CF458F263769','30B5E48B-9843-4421-96B6-BED0B0ECDC61')
Save-JobServerConfiguration $config
In diesem Beispiel wird die aktuelle Konfiguration ermmittelt, verändert und gespeichert.

Top of page

Save-ScheduledService

Speichert Änderungen an einem ScheduledService.

Speichert Änderungen an einem ScheduledService.

Syntax 

Save-ScheduledService [-ScheduledService] <ScheduledService> [-SessionToken] <string> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ScheduledService Zu ändernder Job. true true (ByValue)
-SessionToken Das SessionToken. true false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Schleupen.CS.PI.AIF.ScheduledServices.ScheduledService Zu ändernder Job.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.PowerShell.ScheduledServices.ScheduledServiceType Art des ScheduledService.

Examples

EXAMPLE 1 
Save-ScheduledService -ScheduledService $entity
Speichert Änderungen an einem ScheduledService.

Top of page

Save-ScheduledServiceType

Speichert Änderungen an einem ScheduledServiceType.

Speichert Änderungen an einem ScheduledServiceType.

Syntax 

Save-ScheduledServiceType [-ScheduledServiceType] <ScheduledServiceType> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ScheduledServiceType Jobkategorie. true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Schleupen.CS.PI.AIF.PowerShell.ScheduledServices.ScheduledServiceType Jobkategorie.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.PowerShell.ScheduledServices.ScheduledServiceType Art des ScheduledService.

Examples

EXAMPLE 1 
Save-ScheduledServiceType -ScheduledServiceType $entity
Speichert Änderungen an einem ScheduledServiceType.

Top of page

Select-CustomDataType

Selektiert die CustomDataTypes.

Selektiert die CustomDataTypes.

Syntax 

Select-CustomDataType [[-Name] <string>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Name Name des CustomDataType. false true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String Name des CustomDataType.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.PowerShell.CustomDataTypes.CustomDataType CustomDataType.

Examples

EXAMPLE 1 
Select-CustomDataType -Name "CS.MT.BIB"
Selektiert den CustomDataType mit dem Namen "CS.MT.BIB".

Top of page

Select-FilingCabinet

Selektiert die Dateiablagen.

Selektiert die Dateiablagen anhand der angegebenen Kriterien.

Syntax 

Select-FilingCabinet [[-Id] <Guid>] [[-SearchMode] {BeginsWith | Wildcard | Exact}] 
[[-ArtifactIdentifier] <string>] [[-MaxResults] <int>] [[-Description] <string>] 
[[-IsCheckInCommentRequired] <SwitchParameter>] [[-IsCheckOutCommentRequired] <SwitchParameter>] 
[[-FilingCabinetTypeName] <string>] [[-Name] <string>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id ID der Dateiablage. false true (ByValue)
-ArtifactIdentifier Identifier der Dateiablage. false true (ByValue)
-Description Beschreibung der Dateiablage. false true (ByValue)
-IsCheckInCommentRequired Angabe, ob ein Eincheckkommentar benötigt wird. false false False
-IsCheckOutCommentRequired Angabe, ob ein Auscheckkommentar benötigt wird. false false False
-FilingCabinetTypeName ID der Dateiablageart. false false
-Name Name der Dateiablage. false false
-SearchMode Possible values: BeginsWith, Wildcard, Exact false true (ByValue) BeginsWith
-MaxResults false true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Guid ID der Dateiablage. System.String Identifier der Dateiablage. System.String Beschreibung der Dateiablage. Schleupen.CS.PI.Framework.PowerShell.SearchMode System.Int32

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.FilingCabinets.FilingCabinet Dateiablage.

Examples

EXAMPLE 1 
Select-FilingCabinet
Selektiert alle Dateiablagen.
EXAMPLE 2 
Select-FilingCabinet -ArtifactIdentifier "Schleupen.CS.PI.AIF.Test_1.0"
Selektiert die Dateiablage mit dem angegebenen Identifier.

Top of page

Select-FilingCabinetType

Selektiert die Dateiablagearten.

Selektiert die Dateiablagearten anhand der angegebenen Kriterien.

Syntax 

Select-FilingCabinetType [[-Id] <Guid>] [[-SearchMode] {BeginsWith | Wildcard | Exact}] 
[[-ArtifactIdentifier] <string>] [[-MaxResults] <int>] [[-Description] <string>] 
[[-IsCheckInCommentRequired] <SwitchParameter>] [[-IsCheckOutCommentRequired] <SwitchParameter>] 
[[-Name] <string>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id ID der Dateiablageart. false true (ByValue)
-ArtifactIdentifier Identifier der Dateiablageart. false true (ByValue)
-Description Beschreibung der Dateiablageart. false true (ByValue)
-IsCheckInCommentRequired Angabe, ob ein Eincheckkommentar benötigt wird. false false False
-IsCheckOutCommentRequired Angabe, ob ein Auscheckkommentar benötigt wird. false false False
-Name Name der Dateiablageart. false false
-SearchMode Possible values: BeginsWith, Wildcard, Exact false true (ByValue) BeginsWith
-MaxResults false true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Guid ID der Dateiablageart. System.String Identifier der Dateiablageart. System.String Beschreibung der Dateiablageart. Schleupen.CS.PI.Framework.PowerShell.SearchMode System.Int32

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.FilingCabinets.FilingCabinetType Dateiablageart. Dateiablageart.

Examples

EXAMPLE 1 
Select-FilingCabinetType
Selektiert alle Dateiablagearten.
EXAMPLE 2 
Select-FilingCabinetType -ArtifactIdentifier "Schleupen.CS.PI.AIF.Test_1.0" -SessionToken $sessionToken
Selektiert die Dateiablageart mit dem angegebenen Identifier.

Top of page

Select-JobServerConfiguration

Ermittelt die Konfiguration des Schleupen-CS-3.0-Job-Servers.

Der JobServer ist ein Windowsdienst zur zeitgesteuerten Ausführung von CS-3.0--Services.

Syntax 

Select-JobServerConfiguration [<CommonParameters>]

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.ScheduledServices.Scheduling.JobServerConfiguration Konfiguration des CS-3.0-JobServers

Examples

EXAMPLE 1 
Select-JobServerConfiguration
In diesem Beispiel wird die aktuelle Konfiguration ermmittelt und angezeigt.
EXAMPLE 2 
$config = Select-JobServerConfiguration
In diesem Beispiel wird die aktuelle Konfiguration ermmittelt und einer Variable zugewiesen.

Top of page

Select-MailConfiguration

Selektiert die aktuelle E-Mail-Konfiguration.

Selektiert die aktuelle E-Mail-Konfiguration.

Syntax 

Select-MailConfiguration [-SessionToken] <string> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken SessionToken. true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String SessionToken.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.Mails.MailConfigurationContract

Examples

EXAMPLE 1 
Select-MailConfiguration -SessionToken $token
Selektiert die E-Mail-Konfiguration.

Top of page

Select-ScheduledService

Selektiert ScheduledServices.

Selektiert ScheduledServices.

Syntax 

Select-ScheduledService [[-ServiceId] <string>] [[-Name] <string>] [-SessionToken] <string> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ServiceId ID des Webservice. false true (ByValue)
-Name Name des Services. false true (ByValue)
-SessionToken Das SessionToken. true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String ID des Webservice. System.String Name des Services. System.String Das SessionToken.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.ScheduledServices.ScheduledService Ein zyklisch ausgeführter Service. Ein zyklisch ausgeführter Service.

Examples

EXAMPLE 1 
Select-ScheduledService
Selektiert alle ScheduledServices.
EXAMPLE 2 
Select-ScheduledService -ServiceId "Schleupen.CS.PI.AIF.TestActivityService_3.0"
Selektiert den ScheduledService mit der Service-ID "Schleupen.CS.PI.AIF.TestActivityService_3.0".

Top of page

Select-ScheduledServiceType

Selektiert ScheduledServiceTypes.

Selektiert ScheduledServiceTypes.

Syntax 

Select-ScheduledServiceType [[-ServiceId] <string>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ServiceId Id des Webservice. false true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String Id des Webservice.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.PowerShell.ScheduledServices.ScheduledServiceType Art des ScheduledService.

Examples

EXAMPLE 1 
Select-ScheduledServiceType
Selektiert alle ScheduledServiceTypes.
EXAMPLE 2 
Select-ScheduledServiceType -ServiceId "Schleupen.CS.PI.AIF.TestActivityService_3.0"
Selektiert den ScheduledServiceType "Schleupen.CS.PI.AIF.TestActivityService_3.0".

Top of page

Select-SmtpConfiguration

Selektiert die aktuelle SmtpConfiguration.

Selektiert die aktuelle SmtpConfiguration.

Syntax 

Select-SmtpConfiguration [-SessionToken] <string> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SessionToken Name des Adapters. true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String Name des Adapters.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Schleupen.CS.PI.AIF.Mails.SmtpConfigurationContract

Examples

EXAMPLE 1 
Select-SmtpConfiguration -SessionToken $token
Selektiert die SMTP-Konfiguration.

Top of page

Select-SystemStructureLicenseFile

Liefert eine Übersicht über die Lizenzen.

Liefert eine Übersicht über die Lizenzen in der aktuellen Systemstruktur.

Syntax 

Select-SystemStructureLicenseFile [[-OutputAsObjects] <SwitchParameter>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-OutputAsObjects Wenn angegeben, werden die Lizenzdateizuordnungen als Objekte ausgegeben. false false False

Examples

EXAMPLE 1 
Select-SystemStructureLicenseFile -Verbose
Zeigt die Übersicht an

Top of page

Set-MailConfiguration

Setzt die MailConfiguration.

Setzt die MailConfiguration.

Syntax 

Set-MailConfiguration [-SenderEmailAddress] <string> [-SessionToken] <string> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SenderEmailAddress Standardabsender für E-Mails, die vom System versendet werden. true true (ByValue)
-SessionToken SessionToken. true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String Standardabsender für E-Mails, die vom System versendet werden. System.String SessionToken.

Examples

EXAMPLE 1 
Set-MailConfiguration -SessionToken $token -SenderEmailAddress "abc@def.de"
Setzt die E-Mail-Konfiguration.

Top of page

Set-SmtpConfiguration

Setzt die SmtpConfiguration.

Setzt die SmtpConfiguration.

Syntax 

Set-SmtpConfiguration [-SmtpHost] <string> [[-SmtpPort] <int>] [[-UseDefaultNetworkCredentials] 
<bool>] [[-Credential] <PSCredential>] [[-EnableSsl] <bool>] [-SessionToken] <string> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SmtpHost Hostname oder IP-Adresse. true true (ByValue)
-SmtpPort Port (Standard: 25). false true (ByValue) 0
-UseDefaultNetworkCredentials Legt fest, ob bei der Authentifizierung mit dem SMTP-Server, die Credentials des Aufrufers
verwendet werden sollen.		 false true (ByValue) False
-Credential Anmeldeinformationen, welche bei der Authentifizierung mit dem SMTP-Server verwendet werden sollen. false true (ByValue)
-EnableSsl Legt fest, ob die Kommuniation zum SMTP-Server verschlüsselt erfolgen soll. false true (ByValue) False
-SessionToken SessionToken. true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String Hostname oder IP-Adresse. System.Int32 Port (Standard: 25). System.Boolean Legt fest, ob bei der Authentifizierung mit dem SMTP-Server, die Credentials des Aufrufers verwendet werden sollen. System.Management.Automation.PSCredential Anmeldeinformationen, welche bei der Authentifizierung mit dem SMTP-Server verwendet werden sollen. System.Boolean Legt fest, ob die Kommuniation zum SMTP-Server verschlüsselt erfolgen soll. System.String SessionToken.

Examples

EXAMPLE 1 
Set-SmtpConfiguration -SessionToken $token -Credential (Get-Credential) -SmtpHost "Host" -SmtpPort "1234"
Setzt die SMTP-Konfiguration.

Top of page

Test-SmtpConfiguration

Testet die aktuelle SMTP-Konfiguration.

Testet die aktuelle SMTP-Konfiguration. Sendet ggf.eine Test-E-Mail.

Syntax 

Test-SmtpConfiguration [[-Sender] <string>] [[-Recipient] <string>] [-SessionToken] <string> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Sender Name des Adapters. false true (ByValue)
-Recipient Name des Adapters. false true (ByValue)
-SessionToken Name des Adapters. true true (ByValue)

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String Name des Adapters. System.String Name des Adapters. System.String Name des Adapters.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.String

Examples

EXAMPLE 1 
Test-SmtpConfiguration -SessionToken $token -Sender "sender@schleupen.de" -Recipient "empfänger@schleupen.de"
Testet die aktuelle SMTP-Konfiguration.

Top of page