Il cmdlet Export-IDQDocumentation esporta la documentazione automatica di un Package in formato XML.
A partire da Irion EDM 2016 Update 11 E' stato esteso il comportamento con l'agginta di alcuni parametri opzionali per ottenere anche ulteriori formati di documentazione automatica. |
Sintassi
<# Exports the IrionEDM Package automatic documentation in drive mode #> |
Export-IDQDocumentation [-Fullname] <string> [-Filename] <string> [[-EncryptionPassword] <securestring>] [[-ExportType] {Pdf | Word | Rtf | Xps | Html}] [[-TemplateName] <string>] [[-RuleDocumentationMode] {Technical | Business | Both}] [-WhatIf] [-Confirm] [<CommonParameters>] |
<# Exports the IrionEDM Package automatic documentation in pipeline #> |
Export-IDQDocumentation [-Filename] <string> [[-EncryptionPassword] <securestring>] [[-ExportType] {Pdf | Word | Rtf | Xps | Html}] [[-TemplateName] <string>] [[-RuleDocumentationMode] {Technical | Business | Both}] [-InputObject <psobject>] [-WhatIf] [-Confirm] [<CommonParameters>] |
Parametro |
Descrizione |
Richiesto |
-Filename <string> |
File di destinazione nel file system in cui esportare la documentazione |
Y |
-Fullname <string> |
Full name del Package all'interno del Catalog. |
Y |
-ExportType {Pdf | Word | Rtf | Xps | Html} |
Tipo di file che conterrà la documentazione. |
N |
-TemplateName <string> |
Nome del template da utilizzare per la documentazione |
N |
-RuleDocumentationMode {Technical | Business | Both} |
Modalità di documentazione delle rule |
N |
-InputObject <psobject> |
Oggetto PowerShell corrispondente al Full name del Package all'interno del Catalog. |
Y |
-EncryptionPassword <string> |
Password di esecuzione del package. |
Y |
-Confirm |
Visualizza un messaggio di conferma all’atto dell’esecuzione del comando |
N |
-WhatIf |
Simula il commandlet restituendo a video gli step di esecuzione senza effettuarli |
N |
Il cmdlet ha effetto a condizione che sia lanciato dal drive corrispondente al Catalog. |
Questo parametro indica il tipo di file che conterrà la documentazione.
Se il parametro è omesso, la documentazione è esportata in formato XML.