en-US/PWPS_DAB.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-AddressForLatitudeLongitude --> <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>Get-AddressForLatitudeLongitude</command:name> <command:verb>Get</command:verb> <command:noun>AddressForLatitudeLongitude</command:noun> <maml:description> <maml:para>Provides a street address for a given latitude/longitude.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-AddressForLatitudeLongitude</maml:name> <!-- Parameter: Latitude --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Latitude</maml:name> <maml:description> <maml:para>Latitude in decimal degrees (Required).</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Longitude --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Longitude</maml:name> <maml:description> <maml:para>Longitude in decimal degrees (Required).</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Latitude --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Latitude</maml:name> <maml:description> <maml:para>Latitude in decimal degrees (Required).</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Longitude --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Longitude</maml:name> <maml:description> <maml:para>Longitude in decimal degrees (Required).</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</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>#Example usage for getting street address for a lat/long pair.</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Get-AddressForLatitudeLongitude -Latitude 36.008542 -Longitude -78.928718</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWAAMFile --> <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-PWAAMFile</command:name> <command:verb>Export</command:verb> <command:noun>PWAAMFile</command:noun> <maml:description> <maml:para>Export AAM file for current datasource. Choose to export Environments, Applications, Searches and/or Workflows. Will export Environments if none selected.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: OutputFile --> <command:syntaxItem> <maml:name>Export-PWAAMFile</maml:name> <!-- Parameter: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Full path to output AAM file. (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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Set to export 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> <!-- Parameter: Workflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Workflows</maml:name> <maml:description> <maml:para>Set to export workflows.</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: Applications --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Applications</maml:name> <maml:description> <maml:para>Set to export applications.</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: Searches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Searches</maml:name> <maml:description> <maml:para>Set to export searches.</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: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Full path to output AAM file. (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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Set to export 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> <!-- Parameter: Workflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Workflows</maml:name> <maml:description> <maml:para>Set to export workflows.</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: Applications --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Applications</maml:name> <maml:description> <maml:para>Set to export applications.</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: Searches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Searches</maml:name> <maml:description> <maml:para>Set to export searches.</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>Export-PWAAMFile "c:\temp\environments.aam"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWAAMFile --> <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-PWAAMFile</command:name> <command:verb>Import</command:verb> <command:noun>PWAAMFile</command:noun> <maml:description> <maml:para>Import AAM file into current datasource. Choose to import Environments, Applications, Searches and/or Workflows. Will import Environments if none selected.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ImportFile --> <command:syntaxItem> <maml:name>Import-PWAAMFile</maml:name> <!-- Parameter: ImportFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ImportFile</maml:name> <maml:description> <maml:para>Full path to output AAM file. (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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Set to 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> <!-- Parameter: WorkflowDefinitions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WorkflowDefinitions</maml:name> <maml:description> <maml:para>Set to impot workflows.</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: Applications --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Applications</maml:name> <maml:description> <maml:para>Set to import applications.</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: Searches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Searches</maml:name> <maml:description> <maml:para>Set to import searches.</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: ImportFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ImportFile</maml:name> <maml:description> <maml:para>Full path to output AAM file. (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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Set to 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> <!-- Parameter: WorkflowDefinitions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WorkflowDefinitions</maml:name> <maml:description> <maml:para>Set to impot workflows.</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: Applications --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Applications</maml:name> <maml:description> <maml:para>Set to import applications.</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: Searches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Searches</maml:name> <maml:description> <maml:para>Set to import searches.</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>Import-PWAAMFile "c:\temp\environments.aam"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWAccessControlFromExcel --> <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-PWAccessControlFromExcel</command:name> <command:verb>Import</command:verb> <command:noun>PWAccessControlFromExcel</command:noun> <maml:description> <maml:para>PWAccessControlFromExcel is used to import access control to a folder from an Excel spreadsheet or csv file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Imports access control from an Excel spreadsheet or csv file.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-PWAccessControlFromExcel</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ImportFileNamePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ImportFileNamePath</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ImportFileNamePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ImportFileNamePath</maml:name> <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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for importing access control.</maml:para> <maml:para>Import-PWAccessControlToExcel -InputFolder 'MyProject' -ImportFileNamePath 'D:\Temp\Import\MyProjectAccessControl.xlsx'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWAccessControlItems --> <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>Get-PWAccessControlItems</command:name> <command:verb>Get</command:verb> <command:noun>PWAccessControlItems</command:noun> <maml:description> <maml:para>Returns all access control entries for the specified type and name within the current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWAccessControlItems</maml:name> <!-- Parameter: AccessControlItemType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>AccessControlItemType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AccessControlItemName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>AccessControlItemName</maml:name> <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: AccessControlItemType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>AccessControlItemType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AccessControlItemName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>AccessControlItemName</maml:name> <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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for Get-PWAccessControlItems.</maml:para> <maml:para>#Will return all access control entries for the userlist 'Administrators'.</maml:para> <maml:para>Get-PWAccessControlItems -AccessControlItemType 'userlist' -AccessControlItemName 'administrators' | ft</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWAccessControlToExcel --> <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-PWAccessControlToExcel</command:name> <command:verb>Export</command:verb> <command:noun>PWAccessControlToExcel</command:noun> <maml:description> <maml:para>PWAccessControlToExcel is used to export out access control from a folder to an Excel spreadsheet or csv file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Exports out access control from a folder to an Excel spreadsheet or csv file.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-PWAccessControlToExcel</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExportFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ExportFolder</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>c: emp</dev:defaultValue> </command:parameter> <!-- Parameter: ExportFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ExportFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Levels</maml:name> <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: AllLevels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllLevels</maml:name> <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: ExportFileExtension --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportFileExtension</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>xlsx</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExportFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ExportFolder</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>c: emp</dev:defaultValue> </command:parameter> <!-- Parameter: ExportFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ExportFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExportFileExtension --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportFileExtension</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>xlsx</dev:defaultValue> </command:parameter> <!-- Parameter: Levels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Levels</maml:name> <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: AllLevels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllLevels</maml:name> <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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for exporting access control from a project to an Excel spreadsheet.</maml:para> <maml:para>Export-PWAccessControlToExcel -InputFolder 'MyProject' -ExportFolder 'D:\Temp\Export' -ExportFileName 'MyProjectAccessControl'</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for exporting access control from a project to a CSV file.</maml:para> <maml:para>Export-PWAccessControlToExcel -InputFolder 'MyProject' -ExportFolder 'D:\Temp\Export' -ExportFileName 'MyProjectAccessControl' -ExportFileExtension</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Convert-PWAccessMaskToString --> <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>Convert-PWAccessMaskToString</command:name> <command:verb>Convert</command:verb> <command:noun>PWAccessMaskToString</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Convert-PWAccessMaskToString</maml:name> <!-- Parameter: AccessType --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>AccessType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaskValue --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MaskValue</maml:name> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AccessType --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>AccessType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MaskValue --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MaskValue</maml:name> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage converting mask to string.</maml:para> <maml:para>The following will return a string value for full access control on a folder.</maml:para> <maml:para>Convert-PWAccessMaskToString -MaskValue '66535' -AccessType 'folder'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWApplications --> <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>Get-PWApplications</command:name> <command:verb>Get</command:verb> <command:noun>PWApplications</command:noun> <maml:description> <maml:para>Get-PWApplications returns list of all applications.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns list of all applications.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Add-PWAttributeToInterface --> <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-PWAttributeToInterface</command:name> <command:verb>Add</command:verb> <command:noun>PWAttributeToInterface</command:noun> <maml:description> <maml:para>Add an attribute to an interface (on more attributes page).</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWAttributeToInterface</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of new environment to create.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Name of column to add to interface.</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: Interface --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Interface</maml:name> <maml:description> <maml:para>Name of interface to add to.</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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of new environment to create.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Name of column to add to interface.</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: Interface --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Interface</maml:name> <maml:description> <maml:para>Name of interface to add to.</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>New-PWLogin -DatasourceName server:DSN</maml:para> <maml:para>New-PWEnvironment -EnvironmentName NewEnvironment -TableName t_NewEnvironment -ColumnName DrawingNumber -Interface NewEnvironment</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Clear-PWAuditTrailSettings --> <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>Clear-PWAuditTrailSettings</command:name> <command:verb>Clear</command:verb> <command:noun>PWAuditTrailSettings</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Clear-PWAuditTrailSettings</maml:name> <!-- Parameter: AuditTrailType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>AuditTrailType</maml:name> <maml:description> <maml:para>Possible values: AADMSAT_TYPE_FIRST, AADMSAT_TYPE_VAULT, AADMSAT_TYPE_DOCUMENT, AADMSAT_TYPE_DOCUMENT_SET, AADMSAT_TYPE_WORKFLOW, AADMSAT_TYPE_STATE, AADMSAT_TYPE_USER, AADMSAT_TYPE_GROUP, AADMSAT_TYPE_USER_LIST, AADMSAT_TYPE_LAST, AADMSAT_TYPE_DS_REPORT, AADMSAT_TYPE_USER_LILO</maml:para> </maml:description> <command:parameterValue required="true">AuditTrailTypes</command:parameterValue> <dev:type> <maml:name>PWWrapper+AuditTrailTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_VAULT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DOCUMENT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DOCUMENT_SET</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_WORKFLOW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_GROUP</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER_LIST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DS_REPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER_LILO</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AuditTrailAction --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AuditTrailAction</maml:name> <maml:description> <maml:para>Possible values: AADMSAT_ACT_DOC_FIRST, AADMSAT_ACT_DOC_UNKNOWN, AADMSAT_ACT_DOC_CREATE, AADMSAT_ACT_DOC_MODIFY, AADMSAT_ACT_DOC_ATTR, AADMSAT_ACT_DOC_FILE_ADD, AADMSAT_ACT_DOC_FILE_REM, AADMSAT_ACT_DOC_FILE_REP, AADMSAT_ACT_DOC_CIN, AADMSAT_ACT_DOC_VIEW, AADMSAT_ACT_DOC_CHOUT, AADMSAT_ACT_DOC_CPOUT, AADMSAT_ACT_DOC_GOUT, AADMSAT_ACT_DOC_STATE, AADMSAT_ACT_DOC_FINAL_S, AADMSAT_ACT_DOC_FINAL_R, AADMSAT_ACT_DOC_VERSION, AADMSAT_ACT_DOC_MOVE, AADMSAT_ACT_DOC_COPY, AADMSAT_ACT_DOC_SECUR, AADMSAT_ACT_DOC_REDLINE, AADMSAT_ACT_DOC_DELETE, AADMSAT_ACT_DOC_EXPORT, AADMSAT_ACT_DOC_FREE, AADMSAT_ACT_DOC_EXTRACT, AADMSAT_ACT_DOC_DISTRIBUTE, AADMSAT_ACT_DOC_SEND_TO, AADMSAT_ACT_DOC_COMMENT, AADMSAT_ACT_DOC_IMPORT, AADMSAT_ACT_DOC_ACL_ASSIGN, AADMSAT_ACT_DOC_ACL_MODIFY, AADMSAT_ACT_DOC_ACL_REMOVE, AADMSAT_ACT_DOC_REVIT, AADMSAT_ACT_DOC_PACK, AADMSAT_ACT_DOC_UNPACK, AADMSAT_ACT_DOC_LAST, AADMSAT_ACT_SET_FIRST, AADMSAT_ACT_SET_CREATE, AADMSAT_ACT_SET_ADD, AADMSAT_ACT_SET_REMOVE, AADMSAT_ACT_SET_LAST, AADMSAT_ACT_NONE, AADMSAT_ACT_DEFAULT, AADMSAT_ACT_VLT_FIRST, AADMSAT_ACT_VLT_CREATE, AADMSAT_ACT_VLT_MODIFY, AADMSAT_ACT_VLT_WFLOW, AADMSAT_ACT_VLT_DELETE, AADMSAT_ACT_VLT_STATE, AADMSAT_ACT_VLT_ACL_ASSIGN, AADMSAT_ACT_VLT_ACL_MODIFY, AADMSAT_ACT_VLT_ACL_REMOVE, AADMSAT_ACT_VLT_LAST, AADMSAT_ACT_USER_FIRST, AADMSAT_ACT_USER_LOGIN, AADMSAT_ACT_USER_LOGOUT, AADMSAT_ACT_USER_CREATE, AADMSAT_ACT_USER_LAST, AADMSAT_ACT_GROUP_FIRST, AADMSAT_ACT_GROUP_CREATE, AADMSAT_ACT_GROUP_MODIFY, AADMSAT_ACT_GROUP_ADD, AADMSAT_ACT_GROUP_REMOVE, AADMSAT_ACT_GROUP_LAST, AADMSAT_ACT_USER_LIST_FIRST, AADMSAT_ACT_USER_LIST_CREATE, AADMSAT_ACT_USER_LIST_MODIFY, AADMSAT_ACT_USER_LIST_ADD, AADMSAT_ACT_USER_LIST_REMOVE, AADMSAT_ACT_USER_LIST_LAST, AADMSAT_ACT_VLT_CUSTOM_FIRST, AADMSAT_ACT_VLT_CUSTOM_LAST, AADMSAT_ACT_DOC_CUSTOM_FIRST, AADMSAT_ACT_DOC_CUSTOM_LAST, AADMSAT_ACT_SET_CUSTOM_FIRST, AADMSAT_ACT_SET_CUSTOM_LAST, AADMSAT_ACT_GEN_CUSTOM_FIRST, AADMSAT_ACT_GEN_CUSTOM_LAST, AADMSAT_ACT_DOC_ATTR_CREATE, AADMSAT_ACT_DOC_ATTR_MODIFY, AADMSAT_ACT_DOC_ATTR_DELETE, AADMSAT_ACT_USER_CONNCOUNT</maml:para> </maml:description> <command:parameterValue required="true">AuditTrailActions</command:parameterValue> <dev:type> <maml:name>PWWrapper+AuditTrailActions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AADMSAT_ACT_DEFAULT</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_UNKNOWN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_REM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_REP</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CIN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_VIEW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CHOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CPOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_GOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FINAL_S</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FINAL_R</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_VERSION</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_MOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_COPY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_SECUR</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_REDLINE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_EXPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FREE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_EXTRACT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_DISTRIBUTE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_SEND_TO</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_COMMENT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_IMPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_ASSIGN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_REVIT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_PACK</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_UNPACK</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_NONE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DEFAULT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_WFLOW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_ASSIGN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LOGIN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LOGOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GEN_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GEN_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_CONNCOUNT</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuditTrailType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>AuditTrailType</maml:name> <maml:description> <maml:para>Possible values: AADMSAT_TYPE_FIRST, AADMSAT_TYPE_VAULT, AADMSAT_TYPE_DOCUMENT, AADMSAT_TYPE_DOCUMENT_SET, AADMSAT_TYPE_WORKFLOW, AADMSAT_TYPE_STATE, AADMSAT_TYPE_USER, AADMSAT_TYPE_GROUP, AADMSAT_TYPE_USER_LIST, AADMSAT_TYPE_LAST, AADMSAT_TYPE_DS_REPORT, AADMSAT_TYPE_USER_LILO</maml:para> </maml:description> <command:parameterValue required="true">AuditTrailTypes</command:parameterValue> <dev:type> <maml:name>PWWrapper+AuditTrailTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_VAULT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DOCUMENT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DOCUMENT_SET</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_WORKFLOW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_GROUP</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER_LIST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DS_REPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER_LILO</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AuditTrailAction --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AuditTrailAction</maml:name> <maml:description> <maml:para>Possible values: AADMSAT_ACT_DOC_FIRST, AADMSAT_ACT_DOC_UNKNOWN, AADMSAT_ACT_DOC_CREATE, AADMSAT_ACT_DOC_MODIFY, AADMSAT_ACT_DOC_ATTR, AADMSAT_ACT_DOC_FILE_ADD, AADMSAT_ACT_DOC_FILE_REM, AADMSAT_ACT_DOC_FILE_REP, AADMSAT_ACT_DOC_CIN, AADMSAT_ACT_DOC_VIEW, AADMSAT_ACT_DOC_CHOUT, AADMSAT_ACT_DOC_CPOUT, AADMSAT_ACT_DOC_GOUT, AADMSAT_ACT_DOC_STATE, AADMSAT_ACT_DOC_FINAL_S, AADMSAT_ACT_DOC_FINAL_R, AADMSAT_ACT_DOC_VERSION, AADMSAT_ACT_DOC_MOVE, AADMSAT_ACT_DOC_COPY, AADMSAT_ACT_DOC_SECUR, AADMSAT_ACT_DOC_REDLINE, AADMSAT_ACT_DOC_DELETE, AADMSAT_ACT_DOC_EXPORT, AADMSAT_ACT_DOC_FREE, AADMSAT_ACT_DOC_EXTRACT, AADMSAT_ACT_DOC_DISTRIBUTE, AADMSAT_ACT_DOC_SEND_TO, AADMSAT_ACT_DOC_COMMENT, AADMSAT_ACT_DOC_IMPORT, AADMSAT_ACT_DOC_ACL_ASSIGN, AADMSAT_ACT_DOC_ACL_MODIFY, AADMSAT_ACT_DOC_ACL_REMOVE, AADMSAT_ACT_DOC_REVIT, AADMSAT_ACT_DOC_PACK, AADMSAT_ACT_DOC_UNPACK, AADMSAT_ACT_DOC_LAST, AADMSAT_ACT_SET_FIRST, AADMSAT_ACT_SET_CREATE, AADMSAT_ACT_SET_ADD, AADMSAT_ACT_SET_REMOVE, AADMSAT_ACT_SET_LAST, AADMSAT_ACT_NONE, AADMSAT_ACT_DEFAULT, AADMSAT_ACT_VLT_FIRST, AADMSAT_ACT_VLT_CREATE, AADMSAT_ACT_VLT_MODIFY, AADMSAT_ACT_VLT_WFLOW, AADMSAT_ACT_VLT_DELETE, AADMSAT_ACT_VLT_STATE, AADMSAT_ACT_VLT_ACL_ASSIGN, AADMSAT_ACT_VLT_ACL_MODIFY, AADMSAT_ACT_VLT_ACL_REMOVE, AADMSAT_ACT_VLT_LAST, AADMSAT_ACT_USER_FIRST, AADMSAT_ACT_USER_LOGIN, AADMSAT_ACT_USER_LOGOUT, AADMSAT_ACT_USER_CREATE, AADMSAT_ACT_USER_LAST, AADMSAT_ACT_GROUP_FIRST, AADMSAT_ACT_GROUP_CREATE, AADMSAT_ACT_GROUP_MODIFY, AADMSAT_ACT_GROUP_ADD, AADMSAT_ACT_GROUP_REMOVE, AADMSAT_ACT_GROUP_LAST, AADMSAT_ACT_USER_LIST_FIRST, AADMSAT_ACT_USER_LIST_CREATE, AADMSAT_ACT_USER_LIST_MODIFY, AADMSAT_ACT_USER_LIST_ADD, AADMSAT_ACT_USER_LIST_REMOVE, AADMSAT_ACT_USER_LIST_LAST, AADMSAT_ACT_VLT_CUSTOM_FIRST, AADMSAT_ACT_VLT_CUSTOM_LAST, AADMSAT_ACT_DOC_CUSTOM_FIRST, AADMSAT_ACT_DOC_CUSTOM_LAST, AADMSAT_ACT_SET_CUSTOM_FIRST, AADMSAT_ACT_SET_CUSTOM_LAST, AADMSAT_ACT_GEN_CUSTOM_FIRST, AADMSAT_ACT_GEN_CUSTOM_LAST, AADMSAT_ACT_DOC_ATTR_CREATE, AADMSAT_ACT_DOC_ATTR_MODIFY, AADMSAT_ACT_DOC_ATTR_DELETE, AADMSAT_ACT_USER_CONNCOUNT</maml:para> </maml:description> <command:parameterValue required="true">AuditTrailActions</command:parameterValue> <dev:type> <maml:name>PWWrapper+AuditTrailActions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AADMSAT_ACT_DEFAULT</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_UNKNOWN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_REM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_REP</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CIN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_VIEW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CHOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CPOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_GOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FINAL_S</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FINAL_R</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_VERSION</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_MOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_COPY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_SECUR</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_REDLINE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_EXPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FREE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_EXTRACT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_DISTRIBUTE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_SEND_TO</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_COMMENT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_IMPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_ASSIGN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_REVIT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_PACK</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_UNPACK</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_NONE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DEFAULT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_WFLOW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_ASSIGN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LOGIN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LOGOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GEN_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GEN_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_CONNCOUNT</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-PWAuditTrailSettings --> <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>Get-PWAuditTrailSettings</command:name> <command:verb>Get</command:verb> <command:noun>PWAuditTrailSettings</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWAuditTrailSettings</maml:name> <!-- Parameter: AuditTrailType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>AuditTrailType</maml:name> <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: AuditTrailType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>AuditTrailType</maml:name> <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>Example usage for getting Audit Trail data.</maml:para> </maml:introduction> <dev:code>Get-PWAuditTrailSettings</dev:code> <dev:remarks> <maml:para>Returns all audit trail settings for current datasource.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Example usage for getting only the project/folder Audit Trail data.</maml:para> </maml:introduction> <dev:code>Get-PWAuditTrailSettings -AuditTrailType 'project'</dev:code> <dev:remarks> <maml:para>Returns only the project/folder audit trail settings for current datasource.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWAuditTrailSettings --> <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>Set-PWAuditTrailSettings</command:name> <command:verb>Set</command:verb> <command:noun>PWAuditTrailSettings</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWAuditTrailSettings</maml:name> <!-- Parameter: AuditTrailType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>AuditTrailType</maml:name> <maml:description> <maml:para>Possible values: AADMSAT_TYPE_FIRST, AADMSAT_TYPE_VAULT, AADMSAT_TYPE_DOCUMENT, AADMSAT_TYPE_DOCUMENT_SET, AADMSAT_TYPE_WORKFLOW, AADMSAT_TYPE_STATE, AADMSAT_TYPE_USER, AADMSAT_TYPE_GROUP, AADMSAT_TYPE_USER_LIST, AADMSAT_TYPE_LAST, AADMSAT_TYPE_DS_REPORT, AADMSAT_TYPE_USER_LILO</maml:para> </maml:description> <command:parameterValue required="true">AuditTrailTypes</command:parameterValue> <dev:type> <maml:name>PWWrapper+AuditTrailTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_VAULT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DOCUMENT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DOCUMENT_SET</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_WORKFLOW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_GROUP</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER_LIST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DS_REPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER_LILO</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AuditTrailAction --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AuditTrailAction</maml:name> <maml:description> <maml:para>Possible values: AADMSAT_ACT_DOC_FIRST, AADMSAT_ACT_DOC_UNKNOWN, AADMSAT_ACT_DOC_CREATE, AADMSAT_ACT_DOC_MODIFY, AADMSAT_ACT_DOC_ATTR, AADMSAT_ACT_DOC_FILE_ADD, AADMSAT_ACT_DOC_FILE_REM, AADMSAT_ACT_DOC_FILE_REP, AADMSAT_ACT_DOC_CIN, AADMSAT_ACT_DOC_VIEW, AADMSAT_ACT_DOC_CHOUT, AADMSAT_ACT_DOC_CPOUT, AADMSAT_ACT_DOC_GOUT, AADMSAT_ACT_DOC_STATE, AADMSAT_ACT_DOC_FINAL_S, AADMSAT_ACT_DOC_FINAL_R, AADMSAT_ACT_DOC_VERSION, AADMSAT_ACT_DOC_MOVE, AADMSAT_ACT_DOC_COPY, AADMSAT_ACT_DOC_SECUR, AADMSAT_ACT_DOC_REDLINE, AADMSAT_ACT_DOC_DELETE, AADMSAT_ACT_DOC_EXPORT, AADMSAT_ACT_DOC_FREE, AADMSAT_ACT_DOC_EXTRACT, AADMSAT_ACT_DOC_DISTRIBUTE, AADMSAT_ACT_DOC_SEND_TO, AADMSAT_ACT_DOC_COMMENT, AADMSAT_ACT_DOC_IMPORT, AADMSAT_ACT_DOC_ACL_ASSIGN, AADMSAT_ACT_DOC_ACL_MODIFY, AADMSAT_ACT_DOC_ACL_REMOVE, AADMSAT_ACT_DOC_REVIT, AADMSAT_ACT_DOC_PACK, AADMSAT_ACT_DOC_UNPACK, AADMSAT_ACT_DOC_LAST, AADMSAT_ACT_SET_FIRST, AADMSAT_ACT_SET_CREATE, AADMSAT_ACT_SET_ADD, AADMSAT_ACT_SET_REMOVE, AADMSAT_ACT_SET_LAST, AADMSAT_ACT_NONE, AADMSAT_ACT_DEFAULT, AADMSAT_ACT_VLT_FIRST, AADMSAT_ACT_VLT_CREATE, AADMSAT_ACT_VLT_MODIFY, AADMSAT_ACT_VLT_WFLOW, AADMSAT_ACT_VLT_DELETE, AADMSAT_ACT_VLT_STATE, AADMSAT_ACT_VLT_ACL_ASSIGN, AADMSAT_ACT_VLT_ACL_MODIFY, AADMSAT_ACT_VLT_ACL_REMOVE, AADMSAT_ACT_VLT_LAST, AADMSAT_ACT_USER_FIRST, AADMSAT_ACT_USER_LOGIN, AADMSAT_ACT_USER_LOGOUT, AADMSAT_ACT_USER_CREATE, AADMSAT_ACT_USER_LAST, AADMSAT_ACT_GROUP_FIRST, AADMSAT_ACT_GROUP_CREATE, AADMSAT_ACT_GROUP_MODIFY, AADMSAT_ACT_GROUP_ADD, AADMSAT_ACT_GROUP_REMOVE, AADMSAT_ACT_GROUP_LAST, AADMSAT_ACT_USER_LIST_FIRST, AADMSAT_ACT_USER_LIST_CREATE, AADMSAT_ACT_USER_LIST_MODIFY, AADMSAT_ACT_USER_LIST_ADD, AADMSAT_ACT_USER_LIST_REMOVE, AADMSAT_ACT_USER_LIST_LAST, AADMSAT_ACT_VLT_CUSTOM_FIRST, AADMSAT_ACT_VLT_CUSTOM_LAST, AADMSAT_ACT_DOC_CUSTOM_FIRST, AADMSAT_ACT_DOC_CUSTOM_LAST, AADMSAT_ACT_SET_CUSTOM_FIRST, AADMSAT_ACT_SET_CUSTOM_LAST, AADMSAT_ACT_GEN_CUSTOM_FIRST, AADMSAT_ACT_GEN_CUSTOM_LAST, AADMSAT_ACT_DOC_ATTR_CREATE, AADMSAT_ACT_DOC_ATTR_MODIFY, AADMSAT_ACT_DOC_ATTR_DELETE, AADMSAT_ACT_USER_CONNCOUNT</maml:para> </maml:description> <command:parameterValue required="true">AuditTrailActions</command:parameterValue> <dev:type> <maml:name>PWWrapper+AuditTrailActions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AADMSAT_ACT_DEFAULT</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_UNKNOWN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_REM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_REP</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CIN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_VIEW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CHOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CPOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_GOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FINAL_S</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FINAL_R</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_VERSION</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_MOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_COPY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_SECUR</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_REDLINE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_EXPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FREE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_EXTRACT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_DISTRIBUTE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_SEND_TO</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_COMMENT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_IMPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_ASSIGN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_REVIT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_PACK</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_UNPACK</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_NONE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DEFAULT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_WFLOW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_ASSIGN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LOGIN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LOGOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GEN_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GEN_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_CONNCOUNT</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuditTrailType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>AuditTrailType</maml:name> <maml:description> <maml:para>Possible values: AADMSAT_TYPE_FIRST, AADMSAT_TYPE_VAULT, AADMSAT_TYPE_DOCUMENT, AADMSAT_TYPE_DOCUMENT_SET, AADMSAT_TYPE_WORKFLOW, AADMSAT_TYPE_STATE, AADMSAT_TYPE_USER, AADMSAT_TYPE_GROUP, AADMSAT_TYPE_USER_LIST, AADMSAT_TYPE_LAST, AADMSAT_TYPE_DS_REPORT, AADMSAT_TYPE_USER_LILO</maml:para> </maml:description> <command:parameterValue required="true">AuditTrailTypes</command:parameterValue> <dev:type> <maml:name>PWWrapper+AuditTrailTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_VAULT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DOCUMENT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DOCUMENT_SET</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_WORKFLOW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_GROUP</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER_LIST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_DS_REPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_TYPE_USER_LILO</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: AuditTrailAction --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AuditTrailAction</maml:name> <maml:description> <maml:para>Possible values: AADMSAT_ACT_DOC_FIRST, AADMSAT_ACT_DOC_UNKNOWN, AADMSAT_ACT_DOC_CREATE, AADMSAT_ACT_DOC_MODIFY, AADMSAT_ACT_DOC_ATTR, AADMSAT_ACT_DOC_FILE_ADD, AADMSAT_ACT_DOC_FILE_REM, AADMSAT_ACT_DOC_FILE_REP, AADMSAT_ACT_DOC_CIN, AADMSAT_ACT_DOC_VIEW, AADMSAT_ACT_DOC_CHOUT, AADMSAT_ACT_DOC_CPOUT, AADMSAT_ACT_DOC_GOUT, AADMSAT_ACT_DOC_STATE, AADMSAT_ACT_DOC_FINAL_S, AADMSAT_ACT_DOC_FINAL_R, AADMSAT_ACT_DOC_VERSION, AADMSAT_ACT_DOC_MOVE, AADMSAT_ACT_DOC_COPY, AADMSAT_ACT_DOC_SECUR, AADMSAT_ACT_DOC_REDLINE, AADMSAT_ACT_DOC_DELETE, AADMSAT_ACT_DOC_EXPORT, AADMSAT_ACT_DOC_FREE, AADMSAT_ACT_DOC_EXTRACT, AADMSAT_ACT_DOC_DISTRIBUTE, AADMSAT_ACT_DOC_SEND_TO, AADMSAT_ACT_DOC_COMMENT, AADMSAT_ACT_DOC_IMPORT, AADMSAT_ACT_DOC_ACL_ASSIGN, AADMSAT_ACT_DOC_ACL_MODIFY, AADMSAT_ACT_DOC_ACL_REMOVE, AADMSAT_ACT_DOC_REVIT, AADMSAT_ACT_DOC_PACK, AADMSAT_ACT_DOC_UNPACK, AADMSAT_ACT_DOC_LAST, AADMSAT_ACT_SET_FIRST, AADMSAT_ACT_SET_CREATE, AADMSAT_ACT_SET_ADD, AADMSAT_ACT_SET_REMOVE, AADMSAT_ACT_SET_LAST, AADMSAT_ACT_NONE, AADMSAT_ACT_DEFAULT, AADMSAT_ACT_VLT_FIRST, AADMSAT_ACT_VLT_CREATE, AADMSAT_ACT_VLT_MODIFY, AADMSAT_ACT_VLT_WFLOW, AADMSAT_ACT_VLT_DELETE, AADMSAT_ACT_VLT_STATE, AADMSAT_ACT_VLT_ACL_ASSIGN, AADMSAT_ACT_VLT_ACL_MODIFY, AADMSAT_ACT_VLT_ACL_REMOVE, AADMSAT_ACT_VLT_LAST, AADMSAT_ACT_USER_FIRST, AADMSAT_ACT_USER_LOGIN, AADMSAT_ACT_USER_LOGOUT, AADMSAT_ACT_USER_CREATE, AADMSAT_ACT_USER_LAST, AADMSAT_ACT_GROUP_FIRST, AADMSAT_ACT_GROUP_CREATE, AADMSAT_ACT_GROUP_MODIFY, AADMSAT_ACT_GROUP_ADD, AADMSAT_ACT_GROUP_REMOVE, AADMSAT_ACT_GROUP_LAST, AADMSAT_ACT_USER_LIST_FIRST, AADMSAT_ACT_USER_LIST_CREATE, AADMSAT_ACT_USER_LIST_MODIFY, AADMSAT_ACT_USER_LIST_ADD, AADMSAT_ACT_USER_LIST_REMOVE, AADMSAT_ACT_USER_LIST_LAST, AADMSAT_ACT_VLT_CUSTOM_FIRST, AADMSAT_ACT_VLT_CUSTOM_LAST, AADMSAT_ACT_DOC_CUSTOM_FIRST, AADMSAT_ACT_DOC_CUSTOM_LAST, AADMSAT_ACT_SET_CUSTOM_FIRST, AADMSAT_ACT_SET_CUSTOM_LAST, AADMSAT_ACT_GEN_CUSTOM_FIRST, AADMSAT_ACT_GEN_CUSTOM_LAST, AADMSAT_ACT_DOC_ATTR_CREATE, AADMSAT_ACT_DOC_ATTR_MODIFY, AADMSAT_ACT_DOC_ATTR_DELETE, AADMSAT_ACT_USER_CONNCOUNT</maml:para> </maml:description> <command:parameterValue required="true">AuditTrailActions</command:parameterValue> <dev:type> <maml:name>PWWrapper+AuditTrailActions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>AADMSAT_ACT_DEFAULT</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_UNKNOWN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_REM</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FILE_REP</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CIN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_VIEW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CHOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CPOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_GOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FINAL_S</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FINAL_R</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_VERSION</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_MOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_COPY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_SECUR</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_REDLINE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_EXPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_FREE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_EXTRACT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_DISTRIBUTE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_SEND_TO</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_COMMENT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_IMPORT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_ASSIGN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ACL_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_REVIT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_PACK</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_UNPACK</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_NONE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DEFAULT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_WFLOW</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_STATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_ASSIGN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_ACL_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LOGIN</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LOGOUT</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GROUP_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_ADD</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_REMOVE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_LIST_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_VLT_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_SET_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GEN_CUSTOM_FIRST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_GEN_CUSTOM_LAST</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_DOC_ATTR_DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">AADMSAT_ACT_USER_CONNCOUNT</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Clear-PWAuditTrailSettingsAll --> <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>Clear-PWAuditTrailSettingsAll</command:name> <command:verb>Clear</command:verb> <command:noun>PWAuditTrailSettingsAll</command:noun> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Set-PWAuditTrailSettingsAll --> <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>Set-PWAuditTrailSettingsAll</command:name> <command:verb>Set</command:verb> <command:noun>PWAuditTrailSettingsAll</command:noun> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Add-PWConnectedProject --> <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-PWConnectedProject</command:name> <command:verb>Add</command:verb> <command:noun>PWConnectedProject</command:noun> <maml:description> <maml:para>Creates a CONNECTED project and optionally adds it to a rich project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a project id, a project name and number and location and creates corresponding CONNECTed project and associates it.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Add-PWConnectedProject</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of ProjectWise folders from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectedProjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectName</maml:name> <maml:description> <maml:para>Project Name to create (must be unique)</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: ConnectedProjectNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectNumber</maml:name> <maml:description> <maml:para>Project Number to create (must be unique). Can be non-numeric.</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: Location --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location name for new project.</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: AssetType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AssetType</maml:name> <maml:description> <maml:para>Asset type name for new project (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> <!-- Parameter: Industry --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Industry</maml:name> <maml:description> <maml:para>Industry type name for new project (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> <!-- Parameter: MakeUnique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>MakeUnique</maml:name> <maml:description> <maml:para>If set, will add a date/time suffix to the name and number to ensure uniqueness. Project creation will fail if name and number are not unique.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Only used if CONNECT client session is not established.</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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Only used if CONNECT client session is not established.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of ProjectWise folders from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectedProjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectName</maml:name> <maml:description> <maml:para>Project Name to create (must be unique)</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: ConnectedProjectNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectNumber</maml:name> <maml:description> <maml:para>Project Number to create (must be unique). Can be non-numeric.</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: Location --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location name for new project.</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: AssetType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AssetType</maml:name> <maml:description> <maml:para>Asset type name for new project (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> <!-- Parameter: Industry --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Industry</maml:name> <maml:description> <maml:para>Industry type name for new project (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> <!-- Parameter: MakeUnique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>MakeUnique</maml:name> <maml:description> <maml:para>If set, will add a date/time suffix to the name and number to ensure uniqueness. Project creation will fail if name and number are not unique.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Only used if CONNECT client session is not established.</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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Only used if CONNECT client session is not established.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of ProjectWise folders from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for creating a new CONNECTED project and associating it with rich project in a tree.</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>New-PWLogin -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>#Get all the rich projects in this tree and pipe to this cmdlet</maml:para> <maml:para>$rps = Get-PWRichProjects -FolderPath "PWPS Connected Project Test 6\Projects 2"</maml:para> <maml:para>#foreach rich project, create a Connected Project</maml:para> <maml:para>foreach ($rp in $rps)</maml:para> <maml:para>{</maml:para> <maml:para>write-host $rp</maml:para> <maml:para>Add-PWConnectedProject -InputFolder $rp -ConnectedProjectName $rp.ProjectProperties["PROJECT_Project_Name"] -ConnectedProjectNumber $rp.ProjectProperties["PROJECT_Project_Number"] -Location $rp.ProjectProperties["PROJECT_Location"] -MakeUnique</maml:para> <maml:para>}</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for creating a new CONNECTED project with no project association.</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#no ProjectWise login required, though this assumes you have logged in with your CONNECT client</maml:para> <maml:para>Add-PWConnectedProject -ConnectedProjectName "CONNECTed Project" -ConnectedProjectNumber "1001" -Location "Durham, NC, USA" -MakeUnique</maml:para> <maml:para>#If no CONNECT client login, do this</maml:para> <maml:para>$password="p@ssw0rd1" | ConvertTo-SecureString -AsPlainText -Force</maml:para> <maml:para>Add-PWConnectedProject -ConnectedProjectName "CONNECTed Project" -ConnectedProjectNumber "1002" -Location "Durham, NC, USA" -MakeUnique -ConnectedProjectUser some.user@eagle.bentley.com -ConnectedProjectPassword $password</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWConnectedProjectId --> <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>Get-PWConnectedProjectId</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectedProjectId</command:noun> <maml:description> <maml:para>Gets CONNECTED project ID from a rich project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of ProjectWiseFolders and returns a connected project id.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWConnectedProjectId</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of ProjectWise folders from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of ProjectWise folders from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of ProjectWise folders from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for creating a new CONNECTED project and associating it with a rfor each rich project in a tree.</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>New-PWLogin -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>#Get all the rich projects in this tree and pipe to this cmdlet</maml:para> <maml:para>$rps = Get-PWRichProjects -FolderPath "PWPS Connected Project Test 6\Projects 2"</maml:para> <maml:para>#foreach rich project, create a Connected Project</maml:para> <maml:para>foreach ($rp in $rps)</maml:para> <maml:para>{</maml:para> <maml:para>write-host $rp</maml:para> <maml:para>Get-PWConnectedProjectId -InputFolder $rp</maml:para> <maml:para>}</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWCurrentDatasource --> <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>Get-PWCurrentDatasource</command:name> <command:verb>Get</command:verb> <command:noun>PWCurrentDatasource</command:noun> <maml:description> <maml:para>Get current ProjectWise datasource name.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for getting current datasource name.</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Get-PWCurrentDatasource</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWCurrentDSSession --> <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>Get-PWCurrentDSSession</command:name> <command:verb>Get</command:verb> <command:noun>PWCurrentDSSession</command:noun> <maml:description> <maml:para>Get-PWCurrentDSSession retrieves the current datasource session information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-PWCurrentDSSession retrieves the current datasource session information</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for populating a variable with the current datasource session information.</maml:para> <maml:para>$session = Get-PWCurrentDSSession</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWCustomNumericSetting --> <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>Get-PWCustomNumericSetting</command:name> <command:verb>Get</command:verb> <command:noun>PWCustomNumericSetting</command:noun> <maml:description> <maml:para>Get value for custom numeric setting at the datasource level.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWCustomNumericSetting</maml:name> <!-- Parameter: SettingID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingID</maml:name> <maml:description> <maml:para>Setting ID (normally negative number for custom settings).</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: SettingID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingID</maml:name> <maml:description> <maml:para>Setting ID (normally negative number for custom settings).</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>Get-PWCustomNumericSetting -SettingID -1789</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWCustomNumericSetting --> <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>Set-PWCustomNumericSetting</command:name> <command:verb>Set</command:verb> <command:noun>PWCustomNumericSetting</command:noun> <maml:description> <maml:para>Set value for custom numeric setting at the datasource level.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWCustomNumericSetting</maml:name> <!-- Parameter: SettingID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingID</maml:name> <maml:description> <maml:para>Setting ID (normally negative number for custom settings).</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: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to set for custom setting.</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: SettingID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingID</maml:name> <maml:description> <maml:para>Setting ID (normally negative number for custom settings).</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: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to set for custom setting.</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>Set-PWCustomNumericSetting -SettingID -1789 -Value 10</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWCustomStringSetting --> <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>Get-PWCustomStringSetting</command:name> <command:verb>Get</command:verb> <command:noun>PWCustomStringSetting</command:noun> <maml:description> <maml:para>Get value for custom string setting at the datasource level.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWCustomStringSetting</maml:name> <!-- Parameter: SettingID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingID</maml:name> <maml:description> <maml:para>Setting ID (normally negative number for custom settings).</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: SettingID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingID</maml:name> <maml:description> <maml:para>Setting ID (normally negative number for custom settings).</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>Get-PWCustomStringSetting -SettingID -1776</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWCustomStringSetting --> <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>Set-PWCustomStringSetting</command:name> <command:verb>Set</command:verb> <command:noun>PWCustomStringSetting</command:noun> <maml:description> <maml:para>Set value for custom string setting at the datasource level.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWCustomStringSetting</maml:name> <!-- Parameter: SettingID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingID</maml:name> <maml:description> <maml:para>Setting ID (normally negative number for custom settings).</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: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to set for custom setting.</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: SettingID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingID</maml:name> <maml:description> <maml:para>Setting ID (normally negative number for custom settings).</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: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Value</maml:name> <maml:description> <maml:para>Value to set for custom setting.</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>Set-PWCustomStringSetting -SettingID -1776 -Value "We hold these truths..."</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWDatasourceConfigurationEntry --> <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-PWDatasourceConfigurationEntry</command:name> <command:verb>New</command:verb> <command:noun>PWDatasourceConfigurationEntry</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWDatasourceConfigurationEntry</maml:name> <!-- Parameter: ServerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasourceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DatasourceName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ODBCConnectionName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ODBCConnectionName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseUser --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DatabaseUser</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabasePassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>DatabasePassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsSSO --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IsSSO</maml:name> <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: IsOracle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IsOracle</maml:name> <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: ServerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasourceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DatasourceName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ODBCConnectionName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ODBCConnectionName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabaseUser --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DatabaseUser</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatabasePassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>DatabasePassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsSSO --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IsSSO</maml:name> <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: IsOracle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IsOracle</maml:name> <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:command> <!-- Cmdlet: Get-PWDatasourceGuid --> <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>Get-PWDatasourceGuid</command:name> <command:verb>Get</command:verb> <command:noun>PWDatasourceGuid</command:noun> <maml:description> <maml:para>Get the global unique identifier for the datasource.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Get datasource global unique identifier</maml:para> <maml:para>Get-PWDatasourceGuid</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWDMTransmittal --> <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-PWDMTransmittal</command:name> <command:verb>New</command:verb> <command:noun>PWDMTransmittal</command:noun> <maml:description> <maml:para>Create a transmittal given ConnectedProjectId, Transmittal Name and files to add to the new transmittal.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>New-PWDMTransmittal</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of ProjectWise documents to add to tranmittal (Required). File names should be unique.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>CONNECTed Project in which to create transmittal.</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: TransmittalName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TransmittalName</maml:name> <maml:description> <maml:para>Name of transmittal to create.</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: AcknowledgementDays --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AcknowledgementDays</maml:name> <maml:description> <maml:para>Number of days to allow for acknowledgement.</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>5</dev:defaultValue> </command:parameter> <!-- Parameter: ResponseDays --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ResponseDays</maml:name> <maml:description> <maml:para>Number of days to allow for response.</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>10</dev:defaultValue> </command:parameter> <!-- Parameter: TransmittalComment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>TransmittalComment</maml:name> <maml:description> <maml:para>Comment to include with new transmittal.</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: Classification --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Transmittal classification.</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: SendToEmails --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SendToEmails</maml:name> <maml:description> <maml:para>Comment to include with new transmittal.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Used to identify primary recipient and as fallback login name if CONNECT client session is not established.</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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Only used if CONNECT client session is not established.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of ProjectWise documents to add to tranmittal (Required). File names should be unique.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>CONNECTed Project in which to create transmittal.</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: TransmittalName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TransmittalName</maml:name> <maml:description> <maml:para>Name of transmittal to create.</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: AcknowledgementDays --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AcknowledgementDays</maml:name> <maml:description> <maml:para>Number of days to allow for acknowledgement.</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>5</dev:defaultValue> </command:parameter> <!-- Parameter: ResponseDays --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ResponseDays</maml:name> <maml:description> <maml:para>Number of days to allow for response.</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>10</dev:defaultValue> </command:parameter> <!-- Parameter: TransmittalComment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>TransmittalComment</maml:name> <maml:description> <maml:para>Comment to include with new transmittal.</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: Classification --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Classification</maml:name> <maml:description> <maml:para>Transmittal classification.</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: SendToEmails --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SendToEmails</maml:name> <maml:description> <maml:para>Comment to include with new transmittal.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Used to identify primary recipient and as fallback login name if CONNECT client session is not established.</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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Only used if CONNECT client session is not established.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of ProjectWise documents to add to tranmittal (Required). File names should be unique.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>$connectedProjectGuid = Get-PWFolders -FolderPath "Rich Project From PowerShell\Project 03" -JustOne | Get-PWConnectedProjectId</maml:para> <maml:para>$docs = Get-PWDocumentsBySearch -FolderPath "Rich Project From PowerShell\Project 03" -FileName Merged.pdf</maml:para> <maml:para>New-PWDMTransmittal $docs -ConnectedProjectId $connectedProjectGuid -TransmittalName "New transmittal 07E" -SendToEmails "dave.brumbaugh@bentley.com","dave.brumbaugh@eagle.bentley.com" -TransmittalComment "A comment on this" -Classification "Some classification" -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWDocument --> <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>Copy-PWDocument</command:name> <command:verb>Copy</command:verb> <command:noun>PWDocument</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-PWDocument</maml:name> <!-- Parameter: SourceDocumentNamePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SourceDocumentNamePath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateVersions</maml:name> <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: SourceDocumentNamePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SourceDocumentNamePath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateVersions</maml:name> <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:command> <!-- Cmdlet: New-PWDocument --> <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-PWDocument</command:name> <command:verb>New</command:verb> <command:noun>PWDocument</command:noun> <maml:description> <maml:para>Given a folder object or folder path and path to an existing file create a new document without attributes.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>New-PWDocument</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Target folder path (not required if sending folder(s) on pipeline.</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: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to file on disk.</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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new document (optional).</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: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version string for new document (optional).</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: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Target folder path (not required if sending folder(s) on pipeline.</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: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to file on disk.</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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new document (optional).</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: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version string for new document (optional).</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage getting folders and creating new documents.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Get the folder for folder number 20315 and create a new document there</maml:para> <maml:para>Get-PWFolders 20315 | New-PWDocument -FilePath c:\temp\NewDrawing.dgn</maml:para> <maml:para>#Get the folder at the given folder path and create a document there</maml:para> <maml:para>Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3\Level 4' -JustOne | New-PWDocument -FilePath c:\temp\NewDrawing.dgn -Description 'Drawing 1'</maml:para> <maml:para>#Create a new folder at the given folder path and create a document there</maml:para> <maml:para>New-PWFolder -FolderPath 'PowerShell Demo\Level 2\Level 3\Level 4' -StorageArea Storage01 | New-PWDocument -FilePath c:\temp\NewDrawing.dgn -Description 'Drawing 1'</maml:para> <maml:para>#Create a new document in existing folder</maml:para> <maml:para>New-PWDocument -FolderPath 'Demo\Folder 1' -FilePath c:\temp\NewDrawing.dgn -Description 'Drawing 1'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Rename-PWDocument --> <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>Rename-PWDocument</command:name> <command:verb>Rename</command:verb> <command:noun>PWDocument</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Rename-PWDocument</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DocumentOldName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentOldName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DocumentNewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentNewName</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DocumentOldName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentOldName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DocumentNewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentNewName</maml:name> <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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: New-PWDocumentAbstract --> <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-PWDocumentAbstract</command:name> <command:verb>New</command:verb> <command:noun>PWDocumentAbstract</command:noun> <maml:description> <maml:para>Given a folder object or folder path, create one or more abstract documents without attributes.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>New-PWDocumentAbstract</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Name to prefix abstract document (Optional) If excluded, 'doc' will be used.</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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new document (optional). If excluded, the document name will be used.</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: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version string to use for new document (optional).</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: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of abstract documents to create. (Optional) If excluded, only one will be created</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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Target folder path (not required if sending folder(s) on pipeline).</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: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Target folder path (not required if sending folder(s) on pipeline).</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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Name to prefix abstract document (Optional) If excluded, 'doc' will be used.</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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new document (optional). If excluded, the document name will be used.</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: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version string to use for new document (optional).</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: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of abstract documents to create. (Optional) If excluded, only one will be created</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage getting folders and creating new documents.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para># To create abstract documents without getting InputFolders from the pipeline Supply the folder full path using -FolderPath, supply document name (optional), document description (optional) and/or count (optional) and create a new document there</maml:para> <maml:para>New-PWDocumentAbstract -FolderPath 'Level 1\' -DocumentName 'doc' -Description 'Abstract Document'</maml:para> <maml:para>New-PWDocumentAbstract -FolderPath 'Level 1\' -DocumentName 'AbstractDoc' -Count 2</maml:para> <maml:para># To create abstract documents while getting InputFolders from the pipeline, supply document name (optional), document description (optional) and/or count (optional) and create a new document there</maml:para> <maml:para>Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3\Level 4' -JustOne | New-PWDocumentAbstract -DocumentName 'doc'</maml:para> <maml:para>Get-PWFolders -FolderPath 'Level 1\' | New-PWDocumentAbstract -DocumentName 'AbstractDoc' -Count 3</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWDocumentAttributes --> <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-PWDocumentAttributes</command:name> <command:verb>Update</command:verb> <command:noun>PWDocumentAttributes</command:noun> <maml:description> <maml:para>Updates or creates a new document attribute record.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of document objects from the pipeline and a hashtable of attribute values and updates or creates a document attribute record.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Update-PWDocumentAttributes</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Array of document objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Attributes --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable of attributes. Hashtable in PowerShell looks like this @{Name = 'Value'; Name2 = 'Value2' }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReturnBoolean --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ReturnBoolean</maml:name> <maml:description> <maml:para>Use this switch to return a boolean value indicating if all the passed documents were updated successfully. Default is to pass updated documents out through the pipeline.</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: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Array of document objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Attributes --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable of attributes. Hashtable in PowerShell looks like this @{Name = 'Value'; Name2 = 'Value2' }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReturnBoolean --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ReturnBoolean</maml:name> <maml:description> <maml:para>Use this switch to return a boolean value indicating if all the passed documents were updated successfully. Default is to pass updated documents out through the pipeline.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of document objects from the pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Get the documents in the given path and update them with the listed attributes</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Import\Test' | Update-PWDocumentAttributes -Attributes @{Title = "New Title"; Dwg_no = "007"; SomeNumber = "555" }</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentAuditTrailRecords --> <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>Get-PWDocumentAuditTrailRecords</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentAuditTrailRecords</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWDocumentAuditTrailRecords</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full folder path to folder containing document of retrieve audit trail records of.</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: DocumentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document to retrieve audit trail records for.</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: IncludeSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>When the IncludeSecondary switch parameter is included, the document audit trail entries from the secondary table will be included.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full folder path to folder containing document of retrieve audit trail records of.</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: DocumentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document to retrieve audit trail records for.</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: IncludeSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>When the IncludeSecondary switch parameter is included, the document audit trail entries from the secondary table will be included.</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>Example usage for getting Document Audit Trail data.</maml:para> </maml:introduction> <dev:code>Get-PWDocumentAuditTrailRecords -FolderPath 'Projects' -DocumentName 'BentleySpash.bmp'</dev:code> <dev:remarks> <maml:para>Returns all audit trail records for document 'BentleySplash.bmp' within folder 'Projects' within current datasource.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-PWDocumentAuditTrailRecords -FolderPath 'Projects' -DocumentName 'BentleySpash.bmp' -IncludeSecondary</dev:code> <dev:remarks> <maml:para>Returns all audit trail records from both audit trail table and secondary table for document 'BentleySplash.bmp' within folder 'Projects' within current datasource.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Example usage for determining the creator of a document by retrieving the document audit trail records and filtering on a specific action..</maml:para> </maml:introduction> <dev:code>[string]$user = Get-PWDocumentAuditTrailRecords -FolderPath 'Projects' -DocumentName 'BentleySpash.bmp' | Where-Object {$_.iAction -eq '1001'} | Select sUserName $user = $user.Substring($user.IndexOf('=') + 1) $user = $user.TrimEnd('}') "Document Creator: $user"</dev:code> <dev:remarks> <maml:para>Returns the document creator of the specified document.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWDocumentComment --> <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-PWDocumentComment</command:name> <command:verb>New</command:verb> <command:noun>PWDocumentComment</command:noun> <maml:description> <maml:para>New-PWDocumentComment adds a comment to the audit trail for the specified document.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>New-PWDocumentComment adds a comment to the audit trail for the specified document within the active datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWDocumentComment</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to folder containing the specified document.</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: DocumentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document Name of document to add commen to.</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: Comment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Comment to be added to the documents audit trail.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to folder containing the specified document.</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: DocumentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document Name of document to add commen to.</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: Comment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Comment to be added to the documents audit trail.</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> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWDocumentFile --> <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-PWDocumentFile</command:name> <command:verb>Update</command:verb> <command:noun>PWDocumentFile</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Update-PWDocumentFile</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Target document object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewFile</maml:name> <maml:description> <maml:para>Replacement file 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: NewFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>New file name to apply.</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: UseDocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>UseDocumentName</maml:name> <maml:description> <maml:para>Use document name as base name for newly addeed file.</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: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Target document object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewFile</maml:name> <maml:description> <maml:para>Replacement file 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: NewFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>New file name to apply.</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: UseDocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>UseDocumentName</maml:name> <maml:description> <maml:para>Use document name as base name for newly addeed file.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target document object(s) from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage replacing physical file.</maml:para> <maml:para>The following will replace the existing file associated with the ProjectWise document(s).</maml:para> <maml:para>Get-PWDocumentsBySearch -SearchName 'pdfs' | Update-PWDocumentFile -NewFile 'd:\temp\PSTeamsGeneral.png' | Set-PWDocumentFinalStatus</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWDocumentFileUpdateTimeToNow --> <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-PWDocumentFileUpdateTimeToNow</command:name> <command:verb>Update</command:verb> <command:noun>PWDocumentFileUpdateTimeToNow</command:noun> <maml:description> <maml:para>Updates document's file update time to now. Use to force reprocessing (FTR, thumbnail, properties or rendition generation).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of document objects from the pipeline and allows you to change the file update time to now.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Update-PWDocumentFileUpdateTimeToNow</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline to operate on (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline to operate on (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of document objects from pipeline to operate on (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Get the documents in the given path and update the file update time to now (local).</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Lend Lease\Dotted PDFs" | Update-PWDocumentFileUpdateTimeToNow -UseLocalTime</maml:para> <maml:para>#Get the documents from the search and update the file update time to now (UTC).</maml:para> <maml:para>Get-PWDocumentsBySearch -SearchName "All PDFs" | Update-PWDocumentFileUpdateTimeToNow</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWDocumentFinalStatus --> <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>Set-PWDocumentFinalStatus</command:name> <command:verb>Set</command:verb> <command:noun>PWDocumentFinalStatus</command:noun> <maml:description> <maml:para>Sets or removes a document's final status.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Set-PWDocumentFinalStatus</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoveFinalStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoveFinalStatus</maml:name> <maml:description> <maml:para>Set to clear final status.</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: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoveFinalStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoveFinalStatus</maml:name> <maml:description> <maml:para>Set to clear final status.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Set final status for all documents in a folder.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Get all the documents in this folder tree and set them to final status</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" | Set-PWDocumentFinalStatus</maml:para> <maml:para>#Get all the documents in this folder tree and clear final status</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" | Set-PWDocumentFinalStatus -RemoveFinalStatus</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentFlatSet --> <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>Get-PWDocumentFlatSet</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentFlatSet</command:noun> </command:details> <command:syntax> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Get-PWDocumentFlatSet</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the flat set file.</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: SetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of flat set file.</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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the flat set file.</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: SetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of flat set file.</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder path of folder containing the flat set file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage Get-PWDocumentFlatSet to retrieve all flat set files.</maml:para> <maml:para>The following will return information for all flat set files within the current datasource.</maml:para> <maml:para>Get-PWDocumentFlatSet -Verbose</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Example usage Get-PWDocumentFlat to retrieve flat sets files contained in a specified folder.</maml:para> <maml:para>The following will return information for all flat sets contained in a specified folder.</maml:para> <maml:para>Get-PWDocumentFlatSet -FolderPath 'Projects' -Verbose</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>#Example usage Get-PWDocumentFlat to retrieve a specific flat set file.</maml:para> <maml:para>The following will return information for a specific flat set file based on folder and set name.</maml:para> <maml:para>Get-PWDocumentFlatSet -FolderPath 'Projects' -SetName 'MyTest' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWDocumentFlatSet --> <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-PWDocumentFlatSet</command:name> <command:verb>New</command:verb> <command:noun>PWDocumentFlatSet</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWDocumentFlatSet</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder where the new flat set file will be created.</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: SetMemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetMemberName</maml:name> <maml:description> <maml:para>Name of the document to be added to the new flat set file.</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: SetMemberPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetMemberPath</maml:name> <maml:description> <maml:para>Folder path of the member to be added to the new flat set file.</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: SetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of new set file.</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: SetDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetDescription</maml:name> <maml:description> <maml:para>Description of new flat set file.</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: SetMemberDepartment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetMemberDepartment</maml:name> <maml:description> <maml:para>Department attribute value of the member to be added to the flat new set file.</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: CheckOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckOut</maml:name> <maml:description> <maml:para>When the CheckOut switch parameter is included, the member document will be set to checkout when set is open.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder where the new flat set file will be created.</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: SetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of new set file.</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: SetDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetDescription</maml:name> <maml:description> <maml:para>Description of new flat set file.</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: SetMemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetMemberName</maml:name> <maml:description> <maml:para>Name of the document to be added to the new flat set file.</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: SetMemberPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetMemberPath</maml:name> <maml:description> <maml:para>Folder path of the member to be added to the new flat set file.</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: SetMemberDepartment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetMemberDepartment</maml:name> <maml:description> <maml:para>Department attribute value of the member to be added to the flat new set file.</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: CheckOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckOut</maml:name> <maml:description> <maml:para>When the CheckOut switch parameter is included, the member document will be set to checkout when set is open.</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder path of folder where the new flat set file will be created.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage New-PWDocumentFlatSet.</maml:para> <maml:para>The following will create a new flat set file with the specified document as a member.</maml:para> <maml:para>$SetFileInfo = @{</maml:para> <maml:para>FolderPath = 'Projects'</maml:para> <maml:para>SetName = 'MyTest'</maml:para> <maml:para>SetDescription = 'New Set File'</maml:para> <maml:para>SetMemberName = '2D-M-SAB-LNWK.dwg'</maml:para> <maml:para>SetMemberPath = 'Projects\Upload\Sub-Folder'}</maml:para> <maml:para>New-PWDocumentFlatSet @SetFileInfo -CheckOut -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWDocumentFlatSet --> <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>Remove-PWDocumentFlatSet</command:name> <command:verb>Remove</command:verb> <command:noun>PWDocumentFlatSet</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWDocumentFlatSet</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the flat set file.</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: SetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of flat set file.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the flat set file.</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: SetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of flat set file.</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder path of folder containing the flat set file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage Remove-PWDocumentFlatSet.</maml:para> <maml:para>The following will delete the specified flat set file.</maml:para> <maml:para>Remove-PWDocumentFlatSet -FolderPath 'Projects' -SetName 'DGNs' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentFlatSetByDocument --> <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>Get-PWDocumentFlatSetByDocument</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentFlatSetByDocument</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWDocumentFlatSetByDocument</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the document to determine if it is a member of any flat sets.</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: DocumentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Name of flat set file.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the document to determine if it is a member of any flat sets.</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: DocumentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Name of flat set file.</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder path of folder containing the document to determine if it is a member of any flat sets.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage Get-PWDocumentFlatSetByDocument.</maml:para> <maml:para>The following will return information for all flat sets the specified document is a member of.</maml:para> <maml:para>Get-PWDocumentFlatSetByDocument -FolderPath 'Projects' -DocumentName 'MyDocument.dgn' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWDocumentFlatSetMember --> <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-PWDocumentFlatSetMember</command:name> <command:verb>Add</command:verb> <command:noun>PWDocumentFlatSetMember</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWDocumentFlatSetMember</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the flat set file.</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: SetMemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetMemberName</maml:name> <maml:description> <maml:para>Name of the document to be added to the flat set file.</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: SetMemberPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetMemberPath</maml:name> <maml:description> <maml:para>Folder path of the member to be added to the flat set file.</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: SetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of set file.</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: CheckOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckOut</maml:name> <maml:description> <maml:para>When the CheckOut switch parameter is included, the member document will be set to checkout when set is open.</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: LockToVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LockToVersion</maml:name> <maml:description> <maml:para>When the LockToVersion switch parameter is included, the Lock To Version option for the member will be toggled on.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the flat set file.</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: SetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of set file.</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: SetMemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetMemberName</maml:name> <maml:description> <maml:para>Name of the document to be added to the flat set file.</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: SetMemberPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetMemberPath</maml:name> <maml:description> <maml:para>Folder path of the member to be added to the flat set file.</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: CheckOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckOut</maml:name> <maml:description> <maml:para>When the CheckOut switch parameter is included, the member document will be set to checkout when set is open.</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: LockToVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LockToVersion</maml:name> <maml:description> <maml:para>When the LockToVersion switch parameter is included, the Lock To Version option for the member will be toggled on.</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder path of folder containing the flat set file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage Add-PWDocumentFlatSetMember.</maml:para> <maml:para>The following will add a new member to a flat set.</maml:para> <maml:para>Add-PWDocumentFlatSetMember -FolderPath 'Projects' -SetName 'DGNs' -SetMemberName 'NewDrawing.dgn' -SetMemberPath 'Project\Drawings' -CheckOut -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWDocumentFlatSetMember --> <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>Remove-PWDocumentFlatSetMember</command:name> <command:verb>Remove</command:verb> <command:noun>PWDocumentFlatSetMember</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWDocumentFlatSetMember</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the flat set file.</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: SetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of flat set file.</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: SetMemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>SetMemberName</maml:name> <maml:description> <maml:para>Name of flat set member to be removed.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the flat set file.</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: SetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of flat set file.</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: SetMemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>SetMemberName</maml:name> <maml:description> <maml:para>Name of flat set member to be removed.</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>#Example usage Remove-PWDocumentFlatSetMember.</maml:para> <maml:para>The following will delete the member from the flat set.</maml:para> <maml:para>Remove-PWDocumentFlatSetMember -FolderPath 'Projects' -SetName 'DGNs' -SetMemberName 'MyDrawing.dgn' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentFlatSetMembers --> <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>Get-PWDocumentFlatSetMembers</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentFlatSetMembers</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWDocumentFlatSetMembers</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the flat set file.</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: SetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of flat set file.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of folder containing the flat set file.</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: SetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SetName</maml:name> <maml:description> <maml:para>Name of flat set file.</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder path of folder containing the flat set file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage Get-PWDocumentFlatSetMembers.</maml:para> <maml:para>The following will display the members of a flat set.</maml:para> <maml:para>Get-PWDocumentFlatSetMembers -FolderPath 'Projects' -SetName 'DGNs' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentGeoSpatialLocation --> <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>Get-PWDocumentGeoSpatialLocation</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentGeoSpatialLocation</command:noun> <maml:description> <maml:para>Gets a document's geospatial location.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Get-PWDocumentGeoSpatialLocation</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GetKML --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GetKML</maml:name> <maml:description> <maml:para>Set for KML output.</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: GetGeoJSON --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>GetGeoJSON</maml:name> <maml:description> <maml:para>Set for GeoJSON output.</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: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GetKML --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GetKML</maml:name> <maml:description> <maml:para>Set for KML output.</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: GetGeoJSON --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>GetGeoJSON</maml:name> <maml:description> <maml:para>Set for GeoJSON output.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Get GeoSpatial location of a document.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Get locations for all documents in a folder in WKT</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" | Get-PWDocumentGeoSpatialLocation</maml:para> <maml:para>#Get locations for all documents in a folder in KML</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" | Get-PWDocumentGeoSpatialLocation -GetKML</maml:para> <maml:para>#Get locations for all documents in a folder in GeoJSON</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" | Get-PWDocumentGeoSpatialLocation -GetGeoJSON</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWDocumentGeoSpatialLocation --> <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>Set-PWDocumentGeoSpatialLocation</command:name> <command:verb>Set</command:verb> <command:noun>PWDocumentGeoSpatialLocation</command:noun> <maml:description> <maml:para>Very simple location assignment for a folder. Takes a folder path or array of folder objects and assigns a block or a point on the input Lat/Long or Address and box size.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Set-PWDocumentGeoSpatialLocation</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Array of folder objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Latitude --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Latitude</maml:name> <maml:description> <maml:para>Latitude in decimal degrees.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Longitude --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Longitude</maml:name> <maml:description> <maml:para>Longitude in decimal degrees.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SizeOfBoxInDegrees --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SizeOfBoxInDegrees</maml:name> <maml:description> <maml:para>Size of box in decimal degrees. Defaults to a 10th of a second.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2.77777777777778E-05</dev:defaultValue> </command:parameter> <!-- Parameter: Point --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Point</maml:name> <maml:description> <maml:para>Set to mark with a point rather than a polygon.</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: Address --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Address</maml:name> <maml:description> <maml:para>Address to lookup via Google and assign geo-location to document.</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: WKT --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>WKT</maml:name> <maml:description> <maml:para>Well Known Text string describing polygon.</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: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Array of folder objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Latitude --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Latitude</maml:name> <maml:description> <maml:para>Latitude in decimal degrees.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Longitude --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Longitude</maml:name> <maml:description> <maml:para>Longitude in decimal degrees.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SizeOfBoxInDegrees --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SizeOfBoxInDegrees</maml:name> <maml:description> <maml:para>Size of box in decimal degrees. Defaults to a 10th of a second.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2.77777777777778E-05</dev:defaultValue> </command:parameter> <!-- Parameter: Point --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Point</maml:name> <maml:description> <maml:para>Set to mark with a point rather than a polygon.</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: Address --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Address</maml:name> <maml:description> <maml:para>Address to lookup via Google and assign geo-location to document.</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: WKT --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>WKT</maml:name> <maml:description> <maml:para>Well Known Text string describing polygon.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of folder objects from the pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for creating a new folder and assigning a location to it.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>New-PWFolder -FolderPath "My Locations\Folder 2" -StorageArea "Storage 1" | Set-PWFolderGeoSpatialLocation -Latitude 45 -Longitude 90</maml:para> <maml:para>New-PWFolder -FolderPath "My Locations\Folder 3" -StorageArea "Storage 1" | Set-PWFolderGeoSpatialLocation -Address "704 15th Street, Durham, NC" -Point</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWDocumentProperties --> <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-PWDocumentProperties</command:name> <command:verb>Update</command:verb> <command:noun>PWDocumentProperties</command:noun> <maml:description> <maml:para>Updates document general properties.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of document objects from the pipeline and allows you to reset the document name, description, file name or version string. Update the properties you want to set.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Update-PWDocumentProperties</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline to operate on (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline to operate on (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of document objects from pipeline to operate on (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Get the documents in the given path and update them with the listed attributes. Also supports changing name and filename, but, of course, those must be unique in a folder.</maml:para> <maml:para>$docs = Get-PWDocumentsBySearch -FolderPath "Lend Lease\Dotted PDFs"</maml:para> <maml:para>foreach ($doc in $docs)</maml:para> <maml:para>{</maml:para> <maml:para>$doc.Description = "Changed in PowerShell 2"</maml:para> <maml:para>$doc.Version = "R06"</maml:para> <maml:para>}</maml:para> <maml:para>Update-PWDocumentProperties -InputDocument $docs</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Lend Lease\Dotted PDFs" | Foreach -MemberName Description</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Save-PWDocumentReport --> <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>Save-PWDocumentReport</command:name> <command:verb>Save</command:verb> <command:noun>PWDocumentReport</command:noun> <maml:description> <maml:para>Saves a report of all the documents and metadata contained in a folder path or in a saved search.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Saves a report of all the documents and metadata contained in a folder path or in a saved search. Includes audit trail as well as records from backup audit trail table.</maml:para> <maml:para>Include neither path nor search name to report on whole datasource. Probably not a good idea to include audit trail in that case.</maml:para> <maml:para>Use the recurse parameter to include all sub-folders in the report.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Save-PWDocumentReport</maml:name> <!-- Parameter: ProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectWiseFolder</maml:name> <maml:description> <maml:para>Path to the folder to report on (e.g. "PWPS Connected Project Test 6\Projects 2\Project A").</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>Name of saved search to report on (e.g. "60% Complete").</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: AuditTrailRecordsEnd --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>AuditTrailRecordsEnd</maml:name> <maml:description> <maml:para>If set, include audit trail records older than this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: AppendToXLSX --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>AppendToXLSX</maml:name> <maml:description> <maml:para>Append to an existing XLSX file. Will force Fast output (no hyperlinks).</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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Look for a personal search.</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: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Folder Id of folder to report on.</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Full path to output XLSX file (e.g. "C:\temp\MyOutputfile.xlsx").</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: IncludeVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IncludeVersions</maml:name> <maml:description> <maml:para>Include this switch to report on versions.</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: IncludeAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IncludeAuditTrail</maml:name> <maml:description> <maml:para>Include this switch to include the audit trail.</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: Fast --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Fast</maml:name> <maml:description> <maml:para>Fast Workbook generation at the price of excluding the hyperlinks.</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: AuditTrailRecordsSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AuditTrailRecordsSince</maml:name> <maml:description> <maml:para>If set, get audit trail records newer than this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When included, reports on all the documents within the specified folder and all sub-folders.</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: AuditTrailRecordsStart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>AuditTrailRecordsStart</maml:name> <maml:description> <maml:para>If set, include audit trail records newer than this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </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>Path to the folder to report on (e.g. "PWPS Connected Project Test 6\Projects 2\Project A").</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>Name of saved search to report on (e.g. "60% Complete").</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: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Folder Id of folder to report on.</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Full path to output XLSX file (e.g. "C:\temp\MyOutputfile.xlsx").</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: IncludeVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IncludeVersions</maml:name> <maml:description> <maml:para>Include this switch to report on versions.</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: IncludeAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IncludeAuditTrail</maml:name> <maml:description> <maml:para>Include this switch to include the audit trail.</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: Fast --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Fast</maml:name> <maml:description> <maml:para>Fast Workbook generation at the price of excluding the hyperlinks.</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: AuditTrailRecordsSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AuditTrailRecordsSince</maml:name> <maml:description> <maml:para>If set, get audit trail records newer than this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When included, reports on all the documents within the specified folder and all sub-folders.</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: AuditTrailRecordsStart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>AuditTrailRecordsStart</maml:name> <maml:description> <maml:para>If set, include audit trail records newer than this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: AuditTrailRecordsEnd --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>AuditTrailRecordsEnd</maml:name> <maml:description> <maml:para>If set, include audit trail records older than this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: AppendToXLSX --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>AppendToXLSX</maml:name> <maml:description> <maml:para>Append to an existing XLSX file. Will force Fast output (no hyperlinks).</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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Look for a personal search.</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>#Example usage for reporting on documents.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Will report on the documents ONLY in the folder identified by the folder path.</maml:para> <maml:para>Save-PWDocumentReport -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -OutputFileName "c:\\temp\\xmittalReport.xlsx"</maml:para> <maml:para>#Will report on the documents ONLY in the folder identified by the folder path. Will include audit trail and versions.</maml:para> <maml:para>Save-PWDocumentReport -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -IncludeVersions -IncludeAuditTrail -OutputFileName "c:\\temp\\xmittalReport.xlsx"</maml:para> <maml:para>#Will report on the documents in the folder and all sub-folders identified by the folder path. Will include audit trail and versions.</maml:para> <maml:para>Save-PWDocumentReport -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -IncludeVersions -Recurse -IncludeAuditTrail -OutputFileName "c:\\temp\\xmittalReport.xlsx"</maml:para> <maml:para>#Will report on the documents in the saved search including the audit trail (will only include versions if they are included in search)</maml:para> <maml:para>Save-PWDocumentReport -SearchName "60% Complete" -IncludeAuditTrail -OutputFileName "c:\\temp\\xmittalReport.xlsx"</maml:para> <maml:para>#Will report on the documents in the folder and all sub-folders identified by the folder path. Will include audit trail between the given dates, will include versions and will output to a SQLite database.</maml:para> <maml:para>Save-PWDocumentReport -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -IncludeVersions -Recurse -IncludeAuditTrail -OutputFileName "c:\\temp\\xmittalReport.sqlite" -AuditTrailRecordsStart 2015-01-01 -AuditTrailRecordEnd 2015-12-31</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentReportDataTable --> <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>Get-PWDocumentReportDataTable</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentReportDataTable</command:noun> <maml:description> <maml:para>Output a report of all the documents and metadata contained in a folder path or in a saved search.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Output a report of all the documents and metadata contained in a folder path or in a saved search. Includes audit trail as well as records from backup audit trail table.</maml:para> <maml:para>Include neither path nor search name to report on whole datasource. Probably not a good idea to include audit trail in that case.</maml:para> <maml:para>Use the recurse parameter to include all sub-folders in the report.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWDocumentReportDataTable</maml:name> <!-- Parameter: ProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectWiseFolder</maml:name> <maml:description> <maml:para>Path to the folder to report on (e.g. "PWPS Connected Project Test 6\Projects 2\Project A").</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>Name of saved search to report on (e.g. "60% Complete").</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: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Folder Id of folder to report on.</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: IncludeVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>IncludeVersions</maml:name> <maml:description> <maml:para>Include this switch to report on versions.</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: IncludeAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IncludeAuditTrail</maml:name> <maml:description> <maml:para>Include this switch to include the audit trail.</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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When included, reports on all the documents within the specified folder and all sub-folders. Note that this is a change from the original behavior.</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: AuditTrailRecordsStart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AuditTrailRecordsStart</maml:name> <maml:description> <maml:para>If set, include audit trail records newer than this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: AuditTrailRecordsEnd --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AuditTrailRecordsEnd</maml:name> <maml:description> <maml:para>If set, include audit trail records older than this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Look for a personal search.</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: ProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectWiseFolder</maml:name> <maml:description> <maml:para>Path to the folder to report on (e.g. "PWPS Connected Project Test 6\Projects 2\Project A").</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>Name of saved search to report on (e.g. "60% Complete").</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: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Folder Id of folder to report on.</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: IncludeVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>IncludeVersions</maml:name> <maml:description> <maml:para>Include this switch to report on versions.</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: IncludeAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IncludeAuditTrail</maml:name> <maml:description> <maml:para>Include this switch to include the audit trail.</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: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>When included, reports on all the documents within the specified folder and all sub-folders. Note that this is a change from the original behavior.</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: AuditTrailRecordsStart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AuditTrailRecordsStart</maml:name> <maml:description> <maml:para>If set, include audit trail records newer than this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: AuditTrailRecordsEnd --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AuditTrailRecordsEnd</maml:name> <maml:description> <maml:para>If set, include audit trail records older than this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Look for a personal search.</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> <!-- 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>#Will report on the documents ONLY in the folder identified by the folder path</maml:para> <maml:para>Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A"</maml:para> <maml:para>#Will report on the documents ONLY in the folder identified by the folder path, and will include audit trail and versions.</maml:para> <maml:para>Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -IncludeAuditTrail -IncludeVersions</maml:para> <maml:para>#Will report on the documents in the folder identified by the folder path and all sub-folders.</maml:para> <maml:para>Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -Recurse</maml:para> <maml:para>#Will report on the documents in the folder identified by the folder path and all sub-folders. Will include audit trail and versions.</maml:para> <maml:para>Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -Recurse -IncludeAuditTrail -IncludeVersions</maml:para> <maml:para>#Will report on the documents ONLY in the folder identified by the folder path</maml:para> <maml:para>Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A"</maml:para> <maml:para>#Will report on the documents in the saved search.</maml:para> <maml:para>Get-PWDocumentReportDataTable -SearchName "60% Complete"</maml:para> <maml:para>#Will report on the documents in the saved search including the audit trail (will only include versions if they are included in search)</maml:para> <maml:para>Get-PWDocumentReportDataTable -SearchName "60% Complete" -IncludeAuditTrail</maml:para> <maml:para>#Will report on the documents in the folder and all sub-folders identified by the folder path. Will include audit trail between the given dates and will include versions.</maml:para> <maml:para>Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -IncludeVersions -Recurse -IncludeAuditTrail -AuditTrailRecordsStart 2015-01-01 -AuditTrailRecordEnd 2015-12-31</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: CheckOut-PWDocuments --> <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>CheckOut-PWDocuments</command:name> <command:verb>CheckOut</command:verb> <command:noun>PWDocuments</command:noun> <maml:description> <maml:para>Check out documents passed in the pipeline.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>CheckOut-PWDocuments</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Input array of ProjectWiseDocument objects from the pipeline (Required). Use Get-PWDocumentBySearch or New-PWDocument to feed pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Export --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Export</maml:name> <maml:description> <maml:para>Use this switch to Export documents rather then checking them out. Must include ExportFolder.</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: CopyOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CopyOut</maml:name> <maml:description> <maml:para>Use this switch to copy out documents rather then checking them out.</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: ExportFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ExportFolder</maml:name> <maml:description> <maml:para>Provide an export location for exports (will create 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: NoReferences --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NoReferences</maml:name> <maml:description> <maml:para>Use this switch to skip the references on a copy out.</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: RemoveCopies --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RemoveCopies</maml:name> <maml:description> <maml:para>Use this switch in the fetch-files scenario where it is unnecessary to keep the documents in the working folder. The copy out should have handled getting the files cached on the caching server. No need to double the storage requirements.</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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Input array of ProjectWiseDocument objects from the pipeline (Required). Use Get-PWDocumentBySearch or New-PWDocument to feed pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Export --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Export</maml:name> <maml:description> <maml:para>Use this switch to Export documents rather then checking them out. Must include ExportFolder.</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: ExportFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ExportFolder</maml:name> <maml:description> <maml:para>Provide an export location for exports (will create 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: CopyOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CopyOut</maml:name> <maml:description> <maml:para>Use this switch to copy out documents rather then checking them out.</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: NoReferences --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NoReferences</maml:name> <maml:description> <maml:para>Use this switch to skip the references on a copy out.</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: RemoveCopies --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RemoveCopies</maml:name> <maml:description> <maml:para>Use this switch in the fetch-files scenario where it is unnecessary to keep the documents in the working folder. The copy out should have handled getting the files cached on the caching server. No need to double the storage requirements.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Input array of ProjectWiseDocument objects from the pipeline (Required). Use Get-PWDocumentBySearch or New-PWDocument to feed pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>New-PWLogin -DatasourceName Server:DSN</maml:para> <maml:para>#Get the documents in just this folder (and their versions) where the file name pattern matches %.pdf</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Microstation J' -FileName '%.dgn' | CheckOut-PWDocuments | Select-Object CheckedOutLocalFileName</maml:para> <maml:para>#Should check out all the PDFs in that folder and populate the CheckedOutLocalFileName property on the document object</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWDocuments --> <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-PWDocuments</command:name> <command:verb>Export</command:verb> <command:noun>PWDocuments</command:noun> <maml:description> <maml:para>Export files to a folder and write metadata to a spreadsheet. Should match format from Save-PWDocumentReport.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Export-PWDocuments</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Input array of ProjectWiseDocument objects from the pipeline (Required). Use Get-PWDocumentBySearch or New-PWDocument to feed pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set to find personal search.</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: ProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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="3"> <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: ExportMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ExportMetadata</maml:name> <maml:description> <maml:para>Export metadata if 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: ExportMetadataFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ExportMetadataFile</maml:name> <maml:description> <maml:para>Metadata 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: ExportVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ExportVersions</maml:name> <maml:description> <maml:para>If set, exports versions of files. Appends .verXXXX suffix before extension. Should always be used with ExportMetadata</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: JustOneFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>JustOneFolder</maml:name> <maml:description> <maml:para>If set, exports only the files in the given folder rather than including subfolders.</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: BPRCFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>BPRCFile</maml:name> <maml:description> <maml:para>If included, will build MicroStation batch processing file.</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: ServerIsUTC --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ServerIsUTC</maml:name> <maml:description> <maml:para>Set if server is UTC. Will do file time comparison in UTC.</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: InputDocuments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Input array of ProjectWiseDocument objects from the pipeline (Required). Use Get-PWDocumentBySearch or New-PWDocument to feed pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <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="2"> <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="3"> <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: ExportMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ExportMetadata</maml:name> <maml:description> <maml:para>Export metadata if 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: ExportMetadataFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ExportMetadataFile</maml:name> <maml:description> <maml:para>Metadata 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: ExportVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ExportVersions</maml:name> <maml:description> <maml:para>If set, exports versions of files. Appends .verXXXX suffix before extension. Should always be used with ExportMetadata</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: JustOneFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>JustOneFolder</maml:name> <maml:description> <maml:para>If set, exports only the files in the given folder rather than including subfolders.</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: BPRCFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>BPRCFile</maml:name> <maml:description> <maml:para>If included, will build MicroStation batch processing file.</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: ServerIsUTC --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ServerIsUTC</maml:name> <maml:description> <maml:para>Set if server is UTC. Will do file time comparison in UTC.</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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set to find personal search.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Input array of ProjectWiseDocument objects from the pipeline (Required). Use Get-PWDocumentBySearch or New-PWDocument to feed pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for reporting on documents.</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>New-PWLogin Server:DSN</maml:para> <maml:para>#Will export documents returned by the listed saved searches.</maml:para> <maml:para>Export-PWDocuments -OutputFolder c:\export -Searches "60% Complete;80% Complete;90% Complete" -ExportMetadata -ExportMetadataFile "output.xlsx"</maml:para> <maml:para>#Will export documents in given folder and write metadata file with default filename and set exported (copied out) files to final status.</maml:para> <maml:para>Export-PWDocuments -OutputFolder c:\export -ProjectWiseFolder "Source A\Subfolder 1" -ExportMetadata | Set-PWDocumentFinalStatus</maml:para> <maml:para>#Gets a document, exports it with metadat and sets final status.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -DocumentName 'Final Site Plan' | Export-PWDocuments -OutputFolder c:\export -ExportMetadata | Set-PWDocumentFinalStatus</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWDocuments --> <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-PWDocuments</command:name> <command:verb>Import</command:verb> <command:noun>PWDocuments</command:noun> <maml:description> <maml:para>Imports files from disk and creates corresponding folders and documents in ProjectWise.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-PWDocuments</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Path to the folder on disk 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: ProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectWiseFolder</maml:name> <maml:description> <maml:para>ProjectWise folder path (e.g. "Target A\Subfolder 1\Sub Sub Folder 2").</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: ExtensionsOfInterest --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ExtensionsOfInterest</maml:name> <maml:description> <maml:para>Semi-colon delimited filter for the files from the disk (e.g. ".dgn;.dwg").</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="3"> <maml:name>DefaultStorage</maml:name> <maml:description> <maml:para>Set default storage for new folders to be created.</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: DefaultWorkflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DefaultWorkflow</maml:name> <maml:description> <maml:para>Set default workflow for new folders to be created.</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: DefaultEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>Set default environment for new folders to be created.</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: MakeProjectWiseMatchDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>MakeProjectWiseMatchDisk</maml:name> <maml:description> <maml:para>Delete documents in ProjectWise that are not present on disk. Useful for mirroring data from disk.</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: CreateVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>CreateVersions</maml:name> <maml:description> <maml:para>Set to create a version when the file already exists in ProjectWise. If not set, will just overwrite.</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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Path to the folder on disk 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: ProjectWiseFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectWiseFolder</maml:name> <maml:description> <maml:para>ProjectWise folder path (e.g. "Target A\Subfolder 1\Sub Sub Folder 2").</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: ExtensionsOfInterest --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ExtensionsOfInterest</maml:name> <maml:description> <maml:para>Semi-colon delimited filter for the files from the disk (e.g. ".dgn;.dwg").</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="3"> <maml:name>DefaultStorage</maml:name> <maml:description> <maml:para>Set default storage for new folders to be created.</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: DefaultWorkflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DefaultWorkflow</maml:name> <maml:description> <maml:para>Set default workflow for new folders to be created.</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: DefaultEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>Set default environment for new folders to be created.</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: MakeProjectWiseMatchDisk --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>MakeProjectWiseMatchDisk</maml:name> <maml:description> <maml:para>Delete documents in ProjectWise that are not present on disk. Useful for mirroring data from disk.</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: CreateVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>CreateVersions</maml:name> <maml:description> <maml:para>Set to create a version when the file already exists in ProjectWise. If not set, will just overwrite.</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>#Example usage for reporting on documents.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Will import the documents from the input folder with one of the matching extensions into PW under the give ProjectWise folder. Creates folders as necessary.</maml:para> <maml:para>#Creates versions of duplicate files with the given switch.</maml:para> <maml:para>Import-PWDocuments -InputFolder "c:\files\subfolder" -ProjectWiseFolder "Target A\Folder 1" -ExtensionsOfInterest ".dgn;.dwg" -DefaultStorage Store01 -CreateVersions</maml:para> <maml:para>#Will import files from Input folder. Shows use of pipeline.</maml:para> <maml:para>Import-PWDocuments -InputFolder "c:\files" -ProjectWiseFolder "Target A" -DefaultStorage Store01 -DefaultWorkflow Normal | Set-PWDocumentState -State "Archived"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWDocuments --> <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>Remove-PWDocuments</command:name> <command:verb>Remove</command:verb> <command:noun>PWDocuments</command:noun> <maml:description> <maml:para>Removes documents.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of document objects from the pipeline and deletes them.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Remove-PWDocuments</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseSoftDelete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UseSoftDelete</maml:name> <maml:description> <maml:para>Set this to "soft" delete file into Deleted Items folder.</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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseSoftDelete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UseSoftDelete</maml:name> <maml:description> <maml:para>Set this to "soft" delete file into Deleted Items folder.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Get the documents in the given path and delete them</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Import\Test' -FileName '02_%.pdf'| Remove-PWDocuments</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Rename-PWDocuments --> <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>Rename-PWDocuments</command:name> <command:verb>Rename</command:verb> <command:noun>PWDocuments</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Rename-PWDocuments</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DocumentNamePart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentNamePart</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DocumentNameReplacement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentNameReplacement</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileNamePart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileNamePart</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileNameReplacement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileNameReplacement</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplaceDocumentNameWithFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplaceDocumentNameWithFileName</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReplaceFileNameWithDocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplaceFileNameWithDocumentName</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplaceFileNameWithDocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplaceFileNameWithDocumentName</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReplaceDocumentNameWithFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplaceDocumentNameWithFileName</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentNamePart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentNamePart</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileNamePart --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileNamePart</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DocumentNameReplacement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentNameReplacement</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileNameReplacement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileNameReplacement</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Copy-PWDocumentsByProject --> <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>Copy-PWDocumentsByProject</command:name> <command:verb>Copy</command:verb> <command:noun>PWDocumentsByProject</command:noun> <maml:description> <maml:para>Copy the contents of a folder to another folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copies the contents of a folder to another folder optionally creating new sub-folders to contain the documents.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-PWDocumentsByProject</maml:name> <!-- Parameter: SourceFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SourceFolderPath</maml:name> <maml:description> <maml:para>Folder path to copy from (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: TargetFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetFolderPath</maml:name> <maml:description> <maml:para>Folder path to copy to (Required) (Must 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: DoNotReplicatePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DoNotReplicatePaths</maml:name> <maml:description> <maml:para>If set, will attempt to copy all documents under the source folder tree to the target folder without creating subfolders.</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: NewStorageArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>NewStorageArea</maml:name> <maml:description> <maml:para>If set, will create new folders in this storage area.</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: CreateVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CreateVersions</maml:name> <maml:description> <maml:para>If set, will create new versions of existing documents. Default is to overwrite existing.</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: SourceFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SourceFolderPath</maml:name> <maml:description> <maml:para>Folder path to copy from (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: TargetFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetFolderPath</maml:name> <maml:description> <maml:para>Folder path to copy to (Required) (Must 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: DoNotReplicatePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DoNotReplicatePaths</maml:name> <maml:description> <maml:para>If set, will attempt to copy all documents under the source folder tree to the target folder without creating subfolders.</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: NewStorageArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>NewStorageArea</maml:name> <maml:description> <maml:para>If set, will create new folders in this storage area.</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: CreateVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CreateVersions</maml:name> <maml:description> <maml:para>If set, will create new versions of existing documents. Default is to overwrite existing.</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>Copy contents of source folder to target folder</maml:para> <maml:para>Copy-PWDocumentsByProject -SourceFolderPath 'Top Level\Sub-Folder' -TargetFolderPath 'Top Level 2\Sub-Folder 2' -DefaultStorageArea Storage01</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWDocumentsBySearch --> <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>Copy-PWDocumentsBySearch</command:name> <command:verb>Copy</command:verb> <command:noun>PWDocumentsBySearch</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-PWDocumentsBySearch</maml:name> <!-- Parameter: SearchName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SearchName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplicatePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ReplicatePaths</maml:name> <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: DefaultStorageArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultStorageArea</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Personal</maml:name> <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: SearchName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SearchName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplicatePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ReplicatePaths</maml:name> <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: DefaultStorageArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultStorageArea</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Personal</maml:name> <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>#Example copying documents.</maml:para> <maml:para>The following will copy all documents returned from the saved search to a target folder.</maml:para> <maml:para>Copy-PWDocumentsBySearch -SearchName 'DGNS' -FolderPath 'Projects\CopyToHere' -DefaultStorageArea 'Storage'</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Example copying documents with replicatepaths parameter included.</maml:para> <maml:para>The following will copy all documents returned from the saved search to a target folder and replicate source folder structure.</maml:para> <maml:para>Copy-PWDocumentsBySearch -SearchName 'DGNS' -FolderPath 'Projects\CopyToHere' -DefaultStorageArea 'Storage' -ReplicatePaths</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentsBySearch --> <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>Get-PWDocumentsBySearch</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentsBySearch</command:noun> <maml:description> <maml:para>Get an array of ProjectWiseDocument objects based on a saved search or from a folder tree.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a search name or a folder path, full-text search string, document name or pattern, file name or pattern and returns the matching documents.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWDocumentsBySearch</maml:name> <!-- Parameter: SearchName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Search name to execute.</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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to search.</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: Slow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Slow</maml:name> <maml:description> <maml:para>Set to fill in document name path in document object.</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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set to use a personal search.</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: GetVersionsToo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>GetVersionsToo</maml:name> <maml:description> <maml:para>Return document versions.</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: GetAttributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>GetAttributes</maml:name> <maml:description> <maml:para>Populate attributes in document object. Will degrade performance.</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: JustThisFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>JustThisFolder</maml:name> <maml:description> <maml:para>Only search this folder and not its sub-folders.</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: FileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Filename to search for. Supports wildcards like '%.pdf'</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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document Name to search for. Supports wildcards like '%.pdf'</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: SearchString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Full text search string.</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="8"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment name.</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: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable of attributes to search for. Hashtable in PowerShell looks like this @{Name = 'Value'; Name2 = 'Value2' }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SearchName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Search name to execute.</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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to search.</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: GetVersionsToo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>GetVersionsToo</maml:name> <maml:description> <maml:para>Return document versions.</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: GetAttributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>GetAttributes</maml:name> <maml:description> <maml:para>Populate attributes in document object. Will degrade performance.</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: JustThisFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>JustThisFolder</maml:name> <maml:description> <maml:para>Only search this folder and not its sub-folders.</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: FileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Filename to search for. Supports wildcards like '%.pdf'</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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document Name to search for. Supports wildcards like '%.pdf'</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: SearchString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Full text search string.</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="8"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment name.</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: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable of attributes to search for. Hashtable in PowerShell looks like this @{Name = 'Value'; Name2 = 'Value2' }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Slow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Slow</maml:name> <maml:description> <maml:para>Set to fill in document name path in document object.</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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set to use a personal search.</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>#Example usages for searching for documents.</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>New-PWLogin Server:DSN</maml:para> <maml:para>#Get the documents in just this folder (and their versions) where the file name pattern matches %.pdf</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -GetVersionsToo -JustThisFolder -Filename '%.pdf'</maml:para> <maml:para>#Get the documents in this folder tree (and their versions) where the file name pattern matches %.pdf and 'Primary' is in the full-text index</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -GetVersionsToo -SearchString 'Primary' -Filename '%.pdf'</maml:para> <maml:para>#Get the active documents in this folder tree matching these attributes</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -Attributes @{Name = 'Value'; Name2 = 'Value2' }</maml:para> <maml:para>#Get the documents returned by the saved search</maml:para> <maml:para>Get-PWDocumentsBySearch -SearchName "PDFs in Project"</maml:para> <maml:para>#Get the documents returned by the saved search (note path definition) and populate the attributes and extended information (can be quite slow)</maml:para> <maml:para>Get-PWDocumentsBySearch -SearchName "Rich Project From PowerShell\Project 02\PDF Search made by PowerShell" -GetAttributes</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWDocumentsBySearch --> <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>Remove-PWDocumentsBySearch</command:name> <command:verb>Remove</command:verb> <command:noun>PWDocumentsBySearch</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWDocumentsBySearch</maml:name> <!-- Parameter: SearchName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SearchName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Is personal search.</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: SearchName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SearchName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Is personal search.</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>#Example removing documents.</maml:para> <maml:para>The following will remove all documents returned from the saved search.</maml:para> <maml:para>Remove-PWDocumentsBySearch -SearchName 'DGNS'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWDocumentsBySpreadsheet --> <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-PWDocumentsBySpreadsheet</command:name> <command:verb>Import</command:verb> <command:noun>PWDocumentsBySpreadsheet</command:noun> <maml:description> <maml:para>Imports files from a spreadsheet. Should match format from Save-PWDocumentReport.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-PWDocumentsBySpreadsheet</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: DefaultWorkflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultWorkflow</maml:name> <maml:description> <maml:para>Workflow 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: DefaultEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>Environment 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: VersionIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>VersionIfExists</maml:name> <maml:description> <maml:para>If file exists in ProjectWise, version it. Will overwrite 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: OnlyUpdateAttributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>OnlyUpdateAttributes</maml:name> <maml:description> <maml:para>Only update the attributes.</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: DefaultWorkflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultWorkflow</maml:name> <maml:description> <maml:para>Workflow 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: DefaultEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DefaultEnvironment</maml:name> <maml:description> <maml:para>Environment 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: VersionIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>VersionIfExists</maml:name> <maml:description> <maml:para>If file exists in ProjectWise, version it. Will overwrite 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: OnlyUpdateAttributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>OnlyUpdateAttributes</maml:name> <maml:description> <maml:para>Only update the attributes.</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>#Example usage for reporting on documents.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Will import the documents from the input folder with one of the matching extensions into PW under the give ProjectWise folder. Creates folders as necessary.</maml:para> <maml:para>#Creates versions of duplicate files with the given switch.</maml:para> <maml:para>Import-PWDocumentsBySpreadsheet -InputFile "c:\import\import.xlsx" -TargetProjectWiseFolder "Target A\Folder 1" -DefaultStorage Store01 -VersionIfExists</maml:para> <maml:para>#Will import files from spreadsheet. Shows use of pipeline.</maml:para> <maml:para>Import-PWDocumentsBySpreadsheet -InputFile "c:\import\import.xlsx" -TargetProjectWiseFolder "Target A\Folder 1" -DefaultStorage Store01 -DefaultWorkflow Normal | Set-PWDocumentState -State "Imported"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- 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: CheckIn-PWDocumentsOrFree --> <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>CheckIn-PWDocumentsOrFree</command:name> <command:verb>CheckIn</command:verb> <command:noun>PWDocumentsOrFree</command:noun> <maml:description> <maml:para>Check in or free documents passed in the pipeline.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Input array of ProjectWiseDocument objects from the pipeline (Required). Use Get-PWDocumentBySearch to feed pipeline. Include the -Free switch parameter to free the documents. If the local file is missing, the file will be freed regardless of whether or not the -Free switch parameter is included.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>CheckIn-PWDocumentsOrFree</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Free --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Free</maml:name> <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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Free --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Free</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for checking in document(s).</maml:para> <maml:para>#Get the documents in the folder where filename like *.dgn and check them in.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Microstation J' -FileName '%.dgn' | CheckIn-PWDocumentsOrFree | Select-Object FileName</maml:para> <maml:para>#Should check in all the checked out documents passed to the cmdlet</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for freeing a document(s).</maml:para> <maml:para>#Get the documents in the folder where filename like *.dgn and check them in.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Microstation J' -FileName '%.dgn' | CheckIn-PWDocumentsOrFree -Free | Select-Object FileName</maml:para> <maml:para>#Should free all the checked out documents passed to the cmdlet</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWDocumentState --> <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>Set-PWDocumentState</command:name> <command:verb>Set</command:verb> <command:noun>PWDocumentState</command:noun> <maml:description> <maml:para>Sets a document's workflow state.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a document object from the pipeline and sets it to the indicated workflow state.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Set-PWDocumentState</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>State</maml:name> <maml:description> <maml:para>Name of state to change to.</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: ChangeVersionStates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ChangeVersionStates</maml:name> <maml:description> <maml:para>Change state of old versions passed, too.</maml:para> <maml:para>Requires current user to be an administrator.</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: SkipIntermediateStates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SkipIntermediateStates</maml:name> <maml:description> <maml:para>Go directly to passed state and don't pass through intermediate states.</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: ChangeFinalStatusStates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ChangeFinalStatusStates</maml:name> <maml:description> <maml:para>Change state of documents with final status set.</maml:para> <maml:para>Requires current user to be an administrator.</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: IgnoreStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IgnoreStatus</maml:name> <maml:description> <maml:para>Change state of exported or checked out documents.</maml:para> <maml:para>Requires current user to be an administrator.</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: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>State</maml:name> <maml:description> <maml:para>Name of state to change to.</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: ChangeVersionStates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ChangeVersionStates</maml:name> <maml:description> <maml:para>Change state of old versions passed, too.</maml:para> <maml:para>Requires current user to be an administrator.</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: SkipIntermediateStates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SkipIntermediateStates</maml:name> <maml:description> <maml:para>Go directly to passed state and don't pass through intermediate states.</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: ChangeFinalStatusStates --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ChangeFinalStatusStates</maml:name> <maml:description> <maml:para>Change state of documents with final status set.</maml:para> <maml:para>Requires current user to be an administrator.</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: IgnoreStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IgnoreStatus</maml:name> <maml:description> <maml:para>Change state of exported or checked out documents.</maml:para> <maml:para>Requires current user to be an administrator.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Setting all the documents in a folder to a given state.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Get all the documents in this folder and set them to state 'Completed'</maml:para> <maml:para>#Skipping intermediate states, changing the states of old version, changing the states of documents with final status,</maml:para> <maml:para>#and changing the status of checked out and exported documents. User must be administator for special switches to work.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -GetVersionsToo -JustThisFolder | Set-PWDocumentState -State 'Completed' -SkipIntermediateStates -ChangeVersionStates -ChangeFinalStatusStates -IgnoreStatus</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. Now supports full path to search.</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> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set this if using a personal search.</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: 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. Now supports full path to search.</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> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set this if using a personal search.</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 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> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Is personal search.</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: 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> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Is personal search.</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> <!-- 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: Copy-PWDocumentsToFolder --> <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>Copy-PWDocumentsToFolder</command:name> <command:verb>Copy</command:verb> <command:noun>PWDocumentsToFolder</command:noun> <maml:description> <maml:para>Copies documents to a target folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of document objects from the pipeline and copies them to a target folder.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Copy-PWDocumentsToFolder</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetFolderPath</maml:name> <maml:description> <maml:para>Path to target folder (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: CreateVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CreateVersion</maml:name> <maml:description> <maml:para>Set this to create a new version if the document exists. If not set, document will be overwritten.</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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetFolderPath</maml:name> <maml:description> <maml:para>Path to target folder (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: CreateVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CreateVersion</maml:name> <maml:description> <maml:para>Set this to create a new version if the document exists. If not set, document will be overwritten.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Get the documents in the given path and copy them to a target folder</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Import\Test' -FileName '02_%.pdf'| Copy-PWDocumentsToFolder -TargetFolderPath 'New\Folder\Path'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Move-PWDocumentsToFolder --> <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>Move-PWDocumentsToFolder</command:name> <command:verb>Move</command:verb> <command:noun>PWDocumentsToFolder</command:noun> <maml:description> <maml:para>Moves documents to a target folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of document objects from the pipeline and moves them to a target folder.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Move-PWDocumentsToFolder</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetFolderPath</maml:name> <maml:description> <maml:para>Path to target folder (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: CreateVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CreateVersion</maml:name> <maml:description> <maml:para>Set this to create a new version if the document exists. If not set, document will be overwritten.</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: DoNotPreserveState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DoNotPreserveState</maml:name> <maml:description> <maml:para>Set this to bypass workflow state preservation.</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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetFolderPath</maml:name> <maml:description> <maml:para>Path to target folder (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: CreateVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CreateVersion</maml:name> <maml:description> <maml:para>Set this to create a new version if the document exists. If not set, document will be overwritten.</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: DoNotPreserveState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DoNotPreserveState</maml:name> <maml:description> <maml:para>Set this to bypass workflow state preservation.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Get the documents in the given path and move them to a target folder</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Import\Test' -FileName '02_%.pdf'| Move-PWDocumentsToFolder -TargetFolderPath 'New\Folder\Path'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWDocumentsWithCode --> <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-PWDocumentsWithCode</command:name> <command:verb>Add</command:verb> <command:noun>PWDocumentsWithCode</command:noun> <maml:description> <maml:para>Create new abstract documents with document codes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Will will create abstract documents using the document code.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Add-PWDocumentsWithCode</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of folders to process. Should use Get-PWFolders or related cmdlet to generate</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable of attributes. Hashtable in PowerShell looks like this @{Name = 'Value'; Name2 = 'Value2' }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NumberOfDocuments</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: StartNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of folders to process. Should use Get-PWFolders or related cmdlet to generate</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable of attributes. Hashtable in PowerShell looks like this @{Name = 'Value'; Name2 = 'Value2' }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NumberOfDocuments</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: StartNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of folders to process. Should use Get-PWFolders or related cmdlet to generate</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para># Create 5 abstract documents using document code populated with the passed default attribute values</maml:para> <maml:para>Get-PWFolders -FolderPath 'Replicated\Project 01' | Add-PWDocumentsWithCode -Attributes @{ ProjectNumber = 'BSI400'; AreaShort = 'RW'; DocumentTypeShort = '2DM'; LevelShort = 'NA' } -NumberOfDocuments 5</maml:para> <maml:para># Create 5 abstract documents using document code populated with the passed default attribute values and then attach a dummy file to each with the appropriate name</maml:para> <maml:para>Get-PWFolders -FolderPath 'Replicated\Project 01' | Add-PWDocumentsWithCode -Attributes @{ ProjectNumber = 'BSI400'; AreaShort = 'RW'; DocumentTypeShort = '2DM'; LevelShort = 'NA' } -NumberOfDocuments 5 | Update-PWDocumentFile -NewFile 'C:\temp\dummy.txt' -UseDocumentName</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Submit-PWDocumentToPrint --> <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>Submit-PWDocumentToPrint</command:name> <command:verb>Submit</command:verb> <command:noun>PWDocumentToPrint</command:noun> <maml:description> <maml:para>Copy out files and submit them to print on the default printer. Probably works best for PDFs.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Submit-PWDocumentToPrint</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for print to complete.</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: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for print to complete.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Wait for print to complete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#get all the printers, figure out which one is the current default, change the default printer to the one you want, print your documents, set the printer back to the original default</maml:para> <maml:para>$printers=Get-WMIObject Win32_Printer</maml:para> <maml:para>$defprinter01=Get-WMIObject Win32_Printer | Where{$_.Default -eq $true}</maml:para> <maml:para>$defprinter02=Get-WMIObject Win32_Printer | Where{$_.Name -eq "HP Laser Jet"}</maml:para> <maml:para>$defprinter02.SetDefaultPrinter()</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Submit-PWPDFPrint -Verbose</maml:para> <maml:para>$defprinter01.SetDefaultPrinter()</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWDocumentVersion --> <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-PWDocumentVersion</command:name> <command:verb>New</command:verb> <command:noun>PWDocumentVersion</command:noun> <maml:description> <maml:para>Creates new versions of ProjectWise documents passed on the pipeline.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>#Search for documents and version them to version A.</maml:para> <maml:para>Get-PWDocumentsBySearch -SearchName "Documents in Released State" | New-PWDocumentVersion -VersionString A</maml:para> <maml:para>#Search for documents in folder and version to next version.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Project A\Files to Version" | New-PWDocumentVersion</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>New-PWDocumentVersion</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>List of documents from pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VersionString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VersionString</maml:name> <maml:description> <maml:para>Optional version string.</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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>List of documents from pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VersionString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VersionString</maml:name> <maml:description> <maml:para>Optional version string.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of documents from pipeline (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Search for documents and version them to version A.</maml:para> <maml:para>Get-PWDocumentsBySearch -SearchName "Documents in Released State" | New-PWDocumentVersion -VersionString A</maml:para> <maml:para>#Search for documents in folder version to next version.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Project A\Files to Version" | New-PWDocumentVersion</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWDocumentVersions --> <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>Remove-PWDocumentVersions</command:name> <command:verb>Remove</command:verb> <command:noun>PWDocumentVersions</command:noun> <maml:description> <maml:para>Removes old document versions above a certain number.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of document objects from the pipeline and a number of versions to keep parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Remove-PWDocumentVersions</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfVersionsToKeep --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NumberOfVersionsToKeep</maml:name> <maml:description> <maml:para>Number of versions to keep (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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfVersionsToKeep --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NumberOfVersionsToKeep</maml:name> <maml:description> <maml:para>Number of versions to keep (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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of document objects from pipeline (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Get the documents in the given path and delete old versions of the documents up to the "number of versions to keep"</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Import\Test' | Remove-PWDocumentVersions -NumberOfVersionsToKeep 3</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Search-PWDocumentWithMissingFile --> <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>Search-PWDocumentWithMissingFile</command:name> <command:verb>Search</command:verb> <command:noun>PWDocumentWithMissingFile</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Search-PWDocumentWithMissingFile</maml:name> <!-- Parameter: Document --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Document</maml:name> <maml:description> <maml:para>Document(s) to check if there is an associated file, if yes verify the physical file exists.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseDocument</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Document --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Document</maml:name> <maml:description> <maml:para>Document(s) to check if there is an associated file, if yes verify the physical file exists.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseDocument</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Document(s) to check if there is an associated file, if yes verify the physical file exists.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-PWDSConfigEntry --> <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>Get-PWDSConfigEntry</command:name> <command:verb>Get</command:verb> <command:noun>PWDSConfigEntry</command:noun> <maml:description> <maml:para>Returns datasource information based on server name, FQDN, IPAddress, and datasource name.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWDSConfigEntry</maml:name> <!-- Parameter: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasourceName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatasourceName</maml:name> <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: Server --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Server</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DatasourceName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatasourceName</maml:name> <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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for Get-PWDSConfigEntry.</maml:para> <maml:para>#Will return information for all datasources configured on local system.</maml:para> <maml:para>Get-PWDSConfigEntry</maml:para> <maml:para>#Will return information for all datasources configured on specified server by servername.</maml:para> <maml:para>Get-PWDSConfigEntry -Server 'PWConnect'</maml:para> <maml:para>#Will return information for all datasources configured on specified server by FQDN.</maml:para> <maml:para>Get-PWDSConfigEntry -Server 'Alpo.Bentley.Com'</maml:para> <maml:para>#Will return information for all datasources configured on specified server by IPAddress.</maml:para> <maml:para>Get-PWDSConfigEntry -Server '192.168.1.5'</maml:para> <maml:para>#Will return information for specified datasource.</maml:para> <maml:para>Get-PWDSConfigEntry -DatasourceName 'PWConnectEdition'</maml:para> <maml:para>#Will return information for specified datasource configured on specified server by FQDN.</maml:para> <maml:para>Get-PWDSConfigEntry -Server 'Alpo.Bentley.Com' -DatasourceName 'PWConnectEdition'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWDSSession --> <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>Set-PWDSSession</command:name> <command:verb>Set</command:verb> <command:noun>PWDSSession</command:noun> <maml:description> <maml:para>Set-PWDSSession sets the current ProjectWise datasource session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-PWDSSession sets the current ProjectWise datasource session using the session information passed.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWDSSession</maml:name> <!-- Parameter: PWDSSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>PWDSSession</maml:name> <command:parameterValue required="true">IntPtr</command:parameterValue> <dev:type> <maml:name>System.IntPtr</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: PWDSSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>PWDSSession</maml:name> <command:parameterValue required="true">IntPtr</command:parameterValue> <dev:type> <maml:name>System.IntPtr</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>#Example usage for setting the ProjectWise current datasource session using the session information passed.</maml:para> <maml:para>Set-PWDSSession -PWDSSession $session</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWEnvironment --> <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-PWEnvironment</command:name> <command:verb>New</command:verb> <command:noun>PWEnvironment</command:noun> <maml:description> <maml:para>Create a new environment with one column. Use Add-PWEnvironmentColumn to flesh out environment.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWEnvironment</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of new environment to create.</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: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Name of new table to create.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Name of default column to create. Will be nvarchar(55).</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: Interface --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Interface</maml:name> <maml:description> <maml:para>Name of default interface to create. Defaults to "Default".</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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of new environment to create.</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: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Name of new table to create.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Name of default column to create. Will be nvarchar(55).</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: Interface --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Interface</maml:name> <maml:description> <maml:para>Name of default interface to create. Defaults to "Default".</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>New-PWLogin -DatasourceName server:DSN</maml:para> <maml:para>New-PWEnvironment -EnvironmentName NewEnvironment -TableName t_NewEnvironment -ColumnName DrawingNumber -Interface NewEnvironment</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Clear-PWEnvironmentByFolderPath --> <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>Clear-PWEnvironmentByFolderPath</command:name> <command:verb>Clear</command:verb> <command:noun>PWEnvironmentByFolderPath</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Clear-PWEnvironmentByFolderPath</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SubFolders</maml:name> <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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SubFolders</maml:name> <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:command> <!-- Cmdlet: Set-PWEnvironmentByFolderPath --> <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>Set-PWEnvironmentByFolderPath</command:name> <command:verb>Set</command:verb> <command:noun>PWEnvironmentByFolderPath</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWEnvironmentByFolderPath</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Environment</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SubFolders</maml:name> <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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Environment</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SubFolders</maml:name> <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:command> <!-- Cmdlet: Add-PWEnvironmentColumn --> <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-PWEnvironmentColumn</command:name> <command:verb>Add</command:verb> <command:noun>PWEnvironmentColumn</command:noun> <maml:description> <maml:para>Add-PWEnvironmentColumn adds a new column to the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new column of types (text, integer, decimal, date) to the current datasource</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWEnvironmentColumn</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment to add a new column to.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ColumnName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ColumnType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ColumnType</maml:name> <maml:description> <maml:para>Data type of column to be added to environment.</maml:para> <maml:para>Acceptable values: 'date', 'text', 'decimal', 'integer'</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: ColumnWidth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ColumnWidth</maml:name> <maml:description> <maml:para>Width of column to be added to 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> <!-- Parameter: ColumnScale --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ColumnScale</maml:name> <maml:description> <maml:para>Width of column to be added to 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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment to add a new column to.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ColumnName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ColumnType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ColumnType</maml:name> <maml:description> <maml:para>Data type of column to be added to environment.</maml:para> <maml:para>Acceptable values: 'date', 'text', 'decimal', 'integer'</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: ColumnWidth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ColumnWidth</maml:name> <maml:description> <maml:para>Width of column to be added to 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> <!-- Parameter: ColumnScale --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ColumnScale</maml:name> <maml:description> <maml:para>Width of column to be added to 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>Example usage for adding a new text column to an environment.</maml:para> </maml:introduction> <dev:code>Add-PWEnvironmentColumn -EnvironmentName 'Default' -ColumnName 'MyNewTextAttribute' -ColumnType 'text' -ColumnWidth 100</dev:code> <dev:remarks> <maml:para>This adds a new text column named MyNewTextAttribute with a width of 100 to the 'Default' environment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Example usage for adding a new integer column to an environment.</maml:para> </maml:introduction> <dev:code>Add-PWEnvironmentColumn -EnvironmentName 'Default' -ColumnName 'MyNewIntegerAttribute' -ColumnType 'integer'</dev:code> <dev:remarks> <maml:para>This adds a new integer column named MyNewIntegerAttribute to the 'Default' environment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Example usage for adding a new decimal column to an environment.</maml:para> </maml:introduction> <dev:code>Add-PWEnvironmentColumn -EnvironmentName 'Default' -ColumnName 'MyNewDecimalAttribute' -ColumnType 'decimal' -ColumnWidth 10 -ColumnScale 2</dev:code> <dev:remarks> <maml:para>This adds a new decimal column named MyNewDecimalAttribute with a width of 10 and a scale of 2 to the 'Default' environment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Example usage for adding a new date column to an environment.</maml:para> </maml:introduction> <dev:code>Add-PWEnvironmentColumn -EnvironmentName 'Default' -ColumnName 'MyNewDateAttribute' -ColumnType 'date'</dev:code> <dev:remarks> <maml:para>This adds a new date column named MyNewDateAttribute to the 'Default' environment.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWEnvironmentColumn --> <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>Copy-PWEnvironmentColumn</command:name> <command:verb>Copy</command:verb> <command:noun>PWEnvironmentColumn</command:noun> <maml:description> <maml:para>Copy-PWEnvironmentColumn copies an environment attribute from one environment to another within the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copies an environment attribute from a source environment to a target environment within the current datasource</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-PWEnvironmentColumn</maml:name> <!-- Parameter: SourceEnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SourceEnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute (column) 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: TargetEnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetEnvironmentName</maml:name> <maml:description> <maml:para>Environment to copy attribute (column) to.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Name of column to be copied.</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: SourceEnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SourceEnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute (column) 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: TargetEnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetEnvironmentName</maml:name> <maml:description> <maml:para>Environment to copy attribute (column) to.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Name of column to be copied.</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>Example usage for copying an Environment Attribute.</maml:para> </maml:introduction> <dev:code>Copy-PWEnvironmentColumn -SourceEnvironmentName 'MySourceEnvironment' -TargetEnvironmentName 'MyTargetEnvironment -ColumnName 'MyAttributeToCopy'</dev:code> <dev:remarks> <maml:para>This copies the MyAttributeToCopy environment attribute from MySourceEnvironment to MyTargetEnvironment.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWEnvironmentColumnName --> <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-PWEnvironmentColumnName</command:name> <command:verb>Update</command:verb> <command:noun>PWEnvironmentColumnName</command:noun> <maml:description> <maml:para>Changes the name of a column in an environment.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWEnvironmentColumnName</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of environment to modify.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Name of column to modify.</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: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name for column.</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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of environment to modify.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Name of column to modify.</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: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name for column.</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>#Example usage for changing the name of a column in an environment.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Update-PWEnvironmentColumnName -Environment Environment_1 -Column Column_1 -NewName Column_2</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWEnvironmentColumns --> <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>Get-PWEnvironmentColumns</command:name> <command:verb>Get</command:verb> <command:noun>PWEnvironmentColumns</command:noun> <maml:description> <maml:para>Returns all columns for a specified environment within the current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWEnvironmentColumns</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment to return column information.</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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment to return column information.</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>#Example usage for Get-PWEnvironmentColumnss.</maml:para> <maml:para>#Will return all columns for the specified environment within the current datasource.</maml:para> <maml:para>Get-PWEnvironmentColumns -EnvironmentName 'Simple'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWEnvironmentColumnWidth --> <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-PWEnvironmentColumnWidth</command:name> <command:verb>Update</command:verb> <command:noun>PWEnvironmentColumnWidth</command:noun> <maml:description> <maml:para>Changes width of a column in an environment.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWEnvironmentColumnWidth</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of environment to modify.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Name of column to modify.</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: NewWidth --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>NewWidth</maml:name> <maml:description> <maml:para>New width to set for column.</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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of environment to modify.</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: ColumnName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ColumnName</maml:name> <maml:description> <maml:para>Name of column to modify.</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: NewWidth --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>NewWidth</maml:name> <maml:description> <maml:para>New width to set for column.</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>#Example usage for changing the width of a column.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Update-PWEnvironmentColumnWidth -Environment Environment_1 -Column Column_1 -NewWidth 256</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWEnvironmentCopyData --> <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-PWEnvironmentCopyData</command:name> <command:verb>Update</command:verb> <command:noun>PWEnvironmentCopyData</command:noun> <maml:description> <maml:para>Copies data from one column to another within an environment. Used when adding new columns. May fail on a large quantity of data.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWEnvironmentCopyData</maml:name> <!-- Parameter: Environment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Name of environment to modify.</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: Column --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Column</maml:name> <maml:description> <maml:para>Name of column to modify.</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: TargetColumn --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TargetColumn</maml:name> <maml:description> <maml:para>New name for column.</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: Environment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Name of environment to modify.</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: Column --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Column</maml:name> <maml:description> <maml:para>Name of column to modify.</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: TargetColumn --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TargetColumn</maml:name> <maml:description> <maml:para>New name for column.</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>#Example usage for copying data from one column to another in an environment.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Update-PWEnvironmentCopyData -Environment Environment_1 -Column Column_1 -TargetColumn Column_2</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWEnvironments --> <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>Get-PWEnvironments</command:name> <command:verb>Get</command:verb> <command:noun>PWEnvironments</command:noun> <maml:description> <maml:para>Returns all environment objects from current datasource.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for Get-PWEnvironments.</maml:para> <maml:para>#Will return all environments from current datasource.</maml:para> <maml:para>Get-PWEnvironments</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: Get-PWError --> <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>Get-PWError</command:name> <command:verb>Get</command:verb> <command:noun>PWError</command:noun> <maml:description> <maml:para>Get ProjectWise error description given ID.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ErrorID --> <command:syntaxItem> <maml:name>Get-PWError</maml:name> <!-- Parameter: ErrorID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ErrorID</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</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: ErrorID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ErrorID</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</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:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWFolders -FolderPah 'Top Level\Sub-Folder' | Get-PWManagedWorkspaces</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWExternalUsersToConnectedProject --> <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-PWExternalUsersToConnectedProject</command:name> <command:verb>Add</command:verb> <command:noun>PWExternalUsersToConnectedProject</command:noun> <maml:description> <maml:para>Takes a comma-delimited list of email addresses and adds them as external users to the CONNECTed project associated with the rich project given by the ProjectWise folder path.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWExternalUsersToConnectedProject</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path to the rich project from which we'll find the associated CONNECTed project.</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: ExternalUsers --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ExternalUsers</maml:name> <maml:description> <maml:para>Comma-delimited list of emails for the external user.</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: Review --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Review</maml:name> <maml:description> <maml:para>Set to grant Review privileges to the users.</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: Issue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Issue</maml:name> <maml:description> <maml:para>Set to grant Issue privileges to the users.</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: Receive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Receive</maml:name> <maml:description> <maml:para>Set to grant Receive privileges to the users.</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: Administrator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Administrator</maml:name> <maml:description> <maml:para>Set to grant Administrator privileges to the users.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Will use current CONNECT client session 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Will use current CONNECT client session if not set.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path to the rich project from which we'll find the associated CONNECTed project.</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: ExternalUsers --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ExternalUsers</maml:name> <maml:description> <maml:para>Comma-delimited list of emails for the external user.</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: Review --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Review</maml:name> <maml:description> <maml:para>Set to grant Review privileges to the users.</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: Issue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Issue</maml:name> <maml:description> <maml:para>Set to grant Issue privileges to the users.</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: Receive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Receive</maml:name> <maml:description> <maml:para>Set to grant Receive privileges to the users.</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: Administrator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Administrator</maml:name> <maml:description> <maml:para>Set to grant Administrator privileges to the users.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Will use current CONNECT client session 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Will use current CONNECT client session if not set.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</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>#Example usage for adding an external user to a CONNECTED project.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Add-PWExternalUsersToConnectedProject -FolderPath "PWPS Connected Project Test 6\Projects 2\Project A" -ExternalUsers address1@external.com,address2@external.com,address3@external.com</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFileCheckSumReport --> <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>Get-PWFileCheckSumReport</command:name> <command:verb>Get</command:verb> <command:noun>PWFileCheckSumReport</command:noun> <maml:description> <maml:para>Generates a file checksum report. The idea is to identify files with duplicate content across the datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWFileCheckSumReport</maml:name> <!-- Parameter: SearchName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Search name (can be full 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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to search.</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: OutputReportName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputReportName</maml:name> <maml:description> <maml:para>Report path (.xlsx).</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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Is a personal search.</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: SearchName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Search name (can be full 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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to search.</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: OutputReportName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputReportName</maml:name> <maml:description> <maml:para>Report path (.xlsx).</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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Is a personal search.</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>Get-PWFileCheckSumReport -FolderPath 'Top Level\Sub-Folder' -OutputReportName c:\temp\CheckSumReport.xlsx</maml:para> <maml:para>Get-PWFileCheckSumReport -SearchName 'Top Level\Sub-Folder\Search 01' -OutputReportName c:\temp\CheckSumReport.xlsx -Personal</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWFileTypeAssocation --> <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-PWFileTypeAssocation</command:name> <command:verb>Add</command:verb> <command:noun>PWFileTypeAssocation</command:noun> <maml:description> <maml:para>The Add-PWFileTypeAssociation cmdlet offers a method to add File Type Associations to the document processors.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to add File Type Associations to the document processors.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWFileTypeAssocation</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Application --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Application</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtensionFrom --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ExtensionFrom</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotProcessFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotProcessFiles</maml:name> <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: ExtensionTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExtensionTo</maml:name> <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: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Application --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Application</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtensionFrom --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ExtensionFrom</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtensionTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExtensionTo</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotProcessFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotProcessFiles</maml:name> <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>Example usage for adding a file type association to the File Property document processor.</maml:para> </maml:introduction> <dev:code>Add-PWFileTypeAssocation -Type "File Property" -DoNotProcessFiles -Verbose </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWFolder --> <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>Copy-PWFolder</command:name> <command:verb>Copy</command:verb> <command:noun>PWFolder</command:noun> <maml:description> <maml:para>Copies a folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copy an existing folder into another folder. Can include subfolders and/or documents.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-PWFolder</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full folder path of parent target folder. Required. Folder must 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: FolderToCopy --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderToCopy</maml:name> <maml:description> <maml:para>Path Name of folder to be copied. Required. Folder must 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: DontCopyWorkflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DontCopyWorkflow</maml:name> <maml:description> <maml:para>If included, all sub-folders will be copied.</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: IncludeAccessControl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeAccessControl</maml:name> <maml:description> <maml:para>If included, all access control will be copied.</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: IncludeDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDocuments</maml:name> <maml:description> <maml:para>If included, all documents will be copied.</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: IncludeSubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubFolders</maml:name> <maml:description> <maml:para>If included, all sub-folders will be copied.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full folder path of parent target folder. Required. Folder must 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: FolderToCopy --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderToCopy</maml:name> <maml:description> <maml:para>Path Name of folder to be copied. Required. Folder must 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: IncludeSubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubFolders</maml:name> <maml:description> <maml:para>If included, all sub-folders will be copied.</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: DontCopyWorkflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DontCopyWorkflow</maml:name> <maml:description> <maml:para>If included, all sub-folders will be copied.</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: IncludeDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDocuments</maml:name> <maml:description> <maml:para>If included, all documents will be copied.</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: IncludeAccessControl --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeAccessControl</maml:name> <maml:description> <maml:para>If included, all access control will be copied.</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>Example usage for Copying a folder.</maml:para> <maml:para>This copies the dwgs folder into the projects folder. No documents or sub-folders are included.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Copy-PWFolder -FolderPath "Projects" -FolderToCopy 'DWGS'</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>This copies the DWGS folder into the Project01 folder. Sub-folders and documents will be copied.</maml:para> <maml:para>Copy-PWFolder -FolderPath "Project Folder\Project 01" -FolderToCopy 'Working Folder\DWGS' -IncludeSubFolders -IncludeDocuments</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Move-PWFolder --> <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>Move-PWFolder</command:name> <command:verb>Move</command:verb> <command:noun>PWFolder</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Move-PWFolder</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewParentPath_Or_ROOT_ --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewParentPath_Or_ROOT_</maml:name> <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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewParentPath_Or_ROOT_ --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewParentPath_Or_ROOT_</maml:name> <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:command> <!-- Cmdlet: New-PWFolder --> <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-PWFolder</command:name> <command:verb>New</command:verb> <command:noun>PWFolder</command:noun> <maml:description> <maml:para>Create a new folder path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Given a folder path, storage area, and optionally an environment and workflow, create the path and return the folder on the pipeline.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWFolder</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to create.</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: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area name to create it in.</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>Environment name to apply to new folder.</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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Workflow name to apply to new folder.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to create.</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: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area name to create it in.</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>Environment name to apply to new folder.</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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Workflow name to apply to new folder.</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>#Example usage getting folders and populating path.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Create the path in storage area Storage01</maml:para> <maml:para>New-PWFolder -FolderPath 'New Folder\From PowerShell\Folder 1' -StorageArea Storage01</maml:para> <maml:para>#Create the path in storage area 'Storage01' with environment 'Default' and workflow 'Normal'</maml:para> <maml:para>New-PWFolder -FolderPath 'Level 1\Level 2\Level 3\Level 4' -StorageArea Storage01 -Environment Default -Workflow Normal</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWFolder --> <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>Remove-PWFolder</command:name> <command:verb>Remove</command:verb> <command:noun>PWFolder</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Remove-PWFolder</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoveDocuments</maml:name> <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: RemoveFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RemoveFolders</maml:name> <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: ProceedWithDelete --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ProceedWithDelete</maml:name> <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: DeletePasses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeletePasses</maml:name> <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: RemoveFoldersBrutally --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RemoveFoldersBrutally</maml:name> <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: FullPathToFileRemovalScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>FullPathToFileRemovalScript</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>UseAdminPaths</maml:name> <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: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoveDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoveDocuments</maml:name> <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: RemoveFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RemoveFolders</maml:name> <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: ProceedWithDelete --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ProceedWithDelete</maml:name> <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: DeletePasses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeletePasses</maml:name> <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: RemoveFoldersBrutally --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RemoveFoldersBrutally</maml:name> <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: FullPathToFileRemovalScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>FullPathToFileRemovalScript</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>UseAdminPaths</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Clear-PWFolderEnvironment --> <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>Clear-PWFolderEnvironment</command:name> <command:verb>Clear</command:verb> <command:noun>PWFolderEnvironment</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Clear-PWFolderEnvironment</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-PWFolderEnvironment --> <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>Set-PWFolderEnvironment</command:name> <command:verb>Set</command:verb> <command:noun>PWFolderEnvironment</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Set-PWFolderEnvironment</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewEnvironment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NewEnvironment</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewEnvironment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NewEnvironment</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-PWFolderGeoSpatialLocation --> <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>Get-PWFolderGeoSpatialLocation</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderGeoSpatialLocation</command:noun> <maml:description> <maml:para>Prints out the location of a folder in WKT. Takes a folder path or array of folder objects and retrieves location.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Get-PWFolderGeoSpatialLocation</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Array of folder objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path of folder to read location 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: GetKML --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>GetKML</maml:name> <maml:description> <maml:para>Set for KML output.</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: GetGeoJSON --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>GetGeoJSON</maml:name> <maml:description> <maml:para>Set for GeoJSON output.</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: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Array of folder objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path of folder to read location 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: GetKML --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>GetKML</maml:name> <maml:description> <maml:para>Set for KML output.</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: GetGeoJSON --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>GetGeoJSON</maml:name> <maml:description> <maml:para>Set for GeoJSON output.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of folder objects from the pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for reading a folder's location in GeoJSON.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Get-PWFolder -FolderPath "My Locations\Folder 2" -JustOne| Get-PWFolderGeoSpatialLocation -GetGeoJSON</maml:para> <maml:para>#Example usage for reading a folder's location in KML.</maml:para> <maml:para>Get-PWFolder -FolderPath "My Locations\Folder 2" -JustOne| Get-PWFolderGeoSpatialLocation -GetKML</maml:para> <maml:para>#Example usage for reading a folder's location in WKT.</maml:para> <maml:para>Get-PWFolder -FolderPath "My Locations\Folder 2" -JustOne| Get-PWFolderGeoSpatialLocation</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWFolderGeoSpatialLocation --> <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>Set-PWFolderGeoSpatialLocation</command:name> <command:verb>Set</command:verb> <command:noun>PWFolderGeoSpatialLocation</command:noun> <maml:description> <maml:para>Very simple location assignment for a folder. Takes a folder path or array of folder objects and assigns a block or a point on the input Lat/Long or Address and box size.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Set-PWFolderGeoSpatialLocation</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Array of folder objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path of folder to assign location to.</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: Latitude --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Latitude</maml:name> <maml:description> <maml:para>Latitude in decimal degrees (Required).</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Longitude --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Longitude</maml:name> <maml:description> <maml:para>Longitude in decimal degrees (Required).</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SizeOfBoxInDegrees --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SizeOfBoxInDegrees</maml:name> <maml:description> <maml:para>Size of box in decimal degrees. Defaults to a 10th of a second.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2.77777777777778E-05</dev:defaultValue> </command:parameter> <!-- Parameter: Point --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Point</maml:name> <maml:description> <maml:para>Set to mark with a point rather than a polygon.</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: Address --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Address</maml:name> <maml:description> <maml:para>Set to mark with a point rather than a polygon.</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: WKT --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>WKT</maml:name> <maml:description> <maml:para>Well Known Text string describing polygon.</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: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Array of folder objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path of folder to assign location to.</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: Latitude --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Latitude</maml:name> <maml:description> <maml:para>Latitude in decimal degrees (Required).</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Longitude --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Longitude</maml:name> <maml:description> <maml:para>Longitude in decimal degrees (Required).</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: SizeOfBoxInDegrees --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SizeOfBoxInDegrees</maml:name> <maml:description> <maml:para>Size of box in decimal degrees. Defaults to a 10th of a second.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2.77777777777778E-05</dev:defaultValue> </command:parameter> <!-- Parameter: Point --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Point</maml:name> <maml:description> <maml:para>Set to mark with a point rather than a polygon.</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: Address --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Address</maml:name> <maml:description> <maml:para>Set to mark with a point rather than a polygon.</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: WKT --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>WKT</maml:name> <maml:description> <maml:para>Well Known Text string describing polygon.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of folder objects from the pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for creating a new folder and assigning a location to it.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>New-PWFolder -FolderPath "My Locations\Folder 2" -StorageArea "Storage 1" | Set-PWFolderGeoSpatialLocation -Latitude 45 -Longitude 90</maml:para> <maml:para>New-PWFolder -FolderPath "My Locations\Folder 3" -StorageArea "Storage 1" | Set-PWFolderGeoSpatialLocation -Address "704 15th Street, Durham, NC" -Point</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWFolderNameProps --> <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-PWFolderNameProps</command:name> <command:verb>Update</command:verb> <command:noun>PWFolderNameProps</command:noun> <maml:description> <maml:para>Used to rename or change the description of a folder.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWFolderNameProps</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewDescription</maml:name> <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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewDescription</maml:name> <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>#Example usage for Update-PWFolderNameProps.</maml:para> <maml:para>#Will rename the folder passed in the FolderPath parameter.</maml:para> <maml:para>Update-PWFolderNameProps -FolderPath 'Projects' -NewName 'NewProjects'</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for Update-PWFolderNameProps.</maml:para> <maml:para>#Will update the description of the folder passed in the FolderPath parameter.</maml:para> <maml:para>Update-PWFolderNameProps -FolderPath 'Projects' -NewDescription 'New Projects'</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for Update-PWFolderNameProps.</maml:para> <maml:para>#Will rename and update the description of the folder passed in the FolderPath parameter.</maml:para> <maml:para>Update-PWFolderNameProps -FolderPath 'Projects' -NewName 'NewProjects' -NewDescription 'New Projects'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderPathAndProperties --> <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>Get-PWFolderPathAndProperties</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderPathAndProperties</command:noun> <maml:description> <maml:para>Given a folder object, populate the path and the project properties if available.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Designed to take a folder from the pipeline and fill in the full path and project properties if the folder is also a rich project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderPathAndProperties</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Folder object from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Folder object from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder object from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage getting folders and populating path.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Get the path and all properties for folder number 20315</maml:para> <maml:para>Get-PWFolders 20315 | Get-PWFolderPathAndProperties</maml:para> <maml:para>#Get the folder number and all properties for the given folder path</maml:para> <maml:para>Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3\Level 4' -JustOne | Get-PWFolderPathAndProperties</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderRenditionProfile --> <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>Get-PWFolderRenditionProfile</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderRenditionProfile</command:noun> <maml:description> <maml:para>Gets the default rendition profile for the specified folder.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWFolderRenditionProfile</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to apply default rendition profile.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to apply default rendition profile.</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>#Example usage for getting a default rendition profile.</maml:para> <maml:para>Get-PWFolderRenditionProfile -FolderPath 'Projects\My Project'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWFolderRenditionProfile --> <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>Set-PWFolderRenditionProfile</command:name> <command:verb>Set</command:verb> <command:noun>PWFolderRenditionProfile</command:noun> <maml:description> <maml:para>Sets the default rendition profile for the specified folder.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWFolderRenditionProfile</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to apply default rendition profile.</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: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Rendition Profile name. Must 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to apply default rendition profile.</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: ProfileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Rendition Profile name. Must 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for setting a default rendition profile.</maml:para> <maml:para>Set-PWFolderRenditionProfile -FolderPath 'Projects\My Project' -ProfileName 'PDF to Source Folder'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolders --> <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>Get-PWFolders</command:name> <command:verb>Get</command:verb> <command:noun>PWFolders</command:noun> <maml:description> <maml:para>Gets a list of the folders in a given path or under a given folder ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a folder ID or folder path and enumerates all the folders beneath it in the tree.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWFolders</maml:name> <!-- Parameter: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder ID for enumerating sub-folders.</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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path for enumerating sub-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: FolderName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderName</maml:name> <maml:description> <maml:para>Folder name for enumerating folders. Instructs to search for matching folder names.</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: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>JustOne</maml:name> <maml:description> <maml:para>Just return specified folder.</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: BypassSearchAssembly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>BypassSearchAssembly</maml:name> <maml:description> <maml:para>Search assembly has been shown to cause issues on some platforms. Will cause slower search.</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Provide if you desire a report.</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: Slow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Slow</maml:name> <maml:description> <maml:para>Specify to populate folder path and project properties. Can take a long time for a dense folder tree.</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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder ID for enumerating sub-folders.</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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path for enumerating sub-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: FolderName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderName</maml:name> <maml:description> <maml:para>Folder name for enumerating folders. Instructs to search for matching folder names.</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: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>JustOne</maml:name> <maml:description> <maml:para>Just return specified folder.</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: BypassSearchAssembly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>BypassSearchAssembly</maml:name> <maml:description> <maml:para>Search assembly has been shown to cause issues on some platforms. Will cause slower search.</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Provide if you desire a report.</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: Slow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Slow</maml:name> <maml:description> <maml:para>Specify to populate folder path and project properties. Can take a long time for a dense folder tree.</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>#Example usage for getting all the folders in a given folder path.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Get all the folders in this tree</maml:para> <maml:para>$folders = Get-PWFolders -FolderPath "PWPS Connected Project Test 6\Projects 2"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderSecurity --> <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>Get-PWFolderSecurity</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderSecurity</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderSecurity</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage getting project/folder access control.</maml:para> <maml:para>The following will return a datatable containing the access control of the specified project/folder.</maml:para> <maml:para>Get-PWFolders -FolderPath 'projects' -JustOne -Slow | Get-PWFolderSecurity</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWFolderSecurity --> <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>Remove-PWFolderSecurity</command:name> <command:verb>Remove</command:verb> <command:noun>PWFolderSecurity</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Remove-PWFolderSecurity</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: MemberType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MemberType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>MemberName</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: MemberType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MemberType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>MemberName</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage removing project/folder access control.</maml:para> <maml:para>The following will remove the specified user from the project/folder.</maml:para> <maml:para>Remove-PWFolderSecurity -InputFolder 'Projects\Upload' -MemberType 'u' -MemberName 'username'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Reset-PWFolderSecurity --> <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>Reset-PWFolderSecurity</command:name> <command:verb>Reset</command:verb> <command:noun>PWFolderSecurity</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Reset-PWFolderSecurity</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: AllSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllSecurity</maml:name> <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: DocumentSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentSecurity</maml:name> <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: FolderSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderSecurity</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: AllSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllSecurity</maml:name> <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: FolderSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderSecurity</maml:name> <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: DocumentSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentSecurity</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage resetting project/folder access control.</maml:para> <maml:para>The following will reset only the folder security access control items for the specified project/folder.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Reset-PWFolderSecurity -FolderSecurity</maml:para> <maml:para>The following will reset only the document security access control items for the specified project/folder.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Reset-PWFolderSecurity -DocumentSecurity</maml:para> <maml:para>The following will reset all access control items for the specified project/folder.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Reset-PWFolderSecurity -AllSecurity</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWFolderSecurity --> <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-PWFolderSecurity</command:name> <command:verb>Update</command:verb> <command:noun>PWFolderSecurity</command:noun> <maml:description> <maml:para>UpdatePWFolderSecurity is used to add user(s), group(s), or userlist(s) access control to specified folders</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Membertype specifies whether access should be applied for a user, group, or userlist</maml:para> <maml:para>Valid entries:</maml:para> <maml:para>For users: "u", "user"</maml:para> <maml:para>For groups: "g", "group"</maml:para> <maml:para>For userlists: "ul", "userlist"</maml:para> <maml:para>The MemberAccess specifies the access control to be applied.</maml:para> <maml:para>Valid entries:</maml:para> <maml:para>fc - full control,</maml:para> <maml:para>cp - change permissions,</maml:para> <maml:para>c - create,</maml:para> <maml:para>d - delete,</maml:para> <maml:para>r - read,</maml:para> <maml:para>w - write,</maml:para> <maml:para>cw - change workflow,</maml:para> <maml:para>fr - file read,</maml:para> <maml:para>fw - file write,</maml:para> <maml:para>f - free,</maml:para> <maml:para>na - no access</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Update-PWFolderSecurity</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>The InputFolders parameter contains the folder(s) to apply the access control to.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: MemberType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MemberType</maml:name> <maml:description> <maml:para>The Membertype specifies whether access should be applied</maml:para> <maml:para>for a user, group, or userlist</maml:para> <maml:para>Valid entries are</maml:para> <maml:para>For users: "u", "user"</maml:para> <maml:para>For groups: "g", "group"</maml:para> <maml:para>For userlists: "ul", "userlist"</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: MemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>MemberName</maml:name> <maml:description> <maml:para>Name of user, group or userlist</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: MemberAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>MemberAccess</maml:name> <maml:description> <maml:para>The MemberAccess specifies the access control to be applied.</maml:para> <maml:para>The available entries are:</maml:para> <maml:para>fc - full control,</maml:para> <maml:para>cp - change permissions,</maml:para> <maml:para>c - create,</maml:para> <maml:para>d - delete,</maml:para> <maml:para>r - read,</maml:para> <maml:para>w - write,</maml:para> <maml:para>cw - change workflow,</maml:para> <maml:para>fr - file read,</maml:para> <maml:para>fw - file write,</maml:para> <maml:para>f - free,</maml:para> <maml:para>na - no access</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: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role name to be applied. Valid roles are:</maml:para> <maml:para>"Project Administrator"</maml:para> <maml:para>"Project Leader"</maml:para> <maml:para>"Team Member"</maml:para> <maml:para>"Project Observer"</maml:para> <maml:para>"No Access"</maml:para> <maml:para>"(Roles resolve to a specific set of rights on a project)"</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: DocumentSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentSecurity</maml:name> <maml:description> <maml:para>Apply Document Security.</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: FolderSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderSecurity</maml:name> <maml:description> <maml:para>Apply Folder Security.</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: IncludeInheritance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeInheritance</maml:name> <maml:description> <maml:para>When included, if access control is being inherited, it will be added directly to the folder or document security.</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: StateName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StateName</maml:name> <maml:description> <maml:para>Name of workflow state to apply access control to.</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: WorkFlowName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkFlowName</maml:name> <maml:description> <maml:para>Name of workflow to apply access control to.</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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>The InputFolders parameter contains the folder(s) to apply the access control to.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: MemberType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MemberType</maml:name> <maml:description> <maml:para>The Membertype specifies whether access should be applied</maml:para> <maml:para>for a user, group, or userlist</maml:para> <maml:para>Valid entries are</maml:para> <maml:para>For users: "u", "user"</maml:para> <maml:para>For groups: "g", "group"</maml:para> <maml:para>For userlists: "ul", "userlist"</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: MemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>MemberName</maml:name> <maml:description> <maml:para>Name of user, group or userlist</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: MemberAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>MemberAccess</maml:name> <maml:description> <maml:para>The MemberAccess specifies the access control to be applied.</maml:para> <maml:para>The available entries are:</maml:para> <maml:para>fc - full control,</maml:para> <maml:para>cp - change permissions,</maml:para> <maml:para>c - create,</maml:para> <maml:para>d - delete,</maml:para> <maml:para>r - read,</maml:para> <maml:para>w - write,</maml:para> <maml:para>cw - change workflow,</maml:para> <maml:para>fr - file read,</maml:para> <maml:para>fw - file write,</maml:para> <maml:para>f - free,</maml:para> <maml:para>na - no access</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: Role --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Role</maml:name> <maml:description> <maml:para>The role name to be applied. Valid roles are:</maml:para> <maml:para>"Project Administrator"</maml:para> <maml:para>"Project Leader"</maml:para> <maml:para>"Team Member"</maml:para> <maml:para>"Project Observer"</maml:para> <maml:para>"No Access"</maml:para> <maml:para>"(Roles resolve to a specific set of rights on a project)"</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: FolderSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderSecurity</maml:name> <maml:description> <maml:para>Apply Folder Security.</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: DocumentSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentSecurity</maml:name> <maml:description> <maml:para>Apply Document Security.</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: WorkFlowName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkFlowName</maml:name> <maml:description> <maml:para>Name of workflow to apply access control to.</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: StateName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StateName</maml:name> <maml:description> <maml:para>Name of workflow state to apply access control to.</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: IncludeInheritance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeInheritance</maml:name> <maml:description> <maml:para>When included, if access control is being inherited, it will be added directly to the folder or document security.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The InputFolders parameter contains the folder(s) to apply the access control to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage updating project/folder access control.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>The following example will update the security for the folders being passed via the pipeline, project/folder security only.</maml:para> <maml:para>The user will be added with create, read, write, and delete permissions.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -Slow | Update‐PWFolderSecurity ‐MemberType ʺuʺ</maml:para> <maml:para>‐MemberName “username” ‐MemberAccess “c”, “r”, “w”, “d” ‐FolderSecurity</maml:para> <maml:para>The following example will update the security for the one folder, both project/folder and</maml:para> <maml:para>document security. The group, New Group, will be added with read, write for project/folder</maml:para> <maml:para>and read, write, file read, and file write permissions.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Update‐PWFolderSecurity ‐MemberType ʺgʺ ‐MemberName “New Group”</maml:para> <maml:para>‐MemberAccess “r”, “w”, “fr”, “fw” ‐FolderSecurity ‐DocumentSecurity</maml:para> <maml:para>The following example will update the security for the folders being passed via the pipeline, document security only.</maml:para> <maml:para>The userlist, All_Users will be added with read, file read permissions.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -Slow | Update‐PWFolderSecurity ‐MemberType ʺulʺ</maml:para> <maml:para>‐MemberName “All_Users” ‐MemberAccess “r”, “fr” ‐DocumentSecurity</maml:para> <maml:para>The following example will update the security for the folders passed via the pipelin, document security only.</maml:para> <maml:para>The userlist, All_Users will be added with read, file read permissions.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -Slow | Update‐PWFolderSecurity ‐MemberType ʺulʺ</maml:para> <maml:para>‐MemberName “All_Users” ‐Role “Project Observer” -Verbose</maml:para> <maml:para>The following example will update the security for the specified folder to include the inherited access control.</maml:para> <maml:para>Both folder and document security will be updated. The userlist, All_Users will be added with read, file read permissions.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Update‐PWFolderSecurity ‐MemberType ʺulʺ</maml:para> <maml:para>‐MemberName “All_Users” ‐Role “Project Observer” -IncludeInheritance</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWFolderSecurityByUserListSwap --> <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-PWFolderSecurityByUserListSwap</command:name> <command:verb>Update</command:verb> <command:noun>PWFolderSecurityByUserListSwap</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Update-PWFolderSecurityByUserListSwap</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewUserListName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewUserListName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OldUserListName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OldUserListName</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewUserListName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewUserListName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OldUserListName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OldUserListName</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Update-PWFolderSecurityByUserListSwapWithWorkflow --> <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-PWFolderSecurityByUserListSwapWithWorkflow</command:name> <command:verb>Update</command:verb> <command:noun>PWFolderSecurityByUserListSwapWithWorkflow</command:noun> <maml:description> <maml:para>UpdatePWFolderSecurity is used to add user(s), group(s), or userlist(s) access control to specified folders</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Membertype specifies whether access should be applied for a user, group, or userlist</maml:para> <maml:para>Valid entries:</maml:para> <maml:para>For users: "u", "user"</maml:para> <maml:para>For groups: "g", "group"</maml:para> <maml:para>For userlists: "ul", "userlist"</maml:para> <maml:para>The MemberAccess specifies the access control to be applied.</maml:para> <maml:para>Valid entries:</maml:para> <maml:para>fc - full control,</maml:para> <maml:para>cp - change permissions,</maml:para> <maml:para>c - create,</maml:para> <maml:para>d - delete,</maml:para> <maml:para>r - read,</maml:para> <maml:para>w - write,</maml:para> <maml:para>cw - change workflow,</maml:para> <maml:para>fr - file read,</maml:para> <maml:para>fw - file write,</maml:para> <maml:para>f - free,</maml:para> <maml:para>na - no access</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Update-PWFolderSecurityByUserListSwapWithWorkflow</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewUserListName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewUserListName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OldUserListName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OldUserListName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JustOne</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewUserListName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewUserListName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OldUserListName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OldUserListName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JustOne</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage updating project/folder access control.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>The following example will update the security for the folders being passed via the pipeline, project/folder security only.</maml:para> <maml:para>The user will be added with create, read, write, and delete permissions.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -Slow | Update‐PWFolderSecurity ‐MemberType ʺuʺ</maml:para> <maml:para>‐MemberName “username” ‐MemberAccess “c”, “r”, “w”, “d” ‐FolderSecurity</maml:para> <maml:para>The following example will update the security for the one folder, both project/folder and</maml:para> <maml:para>document security. The group, New Group, will be added with read, write for project/folder</maml:para> <maml:para>and read, write, file read, and file write permissions.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Update‐PWFolderSecurity ‐MemberType ʺgʺ ‐MemberName “New Group”</maml:para> <maml:para>‐MemberAccess “r”, “w”, “fr”, “fw” ‐FolderSecurity ‐DocumentSecurity</maml:para> <maml:para>The following example will update the security for the folders being passed via the pipeline, document security only.</maml:para> <maml:para>The userlist, All_Users will be added with read, file read permissions.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -Slow | Update‐PWFolderSecurity ‐MemberType ʺulʺ</maml:para> <maml:para>‐MemberName “All_Users” ‐MemberAccess “r”, “fr” ‐DocumentSecurity</maml:para> <maml:para>The following example will update the security for the folders passed via the pipelin, document security only.</maml:para> <maml:para>The userlist, All_Users will be added with read, file read permissions.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -Slow | Update‐PWFolderSecurity ‐MemberType ʺulʺ</maml:para> <maml:para>‐MemberName “All_Users” ‐Role “Project Observer” -Verbose</maml:para> <maml:para>The following example will update the security for the specified folder to include the inherited access control.</maml:para> <maml:para>Both folder and document security will be updated. The userlist, All_Users will be added with read, file read permissions.</maml:para> <maml:para>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Update‐PWFolderSecurity ‐MemberType ʺulʺ</maml:para> <maml:para>‐MemberName “All_Users” ‐Role “Project Observer” -IncludeInheritance</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWFoldersFromSpreadsheet --> <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-PWFoldersFromSpreadsheet</command:name> <command:verb>New</command:verb> <command:noun>PWFoldersFromSpreadsheet</command:noun> <maml:description> <maml:para>New-PWFoldersFromSpreadsheet is used to create folders from an Excel spreadsheet. Required fields for the Excel spreadsheet: FullPath, NewParentPath, Description, Storage, Environment, Workflow Example: FullPath | NewParentPath | Description | Storage | Environment | Workflow ----------|----------------------------------|-------------------------------|-----------|--------------|-------------------- | Projects\MyNewProject | My new project | Storage | Simple | Default Workflow | Projects\MyNewProject\Sub1 | My new project sub 1 | Storage | Simple | | Projects\MyNewProject\Sub2 | My new project sub 2 | Storage | Complex | | Projects\MyNewProject\Sub2\Sub2a | My new project sub 2 - sub 2a | | |</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create new folders based on information passed via an Excel spreadsheet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWFoldersFromSpreadsheet</maml:name> <!-- Parameter: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultNewParentPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DefaultNewParentPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultStorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DefaultStorageArea</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultEnvironment</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultWorkflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DefaultWorkflow</maml:name> <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: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultNewParentPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DefaultNewParentPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultStorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DefaultStorageArea</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultEnvironment</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultWorkflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DefaultWorkflow</maml:name> <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>#Example usage for creating folders from an Excel spreadsheet.</maml:para> <maml:para>New-PWFoldersFromSpreadsheet -InputFileName 'd:\temp\import\newprojects.xlsx' -DefaultStorageArea 'Storage'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderTreeDocumentSize --> <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>Get-PWFolderTreeDocumentSize</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderTreeDocumentSize</command:noun> <maml:description> <maml:para>Returns information pertaining to each folder passed. Includes IsRichProject, Top Level ProjectID, Top Level FolderPath, Number of contained documents, sum of document sizes. .</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderTreeDocumentSize</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderTreeDocumentSize"</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderTreeDocumentSize -OutputFileName "D:\TEMP\FolderDocSizeReport.xlsx"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderTreeDocumentStateCount --> <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>Get-PWFolderTreeDocumentStateCount</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderTreeDocumentStateCount</command:noun> <maml:description> <maml:para>Report on a scalar documents and states for a folder tree.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderTreeDocumentStateCount</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of folders from pipeline from Get-PWFolders or Get-PWRichProjects.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Full path to XLSX output file. Will create default name 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of folders from pipeline from Get-PWFolders or Get-PWRichProjects.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Full path to XLSX output file. Will create default name 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of folders from pipeline from Get-PWFolders or Get-PWRichProjects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderTreeDocumentStateCount -IncludeVersions -OutputFileName "c:\temp\Output.xlsx"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderTreeDocumentStateCountDataTable --> <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>Get-PWFolderTreeDocumentStateCountDataTable</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderTreeDocumentStateCountDataTable</command:noun> <maml:description> <maml:para>Report on a scalar documents and states for a folder tree and output datatable for .</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderTreeDocumentStateCountDataTable</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </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>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderTreeDocumentStateCount -IncludeVersions -OutputFileName "c:\temp\Output.xlsx"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderTreeScalar --> <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>Get-PWFolderTreeScalar</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderTreeScalar</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderTreeScalar</maml:name> <!-- Parameter: DocumentAttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DocumentAttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentAttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DocumentAttributeName</maml:name> <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="1"> <maml:name>OutputFileName</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-PWFolderTreeScalarDataTable --> <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>Get-PWFolderTreeScalarDataTable</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderTreeScalarDataTable</command:noun> <maml:description> <maml:para>Report on a scalar attribute value for a folder tree.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderTreeScalarDataTable</maml:name> <!-- Parameter: DocumentAttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DocumentAttributeName</maml:name> <maml:description> <maml:para>Document environment attribute to report on (must be of numeric type).</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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of folders from Get-PWFolders or Get-PWRichProjects.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of folders from Get-PWFolders or Get-PWRichProjects.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentAttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DocumentAttributeName</maml:name> <maml:description> <maml:para>Document environment attribute to report on (must be of numeric type).</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of folders from Get-PWFolders or Get-PWRichProjects.</maml:para> </maml:description> </command:inputType> </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>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderTreeScalarDataTable -IncludeVersions -DocumentAttributeName "PercentComplete" -ShowColumns</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWFolderView --> <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>Set-PWFolderView</command:name> <command:verb>Set</command:verb> <command:noun>PWFolderView</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Set-PWFolderView</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: View --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>View</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: View --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>View</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Clear-PWFolderWorkflow --> <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>Clear-PWFolderWorkflow</command:name> <command:verb>Clear</command:verb> <command:noun>PWFolderWorkflow</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Clear-PWFolderWorkflow</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-PWFolderWorkflow --> <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>Set-PWFolderWorkflow</command:name> <command:verb>Set</command:verb> <command:noun>PWFolderWorkflow</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Set-PWFolderWorkflow</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewWorkflow --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NewWorkflow</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NewState</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewWorkflow --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NewWorkflow</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NewState</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-PWGroupNames --> <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>Get-PWGroupNames</command:name> <command:verb>Get</command:verb> <command:noun>PWGroupNames</command:noun> <maml:description> <maml:para>Get list of group names.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Remove users from a group</maml:para> <maml:para>$groupNames = Get-PWGroupNames</maml:para> <maml:para>$users = Get-PWUsersByMatch -UserName 'dave*','bryan*'</maml:para> <maml:para>foreach ($group in $groupNames)</maml:para> <maml:para>{</maml:para> <maml:para>Remove-PWUserFromGroup $users -GroupName $group</maml:para> <maml:para>}</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWGroupOwners --> <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>Set-PWGroupOwners</command:name> <command:verb>Set</command:verb> <command:noun>PWGroupOwners</command:noun> <maml:description> <maml:para>Set-PWGroupOwners is used to add a user/group/userlist to the Owners of a Group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-PWGroupOwners is used to add a user/group/userlist to the Owners of a Group. Requires a GroupName, Owner, and OwnerType (Possible entries: u, g, ul)</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWGroupOwners</maml:name> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>GroupName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Owner --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Owner</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OwnerType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OwnerType</maml:name> <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: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>GroupName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OwnerType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OwnerType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Owner --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Owner</maml:name> <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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for adding a user to the Owners of the specified Group.</maml:para> <maml:para>Set-PWGroupOwners -GroupName 'Groupies' -Owner 'MyUserName' -OwnerType 'u'</maml:para> <maml:para>#Example usage for adding a group to the Owners of the specified Group.</maml:para> <maml:para>Set-PWGroupOwners -GroupName 'Groupies' -Owner 'MyGroup' -OwnerType 'g'</maml:para> <maml:para>#Example usage for adding a userlist to the Owners of the specified Group.</maml:para> <maml:para>Set-PWPWUserListOwners -GroupName 'Groupies' -Owner 'ULA' -OwnerType 'ul'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWGroupsByUser --> <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>Get-PWGroupsByUser</command:name> <command:verb>Get</command:verb> <command:noun>PWGroupsByUser</command:noun> <maml:description> <maml:para>Returns all groups the user is a member of.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Get-PWGroupsByUser</maml:name> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name to return group membership information. (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: UserName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name to return group membership information. (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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User name to return group membership information. (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWGroupsByUser -UserName 'admin'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWInputOutputPerformanceReport --> <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-PWInputOutputPerformanceReport</command:name> <command:verb>New</command:verb> <command:noun>PWInputOutputPerformanceReport</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. Reports on performance of individual storage areas, and saves list of currently connected users.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWInputOutputPerformanceReport</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>New-PWInputOutputPerformanceReport -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 (will append if file exists), clean up the audit trial entries for this user and collect some statistics which can take time.</maml:para> <maml:para>New-PWInputOutputPerformanceReport -OutputFileName c:\report\stats.xlsx -FileSizeK 100 -CleanUpAuditTrail -CollectExpensiveStatistics</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWInterfaces --> <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>Get-PWInterfaces</command:name> <command:verb>Get</command:verb> <command:noun>PWInterfaces</command:noun> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for getting all interfaces in the datasouce.</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Get-PWInterfaces</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Publish-PWIPlotCreatePDF --> <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>Publish-PWIPlotCreatePDF</command:name> <command:verb>Publish</command:verb> <command:noun>PWIPlotCreatePDF</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Publish-PWIPlotCreatePDF</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PDFFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PDFFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PDFFileFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PDFFileFolderPath</maml:name> <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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PDFFileFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PDFFileFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PDFFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PDFFileName</maml:name> <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>Example usage for creating a PDF file from an IPS file.</maml:para> </maml:introduction> <dev:code>Publish-PWIPlotCreatePDF -UserName 'admin' -UserPassword 'admin' -IPSFolderPath 'IPlot\IPS Files' -IPSFileName 'MyDesignFiles.ips -PDFFileFolderPath 'IPlot\PDF Files' -PDFFileName 'MyDesignFiles.pdf'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWIPlotDocumentsToIPSFile --> <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-PWIPlotDocumentsToIPSFile</command:name> <command:verb>Add</command:verb> <command:noun>PWIPlotDocumentsToIPSFile</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWIPlotDocumentsToIPSFile</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>SetFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PlotFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PlotFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PlotFileFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PlotFileFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetFileFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetFileFolderPath</maml:name> <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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetFileFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetFileFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>SetFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PlotFileFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PlotFileFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PlotFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PlotFileName</maml:name> <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>Example usage for adding a document to an IPS file.</maml:para> </maml:introduction> <dev:code>Add-PWIPlotDocumentsToIPSFile -UserName 'admin' -UserPassword 'admin' -IPSFolderPath 'IPlot\IPS Files' -IPSFileName 'MyDesignFiles.ips' -SetFileFolderPath 'IPlot\Set Files' -SetFileName 'IPlot.set' -PlotFileFolderPath 'Project\Design Files' -PlotFileName 'ArchitecturalSheets.dgn'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWIPlotIPSFile --> <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-PWIPlotIPSFile</command:name> <command:verb>New</command:verb> <command:noun>PWIPlotIPSFile</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWIPlotIPSFile</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <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>Example usage for creating new IPS file.</maml:para> </maml:introduction> <dev:code>New-PWIPlotIPSFile -UserName 'admin' -UserPassword 'admin' -IPSFolderPath 'IPlot\IPS Files' -IPSFileName 'MyDesignFiles.ips'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWIPlotPlotsInIPSFile --> <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>Get-PWIPlotPlotsInIPSFile</command:name> <command:verb>Get</command:verb> <command:noun>PWIPlotPlotsInIPSFile</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWIPlotPlotsInIPSFile</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <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>Example usage to get the plots within an IPS file.</maml:para> </maml:introduction> <dev:code>Get-PWIPlotPlotsInIPSFile -UserName 'admin' -UserPassword 'admin' -IPSFolderPath 'IPlot\IPS Files' -IPSFileName 'Drawings.ips'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWIPlotSetFile --> <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-PWIPlotSetFile</command:name> <command:verb>Add</command:verb> <command:noun>PWIPlotSetFile</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWIPlotSetFile</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>SetFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllPlots --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllPlots</maml:name> <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: PlotFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PlotFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetFileFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetFileFolderPath</maml:name> <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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetFileFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetFileFolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SetFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>SetFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PlotFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PlotFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllPlots --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllPlots</maml:name> <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>Example usage to add a set file to a specific plot within an IPS file when the set file is in the same folder as the IPS file.</maml:para> </maml:introduction> <dev:code>Add-PWIPlotSetFile -UserName 'admin' -UserPassword 'admin' -IPSFolderPath 'IPlot\IPS Files' -IPSFileName 'Drawings.ips' -SetFileName 'iplot.set' -PlotFileName 'architecturalsheets'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Example usage to add a set file to ALL plots within an IPS file when the set file is in the same folder as the IPS file.</maml:para> </maml:introduction> <dev:code>Add-PWIPlotSetFile -UserName 'admin' -UserPassword 'admin' -IPSFolderPath 'IPlot\IPS Files' -IPSFileName 'Drawings.ips' -SetFileName 'iplot.set' -AllPlots</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Example usage to add a set file to a specific plot within an IPS file when the set file is NOT located in the same folder as the IPS file.</maml:para> </maml:introduction> <dev:code>Add-PWIPlotSetFile -UserName 'admin' -UserPassword 'admin' -IPSFolderPath 'IPlot\IPS Files' -IPSFileName 'Drawings.ips' -SetFileFolderPath 'IPlot\Set Files' -SetFileName 'iplot.set' -PlotFileName 'architecturalsheets'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <maml:introduction> <maml:para>Example usage to add a set file to ALL plots within an IPS file when the set file is NOT located in the same folder as the IPS file.</maml:para> </maml:introduction> <dev:code>Add-PWIPlotSetFile -UserName 'admin' -UserPassword 'admin' -IPSFolderPath 'IPlot\IPS Files' -IPSFileName 'Drawings.ips' -SetFileFolderPath 'IPlot\Set Files' -SetFileName 'iplot.set' -AllPlots</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWLogin --> <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-PWLogin</command:name> <command:verb>New</command:verb> <command:noun>PWLogin</command:noun> <maml:description> <maml:para>Login cmdlet native to this module.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: DatasourceName --> <command:syntaxItem> <maml:name>New-PWLogin</maml:name> <!-- Parameter: DatasourceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DatasourceName</maml:name> <maml:description> <maml:para>Datasource to log into (Required). ServerName:DatasourceName format is suggested though will probably work with just display name.</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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name. Leave blank for single sign-on</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: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password. Leave blank for single sign-on</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseGui --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UseGui</maml:name> <maml:description> <maml:para>Flag to force Login GUI</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: DoNotCreateWorkingDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DoNotCreateWorkingDirectory</maml:name> <maml:description> <maml:para>Do not create working directory</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: DatasourceName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DatasourceName</maml:name> <maml:description> <maml:para>Datasource to log into (Required). ServerName:DatasourceName format is suggested though will probably work with just display name.</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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name. Leave blank for single sign-on</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: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password. Leave blank for single sign-on</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseGui --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UseGui</maml:name> <maml:description> <maml:para>Flag to force Login GUI</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: DoNotCreateWorkingDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DoNotCreateWorkingDirectory</maml:name> <maml:description> <maml:para>Do not create working directory</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>Regular login (will fail if user is not admin)</maml:para> <maml:para>New-PWLogin -DatasourceName 'Server:DSN' -UserName 'UserName' -Password 'password'</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Single sign-on login (will fail if user is not admin)</maml:para> <maml:para>New-PWLogin -Datasource 'Server:DSN'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Undo-PWLogin --> <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>Undo-PWLogin</command:name> <command:verb>Undo</command:verb> <command:noun>PWLogin</command:noun> <maml:description> <maml:para>Logout cmdlet native to this module.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Regular logout</maml:para> <maml:para>Undo-PWLogin</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWManagedWorkspaces --> <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>Get-PWManagedWorkspaces</command:name> <command:verb>Get</command:verb> <command:noun>PWManagedWorkspaces</command:noun> <maml:description> <maml:para>Get the managed workspace configuration settings blocks for projects from the pipeline, from a folder path, or for the whole datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Get-PWManagedWorkspaces</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolders --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWFolders -FolderPah 'Top Level\Sub-Folder' | Get-PWManagedWorkspaces</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWManagedWorkspaceVariables --> <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>Get-PWManagedWorkspaceVariables</command:name> <command:verb>Get</command:verb> <command:noun>PWManagedWorkspaceVariables</command:noun> <maml:description> <maml:para>Get the configuration variables for the passed managed workspaces.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputWorkspaces --> <command:syntaxItem> <maml:name>Get-PWManagedWorkspaceVariables</maml:name> <!-- Parameter: InputWorkspaces --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputWorkspaces</maml:name> <maml:description> <maml:para>Target workspace object(s) from pipeline (required).</maml:para> </maml:description> <command:parameterValue required="true">ManagedWorkspaceConfigurationSettingsBlock[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.ManagedWorkspaceConfigurationSettingsBlock[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.ManagedWorkspaceConfigurationSettingsBlock[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputWorkspaces --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputWorkspaces</maml:name> <maml:description> <maml:para>Target workspace object(s) from pipeline (required).</maml:para> </maml:description> <command:parameterValue required="true">ManagedWorkspaceConfigurationSettingsBlock[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.ManagedWorkspaceConfigurationSettingsBlock[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.ManagedWorkspaceConfigurationSettingsBlock[]</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.ManagedWorkspaceConfigurationSettingsBlock[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target workspace object(s) from pipeline (required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWRichProjects | Get-PWManagedWorkspaces | Get-PWManagedWorkspaceVariables</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWMemberToGroup --> <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-PWMemberToGroup</command:name> <command:verb>Add</command:verb> <command:noun>PWMemberToGroup</command:noun> <maml:description> <maml:para>Add-PWMemberToGroup adds a ProjectWise User to a ProjectWise Group.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Add-PWMemberToGroup</maml:name> <!-- Parameter: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to group.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of group to add user to.</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> <!-- Parameter set: GroupID UserName --> <command:syntaxItem> <maml:name>Add-PWMemberToGroup</maml:name> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of group to add user to.</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: UserNames --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>Array of user names to add to Group.</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: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to group.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of group to add user to.</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: UserNames --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>Array of user names to add to Group.</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:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects from the pipeline to add to group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for Add-PWMemberToGroup.</maml:para> <maml:para>Get-PWUsersByMatch -UserName 'dave*','bryan*' -Email '*@bentley.com' | Add-PWMemberToGroup -GroupName "Design"</maml:para> <maml:para>Add-PWMemberToGroup -UserNames "dave","brian" -GroupName "Design"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWMemberToUserList --> <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-PWMemberToUserList</command:name> <command:verb>Add</command:verb> <command:noun>PWMemberToUserList</command:noun> <maml:description> <maml:para>Add-PWMemberToUserList adds a ProjectWise User to a ProjectWise User List.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Add-PWMemberToUserList</maml:name> <!-- Parameter: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to group.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>Name of group to add user to.</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: UserNames --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>Array of user names to add to Group.</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: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to group.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>Name of group to add user to.</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: UserNames --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>Array of user names to add to Group.</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:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects from the pipeline to add to group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for Add-PWMemberToUserList.</maml:para> <maml:para>Get-PWUsersByMatch -UserName 'dave*','bryan*' -Email '*@bentley.com' | Add-PWMemberToUserList -UserList "Project Managers"</maml:para> <maml:para>Add-PWMemberToGroup -UserNames "dave","brian" -UserList "Project Managers"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWMonthlyLogins --> <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>Get-PWMonthlyLogins</command:name> <command:verb>Get</command:verb> <command:noun>PWMonthlyLogins</command:noun> <maml:description> <maml:para>Get monthly count of logins by user.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWMonthlyLogins</maml:name> <!-- Parameter: Month --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Month</maml:name> <maml:description> <maml:para>Month to report on. Defaults to current month.</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: Year --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Year</maml:name> <maml:description> <maml:para>Year to report on. Defaults to current year.</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Provide file name if you want to write data to a spreadsheet.</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: IncludeSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>When the IncludeSecondary switch parameter is included, the audit trail entries from the secondary table will be included.</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: Month --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Month</maml:name> <maml:description> <maml:para>Month to report on. Defaults to current month.</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: Year --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Year</maml:name> <maml:description> <maml:para>Year to report on. Defaults to current year.</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Provide file name if you want to write data to a spreadsheet.</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: IncludeSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>When the IncludeSecondary switch parameter is included, the audit trail entries from the secondary table will be included.</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 count user logins by month and save to spreadsheet.</maml:para> <maml:para>Get-PWMonthlyLogins -Month 9 -Year 2015 -OutputFileName "201509Logins.xlsx"</maml:para> <maml:para>#Will count user logins for the current month.</maml:para> <maml:para>Get-PWMonthlyLogins</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWMonthlyLoginsDataTable --> <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>Get-PWMonthlyLoginsDataTable</command:name> <command:verb>Get</command:verb> <command:noun>PWMonthlyLoginsDataTable</command:noun> <maml:description> <maml:para>Get monthly count of logins by user and return data table suitable for use in SqlBulkCopy insert.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWMonthlyLoginsDataTable</maml:name> <!-- Parameter: Month --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Month</maml:name> <maml:description> <maml:para>Month to report on. Defaults to current month.</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: Year --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Year</maml:name> <maml:description> <maml:para>Year to report on. Defaults to current year.</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: ShowColumns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ShowColumns</maml:name> <maml:description> <maml:para>Show columns.</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: IncludeSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>When the IncludeSecondary switch parameter is included, the audit trail entries from the secondary table will be included.</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: Month --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Month</maml:name> <maml:description> <maml:para>Month to report on. Defaults to current month.</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: Year --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Year</maml:name> <maml:description> <maml:para>Year to report on. Defaults to current year.</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: ShowColumns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ShowColumns</maml:name> <maml:description> <maml:para>Show columns.</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: IncludeSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>When the IncludeSecondary switch parameter is included, the audit trail entries from the secondary table will be included.</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> <!-- 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>#Will count user logins by month and output to data table on pipeline.</maml:para> <maml:para>Get-PWMonthlyLoginsDataTable -Month 9 -Year 2015"</maml:para> <maml:para>#Will count user logins for the current month.</maml:para> <maml:para>Get-PWMonthlyLoginsDataTable</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWODSTables --> <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-PWODSTables</command:name> <command:verb>Add</command:verb> <command:noun>PWODSTables</command:noun> <maml:description> <maml:para>Login cmdlet native to this module.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Regular login (will fail if user is not admin)</maml:para> <maml:para>New-PWLogin -DatasourceName 'Server:DSN' -UserName 'UserName' -Password 'password'</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Single sign-on login (will fail if user is not admin)</maml:para> <maml:para>New-PWLogin -Datasource 'Server:DSN'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWOutgoingTransmittalsReport --> <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>Get-PWOutgoingTransmittalsReport</command:name> <command:verb>Get</command:verb> <command:noun>PWOutgoingTransmittalsReport</command:noun> <maml:description> <maml:para>Generates a report of all the Outgoing Transmittals in the CONNECTed project associated with the rich project given a ProjectWise folder path or folder id.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generates a report of all the Outgoing Transmittals in the CONNECTed project associated with the rich project given a ProjectWise folder path or folder id. If no path or id provided, all CONNECTed projects in the datasource will be reported on otherwise.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWOutgoingTransmittalsReport</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path to the rich project from which we'll find the associated CONNECTed project.</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: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Id of rich project from which we'll find the associated CONNECTed project.</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: OutputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Group name containing participants to add to CONNECTed project.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Will use current CONNECT client session 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Will use current CONNECT client session 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: OpenFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OpenFile</maml:name> <maml:description> <maml:para>Set switch to open file in Excel.</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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path to the rich project from which we'll find the associated CONNECTed project.</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: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Id of rich project from which we'll find the associated CONNECTed project.</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: OutputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Group name containing participants to add to CONNECTed project.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Will use current CONNECT client session 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Will use current CONNECT client session 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: OpenFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OpenFile</maml:name> <maml:description> <maml:para>Set switch to open file in Excel.</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>#Example usage for reporting on outgoing transmittals for a CONNECTED project.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Will report on the Outgoing Transmittals for the CONNECTed Project associated with the ProjectWise Rich Project identified by that path</maml:para> <maml:para>Get-PWOutgoingTransmittalsReport -FolderPath "PWPS Connected Project Test 6\Projects 2\Project A" -OutputFileName "c:\\temp\\xmittalReport.xlsx"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWPath --> <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>Get-PWPath</command:name> <command:verb>Get</command:verb> <command:noun>PWPath</command:noun> <maml:description> <maml:para>Get-PWPath is used to retrieve the folder path ( ProjectWise Bin directory ).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>There are no parameters required.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for getting the folder path information.</maml:para> <maml:para>$pwBinPath = Get-PWPath</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWPDFQRCode --> <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-PWPDFQRCode</command:name> <command:verb>Add</command:verb> <command:noun>PWPDFQRCode</command:noun> <maml:description> <maml:para>Apply a WSG or arbitrary QR Code to PDF in ProjectWise.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Add-PWPDFQRCode</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WSGURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>WSGURL</maml:name> <maml:description> <maml:para>If provided, will affix a QR code which will resolve to this same document via your WSG web server.</maml:para> <maml:para>Example value like: "https://decide-pwce-us-ws.bentley.com/ws/v2.5/Repositories/Bentley.PW--decide-pwce-us.bentley.com~3Adecide-pwce-us-10/"</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: URL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>URL</maml:name> <maml:description> <maml:para>Provide this value instead to produce a generic code.</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: X --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>X</maml:name> <maml:description> <maml:para>X coordinate of lower left corner of code image.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Y --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Y</maml:name> <maml:description> <maml:para>Y coordinate of lower left corner of code image.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Size --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Size</maml:name> <maml:description> <maml:para>Size of image.</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>100</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WSGURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>WSGURL</maml:name> <maml:description> <maml:para>If provided, will affix a QR code which will resolve to this same document via your WSG web server.</maml:para> <maml:para>Example value like: "https://decide-pwce-us-ws.bentley.com/ws/v2.5/Repositories/Bentley.PW--decide-pwce-us.bentley.com~3Adecide-pwce-us-10/"</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: URL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>URL</maml:name> <maml:description> <maml:para>Provide this value instead to produce a generic code.</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: X --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>X</maml:name> <maml:description> <maml:para>X coordinate of lower left corner of code image.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Y --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Y</maml:name> <maml:description> <maml:para>Y coordinate of lower left corner of code image.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Size --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Size</maml:name> <maml:description> <maml:para>Size of image.</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>100</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#WSG Url needs to be specified down to the repository level. Resolves to the file when I scan on an iPad. Less luck on Android.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Add-PWPDFQRCode -WSGURL "https://decide-pwce-us-ws.bentley.com/ws/v2.5/Repositories/Bentley.PW--decide-pwce-us.bentley.com~3Adecide-pwce-us-10"</maml:para> <maml:para>#URL can be anything.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Add-PWPDFQRCode -URL "http://www.bentley.com"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Merge-PWPDFs --> <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>Merge-PWPDFs</command:name> <command:verb>Merge</command:verb> <command:noun>PWPDFs</command:noun> <maml:description> <maml:para>Merge input PDFs into a single file and store it back in ProjectWise</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Merge-PWPDFs</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Target folder for merged document.</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: OutputName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>OutputName</maml:name> <maml:description> <maml:para>Target name for merged document.</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: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Target folder for merged document.</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: OutputName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>OutputName</maml:name> <maml:description> <maml:para>Target name for merged document.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target folder for merged document.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target name for merged document.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#use a variable to hold all the returned documents so they are passed to the merge process properly</maml:para> <maml:para>$pdfs = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf</maml:para> <maml:para>Merge-PWPDFs $pdfs -OutputFolder 'Merged\PDFs' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Split-PWPDFs --> <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>Split-PWPDFs</command:name> <command:verb>Split</command:verb> <command:noun>PWPDFs</command:noun> <maml:description> <maml:para>Split input PDFs into constituent pages and store back in ProjectWise.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Split-PWPDFs</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Target folder for split out pages (defaults to source folder).</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: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Target folder for split out pages (defaults to source folder).</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Documents to copy out and print (Required).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target folder for split out pages (defaults to source folder).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Split-PWPDFs</maml:para> <maml:para>New-PWPDFMergedDocument $pdfs -OutputFolder 'Merged\PDFs' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWPicklist --> <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-PWPicklist</command:name> <command:verb>Add</command:verb> <command:noun>PWPicklist</command:noun> <maml:description> <maml:para>Add-PWPicklist adds new custom picklist within the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds new custom picklist within the current datasource. Once a custom picklist is created, it can be added to an environment attribute. Within ProjectWise Administrator, enter the following into the attribute value tab: SELECT PicklistValue FROM CustomPicklists WHERE PicklistName='MyPicklist' Be sure to replace the picklistname with a valid name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWPicklist</maml:name> <!-- Parameter: PicklistName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>PicklistName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PicklistValues --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>PicklistValues</maml:name> <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: PicklistName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>PicklistName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PicklistValues --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>PicklistValues</maml:name> <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>#Example usage for adding a new custom picklist.</maml:para> <maml:para>Add-PWPicklist -PicklistName 'MyPicklist' -PicklistValues 'one', 'two', 'three' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWPicklist --> <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-PWPicklist</command:name> <command:verb>Export</command:verb> <command:noun>PWPicklist</command:noun> <maml:description> <maml:para>Export-PWPicklist saves the current datasources custom picklists to an XLSX file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export-PWPicklist saves the current datasources custom picklists to an XLSX file.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-PWPicklist</maml:name> <!-- Parameter: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Full path to output XLSX file (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: PicklistName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PicklistName</maml:name> <maml:description> <maml:para>Name of picklist to export (Optional).</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: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Full path to output XLSX file (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: PicklistName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PicklistName</maml:name> <maml:description> <maml:para>Name of picklist to export (Optional).</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>#Example usage for retrieving all custom picklist information.</maml:para> <maml:para>Export-PWPicklist -OutputFile c:\temp\picklists.xlsx</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for retrieiving information for an individual custom picklist.</maml:para> <maml:para>Export-PWPicklist -OutputFile c:\temp\picklists.xlsx -PicklistName 'MyPickList'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWPicklist --> <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>Get-PWPicklist</command:name> <command:verb>Get</command:verb> <command:noun>PWPicklist</command:noun> <maml:description> <maml:para>Get-PWPicklist retrieves custom picklist information available within the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves custom picklist information available within the current datasource.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for retrieving all custom picklist information.</maml:para> <maml:para>Get-PWPicklist -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWPicklist --> <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-PWPicklist</command:name> <command:verb>Import</command:verb> <command:noun>PWPicklist</command:noun> <maml:description> <maml:para>Import-PWPicklist imports custom picklists from an XLSX file into the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Import-PWPicklist imports custom picklists from an XLSX file into the current datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-PWPicklist</maml:name> <!-- Parameter: InputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Full path to output XLSX file (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: PicklistName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PicklistName</maml:name> <maml:description> <maml:para>Name of picklist to import (Optional).</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: InputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Full path to output XLSX file (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: PicklistName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PicklistName</maml:name> <maml:description> <maml:para>Name of picklist to import (Optional).</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>#Example usage for retrieving all custom picklist information.</maml:para> <maml:para>Import-PWPicklist -InputFile c:\temp\picklists.xlsx</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for overwriting individual custom picklist.</maml:para> <maml:para>Import-PWPicklist -InputFile c:\temp\picklists.xlsx -PicklistName 'MyPickList'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWPicklist --> <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>Remove-PWPicklist</command:name> <command:verb>Remove</command:verb> <command:noun>PWPicklist</command:noun> <maml:description> <maml:para>Remove-PWPicklist removes custom picklist from the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a custom picklist from the current datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWPicklist</maml:name> <!-- Parameter: PicklistName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PicklistName</maml:name> <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: PicklistName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PicklistName</maml:name> <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>#Example usage for removing a custom picklist.</maml:para> <maml:para>Remove-PWPicklist -PicklistName 'MyPicklist' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWPicklistItem --> <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>Remove-PWPicklistItem</command:name> <command:verb>Remove</command:verb> <command:noun>PWPicklistItem</command:noun> <maml:description> <maml:para>Remove-PWPicklistItem removes a value(s) from a custom picklist within the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a value(s) from a custom picklist within the current datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWPicklistItem</maml:name> <!-- Parameter: PicklistName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PicklistName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PicklistValues --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>PicklistValues</maml:name> <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: PicklistName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PicklistName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PicklistValues --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>PicklistValues</maml:name> <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>#Example usage for removing an item from a custom picklist.</maml:para> <maml:para>Remove-PWPicklistItem -PicklistName 'MyPicklist' -PicklistValues 'one' -Verbose</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for removing multiple items from a custom picklist.</maml:para> <maml:para>Remove-PWPicklistItem -PicklistName 'MyPicklist' -PicklistValues 'two', 'three' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWPicklistItems --> <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>Get-PWPicklistItems</command:name> <command:verb>Get</command:verb> <command:noun>PWPicklistItems</command:noun> <maml:description> <maml:para>Get-PWPicklist retrieves custom picklist information available within the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves custom picklist information available within the current datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWPicklistItems</maml:name> <!-- Parameter: PicklistName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>PicklistName</maml:name> <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: PicklistName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>PicklistName</maml:name> <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>#Example usage for retrieving all custom picklist information.</maml:para> <maml:para>Get-PWPicklist -Verbose</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for retrieiving information for an individual custom picklist.</maml:para> <maml:para>Get-PWPicklist -PicklistName 'MyPicklist' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWProjectTemplates --> <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>Get-PWProjectTemplates</command:name> <command:verb>Get</command:verb> <command:noun>PWProjectTemplates</command:noun> <maml:description> <maml:para>Get the managed workspace configuration settings blocks for projects from the pipeline, from a folder path, or for the whole datasource.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWFolders -FolderPah 'Top Level\Sub-Folder' | Get-PWManagedWorkspaces</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWPropagateProjectProperties --> <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-PWPropagateProjectProperties</command:name> <command:verb>Update</command:verb> <command:noun>PWPropagateProjectProperties</command:noun> <maml:description> <maml:para>Given an array of folder objects on the pipeline or folder path, update the contained documents to the new project properties. Passes out project documents onto the pipeline.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Update-PWPropagateProjectProperties</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Target folder path (not required if sending folder(s) on pipeline).</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: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Target folder path (not required if sending folder(s) on pipeline).</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage getting folders and creating new documents.</maml:para> <maml:para>#Get the folder for folder number 20315 and update contained documents to new project property values</maml:para> <maml:para>Get-PWFolders 20315 | Update-PWPropagateProjectProperties</maml:para> <maml:para>#Get the folder at the given folder path and create a document there</maml:para> <maml:para>Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3\Level | Update-PWPropagateProjectProperties</maml:para> <maml:para>#Update document attributes for a given folder</maml:para> <maml:para>Update-PWPropagateProjectProperties -FolderPath 'PowerShell Demo\Level 2\Level 3\Level 4'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWPropagateProjectPropertiesToSubProjects --> <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-PWPropagateProjectPropertiesToSubProjects</command:name> <command:verb>Update</command:verb> <command:noun>PWPropagateProjectPropertiesToSubProjects</command:noun> <maml:description> <maml:para>For each rich project passed on the pipeline, update descendents to inherit common Project Property values from projects above. If no rich projects passed, doesn't do anything.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Note the the cmdlet attempts to use the project properties present at the beginning of the cmdlet. Probably easiest to manage by just passing one folder as this recurses tree by default.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Update-PWPropagateProjectPropertiesToSubProjects</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target folder object(s) from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Get the folder for folder number 20315 and update descendant project properties.</maml:para> <maml:para>Get-PWFolders 20315 -JustOne | Update-PWPropagateProjectProperties -Verbose</maml:para> <maml:para>#Get the folders in the tree at the given folder path and working down the tree, update descendant project properties</maml:para> <maml:para>Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3' | Update-PWPropagateProjectProperties -Verbose</maml:para> <maml:para>#Update document attributes for a given folder</maml:para> <maml:para>Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3' -JustOne | Update-PWPropagateProjectProperties -FolderPath 'PowerShell Demo\Level 2\Level 3\Level 4'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Show-PWPS_DABChangeLog --> <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>Show-PWPS_DABChangeLog</command:name> <command:verb>Show</command:verb> <command:noun>PWPS_DABChangeLog</command:noun> <maml:description> <maml:para>Display Change Log.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Show-PWPS_DABChangeLog</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWReferenceCountReportForDocuments --> <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>Get-PWReferenceCountReportForDocuments</command:name> <command:verb>Get</command:verb> <command:noun>PWReferenceCountReportForDocuments</command:noun> <maml:description> <maml:para>Get XLSX report or SQLite or straight DataTable that counts unique references documents passed in pipeline.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Get-PWReferenceCountReportForDocuments</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Documents from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFilePath</maml:name> <maml:description> <maml:para>Full path to output file (XLSX or SQLite). Exclude just to return data tables.</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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Documents from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFilePath</maml:name> <maml:description> <maml:para>Full path to output file (XLSX or SQLite). Exclude just to return data tables.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Documents from pipeline.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Full path to output file (XLSX or SQLite). Exclude just to return data tables.</maml:para> </maml:description> </command:inputType> </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>#use a variable to pass multiple documents. Using a pipe ('|') will cause each document to be processed individually. Ususally not what you want.</maml:para> <maml:para>$documents = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder'</maml:para> <maml:para>Get-PWReferenceCountReportForDocuments $documents -OutputFilePath c:\temp\References.xlsx</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Use data table to populate SQL Server Database</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.References_Table"</maml:para> <maml:para>$documents = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder'</maml:para> <maml:para>$dtable=Get-PWReferenceCountReportForDocuments $documents</maml:para> <maml:para>$bc.WriteToServer($dtable)</maml:para> <maml:para>$cn.Close()</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWReferenceFiles --> <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>Get-PWReferenceFiles</command:name> <command:verb>Get</command:verb> <command:noun>PWReferenceFiles</command:noun> <maml:description> <maml:para>Returns reference documents from the passed documents on the pipeline.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>#Search for documents and return immediate child documents.</maml:para> <maml:para>Get-PWDocumentsBySearch -SearchName "Documents in Released State" | Get-PWReferenceFiles -ReferenceLevel 0</maml:para> <maml:para>#Search for documents in folder tree and return all nested references and fill in folder paths and retrieve attributes.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Project A\Files to Version" | Get-PWReferenceFiles -GetAttributes</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Get-PWReferenceFiles</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of documents passed on pipeline like from Get-PWDocumentsBySearch.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReferenceLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ReferenceLevel</maml:name> <maml:description> <maml:para>Level of nested references to return. Defaults to all nested references.</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>-1</dev:defaultValue> </command:parameter> <!-- Parameter: GetAttributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>GetAttributes</maml:name> <maml:description> <maml:para>Return attributes for references. Takes longer to populate the list.</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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Array of documents passed on pipeline like from Get-PWDocumentsBySearch.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReferenceLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ReferenceLevel</maml:name> <maml:description> <maml:para>Level of nested references to return. Defaults to all nested references.</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>-1</dev:defaultValue> </command:parameter> <!-- Parameter: GetAttributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>GetAttributes</maml:name> <maml:description> <maml:para>Return attributes for references. Takes longer to populate the list.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of documents passed on pipeline like from Get-PWDocumentsBySearch.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Search for documents and return immediate child documents.</maml:para> <maml:para>Get-PWDocumentsBySearch -SearchName "Documents in Released State" | Get-PWReferenceFiles -ReferenceLevel 0</maml:para> <maml:para>#Search for documents in folder tree and return all nested references and fill in folder paths and retrieve attributes.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Project A\Files to Version" | Get-PWReferenceFiles -GetAttributes</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWReferenceFileStoragePathListing --> <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>Get-PWReferenceFileStoragePathListing</command:name> <command:verb>Get</command:verb> <command:noun>PWReferenceFileStoragePathListing</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWReferenceFileStoragePathListing</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SubFolders</maml:name> <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: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UseAdminPaths</maml:name> <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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SubFolders</maml:name> <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: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UseAdminPaths</maml:name> <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:command> <!-- Cmdlet: Get-PWReferenceFileStoragePathListingBySearch --> <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>Get-PWReferenceFileStoragePathListingBySearch</command:name> <command:verb>Get</command:verb> <command:noun>PWReferenceFileStoragePathListingBySearch</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWReferenceFileStoragePathListingBySearch</maml:name> <!-- Parameter: SearchName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Search name (now supports full path to search).</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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Path to output file (.xlsx).</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: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UseAdminPaths</maml:name> <maml:description> <maml:para>Shows Admin paths to correpond to storage areas.</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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Is a personal search.</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: SearchName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Search name (now supports full path to search).</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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Path to output file (.xlsx).</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: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UseAdminPaths</maml:name> <maml:description> <maml:para>Shows Admin paths to correpond to storage areas.</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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Is a personal search.</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:command> <!-- Cmdlet: Get-PWReferenceReportForDocuments --> <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>Get-PWReferenceReportForDocuments</command:name> <command:verb>Get</command:verb> <command:noun>PWReferenceReportForDocuments</command:noun> <maml:description> <maml:para>Get XLSX report or SQLite or straight DataTable for all references in documents passed in pipeline.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Get-PWReferenceReportForDocuments</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Documents from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFilePath</maml:name> <maml:description> <maml:para>Full path to output file (XLSX or SQLite). Exclude just to return data tables.</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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Documents from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFilePath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFilePath</maml:name> <maml:description> <maml:para>Full path to output file (XLSX or SQLite). Exclude just to return data tables.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Documents from pipeline.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Full path to output file (XLSX or SQLite). Exclude just to return data tables.</maml:para> </maml:description> </command:inputType> </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>#use a variable to pass multiple documents. Using a pipe ('|') will cause each document to be processed individually. Ususally not what you want.</maml:para> <maml:para>$documents = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder'</maml:para> <maml:para>Get-PWReferenceReportForDocuments $documents -OutputFilePath c:\temp\References.xlsx</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Use data table to populate SQL Server Database</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.References_Table"</maml:para> <maml:para>$documents = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder'</maml:para> <maml:para>$dtable=Get-PWReferenceReportForDocuments $documents</maml:para> <maml:para>$bc.WriteToServer($dtable)</maml:para> <maml:para>$cn.Close()</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWReferenceReportForFolder --> <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>Get-PWReferenceReportForFolder</command:name> <command:verb>Get</command:verb> <command:noun>PWReferenceReportForFolder</command:noun> <maml:description> <maml:para>Get XLSX report or SQLite DB or straight datatable for all references in the given folder and its children.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWReferenceReportForFolder</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Documents from pipeline.</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: OutputFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFilePath</maml:name> <maml:description> <maml:para>Full path to output file (XLSX or SQLite db).</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: WholeDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WholeDatasource</maml:name> <maml:description> <maml:para>Report on whole datasource.</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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Documents from pipeline.</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: OutputFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFilePath</maml:name> <maml:description> <maml:para>Full path to output file (XLSX or SQLite db).</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: WholeDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WholeDatasource</maml:name> <maml:description> <maml:para>Report on whole datasource.</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> <!-- 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>Get-PWReferenceReportForFolder -WholeDatasource -OutputFilePath c:\temp\References.xlsx</maml:para> <maml:para>Get-PWReferenceReportForFolder -FolderPath 'Top Level\Project 01' -OutputFilePath c:\temp\References.sqlite</maml:para> <maml:para>#Output DataTable</maml:para> <maml:para>Get-PWReferenceReportForFolder -FolderPath 'Top Level\Project 01'</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Use data table to populate SQL Server Database</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.References_Table"</maml:para> <maml:para>$dtable=Get-PWReferenceReportForFolder -WholeDatasource</maml:para> <maml:para>$bc.WriteToServer($dtable)</maml:para> <maml:para>$cn.Close()</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRenditionProfileDefaults --> <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>Get-PWRenditionProfileDefaults</command:name> <command:verb>Get</command:verb> <command:noun>PWRenditionProfileDefaults</command:noun> <maml:description> <maml:para>Get a list of default options for the profiles.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputProfiles --> <command:syntaxItem> <maml:name>Get-PWRenditionProfileDefaults</maml:name> <!-- Parameter: InputProfiles --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputProfiles</maml:name> <maml:description> <maml:para>Array of rendition profile objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">RenditionProfile[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.RenditionProfile[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Rendition profile name. Must 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputProfiles --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputProfiles</maml:name> <maml:description> <maml:para>Array of rendition profile objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">RenditionProfile[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.RenditionProfile[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Rendition profile name. Must 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.RenditionProfile[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of rendition profile objects from the pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for getting a list of default options for all the rendition profiles.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Get-PWRenditionProfiles | Get-PWRendtionProfileDefaults</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRenditionProfiles --> <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>Get-PWRenditionProfiles</command:name> <command:verb>Get</command:verb> <command:noun>PWRenditionProfiles</command:noun> <maml:description> <maml:para>Get a list of available profiles.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWRenditionProfiles</maml:name> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Rendition Profile name. Must 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Rendition Profile name. Must 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for getting a list of rendition profiles.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Get-PWRenditionProfiles</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWRenditionRequest --> <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-PWRenditionRequest</command:name> <command:verb>New</command:verb> <command:noun>PWRenditionRequest</command:noun> <maml:description> <maml:para>Submits a rendition request for documents passed through the pipeline. Takes an optional Rendition Profile name.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>New-PWRenditionRequest</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Array of document objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Rendition Profile name. Must 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputDocuments --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputDocuments</maml:name> <maml:description> <maml:para>Array of document objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseDocument[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProfileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProfileName</maml:name> <maml:description> <maml:para>Rendition Profile name. Must 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of document objects from the pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for creating and submitting a rendition request.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Get the documents from the folder and submit them for plotting.</maml:para> <maml:para>Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -FileName %.dgn -JustThisFolder | New-PWRenditionRequest -Profile "For Construction"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWRichProject --> <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-PWRichProject</command:name> <command:verb>New</command:verb> <command:noun>PWRichProject</command:noun> <maml:description> <maml:para>Creates individual rich projects and upgrades existing folders to rich projects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a path or folders from pipeline, a template name and a hashtable of project properties in order to create a new rich project or upgrade an existing folder.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>New-PWRichProject</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of folders from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NewFolderPath</maml:name> <maml:description> <maml:para>Full folder path of new project to create. Error if already exists.</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: UserListTemplatePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>UserListTemplatePrefix</maml:name> <maml:description> <maml:para>Defaults to '[TEMPLATE]'. Can be used to override that string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[TEMPLATE]</dev:defaultValue> </command:parameter> <!-- Parameter: TemplateName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TemplateName</maml:name> <maml:description> <maml:para>Template name. Error if not found.</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: StorageArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area name is required since that is the thing most likely to vary from the template.</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: BlockSizeInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>BlockSizeInSeconds</maml:name> <maml:description> <maml:para>Geospatial block size to create if latitude and longitude properties are provided (not yet implemented).</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DoNotCopyDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>DoNotCopyDocuments</maml:name> <maml:description> <maml:para>Will copy documents from the template by default. Set this switch to prevent.</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: UserListPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UserListPrefix</maml:name> <maml:description> <maml:para>If provided, user lists that start with '[TEMPLATE]' will be copied and changed to use this value.</maml:para> <maml:para>The idea is to create project-specific user lists.</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: ProjectProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ProjectProperties</maml:name> <maml:description> <maml:para>Hashtable with project properties.</maml:para> <maml:para>In script would be like this: @{PROJECT_Project_Name = "My new project"; PROJECT_Project_Number = "00007"; PROJECT_Project_Manager_Email = "joe.blow@bentley.com" }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpgradeIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>UpgradeIfExists</maml:name> <maml:description> <maml:para>Upgrade the folder if it exists.</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: ProjectType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ProjectType</maml:name> <maml:description> <maml:para>ProjectType for updates.</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: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of folders from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: NewFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NewFolderPath</maml:name> <maml:description> <maml:para>Full folder path of new project to create. Error if already exists.</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: TemplateName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TemplateName</maml:name> <maml:description> <maml:para>Template name. Error if not found.</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: StorageArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area name is required since that is the thing most likely to vary from the template.</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: BlockSizeInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>BlockSizeInSeconds</maml:name> <maml:description> <maml:para>Geospatial block size to create if latitude and longitude properties are provided (not yet implemented).</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DoNotCopyDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>DoNotCopyDocuments</maml:name> <maml:description> <maml:para>Will copy documents from the template by default. Set this switch to prevent.</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: UserListPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UserListPrefix</maml:name> <maml:description> <maml:para>If provided, user lists that start with '[TEMPLATE]' will be copied and changed to use this value.</maml:para> <maml:para>The idea is to create project-specific user lists.</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: UserListTemplatePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>UserListTemplatePrefix</maml:name> <maml:description> <maml:para>Defaults to '[TEMPLATE]'. Can be used to override that string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[TEMPLATE]</dev:defaultValue> </command:parameter> <!-- Parameter: ProjectProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ProjectProperties</maml:name> <maml:description> <maml:para>Hashtable with project properties.</maml:para> <maml:para>In script would be like this: @{PROJECT_Project_Name = "My new project"; PROJECT_Project_Number = "00007"; PROJECT_Project_Manager_Email = "joe.blow@bentley.com" }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpgradeIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>UpgradeIfExists</maml:name> <maml:description> <maml:para>Upgrade the folder if it exists.</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: ProjectType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ProjectType</maml:name> <maml:description> <maml:para>ProjectType for updates.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of folders from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Example usage for creating a new project from a path</maml:para> </maml:introduction> <dev:code>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</dev:code> <dev:remarks> <maml:para>#This returns a folder object so you could save it to a variable and use it for additional operations.</maml:para> <maml:para>New-PWRichProject -NewFolderPath "Test Projects 5\From Script\Project N" -UpgradeIfExists -ProjectType "Civil"</maml:para> <maml:para>#This returns a folder object so you could save it to a variable and use it for additional operations.</maml:para> <maml:para>Get-PWFolders -FolderName "Civil Project%" | New-PWRichProject -UpgradeIfExists -ProjectType "Civil" -ProjectProperties @{PROJECT_Project_Name='A Project Name'; PROJECT_Project_Number='YYYYY'; PROJECT_Project_Manager_Email='dave.brumbaugh@bentley.com'}</maml:para> <maml:para>#Upgrades all folders in datasource starting with "Civil Project..." to rich projects of type "Civil" and sets the project properties.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWRichProjectProperties --> <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-PWRichProjectProperties</command:name> <command:verb>Update</command:verb> <command:noun>PWRichProjectProperties</command:noun> <maml:description> <maml:para>Updates the properties of individual rich projects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a path or a folder from the pipeline, and a hashtable of project properties.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Update-PWRichProjectProperties</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of folders from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full folder path of rich project to update.</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: ProjectProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ProjectProperties</maml:name> <maml:description> <maml:para>Hashtable with project properties.</maml:para> <maml:para>In script would be like this: @{PROJECT_Project_Name = "My new project"; PROJECT_Project_Number = "00007"; PROJECT_Project_Manager_Email = "joe.blow@bentley.com" }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Array of folders from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full folder path of rich project to update.</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: ProjectProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ProjectProperties</maml:name> <maml:description> <maml:para>Hashtable with project properties.</maml:para> <maml:para>In script would be like this: @{PROJECT_Project_Name = "My new project"; PROJECT_Project_Number = "00007"; PROJECT_Project_Manager_Email = "joe.blow@bentley.com" }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of folders from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Update-PWRichProjectProperties -FolderPath "Test Projects 5\From Script\Project N" -ProjectProperties @{PROJECT_Project_Name='A Project Name'; PROJECT_Project_Number='YYYYY'; PROJECT_Project_Manager_Email='dave.brumbaugh@bentley.com'}</maml:para> <maml:para>Get-PWRichProjects -FolderPath 'Top Level\Sub Level' | Update-PWRichProjectProperties -ProjectProperties @{PROJECT_Start_Date = '2017-01-01 01:00:00'; PROJECT_Project_Name='A Project Name'; PROJECT_Project_Number='YYYYY'; PROJECT_Project_Manager_Email='dave.brumbaugh@bentley.com'}</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRichProjectReport --> <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>Get-PWRichProjectReport</command:name> <command:verb>Get</command:verb> <command:noun>PWRichProjectReport</command:noun> <maml:description> <maml:para>Get a report of all the rich project data in the datasource or include the folder path and restrict to a sub-tree.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spreadsheet output from this cmdlet is in a format suitable for use with the New-PWRichProjectsFromSpreadsheet or Update-PWRichProjectsFromSpreadsheet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWRichProjectReport</maml:name> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Name of output file (should have .xlsx extension).</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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Restrict reporting to this folder tree (optional).</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: ProjectType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ProjectType</maml:name> <maml:description> <maml:para>Restrict reporting to this project type (optional).</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: Open --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Open</maml:name> <maml:description> <maml:para>Open the created spreadsheet in Excel on completion.</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: OutputDataTables --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>OutputDataTables</maml:name> <maml:description> <maml:para>Output the generated array of datatables onto the pipeline instead of writing a file.</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Name of output file (should have .xlsx extension).</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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Restrict reporting to this folder tree (optional).</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: ProjectType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ProjectType</maml:name> <maml:description> <maml:para>Restrict reporting to this project type (optional).</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: Open --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Open</maml:name> <maml:description> <maml:para>Open the created spreadsheet in Excel on completion.</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: OutputDataTables --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>OutputDataTables</maml:name> <maml:description> <maml:para>Output the generated array of datatables onto the pipeline instead of writing a file.</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>#Output a spreadsheet with the rich project data</maml:para> <maml:para>Get-PWRichProjectReport -FolderPath 'Top Level\Sub-Folder' -OutputFileName c:\temp\RichProjects.xlsx</maml:para> <maml:para>#Output a array of datatables with the rich project data</maml:para> <maml:para>$dts = Get-PWRichProjectReport -FolderPath 'Top Level\Sub-Folder' -OutputDataTables</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWRichProjectResource --> <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>Set-PWRichProjectResource</command:name> <command:verb>Set</command:verb> <command:noun>PWRichProjectResource</command:noun> <maml:description> <maml:para>Set-PWRichProjectResource is used to manipulate the rich project resources for a specified project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-PWRichProjectResource is used to manipulate the rich project resources for a specified project. A resource type can be set to inherit, none or add specific resource members.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWRichProjectResource</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Specifies the rich project to set the resource data for.</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: ResourceMemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ResourceMemberName</maml:name> <maml:description> <maml:para>Specifies the name of the resource to set. Valid Entries will the name of one of the members of the specified resource type.</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: ResourceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type to 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: Inherit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Inherit</maml:name> <maml:description> <maml:para>When included, the resource type will be set to inherit.</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: None --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>None</maml:name> <maml:description> <maml:para>When included, the resource type will be set to none. If both inherit and none are included, inherit will take precedence.</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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Specifies the rich project to set the resource data for.</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: ResourceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type to 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: ResourceMemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ResourceMemberName</maml:name> <maml:description> <maml:para>Specifies the name of the resource to set. Valid Entries will the name of one of the members of the specified resource type.</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: Inherit --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Inherit</maml:name> <maml:description> <maml:para>When included, the resource type will be set to inherit.</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: None --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>None</maml:name> <maml:description> <maml:para>When included, the resource type will be set to none. If both inherit and none are included, inherit will take precedence.</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the rich project to set the resource data for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for setting a project's application resource to inherit.</maml:para> <maml:para>Set-PWRichProjectResource -FolderPath 'Projects' -ResourceType 'application' -Inherit</maml:para> <maml:para>#Example usage for setting a project's workspace profiles resource to none.</maml:para> <maml:para>Set-PWRichProjectResource -FolderPath 'Projects' -ResourceType 'workspaceprofile' -None</maml:para> <maml:para>#Example usage for adding the MicroStation application to the project's application resources.</maml:para> <maml:para>Set-PWRichProjectResource -FolderPath 'Projects' -ResourceType 'application' -ResourceMemberName 'Microstation'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRichProjectRoles --> <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>Get-PWRichProjectRoles</command:name> <command:verb>Get</command:verb> <command:noun>PWRichProjectRoles</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWRichProjectRoles</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: AccessMask --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessMask</maml:name> <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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <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: DocumentSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentSecurity</maml:name> <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: FolderSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderSecurity</maml:name> <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: RichProjectsOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RichProjectsOnly</maml:name> <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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: AccessMask --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AccessMask</maml:name> <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: FolderSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderSecurity</maml:name> <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: DocumentSecurity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DocumentSecurity</maml:name> <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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <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: RichProjectsOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RichProjectsOnly</maml:name> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage retrieving rich project participant roles.</maml:para> <maml:para>The following will return the rich project participant roles for the rich project passed via the pipeline.</maml:para> <maml:para>Get-PWFolders -FolderPath 'BSI900 - Adelaide Tower' -JustOne -Slow | Get-PWRichProjectRoles</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRichProjects --> <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>Get-PWRichProjects</command:name> <command:verb>Get</command:verb> <command:noun>PWRichProjects</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWRichProjects</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>JustOne</maml:name> <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: BypassSearchAssembly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>BypassSearchAssembly</maml:name> <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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>JustOne</maml:name> <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: BypassSearchAssembly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>BypassSearchAssembly</maml:name> <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:command> <!-- Cmdlet: Get-PWRichProjectScalar --> <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>Get-PWRichProjectScalar</command:name> <command:verb>Get</command:verb> <command:noun>PWRichProjectScalar</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWRichProjectScalar</maml:name> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeyProjectProperty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>KeyProjectProperty</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DocumentAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DocumentAttributeName</maml:name> <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="0"> <maml:name>OutputFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeyProjectProperty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>KeyProjectProperty</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DocumentAttributeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DocumentAttributeName</maml:name> <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:command> <!-- Cmdlet: New-PWRichProjectsFromDataTables --> <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-PWRichProjectsFromDataTables</command:name> <command:verb>New</command:verb> <command:noun>PWRichProjectsFromDataTables</command:noun> <maml:description> <maml:para>Create rich projects from a spreadsheet. Use Get-PWRichProjectReport to create a suitably formatted spreadsheet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spreadsheet input to this cmdlet is in the same format generated by Get-PWRichProjectReport.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Data --> <command:syntaxItem> <maml:name>New-PWRichProjectsFromDataTables</maml:name> <!-- Parameter: Data --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Data</maml:name> <maml:description> <maml:para>Input array of DataTable objects (Required).</maml:para> </maml:description> <command:parameterValue required="true">DataTable[]</command:parameterValue> <dev:type> <maml:name>System.Data.DataTable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultNewParentPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DefaultNewParentPath</maml:name> <maml:description> <maml:para>Default new parent path for new projects (Required). Used if NewParentPath is not filled in on row.</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: DefaultTemplateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DefaultTemplateName</maml:name> <maml:description> <maml:para>Default template name for new projects (Required). Used if TemplateName is not filled in on row.</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: DefaultStorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultStorageArea</maml:name> <maml:description> <maml:para>Default storage area for new projects (Required). Used if NewStorage is not filled in on row.</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: UserListTemplatePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>UserListTemplatePrefix</maml:name> <maml:description> <maml:para>Defaults to '[TEMPLATE]'. Can be used to override that string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[TEMPLATE]</dev:defaultValue> </command:parameter> <!-- Parameter: BlockSizeInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>BlockSizeInSeconds</maml:name> <maml:description> <maml:para>If provided and if ProjectLatitude and ProjectLongitude columns are provided in spreadsheet, will create a geo-location square of this size centered on the Lat/Lon.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: CreateAtRoot --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>CreateAtRoot</maml:name> <maml:description> <maml:para>Overrides NewParentPath and DefaultNewParentPath to create the project at the root of the datasource.</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: Data --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Data</maml:name> <maml:description> <maml:para>Input array of DataTable objects (Required).</maml:para> </maml:description> <command:parameterValue required="true">DataTable[]</command:parameterValue> <dev:type> <maml:name>System.Data.DataTable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultNewParentPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DefaultNewParentPath</maml:name> <maml:description> <maml:para>Default new parent path for new projects (Required). Used if NewParentPath is not filled in on row.</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: DefaultTemplateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DefaultTemplateName</maml:name> <maml:description> <maml:para>Default template name for new projects (Required). Used if TemplateName is not filled in on row.</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: DefaultStorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultStorageArea</maml:name> <maml:description> <maml:para>Default storage area for new projects (Required). Used if NewStorage is not filled in on row.</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: UserListTemplatePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>UserListTemplatePrefix</maml:name> <maml:description> <maml:para>Defaults to '[TEMPLATE]'. Can be used to override that string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[TEMPLATE]</dev:defaultValue> </command:parameter> <!-- Parameter: BlockSizeInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>BlockSizeInSeconds</maml:name> <maml:description> <maml:para>If provided and if ProjectLatitude and ProjectLongitude columns are provided in spreadsheet, will create a geo-location square of this size centered on the Lat/Lon.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: CreateAtRoot --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>CreateAtRoot</maml:name> <maml:description> <maml:para>Overrides NewParentPath and DefaultNewParentPath to create the project at the root of the datasource.</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:inputType> <dev:type> <maml:name>System.Data.DataTable[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Input array of DataTable objects (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Create rich projects from an array of DataTables</maml:para> <maml:para>New-PWRichProjectsFromDataTables -Data $dts -DefaultNewParentPath 'New Projects\Create here' -DefaultTemplateName 'General' -DefaultStorageArea Stor01</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWRichProjectsFromDataTables --> <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-PWRichProjectsFromDataTables</command:name> <command:verb>Update</command:verb> <command:noun>PWRichProjectsFromDataTables</command:noun> <maml:description> <maml:para>Update rich project properties from an array of data tables like that generated by Get-PWRichProjectReport -OutputDataTables.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Table input to this cmdlet is in the same format generated by Get-PWRichProjectReport -OutputDataTables.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Data --> <command:syntaxItem> <maml:name>Update-PWRichProjectsFromDataTables</maml:name> <!-- Parameter: Data --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Data</maml:name> <maml:description> <maml:para>Input array of DataTable objects (Required).</maml:para> </maml:description> <command:parameterValue required="true">DataTable[]</command:parameterValue> <dev:type> <maml:name>System.Data.DataTable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Data --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Data</maml:name> <maml:description> <maml:para>Input array of DataTable objects (Required).</maml:para> </maml:description> <command:parameterValue required="true">DataTable[]</command:parameterValue> <dev:type> <maml:name>System.Data.DataTable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Data.DataTable[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Input array of DataTable objects (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Update rich projects from an array of datatables</maml:para> <maml:para>Update-PWRichProjectsFromDataTables $dts</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWRichProjectsFromSpreadsheet --> <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-PWRichProjectsFromSpreadsheet</command:name> <command:verb>New</command:verb> <command:noun>PWRichProjectsFromSpreadsheet</command:noun> <maml:description> <maml:para>Create rich projects from a spreadsheet. Use Get-PWRichProjectReport to create a suitably formatted spreadsheet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spreadsheet input to this cmdlet is in the same format generated by Get-PWRichProjectReport.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWRichProjectsFromSpreadsheet</maml:name> <!-- Parameter: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>Input spreadsheet (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: DefaultNewParentPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DefaultNewParentPath</maml:name> <maml:description> <maml:para>Default new parent path for new projects (Required). Used if NewParentPath is not filled in on row.</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: DefaultTemplateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DefaultTemplateName</maml:name> <maml:description> <maml:para>Default template name for new projects (Required). Used if TemplateName is not filled in on row.</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: DefaultStorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultStorageArea</maml:name> <maml:description> <maml:para>Default storage area for new projects (Required). Used if NewStorage is not filled in on row.</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: UserListTemplatePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>UserListTemplatePrefix</maml:name> <maml:description> <maml:para>Defaults to '[TEMPLATE]'. Can be used to override that string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[TEMPLATE]</dev:defaultValue> </command:parameter> <!-- Parameter: BlockSizeInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>BlockSizeInSeconds</maml:name> <maml:description> <maml:para>If provided and if ProjectLatitude and ProjectLongitude columns are provided in spreadsheet, will create a geo-location square of this size centered on the Lat/Lon.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: CreateAtRoot --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>CreateAtRoot</maml:name> <maml:description> <maml:para>Overrides NewParentPath and DefaultNewParentPath to create the project at the root of the datasource.</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: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>Input spreadsheet (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: DefaultNewParentPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>DefaultNewParentPath</maml:name> <maml:description> <maml:para>Default new parent path for new projects (Required). Used if NewParentPath is not filled in on row.</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: DefaultTemplateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DefaultTemplateName</maml:name> <maml:description> <maml:para>Default template name for new projects (Required). Used if TemplateName is not filled in on row.</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: DefaultStorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultStorageArea</maml:name> <maml:description> <maml:para>Default storage area for new projects (Required). Used if NewStorage is not filled in on row.</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: UserListTemplatePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>UserListTemplatePrefix</maml:name> <maml:description> <maml:para>Defaults to '[TEMPLATE]'. Can be used to override that string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[TEMPLATE]</dev:defaultValue> </command:parameter> <!-- Parameter: BlockSizeInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>BlockSizeInSeconds</maml:name> <maml:description> <maml:para>If provided and if ProjectLatitude and ProjectLongitude columns are provided in spreadsheet, will create a geo-location square of this size centered on the Lat/Lon.</maml:para> </maml:description> <command:parameterValue required="true">double</command:parameterValue> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: CreateAtRoot --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>CreateAtRoot</maml:name> <maml:description> <maml:para>Overrides NewParentPath and DefaultNewParentPath to create the project at the root of the datasource.</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>#Create rich projects from a spreadsheet</maml:para> <maml:para>New-PWRichProjectsFromSpreadsheet -InputFileName c:\temp\RichProjects01.xlsx -DefaultNewParentPath 'New Projects\Create here' -DefaultTemplateName 'General' -DefaultStorageArea Stor01</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWRichProjectsFromSpreadsheet --> <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-PWRichProjectsFromSpreadsheet</command:name> <command:verb>Update</command:verb> <command:noun>PWRichProjectsFromSpreadsheet</command:noun> <maml:description> <maml:para>Update rich project properties from a spreadsheet. Use Get-PWRichProjectReport to create a suitably formatted spreadsheet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spreadsheet input to this cmdlet is in the same format generated by Get-PWRichProjectReport.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWRichProjectsFromSpreadsheet</maml:name> <!-- Parameter: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>Input spreadsheet (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: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>Input spreadsheet (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 /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Update rich project properties from a spreadsheet</maml:para> <maml:para>Update-PWRichProjectsFromSpreadsheet -InputFileName c:\temp\RichProjects01.xlsx</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRichProjectStateCount --> <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>Get-PWRichProjectStateCount</command:name> <command:verb>Get</command:verb> <command:noun>PWRichProjectStateCount</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWRichProjectStateCount</maml:name> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeyProjectProperty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>KeyProjectProperty</maml:name> <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="0"> <maml:name>OutputFileName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: KeyProjectProperty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>KeyProjectProperty</maml:name> <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:command> <!-- Cmdlet: Convert-PWRichProjectToFolder --> <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>Convert-PWRichProjectToFolder</command:name> <command:verb>Convert</command:verb> <command:noun>PWRichProjectToFolder</command:noun> <maml:description> <maml:para>Converts a Rich Project to a folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Converts the specified rich project to a folder.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Convert-PWRichProjectToFolder</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full folder path of new project to create. Error if already exists.</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: DowngradeSubProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DowngradeSubProjects</maml:name> <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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full folder path of new project to create. Error if already exists.</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: DowngradeSubProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DowngradeSubProjects</maml:name> <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>Example usage for creating a new project from a path</maml:para> </maml:introduction> <dev:code>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</dev:code> <dev:remarks> <maml:para>This converts the specified rich project to a folder.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRichProjectTypes --> <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>Get-PWRichProjectTypes</command:name> <command:verb>Get</command:verb> <command:noun>PWRichProjectTypes</command:noun> <maml:description> <maml:para>Get-PWRichProjectTypes is used to get information pertaining to all ProjectWise Rich Project Types within the active datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>There are no parameters required.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for getting all of the Rich Project Types.</maml:para> <maml:para>Get-PWRichProjectTypes</maml:para> <maml:para>#Example usage for getting specific Rich Project Types</maml:para> <maml:para>Get-PWRichProjectTypes | Where-Object {$_.SystemClass -eq "1" -and $_.ClassDesc -ne "PickLists"}</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWSavedSearch --> <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-PWSavedSearch</command:name> <command:verb>Add</command:verb> <command:noun>PWSavedSearch</command:noun> <maml:description> <maml:para>Create a new saved search.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: OwnerFolder --> <command:syntaxItem> <maml:name>Add-PWSavedSearch</maml:name> <!-- Parameter: OwnerFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OwnerFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: SearchName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Search name.</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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Description</maml:name> <maml:description> <maml:para>Document description to search for. Supports % wildcard.</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: OriginalsOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>OriginalsOnly</maml:name> <maml:description> <maml:para>Set to restrict to active documents.</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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment to search.</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: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable with Attributes to search for. Values support % wildcard for LIKE searches.</maml:para> <maml:para>In script would be like this: @{Attr1 = "Attr 1 value"; Attr2 = "Attr 2 value"; Attr3Wildcard = "Project %" }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: States --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>States</maml:name> <maml:description> <maml:para>Workflow states to search for.</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: UpdatedAfter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>UpdatedAfter</maml:name> <maml:description> <maml:para>Document updated after this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatedBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>UpdatedBefore</maml:name> <maml:description> <maml:para>Document updated before this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ViewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Default view name to assign.</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: SearchFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SearchFolder</maml:name> <maml:description> <maml:para>Folder to search. Will search whole datasource 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: SearchSubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SearchSubFolders</maml:name> <maml:description> <maml:para>Set to search the given folder and its children.</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: SearchText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SearchText</maml:name> <maml:description> <maml:para>Full-text search string.</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: WholePhrase --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WholePhrase</maml:name> <maml:description> <maml:para>Search for the whole phrase.</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: AnyWord --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AnyWord</maml:name> <maml:description> <maml:para>Search for Any Word.</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: SearchAttributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SearchAttributes</maml:name> <maml:description> <maml:para>Search Attributes for text string instead.</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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document name to search for. Supports % wildcard.</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: FileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Document file name to search for. Supports % wildcard.</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: OwnerFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OwnerFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: SearchName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Search name.</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: SearchFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SearchFolder</maml:name> <maml:description> <maml:para>Folder to search. Will search whole datasource 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: SearchSubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SearchSubFolders</maml:name> <maml:description> <maml:para>Set to search the given folder and its children.</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: SearchText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SearchText</maml:name> <maml:description> <maml:para>Full-text search string.</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: WholePhrase --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WholePhrase</maml:name> <maml:description> <maml:para>Search for the whole phrase.</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: AnyWord --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AnyWord</maml:name> <maml:description> <maml:para>Search for Any Word.</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: SearchAttributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SearchAttributes</maml:name> <maml:description> <maml:para>Search Attributes for text string instead.</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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document name to search for. Supports % wildcard.</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: FileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Document file name to search for. Supports % wildcard.</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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Description</maml:name> <maml:description> <maml:para>Document description to search for. Supports % wildcard.</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: OriginalsOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>OriginalsOnly</maml:name> <maml:description> <maml:para>Set to restrict to active documents.</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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment to search.</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: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable with Attributes to search for. Values support % wildcard for LIKE searches.</maml:para> <maml:para>In script would be like this: @{Attr1 = "Attr 1 value"; Attr2 = "Attr 2 value"; Attr3Wildcard = "Project %" }</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: States --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>States</maml:name> <maml:description> <maml:para>Workflow states to search for.</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: UpdatedAfter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>UpdatedAfter</maml:name> <maml:description> <maml:para>Document updated after this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatedBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>UpdatedBefore</maml:name> <maml:description> <maml:para>Document updated before this date.</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ViewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Default view name to assign.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Create a search in each rich project</maml:para> <maml:para>Get-PWRichProjects | Add-PWSavedSearch -SearchName 'PDF Search made by PowerShell' -SearchSubFolders -FileName %.pdf -Verbose</maml:para> <maml:para>#Create a search with attributes and states</maml:para> <maml:para>Get-PWFolders -FolderPath 'Top Level\Project 01' -JustOne | Add-PWSavedSearch -SearchName 'Attribute Search' -SearchFolder 'Top Level\Project 01\PDFs' -SearchSubFolders -FileName %.pdf -Attributes @{DWG_No = "A-7%"; Title = "Detail%" } -States "Draft","Pending Approval" -Verbose</maml:para> <maml:para>#Create a search with dates</maml:para> <maml:para>Get-PWFolders -FolderPath 'Top Level\Project 01' -JustOne | Add-PWSavedSearch -SearchName 'Updated PDFs' -SearchFolder 'Top Level\Project 01\PDFs' -SearchSubFolders -FileName %.pdf -UpdatedAfter 10/11/2017 -Verbose</maml:para> <maml:para>#Create a global search</maml:para> <maml:para>Add-PWSavedSearch -SearchName 'Updated PDFs' -SearchFolder 'Top Level\Project 01\PDFs' -SearchSubFolders -FileName %.pdf -UpdatedAfter 10/11/2017 -Attributes @{DWG_No = "A-7%"; Title = "Detail%" } -States "Draft","Pending Approval" -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWSavedSearch --> <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>Remove-PWSavedSearch</command:name> <command:verb>Remove</command:verb> <command:noun>PWSavedSearch</command:noun> <maml:description> <maml:para>Remove the saved searches for a project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Remove-PWSavedSearch</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to search against. Supports wildcards like 'dave*','bryan*'.</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="2"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>List of search names to search against. Supports wildcards like 'project*','*PDF'.</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: DeleteGlobalTopLevelSearches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DeleteGlobalTopLevelSearches</maml:name> <maml:description> <maml:para>Delete top level, global data source searches.</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: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to search against. Supports wildcards like 'dave*','bryan*'.</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="2"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>List of search names to search against. Supports wildcards like 'project*','*PDF'.</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: DeleteGlobalTopLevelSearches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DeleteGlobalTopLevelSearches</maml:name> <maml:description> <maml:para>Delete top level, global data source searches.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Delete searches that start with "Delete Me"</maml:para> <maml:para>Remove-PWSavedSearch -SearchName "Delete Me*" -Verbose</maml:para> <maml:para>#Get all rich projects in the given tree and remove their saved searches</maml:para> <maml:para>Get-PWRichProjects -FolderPath "Project Parent\EADOC" | Remove-PWSavedSearch</maml:para> <maml:para>#Delete searches belonging to users Dave and Bryan</maml:para> <maml:para>Remove-PWSavedSearch -UserName Dave,Bryan</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWSavedSearches --> <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>Get-PWSavedSearches</command:name> <command:verb>Get</command:verb> <command:noun>PWSavedSearches</command:noun> <maml:description> <maml:para>Get a list of all saved searches within the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Defaults to global saved searches, but user can specify a folder path, an array of folders or whether to return the current user's personal searches.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWSavedSearches</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to search for saved searches.</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: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Project object(s) to search for saved searches.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set this to return the current user's personal searches, otherwise global searches will be returned for the datasource or for the project if one is defined.</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: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Project object(s) to search for saved searches.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseFolder[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to search for saved searches.</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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set this to return the current user's personal searches, otherwise global searches will be returned for the datasource or for the project if one is defined.</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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project object(s) to search for saved searches.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage getting list of global saved searches within the current datasource.</maml:para> <maml:para>#Get the global saved searches within the current datasource.</maml:para> <maml:para>Get-PWSavedSearches</maml:para> <maml:para>#Get the global saved searches within the given folder.</maml:para> <maml:para>Get-PWSavedSearches -FolderPath 'Top Leve\Sub Level\Sub Level2'</maml:para> <maml:para>#Get the current user's saved searches within the given folder.</maml:para> <maml:para>Get-PWSavedSearches -FolderPath 'Top Leve\Sub Level\Sub Level2' -Personal</maml:para> <maml:para>#Get the current user's saved searches at the top level of the datasource.</maml:para> <maml:para>Get-PWSavedSearches -Personal</maml:para> <maml:para>#Get the current user's saved searches for all the projects in the given path.</maml:para> <maml:para>Get-PWRichProjects -FolderPath 'Top Level\Projects' | Get-PWSavedSearches -Personal</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Select-PWSQL --> <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-PWSQL</command:name> <command:verb>Select</command:verb> <command:noun>PWSQL</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Select-PWSQL</maml:name> <!-- Parameter: SQLSelectStatement --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SQLSelectStatement</maml:name> <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="1"> <maml:name>OutputFile</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WriteFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WriteFile</maml:name> <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: SQLSelectStatement --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SQLSelectStatement</maml:name> <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="1"> <maml:name>OutputFile</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WriteFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WriteFile</maml:name> <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:command> <!-- Cmdlet: Update-PWSQL --> <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-PWSQL</command:name> <command:verb>Update</command:verb> <command:noun>PWSQL</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWSQL</maml:name> <!-- Parameter: SecretPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SecretPassword</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SQLCommand --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SQLCommand</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SQLCommandFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SQLCommandFile</maml:name> <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: SQLCommand --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SQLCommand</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SQLCommandFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SQLCommandFile</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SecretPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SecretPassword</maml:name> <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:command> <!-- Cmdlet: Select-PWSQLDataTable --> <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-PWSQLDataTable</command:name> <command:verb>Select</command:verb> <command:noun>PWSQLDataTable</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Select-PWSQLDataTable</maml:name> <!-- Parameter: SQLSelectStatement --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SQLSelectStatement</maml:name> <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> <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: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: New-PWState --> <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-PWState</command:name> <command:verb>New</command:verb> <command:noun>PWState</command:noun> <maml:description> <maml:para>Adds new state to the current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWState</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <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: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <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>#Example usage for New-PWState.</maml:para> <maml:para>#Will return a state object for the new state in the current datasource.</maml:para> <maml:para>New-PWState -Name 'Review' -Description 'Reveiw State'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWState --> <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>Remove-PWState</command:name> <command:verb>Remove</command:verb> <command:noun>PWState</command:noun> <maml:description> <maml:para>Removes the specified state from current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWState</maml:name> <!-- Parameter: StateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>StateName</maml:name> <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: StateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>StateName</maml:name> <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>#Example usage for Remove-PWState.</maml:para> <maml:para>#Will return "true" if the state is successfully removed from the current datasource.</maml:para> <maml:para>Remove-PWState -StateName 'Approved'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWStates --> <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>Get-PWStates</command:name> <command:verb>Get</command:verb> <command:noun>PWStates</command:noun> <maml:description> <maml:para>Returns all state objects from current datasource.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for Get-PWStates.</maml:para> <maml:para>#Will return all state objects from current datasource.</maml:para> <maml:para>Get-PWStates</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWStatistics --> <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>Get-PWStatistics</command:name> <command:verb>Get</command:verb> <command:noun>PWStatistics</command:noun> <maml:description> <maml:para>Reports on statistics from datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWStatistics</maml:name> <!-- Parameter: ForceRefresh --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ForceRefresh</maml:name> <maml:description> <maml:para>Force statistics to be recalculated. Can cause severe performance degradation. Use cautiously.</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: IgnoreLastLoginCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IgnoreLastLoginCount</maml:name> <maml:description> <maml:para>Calculating the last login count can take a substantial amount of time. You may want to skip it.</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: ForceRefresh --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ForceRefresh</maml:name> <maml:description> <maml:para>Force statistics to be recalculated. Can cause severe performance degradation. Use cautiously.</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: IgnoreLastLoginCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IgnoreLastLoginCount</maml:name> <maml:description> <maml:para>Calculating the last login count can take a substantial amount of time. You may want to skip it.</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>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Get all datasource statistics</maml:para> <maml:para>Get-PWStatistics -ForceRefresh -IgnoreLastLoginCount</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWStorageArea --> <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-PWStorageArea</command:name> <command:verb>New</command:verb> <command:noun>PWStorageArea</command:noun> <maml:description> <maml:para>Create a new storage area. Like the name says. Returns a Storage object on the pipeline.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new storage area. Returns a Storage object on the pipeline.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWStorageArea</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</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: HostName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Machine 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: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path for storage area (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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of storage area.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</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: HostName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Machine 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: Path --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path for storage area (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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of storage area.</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>New-PWStorageArea -Name "New Storage" -HostName MachineName -Path "c:\pwstore\New Storage" -Description "New Storage Description"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWStorageAreaForProjectTree --> <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-PWStorageAreaForProjectTree</command:name> <command:verb>Update</command:verb> <command:noun>PWStorageAreaForProjectTree</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWStorageAreaForProjectTree</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewStorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewStorageArea</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotDeleteFromSourceStorage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotDeleteFromSourceStorage</maml:name> <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: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JustOne</maml:name> <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: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseAdminPaths</maml:name> <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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewStorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewStorageArea</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotDeleteFromSourceStorage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotDeleteFromSourceStorage</maml:name> <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: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>JustOne</maml:name> <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: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseAdminPaths</maml:name> <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:command> <!-- Cmdlet: Get-PWStorageAreaList --> <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>Get-PWStorageAreaList</command:name> <command:verb>Get</command:verb> <command:noun>PWStorageAreaList</command:noun> <maml:description> <maml:para>Lists available storage areas.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWStorageAreaList</maml:name> <!-- Parameter: StorageAreaNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>StorageAreaNames</maml:name> <maml:description> <maml:para>Array of storage area names to list.</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: StorageAreaNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>StorageAreaNames</maml:name> <maml:description> <maml:para>Array of storage area names to list.</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>Get-PWStorageAreaList -StorageAreaNames "Storage 1","Storage 2","Project Office"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWStorageDiskUsage --> <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>Get-PWStorageDiskUsage</command:name> <command:verb>Get</command:verb> <command:noun>PWStorageDiskUsage</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputStorageAreas --> <command:syntaxItem> <maml:name>Get-PWStorageDiskUsage</maml:name> <!-- Parameter: InputStorageAreas --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputStorageAreas</maml:name> <command:parameterValue required="true">Storage[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.Storage[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAreaName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>StorageAreaName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ThresholdPercentFree --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ThresholdPercentFree</maml:name> <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: InputStorageAreas --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputStorageAreas</maml:name> <command:parameterValue required="true">Storage[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.Storage[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StorageAreaName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>StorageAreaName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ThresholdPercentFree --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ThresholdPercentFree</maml:name> <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:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.Storage[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Add-PWTagDocumentProperty --> <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-PWTagDocumentProperty</command:name> <command:verb>Add</command:verb> <command:noun>PWTagDocumentProperty</command:noun> <maml:description> <maml:para>Add a binding to a tag in a tagset for attribute exchange for a document property. Arguments are a tag name, a tagset name, a tagset type (one of MicroStation, AutoCAD or MSOffice) and the document property to use.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Name --> <command:syntaxItem> <maml:name>Add-PWTagDocumentProperty</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if 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: TagSetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset for tag name (Required). Will create if 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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Document Property to bind to Tag (Required).</maml:para> <maml:para>Possible values: DocCreateDate, DocCreator, DocCreatorDesc, DocDepartDesc, DocDepartment, DocDescription, DocFileName, DocFileUpdateDate, DocFileUpdaterDesc, DocFileUpdaterName, DocGUID, DocManagerDesc, DocManagerName, DocName, DocNumber, DocSize, DocStorage, DocStorageDesc, DocUpdateDate, DocUpdater, DocUpdaterDesc, DocUserDesc, DocUserName, DocVersion, DocVersionSeq, DocWorkflowDesc, DocWorkflowName, DocWorkflowStateDesc, DocWorkflowStateName, DocWorkspaceProfileDesc, DocWorkfspaceFrofileName</maml:para> </maml:description> <command:parameterValue required="true">AttributeExchangeDocumentProperties</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AttributeExchangeDocumentProperties</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DocCreateDate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DocCreateDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocCreator</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocCreatorDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocDepartDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocDepartment</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocDescription</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocFileName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocFileUpdateDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocFileUpdaterDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocFileUpdaterName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocGUID</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocManagerDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocManagerName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocNumber</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocSize</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocStorage</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocStorageDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocUpdateDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocUpdater</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocUpdaterDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocUserDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocUserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocVersionSeq</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkflowDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkflowName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkflowStateDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkflowStateName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkspaceProfileDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkfspaceFrofileName</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if 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: TagSetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset for tag name (Required). Will create if 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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Document Property to bind to Tag (Required).</maml:para> <maml:para>Possible values: DocCreateDate, DocCreator, DocCreatorDesc, DocDepartDesc, DocDepartment, DocDescription, DocFileName, DocFileUpdateDate, DocFileUpdaterDesc, DocFileUpdaterName, DocGUID, DocManagerDesc, DocManagerName, DocName, DocNumber, DocSize, DocStorage, DocStorageDesc, DocUpdateDate, DocUpdater, DocUpdaterDesc, DocUserDesc, DocUserName, DocVersion, DocVersionSeq, DocWorkflowDesc, DocWorkflowName, DocWorkflowStateDesc, DocWorkflowStateName, DocWorkspaceProfileDesc, DocWorkfspaceFrofileName</maml:para> </maml:description> <command:parameterValue required="true">AttributeExchangeDocumentProperties</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AttributeExchangeDocumentProperties</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>DocCreateDate</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">DocCreateDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocCreator</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocCreatorDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocDepartDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocDepartment</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocDescription</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocFileName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocFileUpdateDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocFileUpdaterDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocFileUpdaterName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocGUID</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocManagerDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocManagerName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocNumber</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocSize</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocStorage</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocStorageDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocUpdateDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocUpdater</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocUpdaterDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocUserDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocUserName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocVersionSeq</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkflowDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkflowName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkflowStateDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkflowStateName</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkspaceProfileDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocWorkfspaceFrofileName</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if does not exist.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-PWTagDocumentProperty -Name 'Tag01' -TagSetName 'New Tagset' -TagSetType MicroStation -Property DocName -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWTagEnvironmentAttribute --> <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-PWTagEnvironmentAttribute</command:name> <command:verb>Add</command:verb> <command:noun>PWTagEnvironmentAttribute</command:noun> <maml:description> <maml:para>Add a binding to a tag in a tagset for attribute exchange for an environment attribute. Arguments are a tag name, a tagset name, a tagset type (one of MicroStation, AutoCAD or MSOffice), the environment name and an attribute name.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Name --> <command:syntaxItem> <maml:name>Add-PWTagEnvironmentAttribute</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if 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: TagSetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset for tag name (Required). Will create if 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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if 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: TagSetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset for tag name (Required). Will create if 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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if does not exist.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-PWTagProjectProperty -Name 'Tag01' -TagSetName 'New Tagset' -TagSetType MicroStation -Property FolderName -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWTagFolderProperty --> <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-PWTagFolderProperty</command:name> <command:verb>Add</command:verb> <command:noun>PWTagFolderProperty</command:noun> <maml:description> <maml:para>Add a binding to a tag in a tagset for attribute exchange for a folder property. Arguments are a tag name, a tagset name, a tagset type (one of MicroStation, AutoCAD or MSOffice) and the folder property to use.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Name --> <command:syntaxItem> <maml:name>Add-PWTagFolderProperty</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if 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: TagSetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset for tag name (Required). Will create if 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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Folder Property to bind to Tag (Required).</maml:para> <maml:para>Possible values: FolderCode, FolderCreateDate, FolderCreator, FolderCreatorDesc, FolderDescription, FolderGUID, FolderManager, FolderManagerDesc, FolderName, FolderNumber, FolderStorage, FolderStorageDesc, FolderUpdateDate, FolderUpdater, FolderUpdaterDesc, FolderVersion, FolderVersionSeq, FolderWorkflowDesc, FolderWorkflowName, FolderWorkflowStateDesc, FolderWorkflowStateName, FolderWorkspaceProfileDesc, FolderWorkfspaceFrofileName</maml:para> </maml:description> <command:parameterValue required="true">AttributeExchangeFolderProperties</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AttributeExchangeFolderProperties</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>FolderCode</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">FolderCode</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderCreateDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderCreator</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderCreatorDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderDescription</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderGUID</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderManager</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderManagerDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderName</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderNumber</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderStorage</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderStorageDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderUpdateDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderUpdater</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderUpdaterDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderVersionSeq</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkflowDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkflowName</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkflowStateDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkflowStateName</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkspaceProfileDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkfspaceFrofileName</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if 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: TagSetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset for tag name (Required). Will create if 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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Property</maml:name> <maml:description> <maml:para>Folder Property to bind to Tag (Required).</maml:para> <maml:para>Possible values: FolderCode, FolderCreateDate, FolderCreator, FolderCreatorDesc, FolderDescription, FolderGUID, FolderManager, FolderManagerDesc, FolderName, FolderNumber, FolderStorage, FolderStorageDesc, FolderUpdateDate, FolderUpdater, FolderUpdaterDesc, FolderVersion, FolderVersionSeq, FolderWorkflowDesc, FolderWorkflowName, FolderWorkflowStateDesc, FolderWorkflowStateName, FolderWorkspaceProfileDesc, FolderWorkfspaceFrofileName</maml:para> </maml:description> <command:parameterValue required="true">AttributeExchangeFolderProperties</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AttributeExchangeFolderProperties</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>FolderCode</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">FolderCode</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderCreateDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderCreator</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderCreatorDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderDescription</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderGUID</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderManager</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderManagerDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderName</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderNumber</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderStorage</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderStorageDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderUpdateDate</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderUpdater</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderUpdaterDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderVersionSeq</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkflowDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkflowName</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkflowStateDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkflowStateName</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkspaceProfileDesc</command:parameterValue> <command:parameterValue required="false" variableLength="false">FolderWorkfspaceFrofileName</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if does not exist.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-PWTagFolderProperty -Name 'Tag01' -TagSetName 'New Tagset' -TagSetType MicroStation -Property FolderName -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWTagMappings --> <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-PWTagMappings</command:name> <command:verb>Export</command:verb> <command:noun>PWTagMappings</command:noun> <maml:description> <maml:para>Export a report suitable for reimport with tag and attribute mappings.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: OutputFile --> <command:syntaxItem> <maml:name>Export-PWTagMappings</maml:name> <!-- Parameter: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Name of file to export to.</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: TagSetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset for export (optional). Will export all 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: TagSetType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to export (optional). Will export all if not provided (MicroStation, AutoCAD and MSOffice).</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice, All</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetTypeWithAll</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetTypeWithAll</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Name of file to export to.</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: TagSetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset for export (optional). Will export all 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: TagSetType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to export (optional). Will export all if not provided (MicroStation, AutoCAD and MSOffice).</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice, All</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetTypeWithAll</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetTypeWithAll</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of file to export to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Export-PWTagMappings -OutputFile c:\temp\tagMappings01.xlsx -TagSetName 'New Tagset' -TagSetType MicroStation -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWTagMappings --> <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-PWTagMappings</command:name> <command:verb>Import</command:verb> <command:noun>PWTagMappings</command:noun> <maml:description> <maml:para>Import spreadsheet suitable for reimport with tag and attribute mappings.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFile --> <command:syntaxItem> <maml:name>Import-PWTagMappings</maml:name> <!-- Parameter: InputFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Name of file to import.</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: TagSetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset to import (optional). Will import all 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: TagSetType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to import (optional). Will import all if not provided (MicroStation, AutoCAD and MSOffice).</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice, All</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetTypeWithAll</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetTypeWithAll</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Name of file to import.</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: TagSetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset to import (optional). Will import all 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: TagSetType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to import (optional). Will import all if not provided (MicroStation, AutoCAD and MSOffice).</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice, All</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetTypeWithAll</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetTypeWithAll</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of file to import.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Export-PWTagMappings -OutputFile c:\temp\tagMappings01.xlsx -TagSetName 'New Tagset' -TagSetType MicroStation -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWTagProjectProperty --> <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-PWTagProjectProperty</command:name> <command:verb>Add</command:verb> <command:noun>PWTagProjectProperty</command:noun> <maml:description> <maml:para>Add a binding to a tag in a tagset for attribute exchange for a project property. Arguments are a tag name, a tagset name, a tagset type (one of MicroStation, AutoCAD or MSOffice), the project type and the project property.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Name --> <command:syntaxItem> <maml:name>Add-PWTagProjectProperty</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if 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: TagSetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset for tag name (Required). Will create if 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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ProjectType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ProjectType</maml:name> <maml:description> <maml:para>Project type 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: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Property</maml:name> <maml:description> <maml:para>Project property 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if 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: TagSetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset for tag name (Required). Will create if 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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ProjectType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ProjectType</maml:name> <maml:description> <maml:para>Project type 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: Property --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Property</maml:name> <maml:description> <maml:para>Project property 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of tag to add document property binding for (Required). Will create if does not exist.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-PWTagProjectProperty -Name 'Tag01' -TagSetName 'New Tagset' -TagSetType MicroStation -Property FolderName -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWTags --> <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-PWTags</command:name> <command:verb>Add</command:verb> <command:noun>PWTags</command:noun> <maml:description> <maml:para>Add a tag to a tagset for attribute exchange. Arguments are an array of tag names to add, the name of the tagset to add them to and the type of the tagset (one of MicroStation, AutoCAD or MSOffice).</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Names --> <command:syntaxItem> <maml:name>Add-PWTags</maml:name> <!-- Parameter: Names --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Names</maml:name> <maml:description> <maml:para>Names of tags to add to tagset (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: TagSetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset to add tags to (Required). Will create if 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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Names --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Names</maml:name> <maml:description> <maml:para>Names of tags to add to tagset (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: TagSetName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>Name of tagset to add tags to (Required). Will create if 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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Names of tags to add to tagset (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-PWTags 'Tag01','Tag02','Tag03' -TagSetName 'New Tagset' -TagSetType MicroStation -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWTagSet --> <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-PWTagSet</command:name> <command:verb>Add</command:verb> <command:noun>PWTagSet</command:noun> <maml:description> <maml:para>Add a tagset for attribute exchange. Arguments are tagset Name and tagset Type which is one of MicroStation, AutoCAD or MSOffice.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Name --> <command:syntaxItem> <maml:name>Add-PWTagSet</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tagset to add (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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tagset to add (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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of tagset to add (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-PWTagset -Name 'New Tagset' -TagSetType MicroStation -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWTagSet --> <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>Remove-PWTagSet</command:name> <command:verb>Remove</command:verb> <command:noun>PWTagSet</command:noun> <maml:description> <maml:para>Remove a tagset for attribute exchange. Arguments are tagset Name and tagset Type which is one of MicroStation, AutoCAD or MSOffice.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Name --> <command:syntaxItem> <maml:name>Remove-PWTagSet</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tagset to add (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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of tagset to add (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: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of tagset to add (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-PWTagset -Name 'New Tagset' -TagSetType MicroStation -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWTagSets --> <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>Get-PWTagSets</command:name> <command:verb>Get</command:verb> <command:noun>PWTagSets</command:noun> <maml:description> <maml:para>List the tagsets defined for a tagset Type which is one of MicroStation, AutoCAD or MSOffice.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWTagSets</maml:name> <!-- Parameter: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TagSetType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TagSetType</maml:name> <maml:description> <maml:para>Type of tagset to add (Required). Must be one of MicroStation, AutoCAD or MSOffice.</maml:para> <maml:para>Possible values: MicroStation, AutoCAD, MSOffice</maml:para> </maml:description> <command:parameterValue required="true">PWTagSetType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWTagSetType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>MicroStation</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">MicroStation</command:parameterValue> <command:parameterValue required="false" variableLength="false">AutoCAD</command:parameterValue> <command:parameterValue required="false" variableLength="false">MSOffice</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWTagsets -TagSetType MicroStation</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># Create up 100000 test documents in the empty folders under "Import Test\Folder 01"</maml:para> <maml:para>Add-PWTestDocumentsInFolders -NumDocuments 100000 -TargetPWFolder "Import Test\Folder 01" -SourceFile c:\temp\dummy.txt</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserAdminRights --> <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>Set-PWUserAdminRights</command:name> <command:verb>Set</command:verb> <command:noun>PWUserAdminRights</command:noun> <maml:description> <maml:para>Upgrade an existing user to be an administrator.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Set-PWUserAdminRights</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Array of user names.</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> <!-- Parameter set: UserId --> <command:syntaxItem> <maml:name>Set-PWUserAdminRights</maml:name> <!-- Parameter: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Array of user ids.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Set-PWUserAdminRights</maml:name> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Array of user names.</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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Array of user ids.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user names.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user ids.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUsersBySearch -UserName 'pwadmin','ics_admin' | Set-PWUserAdminRights</maml:para> <maml:para>New-PWUserSimple 'pwadmin' | Set-PWUserAdminRights</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUserByLastLogin --> <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>Get-PWUserByLastLogin</command:name> <command:verb>Get</command:verb> <command:noun>PWUserByLastLogin</command:noun> <maml:description> <maml:para>Get users by the user's last login.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWUserByLastLogin</maml:name> <!-- Parameter: DaysAgo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DaysAgo</maml:name> <maml:description> <maml:para>Defines the login window in days to use.</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: Since --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Since</maml:name> <maml:description> <maml:para>Use this to get the logins within the window. Without this switch, will default to listing users with last logins outside the window (older) and users who have never logged in.</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: DaysAgo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DaysAgo</maml:name> <maml:description> <maml:para>Defines the login window in days to use.</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: Since --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Since</maml:name> <maml:description> <maml:para>Use this to get the logins within the window. Without this switch, will default to listing users with last logins outside the window (older) and users who have never logged in.</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>Get-PWUserByLastLogin -DaysAgo 30 -Since"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserDisabled --> <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>Set-PWUserDisabled</command:name> <command:verb>Set</command:verb> <command:noun>PWUserDisabled</command:noun> <maml:description> <maml:para>Disable list of users from the pipeline or by search to a named group.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Set-PWUserDisabled</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to add.</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> <!-- Parameter set: UserId --> <command:syntaxItem> <maml:name>Set-PWUserDisabled</maml:name> <!-- Parameter: UserId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Set-PWUserDisabled</maml:name> <!-- Parameter: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to add.</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: UserId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of user names to add.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Set-PWUserDisabled</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserEnabled --> <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>Set-PWUserEnabled</command:name> <command:verb>Set</command:verb> <command:noun>PWUserEnabled</command:noun> <maml:description> <maml:para>Disable list of users from the pipeline or by search to a named group.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Set-PWUserEnabled</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</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> <!-- Parameter set: UserId --> <command:syntaxItem> <maml:name>Set-PWUserEnabled</maml:name> <!-- Parameter: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Set-PWUserEnabled</maml:name> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Set-PWUserDisabled</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWUserFromGroup --> <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>Remove-PWUserFromGroup</command:name> <command:verb>Remove</command:verb> <command:noun>PWUserFromGroup</command:noun> <maml:description> <maml:para>Remove users from the pipeline or by search from a named group.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Remove-PWUserFromGroup</maml:name> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>User list 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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</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> <!-- Parameter set: UserId --> <command:syntaxItem> <maml:name>Remove-PWUserFromGroup</maml:name> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>User list 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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Remove-PWUserFromGroup</maml:name> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>User list 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>User list 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Remove-PWUserFromGroup -GroupName Administrators</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWUserFromUserList --> <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>Remove-PWUserFromUserList</command:name> <command:verb>Remove</command:verb> <command:noun>PWUserFromUserList</command:noun> <maml:description> <maml:para>Remove users from the pipeline or by search to a named user list.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Remove-PWUserFromUserList</maml:name> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list 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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</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> <!-- Parameter set: UserId --> <command:syntaxItem> <maml:name>Remove-PWUserFromUserList</maml:name> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list 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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Remove-PWUserFromUserList</maml:name> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Remove-PWUserFromUserList -UserList "Project 10100 Engineers"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserLicenseSource --> <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>Set-PWUserLicenseSource</command:name> <command:verb>Set</command:verb> <command:noun>PWUserLicenseSource</command:noun> <maml:description> <maml:para>Set the license source for the indicated users.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputUsers --> <command:syntaxItem> <maml:name>Set-PWUserLicenseSource</maml:name> <!-- Parameter: InputUsers --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUsers</maml:name> <maml:description> <maml:para>Target user object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Bentley.ProjectWise.PowerShell.Common.User[]</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputUsers --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUsers</maml:name> <maml:description> <maml:para>Target user object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Bentley.ProjectWise.PowerShell.Common.User[]</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target user object(s) from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUsersByMatch -UserName 'dave*','bryan*' | Set-PWUserLicenseSource -UseClient</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUserListNames --> <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>Get-PWUserListNames</command:name> <command:verb>Get</command:verb> <command:noun>PWUserListNames</command:noun> <maml:description> <maml:para>Get list of user list names.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Remove users from a user list</maml:para> <maml:para>$userlistNames = Get-PWUserListNames</maml:para> <maml:para>$users = Get-PWUsersByMatch -UserName 'dave*','bryan*'</maml:para> <maml:para>foreach ($ul in $userListName)</maml:para> <maml:para>{</maml:para> <maml:para>Remove-PWUserFromUserList $users -UserList $ul</maml:para> <maml:para>}</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserListOwners --> <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>Set-PWUserListOwners</command:name> <command:verb>Set</command:verb> <command:noun>PWUserListOwners</command:noun> <maml:description> <maml:para>Set-PWUserListOwners is used to add a user/group/userlist to the Owners of a UserList.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-PWUserListOwners is used to add a user/group/userlist to the Owners of a UserList. Requires a UserListName, Owner, and OwnerType (Possible entries: u, g, ul)</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWUserListOwners</maml:name> <!-- Parameter: UserListName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserListName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Owner --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Owner</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OwnerType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OwnerType</maml:name> <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: UserListName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserListName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OwnerType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OwnerType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Owner --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Owner</maml:name> <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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for adding a user to the Owners of the specified UserList.</maml:para> <maml:para>Set-PWPWUserListOwners -UserListName 'MyNewUserList' -Owner 'MyUserName' -OwnerType 'u'</maml:para> <maml:para>#Example usage for adding a group to the Owners of the specified UserList.</maml:para> <maml:para>Set-PWPWUserListOwners -UserListName 'MyNewUserList' -Owner 'MyGroup' -OwnerType 'g'</maml:para> <maml:para>#Example usage for adding a userlist to the Owners of the specified UserList.</maml:para> <maml:para>Set-PWPWUserListOwners -UserListName 'MyNewUserList' -Owner 'ULA' -OwnerType 'ul'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUserListsByMember --> <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>Get-PWUserListsByMember</command:name> <command:verb>Get</command:verb> <command:noun>PWUserListsByMember</command:noun> <maml:description> <maml:para>Returns all userlists the specified member belongs to.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWUserListsByMember</maml:name> <!-- Parameter: MemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MemberName</maml:name> <maml:description> <maml:para>User name to return userlist membership information. (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: MemberType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MemberType</maml:name> <maml:description> <maml:para>User name to return userlist membership information. (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: MemberName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>MemberName</maml:name> <maml:description> <maml:para>User name to return userlist membership information. (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: MemberType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MemberType</maml:name> <maml:description> <maml:para>User name to return userlist membership information. (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 /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUserListsByMember -MamberName 'admin' -MemberType user</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUserListsByMember -MamberName 'administrators' -MemberType group</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUserListsByMember -MamberName 'Managers' -MemberType userlist</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUserListsByUser --> <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>Get-PWUserListsByUser</command:name> <command:verb>Get</command:verb> <command:noun>PWUserListsByUser</command:noun> <maml:description> <maml:para>Returns all userlists the user is a member of.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Get-PWUserListsByUser</maml:name> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name to return userlist membership information. (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: UserName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name to return userlist membership information. (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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User name to return userlist membership information. (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUserListsByUser -UserName 'admin'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserNewNameAndDomain --> <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>Set-PWUserNewNameAndDomain</command:name> <command:verb>Set</command:verb> <command:noun>PWUserNewNameAndDomain</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWUserNewNameAndDomain</maml:name> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Domain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewUserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>NewUserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewDomain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>NewDomain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangeToLogical --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ChangeToLogical</maml:name> <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: PasswordPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PasswordPrefix</maml:name> <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: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Domain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewUserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>NewUserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewDomain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>NewDomain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ChangeToLogical --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ChangeToLogical</maml:name> <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: PasswordPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PasswordPrefix</maml:name> <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:command> <!-- Cmdlet: Clear-PWUserRichProjectRights --> <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>Clear-PWUserRichProjectRights</command:name> <command:verb>Clear</command:verb> <command:noun>PWUserRichProjectRights</command:noun> <maml:description> <maml:para>Remove the rights for a user/user list/group to create/delete/modify rich projects.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Clear-PWUserRichProjectRights</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name.</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: ProjectAccess --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectAccess</maml:name> <maml:description> <maml:para>Rights to add. CANCHANGE/MODIFY/DELETE/CREATE/ALL.</maml:para> <maml:para>Possible values: CANCHANGE, CREATE, MODIFY, DELETE, ALL</maml:para> </maml:description> <command:parameterValue required="true">RichProjectAccess</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.RichProjectAccess</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CANCHANGE</command:parameterValue> <command:parameterValue required="false" variableLength="false">CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">ALL</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list name.</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: Group --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group name.</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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name.</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: ProjectAccess --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectAccess</maml:name> <maml:description> <maml:para>Rights to add. CANCHANGE/MODIFY/DELETE/CREATE/ALL.</maml:para> <maml:para>Possible values: CANCHANGE, CREATE, MODIFY, DELETE, ALL</maml:para> </maml:description> <command:parameterValue required="true">RichProjectAccess</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.RichProjectAccess</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CANCHANGE</command:parameterValue> <command:parameterValue required="false" variableLength="false">CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">ALL</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list name.</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: Group --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group name.</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>#Remove all project access for a user</maml:para> <maml:para>Clear-PWUserRichProjectRights -UserName 'dave' -ProjectAccess ALL</maml:para> <maml:para>#Remove project delete rights for a user list</maml:para> <maml:para>Clear-PWUserRichProjectRights -UserList 'Project Managers' -ProjectAccess DELETE</maml:para> <maml:para>#Remove project modify rights for a group</maml:para> <maml:para>Clear-PWUserRichProjectRights -Group 'New Dheli Office' -ProjectAccess MODIFY</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserRichProjectRights --> <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>Set-PWUserRichProjectRights</command:name> <command:verb>Set</command:verb> <command:noun>PWUserRichProjectRights</command:noun> <maml:description> <maml:para>Set the rights for a user to create/delete/modify rich projects.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWUserRichProjectRights</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name.</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: ProjectAccess --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectAccess</maml:name> <maml:description> <maml:para>Rights to add. CANCHANGE/MODIFY/DELETE/CREATE/ALL.</maml:para> <maml:para>Possible values: CANCHANGE, CREATE, MODIFY, DELETE, ALL</maml:para> </maml:description> <command:parameterValue required="true">RichProjectAccess</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.RichProjectAccess</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CANCHANGE</command:parameterValue> <command:parameterValue required="false" variableLength="false">CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">ALL</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list name.</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: Group --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group name.</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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User name.</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: ProjectAccess --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectAccess</maml:name> <maml:description> <maml:para>Rights to add. CANCHANGE/MODIFY/DELETE/CREATE/ALL.</maml:para> <maml:para>Possible values: CANCHANGE, CREATE, MODIFY, DELETE, ALL</maml:para> </maml:description> <command:parameterValue required="true">RichProjectAccess</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.RichProjectAccess</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CANCHANGE</command:parameterValue> <command:parameterValue required="false" variableLength="false">CREATE</command:parameterValue> <command:parameterValue required="false" variableLength="false">MODIFY</command:parameterValue> <command:parameterValue required="false" variableLength="false">DELETE</command:parameterValue> <command:parameterValue required="false" variableLength="false">ALL</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list name.</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: Group --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group name.</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>#Set project access for a user</maml:para> <maml:para>Set-PWUserRichProjectRights -UserName 'dave' -ProjectAccess ALL</maml:para> <maml:para>#Set project delete for a user list</maml:para> <maml:para>Set-PWUserRichProjectRights -UserList 'Project Managers' -ProjectAccess DELETE</maml:para> <maml:para>#Set project modify for a group</maml:para> <maml:para>Set-PWUserRichProjectRights -Group 'New Dheli Office' -ProjectAccess MODIFY</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUsersByMatch --> <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>Get-PWUsersByMatch</command:name> <command:verb>Get</command:verb> <command:noun>PWUsersByMatch</command:noun> <maml:description> <maml:para>Get list of ProjectWise users by list of names or ids or security providers or emails. Produces inclusive list of all search parameters, i.e. OR's them all together.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWUsersByMatch</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to return.</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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserId</maml:name> <maml:description> <maml:para>List of user ids to return.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SecProvider --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SecProvider</maml:name> <maml:description> <maml:para>List of security providers to match on.</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: Email --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Email</maml:name> <maml:description> <maml:para>List of emails to match on.</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: Disabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Set to return just disabled users.</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: Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Set to return just enabled users.</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: LastLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>LastLogin</maml:name> <maml:description> <maml:para>Get last login. This greatly slows down the query.</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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to return.</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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserId</maml:name> <maml:description> <maml:para>List of user ids to return.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SecProvider --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SecProvider</maml:name> <maml:description> <maml:para>List of security providers to match on.</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: Email --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Email</maml:name> <maml:description> <maml:para>List of emails to match on.</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: Disabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>Set to return just disabled users.</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: Enabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Set to return just enabled users.</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: LastLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>LastLogin</maml:name> <maml:description> <maml:para>Get last login. This greatly slows down the query.</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 return users which match either or the name wildcards OR users matching the Email wildcard</maml:para> <maml:para>Get-PWUsersByMatch -UserName 'dave*','bryan*' -Email '*@bentley.com'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWUserSimple --> <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-PWUserSimple</command:name> <command:verb>New</command:verb> <command:noun>PWUserSimple</command:noun> <maml:description> <maml:para>Add Windows or Logical user with no dependency on PWPS.dll.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserNames --> <command:syntaxItem> <maml:name>New-PWUserSimple</maml:name> <!-- Parameter: UserNames --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>New user names. (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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>User Description.</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: SecurityProvider --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityProvider</maml:name> <maml:description> <maml:para>Security Provider.</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: Email --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email.</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: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password. Leave blank for single sign-on</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserNames --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>New user names. (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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>User Description.</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: SecurityProvider --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityProvider</maml:name> <maml:description> <maml:para>Security Provider.</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: Email --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email.</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: Password --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password. Leave blank for single sign-on</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</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>#create logical users using secure string password</maml:para> <maml:para>New-PWUserSimple "MyNewUserName","YourNewUserName" -Password $secureString</maml:para> <maml:para>#create domain user</maml:para> <maml:para>New-PWUserSimple Win.User -SecurityProvider YourDomain -Email Win.User@YourDomain.com</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUsersInGroup --> <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>Get-PWUsersInGroup</command:name> <command:verb>Get</command:verb> <command:noun>PWUsersInGroup</command:noun> <maml:description> <maml:para>Get users in a named group.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: GroupName --> <command:syntaxItem> <maml:name>Get-PWUsersInGroup</maml:name> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group name to add users to (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: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group name to add users to (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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Group name to add users to (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUsersInGroup Adminstrators | Set-PWUserAdminRights</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUsersInUserList --> <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>Get-PWUsersInUserList</command:name> <command:verb>Get</command:verb> <command:noun>PWUsersInUserList</command:noun> <maml:description> <maml:para>Get users in a user list.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserList --> <command:syntaxItem> <maml:name>Get-PWUsersInUserList</maml:name> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserList</maml:name> <maml:description> <maml:para>Group name to add users to (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: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserList</maml:name> <maml:description> <maml:para>Group name to add users to (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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Group name to add users to (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUsersInUserList 'Project Engineers' | Set-PWUserDisabled</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWUsersToConnectedProject --> <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-PWUsersToConnectedProject</command:name> <command:verb>Add</command:verb> <command:noun>PWUsersToConnectedProject</command:noun> <maml:description> <maml:para>Takes an array of user objects from the pipeline and associates them with the CONNECTed project associated with the rich project given a ProjectWise folder path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of user objects from the pipeline and associates them with the CONNECTed project associated with the rich project given a ProjectWise folder path. You can specify the rights each user should be given. Only users with email addresses specified will be added to the CONNECTed project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputUsers --> <command:syntaxItem> <maml:name>Add-PWUsersToConnectedProject</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path to the rich project from which we'll find the associated CONNECTed project.</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: InputUsers --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUsers</maml:name> <maml:description> <maml:para>Array of ProjectWise User objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Review --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Review</maml:name> <maml:description> <maml:para>Set to grant Review privileges to the users.</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: Issue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Issue</maml:name> <maml:description> <maml:para>Set to grant Issue privileges to the users.</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: Receive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Receive</maml:name> <maml:description> <maml:para>Set to grant Receive privileges to the users.</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: Administrator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Administrator</maml:name> <maml:description> <maml:para>Set to grant Administrator privileges to the users.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Will use current CONNECT client session 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Will use current CONNECT client session if not set.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputUsers --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUsers</maml:name> <maml:description> <maml:para>Array of ProjectWise User objects from the pipeline.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path to the rich project from which we'll find the associated CONNECTed project.</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: Review --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Review</maml:name> <maml:description> <maml:para>Set to grant Review privileges to the users.</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: Issue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Issue</maml:name> <maml:description> <maml:para>Set to grant Issue privileges to the users.</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: Receive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Receive</maml:name> <maml:description> <maml:para>Set to grant Receive privileges to the users.</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: Administrator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Administrator</maml:name> <maml:description> <maml:para>Set to grant Administrator privileges to the users.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Will use current CONNECT client session 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Will use current CONNECT client session if not set.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of ProjectWise User objects from the pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for adding users to a CONNECTED project.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Will add the users with email who have logged in within the last year to the CONNECTed Project associated with the ProjectWise Rich Project identified by that path</maml:para> <maml:para>Get-PWUserByLastLogin -DaysAgo 365 -Since | Add-PWUsersToConnectedProject -FolderPath "PWPS Connected Project Test 6\Projects 2\Project A"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWUsersToConnectedProjectByGroup --> <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-PWUsersToConnectedProjectByGroup</command:name> <command:verb>Add</command:verb> <command:noun>PWUsersToConnectedProjectByGroup</command:noun> <maml:description> <maml:para>Takes a group name and associates users in the group with the CONNECTed project associated with the rich project given a ProjectWise folder path or folder id.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a group name and associates users in the group with the CONNECTed project associated with the rich project given a ProjectWise folder path or folder id. You can specify the rights each user should be given. Only users with email addresses specified will be added to the CONNECTed project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWUsersToConnectedProjectByGroup</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path to the rich project from which we'll find the associated CONNECTed project.</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: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Id of rich project from which we'll find the associated CONNECTed project.</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: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group name containing participants to add to CONNECTed project.</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: Review --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Review</maml:name> <maml:description> <maml:para>Set to grant Review privileges to the users.</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: Issue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Issue</maml:name> <maml:description> <maml:para>Set to grant Issue privileges to the users.</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: Receive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Receive</maml:name> <maml:description> <maml:para>Set to grant Receive privileges to the users.</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: Administrator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Administrator</maml:name> <maml:description> <maml:para>Set to grant Administrator privileges to the users.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Will use current CONNECT client session 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Will use current CONNECT client session if not set.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Path to the rich project from which we'll find the associated CONNECTed project.</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: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Id of rich project from which we'll find the associated CONNECTed project.</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: Group --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group name containing participants to add to CONNECTed project.</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: Review --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Review</maml:name> <maml:description> <maml:para>Set to grant Review privileges to the users.</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: Issue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Issue</maml:name> <maml:description> <maml:para>Set to grant Issue privileges to the users.</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: Receive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Receive</maml:name> <maml:description> <maml:para>Set to grant Receive privileges to the users.</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: Administrator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Administrator</maml:name> <maml:description> <maml:para>Set to grant Administrator privileges to the users.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Will use current CONNECT client session 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Will use current CONNECT client session if not set.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</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>#Example usage for adding users to a CONNECTED project.</maml:para> <maml:para>Open-PWConnection -DatasourceName Server:DSN -UserName pwadmin -Password p@ssw0rd</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>#Will add the users with email who have logged in within the last year to the CONNECTed Project associated with the ProjectWise Rich Project identified by that path</maml:para> <maml:para>Add-PWUsersToConnectedProjectByGroup -FolderPath "PWPS Connected Project Test 6\Projects 2\Project A" -Group "Project Managers"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Convert-PWUserToFederated --> <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>Convert-PWUserToFederated</command:name> <command:verb>Convert</command:verb> <command:noun>PWUserToFederated</command:noun> <maml:description> <maml:para>Convert-PWUserToFederated updates a user to a Federated user using the user's email address. Can be overriden by specifying identity name.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Convert-PWUserToFederated</maml:name> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IdentityName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IdentityName</maml:name> <maml:description> <maml:para>Optional identity name to apply to user. Will use user's email by default for identity.</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: NewUserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewUserName</maml:name> <maml:description> <maml:para>Optional new user name to apply to user.</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: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IdentityName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IdentityName</maml:name> <maml:description> <maml:para>Optional identity name to apply to user. Will use user's email by default for identity.</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: NewUserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewUserName</maml:name> <maml:description> <maml:para>Optional new user name to apply to user.</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:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Will update user account to a Federated user and update Identity name to the user's email.</maml:para> <maml:para>Get-PWUserByMatch -Email '*bentley.com' | Convert-PWUserToFederated</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>#Will update user account to a Federated Identity and update Identity name.</maml:para> <maml:para>Convert-PWUserToFederated -UserID 2 -IdentityName 'PWUser1'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWUserToGroup --> <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-PWUserToGroup</command:name> <command:verb>Add</command:verb> <command:noun>PWUserToGroup</command:noun> <maml:description> <maml:para>Add users from the pipeline or by search to a named group.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Add-PWUserToGroup</maml:name> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group name to add users to (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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to add.</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> <!-- Parameter set: UserId --> <command:syntaxItem> <maml:name>Add-PWUserToGroup</maml:name> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group name to add users to (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: UserId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Add-PWUserToGroup</maml:name> <!-- Parameter: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group name to add users to (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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to add.</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: UserId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group name to add users to (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:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of user names to add.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Add-PWUserToGroup -GroupName "Administrators"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserToLogical --> <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>Set-PWUserToLogical</command:name> <command:verb>Set</command:verb> <command:noun>PWUserToLogical</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWUserToLogical</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Domain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserList</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Group</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PasswordPrefix --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>PasswordPrefix</maml:name> <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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Domain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UserList</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Group --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Group</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PasswordPrefix --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>PasswordPrefix</maml:name> <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:command> <!-- Cmdlet: Add-PWUserToUserList --> <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-PWUserToUserList</command:name> <command:verb>Add</command:verb> <command:noun>PWUserToUserList</command:noun> <maml:description> <maml:para>Add users from the pipeline or by search to a named user list.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Add-PWUserToUserList</maml:name> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list 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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</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> <!-- Parameter set: UserId --> <command:syntaxItem> <maml:name>Add-PWUserToUserList</maml:name> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list 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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Add-PWUserToUserList</maml:name> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</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: UserId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputUser --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>User list 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user names to add to user list (supports wildcards).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user ids to add to user list.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects from the pipeline to add to user list.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Add-PWUserToUserList -UserList "Project 10100 Engineers"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUserWorkingDirectory --> <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>Get-PWUserWorkingDirectory</command:name> <command:verb>Get</command:verb> <command:noun>PWUserWorkingDirectory</command:noun> <maml:description> <maml:para>Get the working directory for user.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Get-PWUserWorkingDirectory</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to add.</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> <!-- Parameter set: UserId --> <command:syntaxItem> <maml:name>Get-PWUserWorkingDirectory</maml:name> <!-- Parameter: UserId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Get-PWUserWorkingDirectory</maml:name> <!-- Parameter: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to add.</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: UserId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of user names to add.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-PWUserWorkingDirectory -UserName pwadmin</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserWorkingDirectory --> <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>Set-PWUserWorkingDirectory</command:name> <command:verb>Set</command:verb> <command:noun>PWUserWorkingDirectory</command:noun> <maml:description> <maml:para>Add working directory for user.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: UserName --> <command:syntaxItem> <maml:name>Set-PWUserWorkingDirectory</maml:name> <!-- Parameter: WorkingFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>WorkingFolder</maml:name> <maml:description> <maml:para>Working folder name. Will create if 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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to add.</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> <!-- Parameter set: UserId --> <command:syntaxItem> <maml:name>Set-PWUserWorkingDirectory</maml:name> <!-- Parameter: WorkingFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>WorkingFolder</maml:name> <maml:description> <maml:para>Working folder name. Will create if 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: UserId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Set-PWUserWorkingDirectory</maml:name> <!-- Parameter: WorkingFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>WorkingFolder</maml:name> <maml:description> <maml:para>Working folder name. Will create if 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: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>List of user names to add.</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: UserId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InputUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUser</maml:name> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> <command:parameterValue required="true">User[]</command:parameterValue> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WorkingFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>WorkingFolder</maml:name> <maml:description> <maml:para>Working folder name. Will create if 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of user names to add.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>List of user ids to add.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects to add.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Working folder name. Will create if does not exist.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Set working directory for a user</maml:para> <maml:para>Set-PWUserWorkingDirectory -UserName pwadmin -WorkingDirectory 'c:\pwwork\ds1\pwadmin'</maml:para> <maml:para>#Set working directory for an array of users</maml:para> <maml:para>$users = Get-PWUsersByMatch xadmin13, xadmin14</maml:para> <maml:para>foreach ($user in $users)</maml:para> <maml:para>{</maml:para> <maml:para>Set-PWUserAdminRights $user -Verbose</maml:para> <maml:para>Set-PWUserWorkingDirectory $user -WorkingFolder("c:\pwwork\pwv8i\" + $user.Name) -Verbose</maml:para> <maml:para>}</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWVersion --> <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>Get-PWVersion</command:name> <command:verb>Get</command:verb> <command:noun>PWVersion</command:noun> <maml:description> <maml:para>Get current ProjectWise version.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for getting ProjectWise version.</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Get-PWVersion</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWViews --> <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>Get-PWViews</command:name> <command:verb>Get</command:verb> <command:noun>PWViews</command:noun> <maml:description> <maml:para>Get list of generally available views in the datasource.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for getting view in the datasouce.</maml:para> <maml:para>Import-Module pwps_dab</maml:para> <maml:para>Get-PWViews</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWWorkflow --> <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-PWWorkflow</command:name> <command:verb>New</command:verb> <command:noun>PWWorkflow</command:noun> <maml:description> <maml:para>Adds new workflow to the current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWWorkflow</maml:name> <!-- Parameter: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WorkflowDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>WorkflowDescription</maml:name> <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: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WorkflowDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>WorkflowDescription</maml:name> <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>#Example usage for New-PWWorkflow.</maml:para> <maml:para>#Will return a workflow object for the new workflow in the current datasource.</maml:para> <maml:para>New-PWWorkflow -WorkflowName 'Design' -WorkflowDescription 'Design Workflow'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWWorkflow --> <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>Remove-PWWorkflow</command:name> <command:verb>Remove</command:verb> <command:noun>PWWorkflow</command:noun> <maml:description> <maml:para>Removes the specified workflow from current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWWorkflow</maml:name> <!-- Parameter: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <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: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <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>#Example usage for Remove-PWWorkflow.</maml:para> <maml:para>#Will return "true" if the workflow is successfully removed from the current datasource.</maml:para> <maml:para>Remove-PWWorkflow -WorkflowName 'Approved'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Clear-PWWorkflowByFolderPath --> <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>Clear-PWWorkflowByFolderPath</command:name> <command:verb>Clear</command:verb> <command:noun>PWWorkflowByFolderPath</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Clear-PWWorkflowByFolderPath</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SubFolders</maml:name> <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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SubFolders</maml:name> <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:command> <!-- Cmdlet: Set-PWWorkflowByFolderPath --> <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>Set-PWWorkflowByFolderPath</command:name> <command:verb>Set</command:verb> <command:noun>PWWorkflowByFolderPath</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWWorkflowByFolderPath</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>WorkflowName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>State</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SubFolders</maml:name> <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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>WorkflowName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>State</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SubFolders</maml:name> <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:command> <!-- Cmdlet: Get-PWWorkflows --> <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>Get-PWWorkflows</command:name> <command:verb>Get</command:verb> <command:noun>PWWorkflows</command:noun> <maml:description> <maml:para>Returns all workflow objects from current datasource.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Example usage for Get-PWWorkflows.</maml:para> <maml:para>#Will return all workflow objects from current datasource.</maml:para> <maml:para>Get-PWWorkflows</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWWorkflowState --> <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-PWWorkflowState</command:name> <command:verb>Add</command:verb> <command:noun>PWWorkflowState</command:noun> <maml:description> <maml:para>Adds the specified state to the specified workflow within the current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWWorkflowState</maml:name> <!-- Parameter: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>StateName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextStateName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextStateName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreviousStateName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreviousStateName</maml:name> <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: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>StateName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PreviousStateName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreviousStateName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NextStateName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NextStateName</maml:name> <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>#Example usage for Add-PWWorkflowState.</maml:para> <maml:para>#Will return "true" if the state is successfully added to the workflow within the current datasource.</maml:para> <maml:para>Add-PWWorkflowState -Workflow 'Default Workflow' -StateName 'Review' -PreviousStateName 'Draft' -NextStateName 'Pending Approval'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWWorkflowStateLinks --> <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>Get-PWWorkflowStateLinks</command:name> <command:verb>Get</command:verb> <command:noun>PWWorkflowStateLinks</command:noun> <maml:description> <maml:para>Returns all state objects that are members of the specified workflow from current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWWorkflowStateLinks</maml:name> <!-- Parameter: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <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: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <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>#Example usage for Get-PWWorkflowStateLinks.</maml:para> <maml:para>#Will return all state objects that are members of the specified workflow from current datasource.</maml:para> <maml:para>Get-PWWorkflowStateLinks -WorkflowName 'Default Workflow'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWWorkflowStateLinks --> <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>Remove-PWWorkflowStateLinks</command:name> <command:verb>Remove</command:verb> <command:noun>PWWorkflowStateLinks</command:noun> <maml:description> <maml:para>Removes the specified state from the specified workflow within the current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWWorkflowStateLinks</maml:name> <!-- Parameter: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>StateName</maml:name> <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: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>StateName</maml:name> <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>#Example usage for Remove-PWWorkflowStateLinks.</maml:para> <maml:para>#Will return an updated array of state objects for the specified workflow within the current datasource.</maml:para> <maml:para>Remove-PWWorkflowStateLinks -Workflow 'Default Workflow' -StateName 'Review'</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-RandomString --> <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>Get-RandomString</command:name> <command:verb>Get</command:verb> <command:noun>RandomString</command:noun> <maml:description> <maml:para>Get a random string of a given length. Default characters to be used are abcdefghijklmnopqrstuvwxyzABCEDEFGHIJKLMNOPQRUSTUVWXYZ1234567890 but can be changed by parameter -Characters</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-RandomString</maml:name> <!-- Parameter: Characters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Characters</maml:name> <maml:description> <maml:para>Characters to use for string generation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890</dev:defaultValue> </command:parameter> <!-- Parameter: Length --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Length</maml:name> <maml:description> <maml:para>Length of string to generate (Required).</maml:para> <maml:para>Array of System.Data.DataTable from the pipeline (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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Length --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Length</maml:name> <maml:description> <maml:para>Length of string to generate (Required).</maml:para> <maml:para>Array of System.Data.DataTable from the pipeline (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: Characters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Characters</maml:name> <maml:description> <maml:para>Characters to use for string generation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-RandomString -Length 10 -Characters "abcdefghijklmnopqrstuvwxyz1234567890"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-TablesFromXLSXWorkbook --> <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>Get-TablesFromXLSXWorkbook</command:name> <command:verb>Get</command:verb> <command:noun>TablesFromXLSXWorkbook</command:noun> <maml:description> <maml:para>Read a table-formatted XLSX workbook into an array of data tables.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-TablesFromXLSXWorkbook</maml:name> <!-- Parameter: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <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: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <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>#Read data tables from XLSX</maml:para> <maml:para>Get-TablesFromXLSXWorktook -InputFileName "c:\temp\datatables.xlsx"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-XLSXWorkbook --> <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-XLSXWorkbook</command:name> <command:verb>New</command:verb> <command:noun>XLSXWorkbook</command:noun> <maml:description> <maml:para>Write an array of generic DataTables to an XLSX Workbook.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputTables --> <command:syntaxItem> <maml:name>New-XLSXWorkbook</maml:name> <!-- Parameter: InputTables --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputTables</maml:name> <maml:description> <maml:para>Array of System.Data.DataTable from the pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">DataTable[]</command:parameterValue> <dev:type> <maml:name>System.Data.DataTable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Output file name.</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: Open --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Open</maml:name> <maml:description> <maml:para>Open created workbook in Excel.</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: InputTables --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputTables</maml:name> <maml:description> <maml:para>Array of System.Data.DataTable from the pipeline (Required).</maml:para> </maml:description> <command:parameterValue required="true">DataTable[]</command:parameterValue> <dev:type> <maml:name>System.Data.DataTable[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Output file name.</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: Open --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Open</maml:name> <maml:description> <maml:para>Open created workbook in Excel.</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:inputType> <dev:type> <maml:name>System.Data.DataTable[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of System.Data.DataTable from the pipeline (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>#Get a report of documents in the given folder tree and output to XLSX directly</maml:para> <maml:para>Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS\Projects 2\Project A" -Recurse -IncludeAuditTrail | New-XLSXWorkbook -OutputFileName c:\temp\tables.xlsx</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> </helpItems> |