Schleupen.CS.AP.DM.Systemkonfiguration.PowerShell

New-CSAWCConnection

Erstellt eine neue Archivwebclient-Verbindung.

Erstellt eine neue Archivwebclient-Verbindung, die anschließend mit "Save-CSAWCConnection"
gespeichert werden kann.

Syntax 

New-CSAWCConnection [-SystemStructureElementId] <Guid> [-WebAddress] <String> [-Id] <Guid> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SystemStructureElementId Die Id des zugeordneten Systemstrukturelementes. true true (ByValue)
-WebAddress Die aufzurufende Web-Adresse. true true (ByValue)
-Id Die Id, mit der die Verbindung persistiert werden soll. true true (ByValue)

Examples

BEISPIEL 1 
$connection = New-CSAWCConnection -SystemStructureElementId '779A6F2B-63E4-40E9-BDE1-61C631E9D1CE' -WebAddress 'http://archives.example.com/archive1/client' -Id '379A6F2B-68E4-40E9-ADE1-61C631E9D1C1'
Erstellt eine neue Verbindung anhand der angegebenen Argumente und speichert sie in der Variablen "$connection".

Top of page

New-CSDocumentGroup

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id Keine false true (ByValue)
-Name Keine true true (ByValue)

New-CSDocumentType

Parameters

Name Alias Description Required? Pipeline Input Default Value
-DocumentGroupId Keine false false
-Externalversion Keine true false
-Name Keine true false
-NameSpace Keine true false
-ShortName Keine false false

New-CSEingangsKanalArt

Parameters

Name Alias Description Required? Pipeline Input Default Value
-DialogFlowId Keine true true (ByValue)
-Id Keine true true (ByValue)
-Name Keine true true (ByValue)

New-CSMetadataSchema

Erstellt ein neues Metadata Schema.

Erstellt ein neues Metadata Schema.

Syntax 

