en-US/PWPS_ExpImpAndReports.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Import-PWDocumentsFromArchive --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Import-PWDocumentsFromArchive</command:name> <command:verb>Import</command:verb> <command:noun>PWDocumentsFromArchive</command:noun> <maml:description> <maml:para>Imports files, metadata and audit trail infrom from a SQLite archive container generated by Export-PWDocumentsToArchive</maml:para> </maml:description> </command:details> <maml:description> <maml:para>#Will import documents from an archive container.</maml:para> <maml:para>Import-PWDocumentsFromArchive -InputFile c:\export\export.db -TargetFolder "Imports\From Disk" -DefaultStorage Storage01 -ReplaceIfExists</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-PWDocumentsFromArchive</maml:name> <!-- Parameter: InputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Spreadsheet to import from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetProjectWiseFolder</maml:name> <maml:description> <maml:para>Target parent folder. Builds relative folders beneath.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultStorage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DefaultStorage</maml:name> <maml:description> <maml:para>Storage for new folders.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplaceIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ReplaceIfExists</maml:name> <maml:description> <maml:para>If file exists in ProjectWise, replace it. Will version if not set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LocalFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Local folder for extracting files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnvironmentsOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>EnvironmentsOnly</maml:name> <maml:description> <maml:para>Just import environments.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Spreadsheet to import from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetProjectWiseFolder</maml:name> <maml:description> <maml:para>Target parent folder. Builds relative folders beneath.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultStorage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DefaultStorage</maml:name> <maml:description> <maml:para>Storage for new folders.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplaceIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ReplaceIfExists</maml:name> <maml:description> <maml:para>If file exists in ProjectWise, replace it. Will version if not set.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: LocalFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Local folder for extracting files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnvironmentsOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>EnvironmentsOnly</maml:name> <maml:description> <maml:para>Just import environments.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Will import documents from an archive container.</maml:para> <maml:para>Import-PWDocumentsFromArchive -InputFile c:\export\export.db -TargetFolder "Imports\From Disk" -DefaultStorage Storage01 -ReplaceIfExists</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWDocumentsToArchive --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-PWDocumentsToArchive</command:name> <command:verb>Export</command:verb> <command:noun>PWDocumentsToArchive</command:noun> <maml:description> <maml:para>Export files, metadata, and audit trail data to a SQLite container. Should be able to import with Import-PWDocumentsFromArchive.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>#Will export documents returned by the listed saved searches to an archive container.</maml:para> <maml:para>#SQLiteStudio seems like an adequate managment tool (http://sqlitestudio.pl/?act=download) for the resulting container.</maml:para> <maml:para>Export-PWDocumentsToArchive -OutputFolder c:\export -Searches "60% Complete;80% Complete;90% Complete"</maml:para> <maml:para>#Will export documents in given folder to an archive container.</maml:para> <maml:para>Export-PWDocumentsToArchive -OutputFolder c:\export -ProjectWiseFolder "Source A\Subfolder 1"</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-PWDocumentsToArchive</maml:name> <!-- Parameter: OutputFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Folder on disk for output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectWiseFolder</maml:name> <maml:description> <maml:para>Optional ProjectWise folder path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Searches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Searches</maml:name> <maml:description> <maml:para>Optional semi-colon delimited list of saved searches to process.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Optional output file name to use. Will use default name if not set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DummyFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DummyFileName</maml:name> <maml:description> <maml:para>Set this to short-circuit file transfer. Will use this dummy file to emulate the file storage in the archive. Mostly used for testing.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: OutputFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Folder on disk for output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectWiseFolder</maml:name> <maml:description> <maml:para>Optional ProjectWise folder path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Searches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Searches</maml:name> <maml:description> <maml:para>Optional semi-colon delimited list of saved searches to process.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Optional output file name to use. Will use default name if not set.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DummyFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DummyFileName</maml:name> <maml:description> <maml:para>Set this to short-circuit file transfer. Will use this dummy file to emulate the file storage in the archive. Mostly used for testing.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Will export documents returned by the listed saved searches to an archive container.</maml:para> <maml:para>#SQLiteStudio seems like an adequate managment tool (http://sqlitestudio.pl/?act=download) for the resulting container.</maml:para> <maml:para>Export-PWDocumentsToArchive -OutputFolder c:\export -Searches "60% Complete;80% Complete;90% Complete"</maml:para> <maml:para>#Will export documents in given folder to an archive container.</maml:para> <maml:para>Export-PWDocumentsToArchive -OutputFolder c:\export -ProjectWiseFolder "Source A\Subfolder 1"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWDocumentsToDataSet --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Export-PWDocumentsToDataSet</command:name> <command:verb>Export</command:verb> <command:noun>PWDocumentsToDataSet</command:noun> <maml:description> <maml:para>Report general data, metadata, and audit trail data to DataSet object. Should be usable with SQL Bulk Import.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>#Will report on the documents returned by the saved search to an DataSet.</maml:para> <maml:para>Export-PWDocumentsToDataSet -SearchName "60% Complete"</maml:para> <maml:para>#Will report on documents in given folder to a DataSet.</maml:para> <maml:para>Export-PWDocumentsToDataSet -ProjectWiseFolder "Source A\Subfolder 1"</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-PWDocumentsToDataSet</maml:name> <!-- Parameter: ProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectWiseFolder</maml:name> <maml:description> <maml:para>Optional ProjectWise folder path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SearchName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Optional saved search name to process.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>SQLite output filename.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectWiseFolder</maml:name> <maml:description> <maml:para>Optional ProjectWise folder path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SearchName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Optional saved search name to process.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>SQLite output filename.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DataSet --> <command:returnValue> <dev:type> <maml:name>System.Data.DataSet</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Will report on the documents returned by the saved search to an DataSet.</maml:para> <maml:para>Export-PWDocumentsToDataSet -SearchName "60% Complete"</maml:para> <maml:para>#Will report on documents in given folder treee to a DataSet.</maml:para> <maml:para>Export-PWDocumentsToDataSet -ProjectWiseFolder "Source A\Subfolder 1"</maml:para> <maml:para>#DataSet output handling in PowerShell</maml:para> <maml:para>$ds=Export-PWDocumentsToDataSet -ProjectWiseFolder "Add Test Docs 01"</maml:para> <maml:para>foreach ($table in $ds.Tables)</maml:para> <maml:para>{</maml:para> <maml:para>Write-Host "TableName: $($table.TableName)"</maml:para> <maml:para>foreach ($column in $table.Columns)</maml:para> <maml:para>{</maml:para> <maml:para>write-Host "ColumnName: $($column.ColumnName), ColumnType: $($column.DataType)"</maml:para> <maml:para>}</maml:para> <maml:para>foreach ($row in $table.Rows)</maml:para> <maml:para>{</maml:para> <maml:para>foreach ($column in $table.Columns)</maml:para> <maml:para>{</maml:para> <maml:para>write-Host "$($column.ColumnName): $($row[$($column.ColumnName)])"</maml:para> <maml:para>}</maml:para> <maml:para>}</maml:para> <maml:para>}</maml:para> <maml:para>#Bulk copy into SQL Server. NB: used the OutputFile argument to save a SQLite copy of the data and then used the SQLite DDL to build a SQL Server table. Direct cut and paste.</maml:para> <maml:para>$ds=Export-PWDocumentsToDataSet -ProjectWiseFolder "Add Test Docs 01"</maml:para> <maml:para>$cn = new-object System.Data.SqlClient.SqlConnection("Data Source=brumd09515rem;User ID=sa;Password=pwd;Initial Catalog=BulkCopyTest");</maml:para> <maml:para>$cn.Open()</maml:para> <maml:para>$bc = new-object ("System.Data.SqlClient.SqlBulkCopy") $cn</maml:para> <maml:para>$bc.DestinationTableName = "dbo.General_Documents_Table"</maml:para> <maml:para>$dtable=$ds.Tables["General_Documents_Table"]</maml:para> <maml:para>$bc.WriteToServer($dtable)</maml:para> <maml:para>$cn.Close()</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWEnvironmentsReport --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-PWEnvironmentsReport</command:name> <command:verb>New</command:verb> <command:noun>PWEnvironmentsReport</command:noun> <maml:description> <maml:para>Report on environments including triggers, default values and lookups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Provide report in SQLite format or XLSX or in a format suitable for insert into SQL Server database.</maml:para> <maml:para>#Will save report to a local SQLite database.</maml:para> <maml:para>#SQLiteStudio seems like a decent managment tool (http://sqlitestudio.pl/?act=download).</maml:para> <maml:para>New-PWEnvironmenstReport -OutputFileName c:\report\environments.db</maml:para> <maml:para>#Will save report to a local XLSX file.</maml:para> <maml:para>New-PWEnvironmentsReport -OutputFileName c:\report\stats.xlsx</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWEnvironmentsReport</maml:name> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Output file name. If no XLSX extension, will save in SQLite format. If not provided, will output as data table suitable for insert to SQL Server</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Provide environment name if just reporting on one environment.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Output file name. If no XLSX extension, will save in SQLite format. If not provided, will output as data table suitable for insert to SQL Server</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Provide environment name if just reporting on one environment.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Provide report in SQLite format or XLSX or in a format suitable for insert into SQL Server database.</maml:para> <maml:para>#Will save report to a local SQLite database.</maml:para> <maml:para>#SQLiteStudio seems like a decent managment tool (http://sqlitestudio.pl/?act=download).</maml:para> <maml:para>New-PWEnvironmenstReport -OutputFileName c:\report\environments.db</maml:para> <maml:para>#Will save report to a local XLSX file. Just report on one environment.</maml:para> <maml:para>New-PWEnvironmentsReport -OutputFileName c:\report\stats.xlsx -Environment Titleblock</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWInputOutputReport --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-PWInputOutputReport</command:name> <command:verb>Update</command:verb> <command:noun>PWInputOutputReport</command:noun> <maml:description> <maml:para>Keep track of performance statistics for datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Intent is to keep an on-going log of performance. Also saves list of currently connected users.</maml:para> <maml:para>#Will save report to a local SQLite database, clean up the audit trial entries for this user and collect some statistics which can take time.</maml:para> <maml:para>Update-PWInputOutputReport -OutputFileName c:\report\stats.db -FileSizeK 100 -CleanUpAuditTrail -CollectExpensiveStatistics</maml:para> <maml:para>#SQLiteStudio seems like an adequate managment tool (http://sqlitestudio.pl/?act=download).</maml:para> <maml:para>#Will save report to a local XLSX file, clean up the audit trial entries for this user and collect some statistics which can take time.</maml:para> <maml:para>Update-PWInputOutputReport -OutputFileName c:\report\stats.xlsx -FileSizeK 100 -CleanUpAuditTrail -CollectExpensiveStatistics</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWInputOutputReport</maml:name> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Output file name. If no XLSX extension, will save in SQLite format. If not provided, will output as data table suitable for insert to SQL Server</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileSizeK --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FileSizeK</maml:name> <maml:description> <maml:para>Size for test file to use for file transfer tests</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: CleanUpAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CleanUpAuditTrail</maml:name> <maml:description> <maml:para>If set, will remove audit trail entries for the currently connected user (prevents extraneous entries for admin connections)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CollectExpensiveStatistics --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CollectExpensiveStatistics</maml:name> <maml:description> <maml:para>If set, will collect statistics, which can take a while.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Use this folder to write sqlite output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Output file name. If no XLSX extension, will save in SQLite format. If not provided, will output as data table suitable for insert to SQL Server</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileSizeK --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FileSizeK</maml:name> <maml:description> <maml:para>Size for test file to use for file transfer tests</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: CleanUpAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CleanUpAuditTrail</maml:name> <maml:description> <maml:para>If set, will remove audit trail entries for the currently connected user (prevents extraneous entries for admin connections)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CollectExpensiveStatistics --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CollectExpensiveStatistics</maml:name> <maml:description> <maml:para>If set, will collect statistics, which can take a while.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Use this folder to write sqlite output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Will save report to a local SQLite database, clean up the audit trial entries for this user and collect some statistics which can take time.</maml:para> <maml:para>Update-PWInputOutputReport -OutputFileName c:\report\stats.db -FileSizeK 100 -CleanUpAuditTrail -CollectExpensiveStatistics</maml:para> <maml:para>#SQLiteStudio seems like an adequate managment tool (http://sqlitestudio.pl/?act=download).</maml:para> <maml:para>#Will save report to a local XLSX file, clean up the audit trial entries for this user and collect some statistics which can take time.</maml:para> <maml:para>Update-PWInputOutputReport -OutputFileName c:\report\stats.xlsx -FileSizeK 100 -CleanUpAuditTrail -CollectExpensiveStatistics</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Select-PWSQLDataTableToSQLite --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Select-PWSQLDataTableToSQLite</command:name> <command:verb>Select</command:verb> <command:noun>PWSQLDataTableToSQLite</command:noun> <maml:description> <maml:para>Pass in a SQL Select statement and have the output returned as a table in a new SQLite database. Can be used to debug output from SQL Select statement.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If using the Bulk Import features of SQL Server, it's important to make sure the columns match up. This is an easy way to debug the data before trying to do a bulk insert.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Select-PWSQLDataTableToSQLite</maml:name> <!-- Parameter: SQLSelectStatement --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SQLSelectStatement</maml:name> <maml:description> <maml:para>SQL Select statement to execute (Required).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SQLiteFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SQLiteFolder</maml:name> <maml:description> <maml:para>Folder to write SQLite database to. Omit if database is not required.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SQLSelectStatement --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SQLSelectStatement</maml:name> <maml:description> <maml:para>SQL Select statement to execute (Required).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SQLiteFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SQLiteFolder</maml:name> <maml:description> <maml:para>Folder to write SQLite database to. Omit if database is not required.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DataTable --> <command:returnValue> <dev:type> <maml:name>System.Data.DataTable</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Select-PWSQLDataTableToSQLite -SQLiteFolder c:\dboutput\</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWTestDocuments --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PWTestDocuments</command:name> <command:verb>Add</command:verb> <command:noun>PWTestDocuments</command:noun> <maml:description> <maml:para>Create new documents and folders for testing. Provide path to a data file to make normal documents. Otherwise, documents will be abstract.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Will first create folders up to NumFolders and then will create documents up to NumDocuments.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWTestDocuments</maml:name> <!-- Parameter: NumDocuments --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NumDocuments</maml:name> <maml:description> <maml:para>Number of documents to create (Required).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NumFolders --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NumFolders</maml:name> <maml:description> <maml:para>Number of folders to create (Required).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: FolderDepth --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderDepth</maml:name> <maml:description> <maml:para>Depth of new folder tree (Required).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area name (Required).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetPWFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>TargetPWFolder</maml:name> <maml:description> <maml:para>Target folder name (Optional). Will be created if it does not exist.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SourceFile</maml:name> <maml:description> <maml:para>Source file name (Optional). Will be used to create documents. Abstract documents will be created if not provided.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileSizeK --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>FileSizeK</maml:name> <maml:description> <maml:para>Source file name (Optional). Will be used to create documents. Abstract documents will be created if not provided.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NumDocuments --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NumDocuments</maml:name> <maml:description> <maml:para>Number of documents to create (Required).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NumFolders --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NumFolders</maml:name> <maml:description> <maml:para>Number of folders to create (Required).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: FolderDepth --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderDepth</maml:name> <maml:description> <maml:para>Depth of new folder tree (Required).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area name (Required).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetPWFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>TargetPWFolder</maml:name> <maml:description> <maml:para>Target folder name (Optional). Will be created if it does not exist.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SourceFile</maml:name> <maml:description> <maml:para>Source file name (Optional). Will be used to create documents. Abstract documents will be created if not provided.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileSizeK --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>FileSizeK</maml:name> <maml:description> <maml:para>Source file name (Optional). Will be used to create documents. Abstract documents will be created if not provided.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-PWTestDocuments -NumDocuments 100000 -NumFolders 10000 -FolderDepth 3 -StorageArea Storage1 -TargetPWFolder "Import Test" -SourceFile c:\temp\dummy.txt</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWTestDocumentsInFolders --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-PWTestDocumentsInFolders</command:name> <command:verb>Add</command:verb> <command:noun>PWTestDocumentsInFolders</command:noun> <maml:description> <maml:para>Create new documents for testing. Provide path to a data file to make normal documents. Otherwise, documents will be abstract.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Will will create documents in the empty folders up to NumDocuments.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWTestDocumentsInFolders</maml:name> <!-- Parameter: NumDocuments --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NumDocuments</maml:name> <maml:description> <maml:para>Number of documents to create (Required).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: TargetPWFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetPWFolder</maml:name> <maml:description> <maml:para>Target folder name. Will fill the folders beneath this root.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>StartNumber</maml:name> <maml:description> <maml:para>Start number for naming (Optional).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourceFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SourceFile</maml:name> <maml:description> <maml:para>Source file name (Optional). Will be used to create documents. Abstract documents will be created if this and FileSizeK not provided.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileSizeK --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FileSizeK</maml:name> <maml:description> <maml:para>File size for creating dummy files (Optional). Will be used to create dummy documents. Abstract documents will be created if this and SourceFile not provided.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NumDocuments --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NumDocuments</maml:name> <maml:description> <maml:para>Number of documents to create (Required).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: TargetPWFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetPWFolder</maml:name> <maml:description> <maml:para>Target folder name. Will fill the folders beneath this root.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>StartNumber</maml:name> <maml:description> <maml:para>Start number for naming (Optional).</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SourceFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SourceFile</maml:name> <maml:description> <maml:para>Source file name (Optional). Will be used to create documents. Abstract documents will be created if this and FileSizeK not provided.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileSizeK --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FileSizeK</maml:name> <maml:description> <maml:para>File size for creating dummy files (Optional). Will be used to create dummy documents. Abstract documents will be created if this and SourceFile not provided.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-PWTestDocumentsInFolders -NumDocuments 100000 -TargetPWFolder "Import Test" -SourceFile c:\temp\dummy.txt</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> </helpItems> |