New-CSMetadataSchema [-Namespace] <String> [-Name] <String> [-ExternalVersion] <String> 
[-Abstract] [[-DerivedFrom] <String>] [[-CabinetFileInfoId] <String>] [[-ServiceArtifactId] 
<String>] [[-DialogFlowId] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Namespace Der Namensraum des Schemas. true true (ByValue)
-Name Der Namedes Schemas. true true (ByValue)
-ExternalVersion Die Externe Versionsnummer des Metadatenschemas. true true (ByValue)
-Abstract Gibt an ob das Schema Abstract ist. false false False
-DerivedFrom Gibt an von welchem Schema, diese spezialisiert ist. false false
-CabinetFileInfoId Die Id des zugehörigen CabinetFileInfos. false false [guid]::empty
-ServiceArtifactId false false
-DialogFlowId false false

Examples

BEISPIEL 1 
# Legt eine neues Metadata Schema als Domainobjekt an.
New-CSMetadataSchema -Name 'TestName' -Namespace 'TestNamespace' -ExternalVersion '6.0'

Top of page

New-CSMetadataSchemaPropertyDescription

Eine Hilfsmethode für das Erstellen eines Objektes welcher eine Eigenschaft eines Metadatenschematas beschreibt.

Erstellt ein Objekt welches eine Eigenschaft eines Metadatenschematas beschreibt.

Syntax 

New-CSMetadataSchemaPropertyDescription [-Name] <String> [-DisplayName] <String> [-PropertyType] 
{Boolean | DateTime | Double | Long | String} [[-Choice] <String>] [[-Group] <String>] 
[-IsMandatory] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Name Der Name des Eigenschaftes. true true (ByValue)
-DisplayName Der Anzeigename welches für die Oberfläche verwendet wird. true true (ByValue)
-PropertyType Gibt den Typ der Eigenschaft an. true false
-Choice Legt fest ob, und zu welchen Choice-Element die Eigenschaft gehört. false true (ByValue) [string]::Empty
-Group Legt fest ob, und zu welchen Group-Element die Eigenschaft gehört. false true (ByValue) [string]::Empty
-IsMandatory false true (ByValue) False

Examples

BEISPIEL 1 
# Legt eine neues Metadata Schema als Domainobjekt an.
New-CSMetadataSchemaPropertyDescription -Name 'SystemUsage' -DisplayName 'Verwendungszweck' -PropertyType String

Top of page

New-CSMetadataSchemaV2

Erstellt ein neues Metadaten Schema.

Erstellt ein neues Metadaten Schema.

Syntax 

New-CSMetadataSchemaV2 [-Namespace] <String> [-Name] <String> [-ExternalVersion] <String> 
[-Abstract] [[-DerivedFrom] <String>] [[-ServiceArtifactId] <String>] [[-DialogFlowId] <String>] 
[[-PropertyDescriptions] <CSMetadataSchemaPropertyDescription[]>] [-DisplayName] <String> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Namespace Der Namensraum des Schemas. true true (ByValue)
-Name Der Name des Schemas. true true (ByValue)
-ExternalVersion Die Externe Versionsnummer des Metadatenschemas. true true (ByValue)
-Abstract Gibt an ob das Schema abstract ist. false false False
-DerivedFrom Gibt an von welchem Schema, diese spezialisiert ist. false false
-ServiceArtifactId false false
-DialogFlowId false false
-PropertyDescriptions false false
-DisplayName true false

Examples

BEISPIEL 1 
# Legt eine neues Metadata Schema als Domainobjekt an.
New-CSMetadataSchemaV2 -Name 'TestName' -Namespace 'Schleupen.CS.XS' -ExternalVersion '3.0'

Top of page

Remove-CSAWCConnection

Entfernt die angegebenen Archivwebclient-Verbindungen.

Entfernt eine oder mehrere Archivwebclient-Verbindungen anhand der übergebenen Ids.

Syntax 

Remove-CSAWCConnection -Ids <Guid[]> -SessionToken <String> [<CommonParameters>]

Remove-CSAWCConnection -Id <Guid> -SessionToken <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Ids Die Ids der zu löschenden Archivwebclient-Verbindungen. true true (ByValue)
-Id Die Id der zu löschenden Archivwebclient-Verbindung. true true (ByValue)
-SessionToken Das Session Token. true true (ByValue)

Examples

BEISPIEL 1 
Remove-CSAWCConnection -SessionToken $sessionToken -Id b4bf834f-85b3-4283-a841-af0bb040cade
Entfernt eine Archivwebclient-Verbindung anhand der angegebenen Id. Der zugehörige Systemstrukturknoten wird als Session Token angegeben.
BEISPIEL 2 
Remove-CSAWCConnection -SessionToken $sessionToken -Ids @('b4bf834f-85b3-4283-a841-af0bb040cade','c3bf834f-85b3-4283-a841-af0bb040cacd')
Entfernt zwei Archivwebclient-Verbindungen anhand der angegebenen Ids. Der zugehörige Systemstrukturknoten wird als Session Token angegeben.

Top of page

Remove-CSDocumentGroup

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id Keine true true (ByValue)
-Ids Keine true true (ByValue)
-Name Keine true true (ByValue)
-SessionToken Keine true true (ByValue)

Remove-CSDocumentType

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id Keine true true (ByValue)
-Ids Keine true true (ByValue)
-SessionToken Keine true true (ByValue)

Remove-CSEingangsKanalArt

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id Keine true true (ByValue)
-Ids Keine true true (ByValue)
-SessionToken Keine true true (ByValue)

Remove-CSMetadataSchema

Löscht ein Schema.

Löscht ein Schema.

Syntax 

Remove-CSMetadataSchema [-MetadataSchema] <CSMetadataSchemaV2> [-SessionToken] <String> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-MetadataSchema Das zu löschende Schema. true true (ByValue)
-SessionToken Der Session Token. true true (ByValue)

Examples

BEISPIEL 1 
# Löscht eine Metadatenschema aus dem System.
$sessionToken = Request-SessionToken -ViewName Standard -ElementName 9999 -ElementTypeName Mandant -SystemUsages Produktiv $metadataSchema = Select-CSMetadataSchemaV2 -SessionToken $st -Name 'TestName' -Namespace 'Schleupen.CS.AP.DM' -ExternalVersion '3.0' Remove-CSMetadataSchema -MetadataSChema $metadataSchema -SessionToken $sessionToken

Top of page

Save-CSAWCConnection

Speichert die angegebene Archivwebclient-Verbindung.

Speichert die angegebene Archivwebclient-Verbindung. Sofern bereits eine
Archivwebclient-Verbindung mit der gleichen Id existiert, wird diese überschrieben, ansonsten wird
eine neue angelegt.

Syntax 

Save-CSAWCConnection [-SessionToken] <String> [-Connection] <Object> [<CommonParameters>]

Parameters

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

Examples

BEISPIEL 1 
Save-CSAWCConnection -SessionToken $sessionToken -Connection $connection
Legt eine neue Archivwebclient-Verbindung an und speichert sie. Der zugehörige Systemstrukturknoten wird als Session Token angegeben.

Top of page

Save-CSDocumentGroup

Parameters

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

Save-CSDocumentType

Speichert einen Dokumententypen.

Speichert einen Dokumententypen.

Syntax 

Save-CSDocumentType [-DocumentType] <CSDocumentType> [-SessionToken] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-DocumentType Der zu speichernde Dokumententyp. true true (ByValue)
-SessionToken Der Session Token. true true (ByValue)

Examples

BEISPIEL 1 
# Persistiert einen Dokumenttypen.
$nameSpace = "aaa.bbb " $name = "ccc" $externalVersion = "1.0" $documentType = New-CSDocumentType -Namespace $nameSpace -Name $name -Externalversion $externalVersion -DocumentGroupId '0B2E84F6-5251-4FD0-8B40-20176635C807' Save-CSDocumentType -DocumentType $documentType -SessionToken $sessionToken

Top of page

Save-CSEingangsKanalArt

Parameters

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

Save-CSMetadataSchema

Speichert ein Schema.

Speichert ein Schema.

Syntax 

Save-CSMetadataSchema [-MetadataSchema] <CSMetadataSchema> [-XsdFilePath] <String> [-SessionToken] 
<String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-MetadataSchema Der zu speichernde Schema. true true (ByValue)
-XsdFilePath Der vollständige Pfad (inkl. Dateiname) der Datei. true true (ByValue)
-SessionToken Der Session Token. true true (ByValue)

Examples

BEISPIEL 1 
# Legt eine neues Metadata Schema als Domainobjekt an.
$sessionToken = Request-SessionToken -ViewName Standard -ElementName 9999 -ElementTypeName Mandant -SystemUsages Produktiv Save-CSMetadataSchema -MetadataSchema (New-CSMetadataSchema -Name 'SystemAndClassificationAttribute_Schema' -Namespace 'Schleupen.CS' -ExternalVersion '3.0') -XsdFilePath (Join-Path $PSScriptRoot -ChildPath 'FileName.xsd') -SessionToken $sessionToken

Top of page

Save-CSMetadataSchemaV2

Speichert ein Schema.

Speichert ein Schema.

Syntax 

Save-CSMetadataSchemaV2 [-MetadataSchema] <CSMetadataSchemaV2> [-SessionToken] <String> 
[<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-MetadataSchema Der zu speichernde Schema. true true (ByValue)
-SessionToken Der Session Token. true true (ByValue)

Examples

BEISPIEL 1 
# Legt eine neues Metadata Schema als Domainobjekt an.
$sessionToken = Request-SessionToken -ViewName Standard -ElementName 9999 -ElementTypeName Mandant -SystemUsages Produktiv Save-CSMetadataSchemaV2 -MetadataSchema (New-CSMetadataSchemaV2 -Name 'SystemAndClassificationAttribute_Schema' -Namespace 'Schleupen.CS' -ExternalVersion '3.0') -XsdFilePath (Join-Path $PSScriptRoot -ChildPath 'FileName.xsd') -SessionToken $sessionToken

Top of page

Select-CSAWCConnection

Listet vorhandene Archivwebclient-Verbindungen auf.

Listet vorhandene Archivwebclient-Verbindungen anhand der übergebenen Kriterien auf.

Syntax 

Select-CSAWCConnection [-SystemStructureElementId <Guid>] [-WebAddress <String>] -SessionToken 
<String> [<CommonParameters>]

Select-CSAWCConnection [-Id <Guid>] -SessionToken <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-SystemStructureElementId Die Id des Systemstrukturelementes, dem die Verbindung zugeordnet ist. false true (ByValue)
-WebAddress Die konfigurierte Web-Adresse der Verbindung. false true (ByValue)
-Id Die Id der Verbindung. false true (ByValue)
-SessionToken Das Session Token. true true (ByValue)

Examples

BEISPIEL 1 
Select-CSAWCConnection -SessionToken $sessionToken -SystemStructureElementId '779A6F2B-63E4-40E9-BDE1-61C631E9D1CE'
Selektiert Verbindungen anhand ihres Systemstrukturelementes. Der zugehörige Systemstrukturknoten wird als SessionToken angegeben.
BEISPIEL 2 
Select-CSAWCConnection -SessionToken $sessionToken -WebAddress 'http://archives.example.com/archive1/client'
Selektiert Verbindungen anhand ihrer Web-Adresse. Der zugehörige Systemstrukturknoten wird als Session Token angegeben.
BEISPIEL 3 
Select-CSAWCConnection -SessionToken $sessionToken -Id '779A6F2B-63E4-40E9-BDE1-61C631E9D1CE'
Selektiert eine Eingangskanal-Art anhand eines Ids. Der zugehörige Systemstrukturknoten wird als Session Token angegeben.

Top of page

Select-CSDocumentGroup

Parameters

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

Select-CSDocumentTypeById

Parameters

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

Select-CSDocumentTypeByName

Parameters

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

Select-CSEingangsKanalArt

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Id Keine false true (ByValue)
-Name Keine false true (ByValue)
-SessionToken Keine false true (ByValue)

Select-CSMetadataSchema

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ExternalVersion Keine true true (ByValue)
-Name Keine true true (ByValue)
-Namespace Keine true true (ByValue)
-SessionToken Keine true true (ByValue)

Select-CSMetadataSchemaV2

Parameters

Name Alias Description Required? Pipeline Input Default Value
-ExternalVersion Keine false true (ByValue)
-Name Keine false true (ByValue)
-Namespace Keine false true (ByValue)
-SessionToken Keine true true (ByValue)

Update-CSMetadataSchemaAndQueryServiceEndpointForCompletingMetadata

Konfiguriert für ein existierendes Metadatenschema einen spezifischen Dienst und Dialogablauf für die automatische und manuelle Metadatenvervollständigung und stellt sicher, dass für den Dienst auch ein zugehöriger Endpunkt definiert ist.

Konfiguriert für ein existierendes Metadatenschema einen spezifischen Dienst und Dialogablauf für
die
automatische und manuelle Metadatenvervollständigung und stellt sicher, dass für den Dienst auch
ein
zugehöriger Endpunkt definiert ist. Das Metadatenschema muss bereits vorhanden sein. Der
Endpunkt wird
angelegt, falls er noch nicht vorhanden ist.

Syntax 

Update-CSMetadataSchemaAndQueryServiceEndpointForCompletingMetadata [-MetadataSchemaNamespace] 
<String> [-MetadataSchemaName] <String> [-MetadataSchemaVersion] <String> 
[-QueryServiceArtifactId] <String> [-QueryServiceAddressTemplate] <String> [[-DialogFlowId] 
<String>] [-SessionToken] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-MetadataSchemaNamespace Der Namensraum des zu konfigurierenden Metadatenschemas. true true (ByValue)
-MetadataSchemaName Der Name des zu konfigurierenden Metadatenschemas. true true (ByValue)
-MetadataSchemaVersion Die Version des zu konfigurierenden Metadatenschemas. true true (ByValue)
-QueryServiceArtifactId Die Artefakt-Id des spezifischen Metadatenabfragedienstes für die automatische
Metadatenvervollständigung.		 true true (ByValue)
-QueryServiceAddressTemplate Die Adressvorlage für den Endpunkt des spezifischen Metadatenabfragedienstes. true true (ByValue)
-DialogFlowId Die Artefakt-Id des Dialogablaufs für die manuelle Metadatenvervollständigung. false true (ByValue)
-SessionToken Das Session Token. true true (ByValue)

Examples

BEISPIEL 1 
$sessionToken = Request-SessionToken -ViewName Standard -ElementName 9999 -ElementTypeName Mandant -SystemUsages Produktiv
Update-CSMetadataSchemaAndQueryServiceEndpointForCompletingMetadata ` -MetadataSchemaNamespace "Schleupen.XS.AP.ZD.Metadata" ` -MetadataSchemaName "Person" ` -MetadataSchemaVersion "3.1" ` -QueryServiceArtifactId "Schleupen.XS.AP.ZD.Personen.PersonMetadatenQueryService_3.1" ` -QueryServiceAddressTemplate "http://{DeploymentRole:BusinessProcessServer}/Schleupen/Schleupen.XS .AP.ZD.Personen.Services/Schleupen.XS.AP.DM.Metadaten.DokumentMetadatenQueryService_3.1.DokumentMet adatenQueryService.svc/" ` -DialogFlowId "Schleupen.CS.asd.sta.per.PersonVerwalten_3.1" ` -SessionToken $sessionToken Konfiguriert für das Metadatenschema "Schleupen.XS.AP.ZD.Metadata.Person_3.1" den in "AP.ZD" befindlichen spezifischen Abfragedienst "PersonMetadatenQueryService_3.1" sowie den in "asd.sta.per" befindlichen Dialogablauf "PersonVerwalten_3.1" und stellt sicher, dass für den Dienst auch ein zugehöriger Endpunkt registriert ist.

Top of page

Update-CSMetadataSchemaAndQueryServiceEndpointForCompletingMetadataV2

Konfiguriert für ein existierendes Metadatenschema einen spezifischen Dienst und Dialogablauf für die automatische und manuelle Metadatenvervollständigung und stellt sicher, dass für den Dienst auch ein zugehöriger Endpunkt definiert ist.

Konfiguriert für ein existierendes Metadatenschema einen spezifischen Dienst und Dialogablauf für
die
automatische und manuelle Metadatenvervollständigung und stellt sicher, dass für den Dienst auch
ein
zugehöriger Endpunkt definiert ist. Das Metadatenschema muss bereits vorhanden sein. Der
Endpunkt wird
angelegt, falls er noch nicht vorhanden ist.

Syntax 

Update-CSMetadataSchemaAndQueryServiceEndpointForCompletingMetadataV2 [-MetadataSchemaNamespace] 
<String> [-MetadataSchemaName] <String> [-MetadataSchemaVersion] <String> 
[-QueryServiceArtifactId] <String> [-QueryServiceAddressTemplate] <String> [[-DialogFlowId] 
<String>] [-SessionToken] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-MetadataSchemaNamespace Der Namensraum des zu konfigurierenden Metadatenschemas. true true (ByValue)
-MetadataSchemaName Der Name des zu konfigurierenden Metadatenschemas. true true (ByValue)
-MetadataSchemaVersion Die Version des zu konfigurierenden Metadatenschemas. true true (ByValue)
-QueryServiceArtifactId Die Artefakt-Id des spezifischen Metadatenabfragedienstes für die automatische
Metadatenvervollständigung.		 true true (ByValue)
-QueryServiceAddressTemplate Die Adressvorlage für den Endpunkt des spezifischen Metadatenabfragedienstes. true true (ByValue)
-DialogFlowId Die Artefakt-Id des Dialogablaufs für die manuelle Metadatenvervollständigung. false true (ByValue)
-SessionToken Das Session Token. true true (ByValue)

Examples

BEISPIEL 1 
$sessionToken = Request-SessionToken -ViewName Standard -ElementName 9999 -ElementTypeName Mandant -SystemUsages Produktiv
Update-CSMetadataSchemaAndQueryServiceEndpointForCompletingMetadataV2 ` -MetadataSchemaNamespace "Schleupen.XS.AP.ZD.Metadata" ` -MetadataSchemaName "Person" ` -MetadataSchemaVersion "3.1" ` -QueryServiceArtifactId "Schleupen.XS.AP.ZD.Personen.PersonMetadatenQueryService_3.1" ` -QueryServiceAddressTemplate "http://{DeploymentRole:BusinessProcessServer}/Schleupen/Schleupen.XS .AP.ZD.Personen.Services/Schleupen.XS.AP.DM.Metadaten.DokumentMetadatenQueryService_3.1.DokumentMet adatenQueryService.svc/" ` -DialogFlowId "Schleupen.CS.asd.sta.per.PersonVerwalten_3.1" ` -SessionToken $sessionToken Konfiguriert für das Metadatenschema "Schleupen.XS.AP.ZD.Metadata.Person_3.1" den in "AP.ZD" befindlichen spezifischen Abfragedienst "PersonMetadatenQueryService_3.1" sowie den in "asd.sta.per" befindlichen Dialogablauf "PersonVerwalten_3.1" und stellt sicher, dass für den Dienst auch ein zugehöriger Endpunkt registriert ist.

Top of page